1 /*****************************************************************************
2 * playlist_internal.h : Playlist internals
3 *****************************************************************************
4 * Copyright (C) 1999-2008 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Clément Stenac <zorglub@videolan.org>
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.
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.
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 *****************************************************************************/
25 #ifndef __LIBVLC_PLAYLIST_INTERNAL_H
26 # define __LIBVLC_PLAYLIST_INTERNAL_H 1
30 * This file contain internal structures and function prototypes related
31 * to the playlist in vlc
33 * \defgroup vlc_playlist Playlist
37 #include "input/input_internal.h"
40 typedef struct playlist_preparse_t
45 input_item_t **pp_waiting;
48 } playlist_preparse_t;
50 typedef struct playlist_fetcher_t
57 input_item_t **pp_waiting;
60 DECL_ARRAY(playlist_album_t) albums;
63 typedef struct playlist_private_t
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 */
70 playlist_item_array_t items_to_delete; /**< Array of items and nodes to
71 delete... At the very end. This sucks. */
73 struct playlist_services_discovery_support_t {
74 /* the playlist items for category and onelevel */
75 playlist_item_t* p_cat;
76 playlist_item_t* p_one;
77 services_discovery_t * p_sd; /**< Loaded service discovery modules */
79 int i_sds; /**< Number of service discovery modules */
80 input_thread_t * p_input; /**< the input thread associated
81 * with the current item */
83 /* Current status. These fields are readonly, only the playlist
84 * main loop can touch it*/
85 playlist_status_t i_status; /**< Current status of playlist */
86 playlist_item_t * p_item; /**< Currently playing/active item */
87 playlist_item_t * p_node; /**< Current node to play from */
91 /* Request. Use this to give orders to the playlist main loop */
92 playlist_status_t i_status; /**< requested playlist status */
93 playlist_item_t * p_node; /**< requested node to play from */
94 playlist_item_t * p_item; /**< requested item to play in the node */
96 int i_skip; /**< Number of items to skip */
98 bool b_request;/**< Set to true by the requester
99 The playlist sets it back to false
100 when processing the request */
101 vlc_mutex_t lock; /**< Lock to protect request */
104 bool b_tree; /**< Display as a tree */
105 bool b_doing_ml; /**< Doing media library stuff get quicker */
106 bool b_auto_preparse;
109 } playlist_private_t;
111 #define pl_priv( pl ) ((playlist_private_t *)(pl))
113 /*****************************************************************************
115 *****************************************************************************/
118 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
119 void __playlist_ThreadCreate ( vlc_object_t * );
121 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
122 input_item_t *p_input );
124 /* Creation/Deletion */
125 playlist_t *playlist_Create ( vlc_object_t * );
128 void playlist_MainLoop( playlist_t * );
129 void playlist_LastLoop( playlist_t * );
130 void *playlist_PreparseLoop( void * );
131 void *playlist_FetcherLoop( void * );
133 void ResetCurrentlyPlaying( playlist_t *, bool, playlist_item_t * );
135 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
136 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
137 void set_current_status_item( playlist_t *, playlist_item_t * );
138 void set_current_status_node( playlist_t *, playlist_item_t * );
141 playlist_item_t * playlist_NextItem ( playlist_t * );
142 int playlist_PlayItem ( playlist_t *, playlist_item_t * );
145 int playlist_MLLoad( playlist_t *p_playlist );
146 int playlist_MLDump( playlist_t *p_playlist );
148 /**********************************************************************
150 **********************************************************************/
152 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
153 int i_node_id, bool b_signal );
155 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
156 playlist_item_t *,int , int, bool );
159 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
160 int i_input_id, playlist_item_t *p_root,
163 int playlist_DeleteFromInputInParent( playlist_t *, int, playlist_item_t *, bool );
164 int playlist_DeleteFromItemId( playlist_t*, int );
165 int playlist_ItemRelease( playlist_item_t * );
167 void playlist_release_current_input( playlist_t * p_playlist );
168 void playlist_set_current_input(
169 playlist_t * p_playlist, input_thread_t * p_input );
175 #define PLAYLIST_DEBUG 1
176 //#undef PLAYLIST_DEBUG2
178 #ifdef PLAYLIST_DEBUG
179 #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
180 #ifdef PLAYLIST_DEBUG2
181 #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
183 #define PL_DEBUG2( msg, args... ) {}
186 #define PL_DEBUG( msg, args ... ) {}
187 #define PL_DEBUG2( msg, args... ) {}
190 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
192 #define PL_ASSERT_LOCKED vlc_assert_locked( &(vlc_internals(p_playlist)->lock) )
194 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
195 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
197 if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
200 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
201 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
203 if( cond ) PL_UNLOCK;
206 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */