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 } playlist_private_t;
  70
  71 #define pl_priv( pl ) ((playlist_private_t *)(pl))
  72
  73 /*****************************************************************************
  74  * Prototypes
  75  *****************************************************************************/
  76
  77 /* Global thread */
  78 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
  79 void        __playlist_ThreadCreate   ( vlc_object_t * );
  80
  81 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
  82                                               input_item_t *p_input );
  83
  84 /* Creation/Deletion */
  85 playlist_t *playlist_Create   ( vlc_object_t * );
  86
  87 /* Engine */
  88 void playlist_MainLoop( playlist_t * );
  89 void playlist_LastLoop( playlist_t * );
  90 void *playlist_PreparseLoop( void * );
  91 void *playlist_FetcherLoop( void * );
  92
  93 void ResetCurrentlyPlaying( playlist_t *, bool, playlist_item_t * );
  94
  95 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
  96 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
  97 void set_current_status_item( playlist_t *, playlist_item_t * );
  98 void set_current_status_node( playlist_t *, playlist_item_t * );
  99
 100 /* Control */
 101 playlist_item_t * playlist_NextItem  ( playlist_t * );
 102 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
 103
 104 /* Load/Save */
 105 int playlist_MLLoad( playlist_t *p_playlist );
 106 int playlist_MLDump( playlist_t *p_playlist );
 107
 108 /**********************************************************************
 109  * Item management
 110  **********************************************************************/
 111
 112 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
 113                              int i_node_id, bool b_signal );
 114
 115 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
 116         playlist_item_t *,int , int, bool );
 117
 118 /* Tree walking */
 119 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
 120                                    int i_input_id, playlist_item_t *p_root,
 121                                    bool );
 122
 123 int playlist_DeleteFromInputInParent( playlist_t *, int, playlist_item_t *, bool );
 124 int playlist_DeleteFromItemId( playlist_t*, int );
 125 int playlist_ItemRelease( playlist_item_t * );
 126
 127 void playlist_release_current_input( playlist_t * p_playlist );
 128 void playlist_set_current_input(
 129     playlist_t * p_playlist, input_thread_t * p_input );
 130
 131 /**
 132  * @}
 133  */
 134
 135 #define PLAYLIST_DEBUG 1
 136 //#undef PLAYLIST_DEBUG2
 137
 138 #ifdef PLAYLIST_DEBUG
 139  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 140  #ifdef PLAYLIST_DEBUG2
 141   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 142  #else
 143   #define PL_DEBUG2( msg, args... ) {}
 144  #endif
 145 #else
 146  #define PL_DEBUG( msg, args ... ) {}
 147  #define PL_DEBUG2( msg, args... ) {}
 148 #endif
 149
 150 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
 151
 152 #define PL_ASSERT_LOCKED vlc_assert_locked( &(vlc_internals(p_playlist)->lock) )
 153
 154 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
 155 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
 156 {
 157     if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
 158 }
 159
 160 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
 161 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
 162 {
 163     if( cond ) PL_UNLOCK;
 164 }
 165
 166 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */