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