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_services_discovery_support_t {
45 /* the playlist items for category and onelevel */
46 playlist_item_t *p_cat;
47 playlist_item_t *p_one;
48 services_discovery_t *p_sd; /**< Loaded service discovery modules */
53 typedef struct playlist_private_t
55 playlist_t public_data;
56 playlist_preparser_t *p_preparser; /**< Preparser data */
57 playlist_fetcher_t *p_fetcher; /**< Meta and art fetcher data */
59 playlist_item_array_t items_to_delete; /**< Array of items and nodes to
60 delete... At the very end. This sucks. */
62 vlc_sd_internal_t **pp_sds;
63 int i_sds; /**< Number of service discovery modules */
64 input_thread_t * p_input; /**< the input thread associated
65 * with the current item */
66 input_resource_t * p_input_resource; /**< input resources */
68 /* Current status. These fields are readonly, only the playlist
69 * main loop can touch it*/
70 playlist_status_t i_status; /**< Current status of playlist */
71 playlist_item_t * p_item; /**< Currently playing/active item */
72 playlist_item_t * p_node; /**< Current node to play from */
76 /* Request. Use this to give orders to the playlist main loop */
77 playlist_status_t i_status; /**< requested playlist status */
78 playlist_item_t * p_node; /**< requested node to play from */
79 playlist_item_t * p_item; /**< requested item to play in the node */
81 int i_skip; /**< Number of items to skip */
83 bool b_request;/**< Set to true by the requester
84 The playlist sets it back to false
85 when processing the request */
86 vlc_mutex_t lock; /**< Lock to protect request */
89 vlc_thread_t thread; /**< engine thread */
90 vlc_mutex_t lock; /**< dah big playlist global lock */
91 vlc_cond_t signal; /**< wakes up the playlist engine thread */
93 int i_last_playlist_id; /**< Last id to an item */
94 bool b_reset_currently_playing; /** Reset current item array */
96 bool b_tree; /**< Display as a tree */
97 bool b_doing_ml; /**< Doing media library stuff get quicker */
99 mtime_t last_rebuild_date;
101 } playlist_private_t;
103 #define pl_priv( pl ) ((playlist_private_t *)(pl))
105 /*****************************************************************************
107 *****************************************************************************/
109 /* Creation/Deletion */
110 playlist_t *playlist_Create( vlc_object_t * );
113 void playlist_Activate( playlist_t * );
114 void playlist_Deactivate( playlist_t * );
117 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
118 input_item_t *p_input );
121 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
122 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
123 void set_current_status_item( playlist_t *, playlist_item_t * );
124 void set_current_status_node( playlist_t *, playlist_item_t * );
127 int playlist_MLLoad( playlist_t *p_playlist );
128 int playlist_MLDump( playlist_t *p_playlist );
130 /**********************************************************************
132 **********************************************************************/
134 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
135 int i_node_id, bool b_signal );
137 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
138 playlist_item_t *,int , int, bool );
141 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
142 input_item_t *p_input, playlist_item_t *p_root,
145 int playlist_DeleteFromInputInParent( playlist_t *, input_item_t *,
146 playlist_item_t *, bool );
147 int playlist_DeleteFromItemId( playlist_t*, int );
148 int playlist_ItemRelease( playlist_item_t * );
151 void playlist_NodesPairCreate( playlist_t *, const char *, playlist_item_t **, playlist_item_t **, bool );
152 int playlist_NodeEmpty( playlist_t *, playlist_item_t *, bool );
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 */