src/playlist/playlist_internal.h

   1 /*****************************************************************************
   2  * playlist_internal.h : Playlist internals
   3  *****************************************************************************
   4  * Copyright (C) 1999-2008 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Clément Stenac <zorglub@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef __LIBVLC_PLAYLIST_INTERNAL_H
  26 # define __LIBVLC_PLAYLIST_INTERNAL_H 1
  27
  28 /**
  29  * \defgroup playlist_internals VLC playlist internals
  30  * \ingroup playlist
  31  *
  32  * @{
  33  * \file
  34  * VLC playlist internal interface
  35  */
  36
  37 #include "input/input_interface.h"
  38 #include <assert.h>
  39
  40 #include "art.h"
  41 #include "preparser.h"
  42
  43 typedef struct vlc_sd_internal_t vlc_sd_internal_t;
  44
  45 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
  46
  47 typedef struct playlist_private_t
  48 {
  49     playlist_t           public_data;
  50     struct intf_thread_t *interface; /**< Linked-list of interfaces */
  51
  52     void *input_tree; /**< Search tree for input item
  53                            to playlist item mapping */
  54     void *id_tree; /**< Search tree for item ID to item mapping */
  55
  56     vlc_sd_internal_t   **pp_sds;
  57     int                   i_sds;   /**< Number of service discovery modules */
  58     input_thread_t *      p_input;  /**< the input thread associated
  59                                      * with the current item */
  60     input_resource_t *   p_input_resource; /**< input resources */
  61     struct {
  62         /* Current status. These fields are readonly, only the playlist
  63          * main loop can touch it*/
  64         playlist_item_t *   p_item; /**< Currently playing/active item */
  65         playlist_item_t *   p_node; /**< Current node to play from */
  66     } status;
  67
  68     struct {
  69         /* Request. Use this to give orders to the playlist main loop  */
  70         playlist_item_t *   p_node;   /**< requested node to play from */
  71         playlist_item_t *   p_item;   /**< requested item to play in the node */
  72
  73         int                 i_skip;   /**< Number of items to skip */
  74
  75         bool          b_request;/**< Set to true by the requester
  76                                            The playlist sets it back to false
  77                                            when processing the request */
  78     } request;
  79
  80     vlc_thread_t thread; /**< engine thread */
  81     vlc_mutex_t lock; /**< dah big playlist global lock */
  82     vlc_cond_t signal; /**< wakes up the playlist engine thread */
  83     bool     killed; /**< playlist is shutting down */
  84
  85     int      i_last_playlist_id; /**< Last id to an item */
  86     bool     b_reset_currently_playing; /** Reset current item array */
  87
  88     bool     b_tree; /**< Display as a tree */
  89     bool     b_preparse; /**< Preparse items */
  90 } playlist_private_t;
  91
  92 #define pl_priv( pl ) container_of(pl, playlist_private_t, public_data)
  93
  94 /*****************************************************************************
  95  * Prototypes
  96  *****************************************************************************/
  97
  98 /* Creation/Deletion */
  99 playlist_t *playlist_Create( vlc_object_t * );
 100 void playlist_Destroy( playlist_t * );
 101 void playlist_Activate( playlist_t * );
 102
 103 /* */
 104 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
 105                                             input_item_t *p_input );
 106
 107 /* Engine */
 108 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
 109 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
 110 void set_current_status_item( playlist_t *, playlist_item_t * );
 111 void set_current_status_node( playlist_t *, playlist_item_t * );
 112
 113 /* Load/Save */
 114 int playlist_MLLoad( playlist_t *p_playlist );
 115 int playlist_MLDump( playlist_t *p_playlist );
 116
 117 /**********************************************************************
 118  * Item management
 119  **********************************************************************/
 120
 121 void playlist_SendAddNotify( playlist_t *p_playlist, playlist_item_t *item );
 122
 123 int playlist_InsertInputItemTree ( playlist_t *,
 124         playlist_item_t *, input_item_node_t *, int, bool );
 125
 126 /* Tree walking */
 127 int playlist_NodeInsert(playlist_item_t*, playlist_item_t *, int);
 128
 129 /**
 130  * Flags for playlist_NodeDeleteExplicit
 131  * \defgroup playlist_NodeDeleteExplicit_flags
 132  * @{
 133  **/
 134 #define PLAYLIST_DELETE_FORCE 0x01 /**< delete node even if read-only */
 135 #define PLAYLIST_DELETE_STOP_IF_CURRENT 0x02 /**< stop playlist playback if
 136                                                   node is currently the one
 137                                                   played */
 138 /** @} */
 139
 140 /**
 141  * Delete a node with explicit semantics
 142  *
 143  * This function acts like \ref playlist_NodeDelete with the advantage of the
 144  * caller being able control some of the semantics of the function.
 145  *
 146  * \ref p_playlist the playlist where the node is to be deleted
 147  * \ref p_node the node to delete
 148  * \ref flags a bitfield consisting of \ref playlist_NodeDeleteExplicit_flags
 149  **/
 150 void playlist_NodeDeleteExplicit(playlist_t*, playlist_item_t*,
 151     int flags);
 152
 153 void playlist_ItemRelease( playlist_t *, playlist_item_t * );
 154
 155 void ResetCurrentlyPlaying( playlist_t *p_playlist, playlist_item_t *p_cur );
 156 void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur );
 157
 158 playlist_item_t * playlist_GetNextLeaf( playlist_t *, playlist_item_t *p_root,
 159     playlist_item_t *p_item, bool b_ena, bool b_unplayed ) VLC_USED;
 160
 161 #define PLAYLIST_DEBUG 1
 162 //#undef PLAYLIST_DEBUG2
 163
 164 #ifdef PLAYLIST_DEBUG
 165  #define PL_DEBUG( ... ) msg_Dbg( p_playlist, __VA_ARGS__ )
 166  #ifdef PLAYLIST_DEBUG2
 167   #define PL_DEBUG2( msg, ... ) msg_Dbg( p_playlist, __VA_ARGS__ )
 168  #else
 169   #define PL_DEBUG2( msg, ... ) {}
 170  #endif
 171 #else
 172  #define PL_DEBUG( msg, ... ) {}
 173  #define PL_DEBUG2( msg, ... ) {}
 174 #endif
 175
 176 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
 177
 178 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
 179 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
 180 {
 181     if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
 182 }
 183
 184 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
 185 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
 186 {
 187     if( cond ) PL_UNLOCK;
 188 }
 189
 190 /** @} */
 191 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */