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

   1 /*****************************************************************************
   2  * playlist_internal.h : Functions for use by the playlist
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 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_COMMON_MEMBERS
  43     vlc_mutex_t     lock;
  44     int             i_waiting;
  45     input_item_t  **pp_waiting;
  46 } playlist_preparse_t;
  47
  48 typedef struct playlist_fetcher_t
  49 {
  50     VLC_COMMON_MEMBERS
  51     vlc_mutex_t     lock;
  52     int             i_art_policy;
  53     int             i_waiting;
  54     input_item_t    **pp_waiting;
  55
  56     DECL_ARRAY(playlist_album_t) albums;
  57 } playlist_fetcher_t;
  58
  59 struct playlist_private_t
  60 {
  61     playlist_preparse_t  *p_preparse; /**< Preparser object */
  62     playlist_fetcher_t   *p_fetcher; /**< Meta and art fetcher object */
  63     sout_instance_t      *p_sout; /**< Kept sout instance */
  64 };
  65
  66 /*****************************************************************************
  67  * Prototypes
  68  *****************************************************************************/
  69
  70 /* Global thread */
  71 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
  72 void        __playlist_ThreadCreate   ( vlc_object_t * );
  73
  74 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
  75                                               input_item_t *p_input );
  76
  77 /* Creation/Deletion */
  78 playlist_t *playlist_Create   ( vlc_object_t * );
  79
  80 /* Engine */
  81 void playlist_MainLoop( playlist_t * );
  82 void playlist_LastLoop( playlist_t * );
  83 void playlist_PreparseLoop( playlist_preparse_t * );
  84 void playlist_FetcherLoop( playlist_fetcher_t * );
  85
  86 void ResetCurrentlyPlaying( playlist_t *, bool, playlist_item_t * );
  87
  88 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
  89 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
  90 void set_current_status_item( playlist_t *, playlist_item_t * );
  91 void set_current_status_node( playlist_t *, playlist_item_t * );
  92
  93 /* Control */
  94 playlist_item_t * playlist_NextItem  ( playlist_t * );
  95 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
  96
  97 /* Load/Save */
  98 int playlist_MLLoad( playlist_t *p_playlist );
  99 int playlist_MLDump( playlist_t *p_playlist );
 100
 101 /**********************************************************************
 102  * Item management
 103  **********************************************************************/
 104
 105 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
 106                              int i_node_id, bool b_signal );
 107
 108 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
 109         playlist_item_t *,int , int, bool );
 110
 111 /* Tree walking */
 112 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
 113                                    int i_input_id, playlist_item_t *p_root,
 114                                    bool );
 115
 116 int playlist_DeleteFromInputInParent( playlist_t *, int, playlist_item_t *, bool );
 117 int playlist_DeleteFromItemId( playlist_t*, int );
 118 int playlist_ItemRelease( playlist_item_t * );
 119
 120 void playlist_release_current_input( playlist_t * p_playlist );
 121 void playlist_set_current_input(
 122     playlist_t * p_playlist, input_thread_t * p_input );
 123
 124 /**
 125  * @}
 126  */
 127
 128 #define PLAYLIST_DEBUG 1
 129 //#undef PLAYLIST_DEBUG2
 130
 131 #ifdef PLAYLIST_DEBUG
 132  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 133  #ifdef PLAYLIST_DEBUG2
 134   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 135  #else
 136   #define PL_DEBUG2( msg, args... ) {}
 137  #endif
 138 #else
 139  #define PL_DEBUG( msg, args ... ) {}
 140  #define PL_DEBUG2( msg, args... ) {}
 141 #endif
 142
 143 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
 144
 145 #define PL_ASSERT_LOCKED vlc_assert_locked( &(vlc_internals(p_playlist)->lock) )
 146
 147 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
 148 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
 149 {
 150     if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
 151 }
 152
 153 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
 154 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
 155 {
 156     if( cond ) PL_UNLOCK;
 157 }
 158
 159 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */