e82b677ee5eb31d54ff736fafc16c4e7657c5e78
[vlc.git] / src / playlist / playlist_internal.h
1 /*****************************************************************************
2  * playlist_internal.h : Functions for use by the playlist
3  *****************************************************************************
4  * Copyright (C) 1999-2004 the VideoLAN team
5  * $Id: vlc_playlist.h 16505 2006-09-03 21:53:38Z zorglub $
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 /**
26  *  \file
27  *  This file contain internal structures and function prototypes related
28  *  to the playlist in vlc
29  *
30  * \defgroup vlc_playlist Playlist
31  * @{
32  */
33
34 #include "input/input_internal.h"
35
36 struct playlist_preparse_t
37 {
38     VLC_COMMON_MEMBERS
39     vlc_mutex_t     lock;
40     int             i_waiting;
41     input_item_t  **pp_waiting;
42 };
43
44 typedef struct preparse_item_t
45 {
46     input_item_t *p_item;
47     vlc_bool_t   b_fetch_art;
48 } preparse_item_t;
49
50 struct playlist_fetcher_t
51 {
52     VLC_COMMON_MEMBERS
53     vlc_mutex_t     lock;
54     int             i_art_policy;
55     int             i_waiting;
56     preparse_item_t *p_waiting;
57
58     DECL_ARRAY(playlist_album_t) albums;
59 };
60
61 /*****************************************************************************
62  * Prototypes
63  *****************************************************************************/
64
65 /* Global thread */
66 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
67 void        __playlist_ThreadCreate   ( vlc_object_t * );
68 int           playlist_ThreadDestroy  ( playlist_t * );
69
70 /* Creation/Deletion */
71 playlist_t *playlist_Create   ( vlc_object_t * );
72 void        playlist_Destroy  ( playlist_t * );
73
74 /* Engine */
75 void playlist_MainLoop( playlist_t * );
76 void playlist_LastLoop( playlist_t * );
77 void playlist_PreparseLoop( playlist_preparse_t * );
78 void playlist_FetcherLoop( playlist_fetcher_t * );
79
80 void ResetCurrentlyPlaying( playlist_t *, vlc_bool_t, playlist_item_t * );
81
82 /* Control */
83 playlist_item_t * playlist_NextItem  ( playlist_t * );
84 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
85
86 /* Load/Save */
87 int playlist_MLLoad( playlist_t *p_playlist );
88 int playlist_MLDump( playlist_t *p_playlist );
89
90 /**********************************************************************
91  * Item management
92  **********************************************************************/
93
94 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
95                              int i_node_id, vlc_bool_t b_signal );
96
97 /* Tree walking */
98 int playlist_GetAllEnabledChildren( playlist_t *p_playlist,
99                                     playlist_item_t *p_node,
100                                     playlist_item_t ***ppp_items );
101 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
102                                     playlist_item_t *p_root,
103                                     playlist_item_t *, vlc_bool_t, vlc_bool_t );
104 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
105                                     playlist_item_t *p_root,
106                                     playlist_item_t *, vlc_bool_t, vlc_bool_t );
107 playlist_item_t *playlist_GetLastLeaf( playlist_t *p_playlist,
108                                     playlist_item_t *p_root );
109
110 int playlist_DeleteFromItemId( playlist_t*, int );
111 int playlist_ItemDelete ( playlist_item_t * );
112
113 /**
114  * @}
115  */
116
117 #define PLAYLIST_DEBUG 1
118 //#undef PLAYLIST_DEBUG2
119
120 #ifdef PLAYLIST_DEBUG
121  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
122  #ifdef PLAYLIST_DEBUG2
123   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
124  #else
125   #define PL_DEBUG2( msg, args... ) {}
126  #endif
127 #else
128  #define PL_DEBUG( msg, args ... ) {}
129  #define PL_DEBUG2( msg, args... ) {}
130 #endif
131
132 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"