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