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