playlist: Properly clean the playlist using the object destructor.
[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$
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
39 struct playlist_preparse_t
40 {
41     VLC_COMMON_MEMBERS
42     vlc_mutex_t     lock;
43     int             i_waiting;
44     input_item_t  **pp_waiting;
45 };
46
47 typedef struct preparse_item_t
48 {
49     input_item_t *p_item;
50     vlc_bool_t   b_fetch_art;
51 } preparse_item_t;
52
53 struct playlist_fetcher_t
54 {
55     VLC_COMMON_MEMBERS
56     vlc_mutex_t     lock;
57     int             i_art_policy;
58     vlc_bool_t      b_fetch_meta;
59     int             i_waiting;
60     preparse_item_t *p_waiting;
61
62     DECL_ARRAY(playlist_album_t) albums;
63 };
64
65 /*****************************************************************************
66  * Prototypes
67  *****************************************************************************/
68
69 /* Global thread */
70 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
71 void        __playlist_ThreadCreate   ( vlc_object_t * );
72 int           playlist_ThreadDestroy  ( playlist_t * );
73
74 /* Creation/Deletion */
75 playlist_t *playlist_Create   ( vlc_object_t * );
76 void        playlist_Destroy  ( playlist_t * );
77
78 /* Engine */
79 void playlist_MainLoop( playlist_t * );
80 void playlist_LastLoop( playlist_t * );
81 void playlist_PreparseLoop( playlist_preparse_t * );
82 void playlist_FetcherLoop( playlist_fetcher_t * );
83
84 void ResetCurrentlyPlaying( playlist_t *, vlc_bool_t, playlist_item_t * );
85
86 /* Control */
87 playlist_item_t * playlist_NextItem  ( playlist_t * );
88 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
89
90 /* Load/Save */
91 int playlist_MLLoad( playlist_t *p_playlist );
92 int playlist_MLDump( playlist_t *p_playlist );
93
94 /**********************************************************************
95  * Item management
96  **********************************************************************/
97
98 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
99                              int i_node_id, vlc_bool_t b_signal );
100
101 /* Tree walking */
102 int playlist_GetAllEnabledChildren( playlist_t *p_playlist,
103                                     playlist_item_t *p_node,
104                                     playlist_item_t ***ppp_items );
105 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
106                                     playlist_item_t *p_root,
107                                     playlist_item_t *, vlc_bool_t, vlc_bool_t );
108 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
109                                     playlist_item_t *p_root,
110                                     playlist_item_t *, vlc_bool_t, vlc_bool_t );
111 playlist_item_t *playlist_GetLastLeaf( playlist_t *p_playlist,
112                                     playlist_item_t *p_root );
113
114 int playlist_DeleteFromItemId( playlist_t*, int );
115 int playlist_ItemDelete ( playlist_item_t * );
116
117 /**
118  * @}
119  */
120
121 #define PLAYLIST_DEBUG 1
122 //#undef PLAYLIST_DEBUG2
123
124 #ifdef PLAYLIST_DEBUG
125  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
126  #ifdef PLAYLIST_DEBUG2
127   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
128  #else
129   #define PL_DEBUG2( msg, args... ) {}
130  #endif
131 #else
132  #define PL_DEBUG( msg, args ... ) {}
133  #define PL_DEBUG2( msg, args... ) {}
134 #endif
135
136 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
137 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */