1 /*****************************************************************************
2 * playlist_internal.h : Playlist internals
3 *****************************************************************************
4 * Copyright (C) 1999-2008 VLC authors and VideoLAN
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 it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * 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"
41 #include "preparser.h"
43 typedef struct vlc_sd_internal_t vlc_sd_internal_t;
45 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
47 typedef struct playlist_private_t
49 playlist_t public_data;
50 playlist_preparser_t *p_preparser; /**< Preparser data */
51 struct intf_thread_t *interface; /**< Linked-list of interfaces */
53 playlist_item_array_t items_to_delete; /**< Array of items and nodes to
54 delete... At the very end. This sucks. */
56 vlc_sd_internal_t **pp_sds;
57 int i_sds; /**< Number of service discovery modules */
58 input_thread_t * p_input; /**< the input thread associated
59 * with the current item */
60 input_resource_t * p_input_resource; /**< input resources */
62 /* Current status. These fields are readonly, only the playlist
63 * main loop can touch it*/
64 playlist_item_t * p_item; /**< Currently playing/active item */
65 playlist_item_t * p_node; /**< Current node to play from */
69 /* Request. Use this to give orders to the playlist main loop */
70 playlist_item_t * p_node; /**< requested node to play from */
71 playlist_item_t * p_item; /**< requested item to play in the node */
73 int i_skip; /**< Number of items to skip */
75 bool b_request;/**< Set to true by the requester
76 The playlist sets it back to false
77 when processing the request */
78 vlc_mutex_t lock; /**< Lock to protect request */
81 vlc_thread_t thread; /**< engine thread */
82 vlc_mutex_t lock; /**< dah big playlist global lock */
83 vlc_cond_t signal; /**< wakes up the playlist engine thread */
84 bool killed; /**< playlist is shutting down */
86 int i_last_playlist_id; /**< Last id to an item */
87 bool b_reset_currently_playing; /** Reset current item array */
89 bool b_tree; /**< Display as a tree */
92 #define pl_priv( pl ) ((playlist_private_t *)(pl))
94 /*****************************************************************************
96 *****************************************************************************/
98 /* Creation/Deletion */
99 playlist_t *playlist_Create( vlc_object_t * );
100 void playlist_Destroy( playlist_t * );
101 void playlist_Activate( playlist_t * );
104 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
105 input_item_t *p_input );
108 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
109 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
110 void set_current_status_item( playlist_t *, playlist_item_t * );
111 void set_current_status_node( playlist_t *, playlist_item_t * );
114 int playlist_MLLoad( playlist_t *p_playlist );
115 int playlist_MLDump( playlist_t *p_playlist );
117 /**********************************************************************
119 **********************************************************************/
121 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
122 int i_node_id, bool b_signal );
124 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
125 playlist_item_t *,int , int, bool );
127 int playlist_InsertInputItemTree ( playlist_t *,
128 playlist_item_t *, input_item_node_t *, int, bool );
131 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
132 input_item_t *p_input, playlist_item_t *p_root,
135 int playlist_DeleteFromInputInParent( playlist_t *, input_item_t *,
136 playlist_item_t *, bool );
137 int playlist_DeleteFromItemId( playlist_t*, int );
138 int playlist_ItemRelease( playlist_item_t * );
140 int playlist_NodeEmpty( playlist_t *, playlist_item_t *, bool );
141 int playlist_DeleteItem( playlist_t * p_playlist, playlist_item_t *, bool);
143 void ResetCurrentlyPlaying( playlist_t *p_playlist, playlist_item_t *p_cur );
144 void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur );
150 #define PLAYLIST_DEBUG 1
151 //#undef PLAYLIST_DEBUG2
153 #ifdef PLAYLIST_DEBUG
154 #define PL_DEBUG( ... ) msg_Dbg( p_playlist, __VA_ARGS__ )
155 #ifdef PLAYLIST_DEBUG2
156 #define PL_DEBUG2( msg, ... ) msg_Dbg( p_playlist, __VA_ARGS__ )
158 #define PL_DEBUG2( msg, ... ) {}
161 #define PL_DEBUG( msg, ... ) {}
162 #define PL_DEBUG2( msg, ... ) {}
165 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
167 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
168 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
170 if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
173 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
174 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
176 if( cond ) PL_UNLOCK;
179 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */