Playlist thread is not cancellable as of now, no point in trying
[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 #include "art.h"
41 #include "fetcher.h"
42 #include "preparser.h"
43
44 typedef struct playlist_private_t
45 {
46     playlist_t           public_data;
47     playlist_preparser_t *p_preparser;  /**< Preparser data */
48     playlist_fetcher_t   *p_fetcher;    /**< Meta and art fetcher data */
49
50     playlist_item_array_t items_to_delete; /**< Array of items and nodes to
51             delete... At the very end. This sucks. */
52
53     struct playlist_services_discovery_support_t {
54         /* the playlist items for category and onelevel */
55         playlist_item_t*    p_cat;
56         playlist_item_t*    p_one;
57         services_discovery_t * p_sd; /**< Loaded service discovery modules */
58     } ** pp_sds;
59     int                   i_sds;   /**< Number of service discovery modules */
60     input_thread_t *      p_input;  /**< the input thread associated
61                                      * with the current item */
62     input_ressource_t *   p_input_ressource; /**< input ressources */
63     struct {
64         /* Current status. These fields are readonly, only the playlist
65          * main loop can touch it*/
66         playlist_status_t   i_status;  /**< Current status of playlist */
67         playlist_item_t *   p_item; /**< Currently playing/active item */
68         playlist_item_t *   p_node; /**< Current node to play from */
69     } status;
70
71     struct {
72         /* Request. Use this to give orders to the playlist main loop  */
73         playlist_status_t   i_status; /**< requested playlist status */
74         playlist_item_t *   p_node;   /**< requested node to play from */
75         playlist_item_t *   p_item;   /**< requested item to play in the node */
76
77         int                 i_skip;   /**< Number of items to skip */
78
79         bool          b_request;/**< Set to true by the requester
80                                            The playlist sets it back to false
81                                            when processing the request */
82         vlc_mutex_t         lock;     /**< Lock to protect request */
83     } request;
84
85     vlc_thread_t thread; /**< engine thread */
86     vlc_cond_t signal; /**< wakes up the playlist engine thread */
87
88     int      i_last_playlist_id; /**< Last id to an item */
89     bool     b_reset_currently_playing; /** Reset current item array */
90
91     bool     b_tree; /**< Display as a tree */
92     bool     b_doing_ml; /**< Doing media library stuff  get quicker */
93     bool     b_auto_preparse;
94     mtime_t  last_rebuild_date;
95
96 } playlist_private_t;
97
98 #define pl_priv( pl ) ((playlist_private_t *)(pl))
99
100 /*****************************************************************************
101  * Prototypes
102  *****************************************************************************/
103
104 /* Creation/Deletion */
105 playlist_t *playlist_Create( vlc_object_t * );
106
107 /* */
108 void playlist_Activate( playlist_t * );
109 void playlist_Deactivate( playlist_t * );
110
111 /* */
112 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
113                                               input_item_t *p_input );
114
115 /* Engine */
116 playlist_item_t * get_current_status_item( playlist_t * p_playlist);
117 playlist_item_t * get_current_status_node( playlist_t * p_playlist );
118 void set_current_status_item( playlist_t *, playlist_item_t * );
119 void set_current_status_node( playlist_t *, playlist_item_t * );
120
121 /* Load/Save */
122 int playlist_MLLoad( playlist_t *p_playlist );
123 int playlist_MLDump( playlist_t *p_playlist );
124
125 /**********************************************************************
126  * Item management
127  **********************************************************************/
128
129 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
130                              int i_node_id, bool b_signal );
131
132 playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
133         playlist_item_t *,int , int, bool );
134
135 /* Tree walking */
136 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
137                                    int i_input_id, playlist_item_t *p_root,
138                                    bool );
139
140 int playlist_DeleteFromInputInParent( playlist_t *, int, playlist_item_t *, bool );
141 int playlist_DeleteFromItemId( playlist_t*, int );
142 int playlist_ItemRelease( playlist_item_t * );
143
144 /**
145  * @}
146  */
147
148 #define PLAYLIST_DEBUG 1
149 //#undef PLAYLIST_DEBUG2
150
151 #ifdef PLAYLIST_DEBUG
152  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
153  #ifdef PLAYLIST_DEBUG2
154   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
155  #else
156   #define PL_DEBUG2( msg, args... ) {}
157  #endif
158 #else
159  #define PL_DEBUG( msg, args ... ) {}
160  #define PL_DEBUG2( msg, args... ) {}
161 #endif
162
163 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
164
165 #define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
166 static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
167 {
168     if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
169 }
170
171 #define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
172 static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
173 {
174     if( cond ) PL_UNLOCK;
175 }
176
177 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */