git.sesse.net Git - vlc/blob - src/playlist/playlist_internal.h

   1 /*****************************************************************************
   2  * playlist_internal.h : Playlist internals
   3  *****************************************************************************
   4  * Copyright (C) 1999-2008 the VideoLAN team
   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
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 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 General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, 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_internal.h"
  38 #include <assert.h>
  39
  40 typedef struct playlist_preparse_t
  41 {
  42     vlc_thread_t    thread;
  43     vlc_mutex_t     lock;
  44     vlc_cond_t      wait;
  45     input_item_t  **pp_waiting;
  46     int             i_waiting;
  47     bool            up;
  48 } playlist_preparse_t;
  49
  50 typedef struct playlist_fetcher_t
  51 {
  52     vlc_thread_t    thread;
  53     vlc_mutex_t     lock;
  54     vlc_cond_t      wait;
  55     int             i_art_policy;
  56     int             i_waiting;
  57     input_item_t    **pp_waiting;
  58     bool            up;
  59
  60     DECL_ARRAY(playlist_album_t) albums;
  61 } playlist_fetcher_t;
  62
  63 typedef struct playlist_private_t
  64 {
  65     playlist_t           public_data;
  66     playlist_preparse_t  preparse; /**< Preparser data */
  67     playlist_fetcher_t   fetcher; /**< Meta and art fetcher data */
  68     sout_instance_t      *p_sout; /**< Kept sout instance */
  69
  70     struct playlist_services_discovery_support_t {
  71         /* the playlist items for category and onelevel */
  72         playlist_item_t*    p_cat;
  73         playlist_item_t*    p_one;
  74         services_discovery_t * p_sd; /**< Loaded service discovery modules */
  75     } ** pp_sds;
  76     int                   i_sds;   /**< Number of service discovery modules */
  77     input_thread_t *      p_input;  /**< the input thread associated
  78                                      * with the current item */
  79     struct {
  80         /* Current status. These fields are readonly, only the playlist
  81          * main loop can touch it*/
  82         playlist_status_t   i_status;  /**< Current status of playlist */
  83         playlist_item_t *   p_item; /**< Currently playing/active item */
  84         playlist_item_t *   p_node; /**< Current node to play from */
  85     } status;
  86
  87     struct {
  88         /* Request. Use this to give orders to the playlist main loop  */
  89         playlist_status_t   i_status; /**< requested playlist status */
  90         playlist_item_t *   p_node;   /**< requested node to play from */
  91         playlist_item_t *   p_item;   /**< requested item to play in the node */
  92
  93         int                 i_skip;   /**< Number of items to skip */
  94
  95         bool          b_request;/**< Set to true by the requester
  96                                            The playlist sets it back to false
  97                                            when processing the request */
  98         vlc_mutex_t         lock;     /**< Lock to protect request */
  99     } request;
 100
 101 } playlist_private_t;
 102
 103 #define pl_priv( pl ) ((playlist_private_t *)(pl))
 104
 105 /*****************************************************************************
 106  * Prototypes
 107  *****************************************************************************/
 108
 109 /* Global thread */
 110 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
 111 void        __playlist_ThreadCreate   ( vlc_object_t * );
 112
 113 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
 114                                               input_item_t *p_input );
 115
 116 /* Creation/Deletion */
 117 playlist_t *playlist_Create   ( vlc_object_t * );
 118
 119 /* Engine */
 120 void playlist_MainLoop( playlist_t * );
 121 void playlist_LastLoop( playlist_t * );
 122 void *playlist_PreparseLoop( void * );
 123 void *playlist_FetcherLoop( void * );
 124
 125 void ResetCurrentlyPlaying( playlist_t *, bool, playlist_item_t * );
 126
 127 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
 128 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
 129 void set_current_status_item( playlist_t *, playlist_item_t * );
 130 void set_current_status_node( playlist_t *, playlist_item_t * );
 131
 132 /* Control */
 133 playlist_item_t * playlist_NextItem  ( playlist_t * );
 134 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
 135
 136 /* Load/Save */
 137 int playlist_MLLoad( playlist_t *p_playlist );
 138 int playlist_MLDump( playlist_t *p_playlist );
 139
 140 /**********************************************************************
 141  * Item management
 142  **********************************************************************/
 143
 144 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
 145                              int i_node_id, bool b_signal );
 146
 147 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
 148         playlist_item_t *,int , int, bool );
 149
 150 /* Tree walking */
 151 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
 152                                    int i_input_id, playlist_item_t *p_root,
 153                                    bool );
 154
 155 int playlist_DeleteFromInputInParent( playlist_t *, int, playlist_item_t *, bool );
 156 int playlist_DeleteFromItemId( playlist_t*, int );
 157 int playlist_ItemRelease( playlist_item_t * );
 158
 159 void playlist_release_current_input( playlist_t * p_playlist );
 160 void playlist_set_current_input(
 161     playlist_t * p_playlist, input_thread_t * p_input );
 162
 163 /**
 164  * @}
 165  */
 166
 167 #define PLAYLIST_DEBUG 1
 168 //#undef PLAYLIST_DEBUG2
 169
 170 #ifdef PLAYLIST_DEBUG
 171  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 172  #ifdef PLAYLIST_DEBUG2
 173   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 174  #else
 175   #define PL_DEBUG2( msg, args... ) {}
 176  #endif
 177 #else
 178  #define PL_DEBUG( msg, args ... ) {}
 179  #define PL_DEBUG2( msg, args... ) {}
 180 #endif
 181
 182 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
 183
 184 #define PL_ASSERT_LOCKED vlc_assert_locked( &(vlc_internals(p_playlist)->lock) )
 185
 186 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
 187 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
 188 {
 189     if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
 190 }
 191
 192 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
 193 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
 194 {
 195     if( cond ) PL_UNLOCK;
 196 }
 197
 198 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */