root/src/playlist/playlist_internal.h

Revision 35506f4d2f1f31e36eb8fe09f6cd1cb602065507, 7.0 kB (checked in by Pierre d'Herbemont <pdherbemont@videolan.org>, 2 weeks ago)

playlist: items_to_delete is now private.

  • Property mode set to 100644
Line 
1 /*****************************************************************************
2  * playlist_internal.h : Playlist internals
3  *****************************************************************************
4  * Copyright (C) 1999-2008 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *          Clément Stenac <zorglub@videolan.org>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 #ifndef __LIBVLC_PLAYLIST_INTERNAL_H
26 # define __LIBVLC_PLAYLIST_INTERNAL_H 1
27
28 /**
29  *  \file
30  *  This file contain internal structures and function prototypes related
31  *  to the playlist in vlc
32  *
33  * \defgroup vlc_playlist Playlist
34  * @{
35  */
36
37 #include "input/input_internal.h"
38 #include <assert.h>
39
40 typedef struct playlist_preparse_t
41 {
42     vlc_thread_t    thread;
43     vlc_mutex_t     lock;
44     vlc_cond_t      wait;
45     input_item_t  **pp_waiting;
46     int             i_waiting;
47     bool            up;
48 } playlist_preparse_t;
49
50 typedef struct playlist_fetcher_t
51 {
52     vlc_thread_t    thread;
53     vlc_mutex_t     lock;
54     vlc_cond_t      wait;
55     int             i_art_policy;
56     int             i_waiting;
57     input_item_t    **pp_waiting;
58     bool            up;
59
60     DECL_ARRAY(playlist_album_t) albums;
61 } playlist_fetcher_t;
62
63 typedef struct playlist_private_t
64 {
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 */
69
70     playlist_item_array_t items_to_delete; /**< Array of items and nodes to
71             delete... At the very end. This sucks. */
72
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 */
78     } ** pp_sds;
79     int                   i_sds;   /**< Number of service discovery modules */
80     input_thread_t *      p_input;  /**< the input thread associated
81                                      * with the current item */
82     struct {
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 */
88     } status;
89
90     struct {
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 */
95
96         int                 i_skip;   /**< Number of items to skip */
97
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 */
102     } request;
103
104 } playlist_private_t;
105
106 #define pl_priv( pl ) ((playlist_private_t *)(pl))
107
108 /*****************************************************************************
109  * Prototypes
110  *****************************************************************************/
111
112 /* Global thread */
113 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
114 void        __playlist_ThreadCreate   ( vlc_object_t * );
115
116 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
117                                               input_item_t *p_input );
118
119 /* Creation/Deletion */
120 playlist_t *playlist_Create   ( vlc_object_t * );
121
122 /* Engine */
123 void playlist_MainLoop( playlist_t * );
124 void playlist_LastLoop( playlist_t * );
125 void *playlist_PreparseLoop( void * );
126 void *playlist_FetcherLoop( void * );
127
128 void ResetCurrentlyPlaying( playlist_t *, bool, playlist_item_t * );
129
130 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
131 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
132 void set_current_status_item( playlist_t *, playlist_item_t * );
133 void set_current_status_node( playlist_t *, playlist_item_t * );
134
135 /* Control */
136 playlist_item_t * playlist_NextItem  ( playlist_t * );
137 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
138
139 /* Load/Save */
140 int playlist_MLLoad( playlist_t *p_playlist );
141 int playlist_MLDump( playlist_t *p_playlist );
142
143 /**********************************************************************
144  * Item management
145  **********************************************************************/
146
147 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
148                              int i_node_id, bool b_signal );
149
150 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
151         playlist_item_t *,int , int, bool );
152
153 /* Tree walking */
154 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
155                                    int i_input_id, playlist_item_t *p_root,
156                                    bool );
157
158 int playlist_DeleteFromInputInParent( playlist_t *, int, playlist_item_t *, bool );
159 int playlist_DeleteFromItemId( playlist_t*, int );
160 int playlist_ItemRelease( playlist_item_t * );
161
162 void playlist_release_current_input( playlist_t * p_playlist );
163 void playlist_set_current_input(
164     playlist_t * p_playlist, input_thread_t * p_input );
165
166 /**
167  * @}
168  */
169
170 #define PLAYLIST_DEBUG 1
171 //#undef PLAYLIST_DEBUG2
172
173 #ifdef PLAYLIST_DEBUG
174  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
175  #ifdef PLAYLIST_DEBUG2
176   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
177  #else
178   #define PL_DEBUG2( msg, args... ) {}
179  #endif
180 #else
181  #define PL_DEBUG( msg, args ... ) {}
182  #define PL_DEBUG2( msg, args... ) {}
183 #endif
184
185 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
186
187 #define PL_ASSERT_LOCKED vlc_assert_locked( &(vlc_internals(p_playlist)->lock) )
188
189 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
190 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
191 {
192     if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
193 }
194
195 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
196 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
197 {
198     if( cond ) PL_UNLOCK;
199 }
200
201 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */
Note: See TracBrowser for help on using the browser.