src/playlist_legacy/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 "preparser/preparser.h"
  41
  42 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
  43
  44 typedef struct playlist_private_t
  45 {
  46     playlist_t           public_data;
  47     struct intf_thread_t *interface; /**< Linked-list of interfaces */
  48
  49     void *input_tree; /**< Search tree for input item
  50                            to playlist item mapping */
  51     void *id_tree; /**< Search tree for item ID to item mapping */
  52
  53     struct vlc_list       sds;
  54     input_thread_t *      p_input;  /**< the input thread associated
  55                                      * with the current item */
  56     input_resource_t *   p_input_resource; /**< input resources */
  57     vlc_renderer_item_t *p_renderer;
  58     struct {
  59         /* Current status. These fields are readonly, only the playlist
  60          * main loop can touch it*/
  61         playlist_item_t *   p_item; /**< Currently playing/active item */
  62         playlist_item_t *   p_node; /**< Current node to play from */
  63     } status;
  64
  65     struct {
  66         /* Request. Use this to give orders to the playlist main loop  */
  67         playlist_item_t *   p_node;   /**< requested node to play from */
  68         playlist_item_t *   p_item;   /**< requested item to play in the node */
  69
  70         int                 i_skip;   /**< Number of items to skip */
  71
  72         bool          b_request;/**< Set to true by the requester
  73                                            The playlist sets it back to false
  74                                            when processing the request */
  75         bool input_dead; /**< Set when input has finished. */
  76     } request;
  77
  78     vlc_thread_t thread; /**< engine thread */
  79     vlc_mutex_t lock; /**< dah big playlist global lock */
  80     vlc_cond_t signal; /**< wakes up the playlist engine thread */
  81     bool     killed; /**< playlist is shutting down */
  82     bool     cork_effective; /**< Corked while actively playing */
  83
  84     int      i_last_playlist_id; /**< Last id to an item */
  85     bool     b_reset_currently_playing; /** Reset current item array */
  86
  87     bool     b_tree; /**< Display as a tree */
  88     bool     b_preparse; /**< Preparse items */
  89 } playlist_private_t;
  90
  91 #define pl_priv( pl ) container_of(pl, playlist_private_t, public_data)
  92
  93 /*****************************************************************************
  94  * Prototypes
  95  *****************************************************************************/
  96
  97 /* Creation/Deletion */
  98 playlist_t *playlist_Create( vlc_object_t * );
  99 void playlist_Destroy( playlist_t * );
 100 void playlist_Activate( playlist_t * );
 101
 102 /* */
 103 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
 104                                             input_item_t *p_input );
 105
 106 /* Engine */
 107 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
 108 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
 109 void set_current_status_item( playlist_t *, playlist_item_t * );
 110 void set_current_status_node( playlist_t *, playlist_item_t * );
 111
 112 /**********************************************************************
 113  * Item management
 114  **********************************************************************/
 115
 116 void playlist_SendAddNotify( playlist_t *p_playlist, playlist_item_t *item );
 117
 118 int playlist_InsertInputItemTree ( playlist_t *,
 119         playlist_item_t *, input_item_node_t *, int, bool );
 120
 121 void playlist_AddSubtree(playlist_t *, input_item_t *, input_item_node_t *);
 122
 123 /* Tree walking */
 124 int playlist_NodeInsert(playlist_item_t*, playlist_item_t *, int);
 125
 126 /**
 127  * Flags for playlist_NodeDeleteExplicit
 128  * \defgroup playlist_NodeDeleteExplicit_flags
 129  * @{
 130  **/
 131 #define PLAYLIST_DELETE_FORCE 0x01 /**< delete node even if read-only */
 132 #define PLAYLIST_DELETE_STOP_IF_CURRENT 0x02 /**< stop playlist playback if
 133                                                   node is currently the one
 134                                                   played */
 135 /** @} */
 136
 137 /**
 138  * Delete a node with explicit semantics
 139  *
 140  * This function acts like \ref playlist_NodeDelete with the advantage of the
 141  * caller being able control some of the semantics of the function.
 142  *
 143  * \ref p_playlist the playlist where the node is to be deleted
 144  * \ref p_node the node to delete
 145  * \ref flags a bitfield consisting of \ref playlist_NodeDeleteExplicit_flags
 146  **/
 147 void playlist_NodeDeleteExplicit(playlist_t*, playlist_item_t*,
 148     int flags);
 149
 150 void playlist_ItemRelease( playlist_t *, playlist_item_t * );
 151
 152 void ResetCurrentlyPlaying( playlist_t *p_playlist, playlist_item_t *p_cur );
 153 void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur );
 154
 155 playlist_item_t * playlist_GetNextLeaf( playlist_t *, playlist_item_t *p_root,
 156     playlist_item_t *p_item, bool b_ena, bool b_unplayed ) VLC_USED;
 157
 158 #define PLAYLIST_DEBUG 1
 159 //#undef PLAYLIST_DEBUG2
 160
 161 #ifdef PLAYLIST_DEBUG
 162  #define PL_DEBUG( ... ) msg_Dbg( p_playlist, __VA_ARGS__ )
 163  #ifdef PLAYLIST_DEBUG2
 164   #define PL_DEBUG2( msg, ... ) msg_Dbg( p_playlist, __VA_ARGS__ )
 165  #else
 166   #define PL_DEBUG2( msg, ... ) {}
 167  #endif
 168 #else
 169  #define PL_DEBUG( msg, ... ) {}
 170  #define PL_DEBUG2( msg, ... ) {}
 171 #endif
 172
 173 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
 174
 175 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
 176 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
 177 {
 178     if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
 179 }
 180
 181 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
 182 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
 183 {
 184     if( cond ) PL_UNLOCK;
 185 }
 186
 187 /** @} */
 188 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */