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"
42 #include "preparser.h"
44 typedef struct vlc_sd_internal_t vlc_sd_internal_t;
46 typedef struct playlist_private_t
48 playlist_t public_data;
49 playlist_preparser_t *p_preparser; /**< Preparser data */
50 playlist_fetcher_t *p_fetcher; /**< Meta and art fetcher data */
52 playlist_item_array_t items_to_delete; /**< Array of items and nodes to
53 delete... At the very end. This sucks. */
55 vlc_sd_internal_t **pp_sds;
56 int i_sds; /**< Number of service discovery modules */
57 input_thread_t * p_input; /**< the input thread associated
58 * with the current item */
59 input_resource_t * p_input_resource; /**< input resources */
61 /* Current status. These fields are readonly, only the playlist
62 * main loop can touch it*/
63 playlist_status_t i_status; /**< Current status of playlist */
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_status_t i_status; /**< requested playlist status */
71 playlist_item_t * p_node; /**< requested node to play from */
72 playlist_item_t * p_item; /**< requested item to play in the node */
74 int i_skip; /**< Number of items to skip */
76 bool b_request;/**< Set to true by the requester
77 The playlist sets it back to false
78 when processing the request */
79 vlc_mutex_t lock; /**< Lock to protect request */
82 vlc_thread_t thread; /**< engine thread */
83 vlc_mutex_t lock; /**< dah big playlist global lock */
84 vlc_cond_t signal; /**< wakes up the playlist engine thread */
85 bool killed; /**< playlist is shutting down */
87 int i_last_playlist_id; /**< Last id to an item */
88 bool b_reset_currently_playing; /** Reset current item array */
90 bool b_tree; /**< Display as a tree */
91 bool b_doing_ml; /**< Doing media library stuff get quicker */
93 mtime_t last_rebuild_date;
97 #define pl_priv( pl ) ((playlist_private_t *)(pl))
99 /*****************************************************************************
101 *****************************************************************************/
103 /* Creation/Deletion */
104 playlist_t *playlist_Create( vlc_object_t * );
105 void playlist_Destroy( playlist_t * );
108 void playlist_Activate( playlist_t * );
109 void playlist_Deactivate( playlist_t * );
110 void pl_Deactivate (libvlc_int_t *);
113 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
114 input_item_t *p_input );
117 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
118 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
119 void set_current_status_item( playlist_t *, playlist_item_t * );
120 void set_current_status_node( playlist_t *, playlist_item_t * );
123 int playlist_MLLoad( playlist_t *p_playlist );
124 int playlist_MLDump( playlist_t *p_playlist );
126 /**********************************************************************
128 **********************************************************************/
130 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
131 int i_node_id, bool b_signal );
133 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
134 playlist_item_t *,int , int, bool );
136 int playlist_InsertInputItemTree ( playlist_t *,
137 playlist_item_t *, input_item_node_t *, int, bool );
140 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
141 input_item_t *p_input, playlist_item_t *p_root,
144 int playlist_DeleteFromInputInParent( playlist_t *, input_item_t *,
145 playlist_item_t *, bool );
146 int playlist_DeleteFromItemId( playlist_t*, int );
147 int playlist_ItemRelease( playlist_item_t * );
149 int playlist_NodeEmpty( playlist_t *, playlist_item_t *, bool );
150 int playlist_DeleteItem( playlist_t * p_playlist, playlist_item_t *, bool);
152 void ResetCurrentlyPlaying( playlist_t *p_playlist, playlist_item_t *p_cur );
153 void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur );
159 #define PLAYLIST_DEBUG 1
160 //#undef PLAYLIST_DEBUG2
162 #ifdef PLAYLIST_DEBUG
163 #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
164 #ifdef PLAYLIST_DEBUG2
165 #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
167 #define PL_DEBUG2( msg, args... ) {}
170 #define PL_DEBUG( msg, args ... ) {}
171 #define PL_DEBUG2( msg, args... ) {}
174 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
176 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
177 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
179 if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
182 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
183 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
185 if( cond ) PL_UNLOCK;
188 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */