Playlist: put private data after public data
[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_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_COMMON_MEMBERS
53     vlc_mutex_t     lock;
54     int             i_art_policy;
55     int             i_waiting;
56     input_item_t    **pp_waiting;
57
58     DECL_ARRAY(playlist_album_t) albums;
59 } playlist_fetcher_t;
60
61 typedef struct playlist_private_t
62 {
63     playlist_t           public_data;
64     playlist_preparse_t  preparse; /**< Preparser data */
65     playlist_fetcher_t   *p_fetcher; /**< Meta and art fetcher object */
66     sout_instance_t      *p_sout; /**< Kept sout instance */
67 } playlist_private_t;
68
69 #define pl_priv( pl ) ((playlist_private_t *)(pl))
70
71 /*****************************************************************************
72  * Prototypes
73  *****************************************************************************/
74
75 /* Global thread */
76 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
77 void        __playlist_ThreadCreate   ( vlc_object_t * );
78
79 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
80                                               input_item_t *p_input );
81
82 /* Creation/Deletion */
83 playlist_t *playlist_Create   ( vlc_object_t * );
84
85 /* Engine */
86 void playlist_MainLoop( playlist_t * );
87 void playlist_LastLoop( playlist_t * );
88 void *playlist_PreparseLoop( void * );
89 void playlist_FetcherLoop( playlist_fetcher_t * );
90
91 void ResetCurrentlyPlaying( playlist_t *, bool, playlist_item_t * );
92
93 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
94 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
95 void set_current_status_item( playlist_t *, playlist_item_t * );
96 void set_current_status_node( playlist_t *, playlist_item_t * );
97
98 /* Control */
99 playlist_item_t * playlist_NextItem  ( playlist_t * );
100 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
101
102 /* Load/Save */
103 int playlist_MLLoad( playlist_t *p_playlist );
104 int playlist_MLDump( playlist_t *p_playlist );
105
106 /**********************************************************************
107  * Item management
108  **********************************************************************/
109
110 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
111                              int i_node_id, bool b_signal );
112
113 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
114         playlist_item_t *,int , int, bool );
115
116 /* Tree walking */
117 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
118                                    int i_input_id, playlist_item_t *p_root,
119                                    bool );
120
121 int playlist_DeleteFromInputInParent( playlist_t *, int, playlist_item_t *, bool );
122 int playlist_DeleteFromItemId( playlist_t*, int );
123 int playlist_ItemRelease( playlist_item_t * );
124
125 void playlist_release_current_input( playlist_t * p_playlist );
126 void playlist_set_current_input(
127     playlist_t * p_playlist, input_thread_t * p_input );
128
129 /**
130  * @}
131  */
132
133 #define PLAYLIST_DEBUG 1
134 //#undef PLAYLIST_DEBUG2
135
136 #ifdef PLAYLIST_DEBUG
137  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
138  #ifdef PLAYLIST_DEBUG2
139   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
140  #else
141   #define PL_DEBUG2( msg, args... ) {}
142  #endif
143 #else
144  #define PL_DEBUG( msg, args ... ) {}
145  #define PL_DEBUG2( msg, args... ) {}
146 #endif
147
148 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
149
150 #define PL_ASSERT_LOCKED vlc_assert_locked( &(vlc_internals(p_playlist)->lock) )
151
152 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
153 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
154 {
155     if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
156 }
157
158 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
159 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
160 {
161     if( cond ) PL_UNLOCK;
162 }
163
164 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */