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  *  \file
  30  *  This file contain internal structures and function prototypes related
  31  *  to the playlist in vlc
  32  *
  33  * \defgroup vlc_playlist Playlist
  34  * @{
  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     playlist_preparser_t *p_preparser;  /**< Preparser data */
  51     struct intf_thread_t *interface; /**< Linked-list of interfaces */
  52
  53     playlist_item_array_t items_to_delete; /**< Array of items and nodes to
  54             delete... At the very end. This sucks. */
  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_status_t   i_status;  /**< Current status of playlist */
  65         playlist_item_t *   p_item; /**< Currently playing/active item */
  66         playlist_item_t *   p_node; /**< Current node to play from */
  67     } status;
  68
  69     struct {
  70         /* Request. Use this to give orders to the playlist main loop  */
  71         playlist_status_t   i_status; /**< requested playlist status */
  72         playlist_item_t *   p_node;   /**< requested node to play from */
  73         playlist_item_t *   p_item;   /**< requested item to play in the node */
  74
  75         int                 i_skip;   /**< Number of items to skip */
  76
  77         bool          b_request;/**< Set to true by the requester
  78                                            The playlist sets it back to false
  79                                            when processing the request */
  80         vlc_mutex_t         lock;     /**< Lock to protect request */
  81     } request;
  82
  83     vlc_thread_t thread; /**< engine thread */
  84     vlc_mutex_t lock; /**< dah big playlist global lock */
  85     vlc_cond_t signal; /**< wakes up the playlist engine thread */
  86     bool     killed; /**< playlist is shutting down */
  87
  88     int      i_last_playlist_id; /**< Last id to an item */
  89     bool     b_reset_currently_playing; /** Reset current item array */
  90
  91     bool     b_tree; /**< Display as a tree */
  92     bool     b_doing_ml; /**< Doing media library stuff  get quicker */
  93 } playlist_private_t;
  94
  95 #define pl_priv( pl ) ((playlist_private_t *)(pl))
  96
  97 /*****************************************************************************
  98  * Prototypes
  99  *****************************************************************************/
 100
 101 /* Creation/Deletion */
 102 playlist_t *playlist_Create( vlc_object_t * );
 103 void playlist_Destroy( playlist_t * );
 104 void playlist_Activate( playlist_t * );
 105
 106 /* */
 107 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
 108                                             input_item_t *p_input );
 109
 110 /* Engine */
 111 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
 112 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
 113 void set_current_status_item( playlist_t *, playlist_item_t * );
 114 void set_current_status_node( playlist_t *, playlist_item_t * );
 115
 116 /* Load/Save */
 117 int playlist_MLLoad( playlist_t *p_playlist );
 118 int playlist_MLDump( playlist_t *p_playlist );
 119
 120 /**********************************************************************
 121  * Item management
 122  **********************************************************************/
 123
 124 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
 125                              int i_node_id, bool b_signal );
 126
 127 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
 128         playlist_item_t *,int , int, bool );
 129
 130 int playlist_InsertInputItemTree ( playlist_t *,
 131         playlist_item_t *, input_item_node_t *, int, bool );
 132
 133 /* Tree walking */
 134 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
 135                                 input_item_t *p_input, playlist_item_t *p_root,
 136                                 bool );
 137
 138 int playlist_DeleteFromInputInParent( playlist_t *, input_item_t *,
 139                                       playlist_item_t *, bool );
 140 int playlist_DeleteFromItemId( playlist_t*, int );
 141 int playlist_ItemRelease( playlist_item_t * );
 142
 143 int playlist_NodeEmpty( playlist_t *, playlist_item_t *, bool );
 144 int playlist_DeleteItem( playlist_t * p_playlist, playlist_item_t *, bool);
 145
 146 void ResetCurrentlyPlaying( playlist_t *p_playlist, playlist_item_t *p_cur );
 147 void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur );
 148
 149 /**
 150  * @}
 151  */
 152
 153 #define PLAYLIST_DEBUG 1
 154 //#undef PLAYLIST_DEBUG2
 155
 156 #ifdef PLAYLIST_DEBUG
 157  #define PL_DEBUG( ... ) msg_Dbg( p_playlist, __VA_ARGS__ )
 158  #ifdef PLAYLIST_DEBUG2
 159   #define PL_DEBUG2( msg, ... ) msg_Dbg( p_playlist, __VA_ARGS__ )
 160  #else
 161   #define PL_DEBUG2( msg, ... ) {}
 162  #endif
 163 #else
 164  #define PL_DEBUG( msg, ... ) {}
 165  #define PL_DEBUG2( msg, ... ) {}
 166 #endif
 167
 168 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
 169
 170 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
 171 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
 172 {
 173     if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
 174 }
 175
 176 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
 177 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
 178 {
 179     if( cond ) PL_UNLOCK;
 180 }
 181
 182 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */