Use input_interface.h (playlist).
[vlc.git] / src / playlist / playlist_internal.h
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_interface.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     bool     b_tree; /**< Display as a tree */
105     bool     b_doing_ml; /**< Doing media library stuff  get quicker */
106     bool     b_auto_preparse;
107     bool     b_cant_sleep;
108     mtime_t  gc_date;
109     mtime_t  last_rebuild_date;
110     bool     b_reset_currently_playing; /** Reset current item array */
111     int      i_last_playlist_id; /**< Last id to an item */
112
113 } playlist_private_t;
114
115 #define pl_priv( pl ) ((playlist_private_t *)(pl))
116
117 /*****************************************************************************
118  * Prototypes
119  *****************************************************************************/
120
121 /* Global thread */
122 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
123 void        __playlist_ThreadCreate   ( vlc_object_t * );
124
125 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
126                                               input_item_t *p_input );
127
128 /* Creation/Deletion */
129 playlist_t *playlist_Create   ( vlc_object_t * );
130
131 /* Engine */
132 void playlist_MainLoop( playlist_t * );
133 void playlist_LastLoop( playlist_t * );
134 void *playlist_PreparseLoop( void * );
135 void *playlist_FetcherLoop( void * );
136
137 void ResetCurrentlyPlaying( playlist_t *, bool, playlist_item_t * );
138
139 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
140 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
141 void set_current_status_item( playlist_t *, playlist_item_t * );
142 void set_current_status_node( playlist_t *, playlist_item_t * );
143
144 /* Control */
145 playlist_item_t * playlist_NextItem  ( playlist_t * );
146 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
147
148 /* Load/Save */
149 int playlist_MLLoad( playlist_t *p_playlist );
150 int playlist_MLDump( playlist_t *p_playlist );
151
152 /**********************************************************************
153  * Item management
154  **********************************************************************/
155
156 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
157                              int i_node_id, bool b_signal );
158
159 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
160         playlist_item_t *,int , int, bool );
161
162 /* Tree walking */
163 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
164                                    int i_input_id, playlist_item_t *p_root,
165                                    bool );
166
167 int playlist_DeleteFromInputInParent( playlist_t *, int, playlist_item_t *, bool );
168 int playlist_DeleteFromItemId( playlist_t*, int );
169 int playlist_ItemRelease( playlist_item_t * );
170
171 void playlist_release_current_input( playlist_t * p_playlist );
172 void playlist_set_current_input(
173     playlist_t * p_playlist, input_thread_t * p_input );
174
175 /**
176  * @}
177  */
178
179 #define PLAYLIST_DEBUG 1
180 //#undef PLAYLIST_DEBUG2
181
182 #ifdef PLAYLIST_DEBUG
183  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
184  #ifdef PLAYLIST_DEBUG2
185   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
186  #else
187   #define PL_DEBUG2( msg, args... ) {}
188  #endif
189 #else
190  #define PL_DEBUG( msg, args ... ) {}
191  #define PL_DEBUG2( msg, args... ) {}
192 #endif
193
194 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
195
196 #define PL_ASSERT_LOCKED vlc_assert_locked( &(vlc_internals(p_playlist)->lock) )
197
198 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
199 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
200 {
201     if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
202 }
203
204 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
205 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
206 {
207     if( cond ) PL_UNLOCK;
208 }
209
210 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */