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_interface.h"
42 #include "preparser.h"
44 typedef struct playlist_private_t
46 playlist_t public_data;
47 playlist_preparser_t *p_preparser; /**< Preparser data */
48 playlist_fetcher_t *p_fetcher; /**< Meta and art fetcher data */
49 sout_instance_t *p_sout; /**< Kept sout instance */
51 playlist_item_array_t items_to_delete; /**< Array of items and nodes to
52 delete... At the very end. This sucks. */
54 struct playlist_services_discovery_support_t {
55 /* the playlist items for category and onelevel */
56 playlist_item_t* p_cat;
57 playlist_item_t* p_one;
58 services_discovery_t * p_sd; /**< Loaded service discovery modules */
60 int i_sds; /**< Number of service discovery modules */
61 input_thread_t * p_input; /**< the input thread associated
62 * with the current item */
64 /* Current status. These fields are readonly, only the playlist
65 * main loop can touch it*/
66 playlist_status_t i_status; /**< Current status of playlist */
67 playlist_item_t * p_item; /**< Currently playing/active item */
68 playlist_item_t * p_node; /**< Current node to play from */
72 /* Request. Use this to give orders to the playlist main loop */
73 playlist_status_t i_status; /**< requested playlist status */
74 playlist_item_t * p_node; /**< requested node to play from */
75 playlist_item_t * p_item; /**< requested item to play in the node */
77 int i_skip; /**< Number of items to skip */
79 bool b_request;/**< Set to true by the requester
80 The playlist sets it back to false
81 when processing the request */
82 vlc_mutex_t lock; /**< Lock to protect request */
85 bool b_tree; /**< Display as a tree */
86 bool b_doing_ml; /**< Doing media library stuff get quicker */
88 mtime_t last_rebuild_date;
89 bool b_reset_currently_playing; /** Reset current item array */
90 int i_last_playlist_id; /**< Last id to an item */
94 #define pl_priv( pl ) ((playlist_private_t *)(pl))
96 /*****************************************************************************
98 *****************************************************************************/
100 /* Creation/Deletion */
101 playlist_t *playlist_Create( vlc_object_t * );
104 void playlist_Activate( playlist_t * );
105 void playlist_Deactivate( playlist_t * );
108 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
109 input_item_t *p_input );
112 void playlist_MainLoop( playlist_t * );
114 void ResetCurrentlyPlaying( playlist_t *, bool, playlist_item_t * );
116 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
117 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
118 void set_current_status_item( playlist_t *, playlist_item_t * );
119 void set_current_status_node( playlist_t *, playlist_item_t * );
122 playlist_item_t * playlist_NextItem ( playlist_t * );
123 int playlist_PlayItem ( playlist_t *, playlist_item_t * );
126 int playlist_MLLoad( playlist_t *p_playlist );
127 int playlist_MLDump( playlist_t *p_playlist );
129 /**********************************************************************
131 **********************************************************************/
133 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
134 int i_node_id, bool b_signal );
136 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
137 playlist_item_t *,int , int, bool );
140 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
141 int i_input_id, playlist_item_t *p_root,
144 int playlist_DeleteFromInputInParent( playlist_t *, int, playlist_item_t *, bool );
145 int playlist_DeleteFromItemId( playlist_t*, int );
146 int playlist_ItemRelease( playlist_item_t * );
148 void playlist_release_current_input( playlist_t * p_playlist );
149 void playlist_set_current_input(
150 playlist_t * p_playlist, input_thread_t * p_input );
157 #define PLAYLIST_DEBUG 1
158 //#undef PLAYLIST_DEBUG2
160 #ifdef PLAYLIST_DEBUG
161 #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
162 #ifdef PLAYLIST_DEBUG2
163 #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
165 #define PL_DEBUG2( msg, args... ) {}
168 #define PL_DEBUG( msg, args ... ) {}
169 #define PL_DEBUG2( msg, args... ) {}
172 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
174 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
175 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
177 if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
180 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
181 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
183 if( cond ) PL_UNLOCK;
186 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */