9144fbb01d925e8f030260ddbc57def86f675e16
[vlc.git] / include / vlc_input_item.h
1 /*****************************************************************************
2  * vlc_input_item.h: Core input item
3  *****************************************************************************
4  * Copyright (C) 1999-2009 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
8  *          Laurent Aimar <fenrir@via.ecp.fr>
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #ifndef VLC_INPUT_ITEM_H
26 #define VLC_INPUT_ITEM_H 1
27
28 /**
29  * \file
30  * This file defines functions, structures and enums for input items in vlc
31  */
32
33 #include <vlc_meta.h>
34 #include <vlc_epg.h>
35 #include <vlc_events.h>
36
37 #include <string.h>
38
39 typedef struct input_item_opaque input_item_opaque_t;
40
41 struct info_t
42 {
43     char *psz_name;            /**< Name of this info */
44     char *psz_value;           /**< Value of the info */
45 };
46
47 struct info_category_t
48 {
49     char   *psz_name;      /**< Name of this category */
50     int    i_infos;        /**< Number of infos in the category */
51     struct info_t **pp_infos;     /**< Pointer to an array of infos */
52 };
53
54 /**
55  * Describes an input and is used to spawn input_thread_t objects.
56  */
57 struct input_item_t
58 {
59     int        i_id;                 /**< Identifier of the item */
60
61     char       *psz_name;            /**< text describing this item */
62     char       *psz_uri;             /**< mrl of this item */
63
64     int        i_options;            /**< Number of input options */
65     char       **ppsz_options;       /**< Array of input options */
66     uint8_t    *optflagv;            /**< Some flags of input options */
67     unsigned   optflagc;
68     input_item_opaque_t *opaques;    /**< List of opaque pointer values */
69
70     mtime_t    i_duration;           /**< Duration in microseconds */
71
72
73     int        i_categories;         /**< Number of info categories */
74     info_category_t **pp_categories; /**< Pointer to the first info category */
75
76     int         i_es;                /**< Number of es format descriptions */
77     es_format_t **es;                /**< Es formats */
78
79     input_stats_t *p_stats;          /**< Statistics */
80
81     vlc_meta_t *p_meta;
82
83     int         i_epg;               /**< Number of EPG entries */
84     vlc_epg_t   **pp_epg;            /**< EPG entries */
85
86     vlc_event_manager_t event_manager;
87
88     vlc_mutex_t lock;                 /**< Lock for the item */
89
90     uint8_t     i_type;              /**< Type (file, disc, ... see input_item_type_e) */
91     bool        b_net;               /**< Net: always true for TYPE_STREAM, it
92                                           depends for others types */
93     bool        b_error_when_reading;/**< Error When Reading */
94
95     int         i_preparse_depth;    /**< How many level of sub items can be preparsed:
96                                           -1: recursive, 0: none, >0: n levels */
97
98     bool        b_preparse_interact; /**< Force interaction with the user when
99                                           preparsing.*/
100 };
101
102 TYPEDEF_ARRAY(input_item_t*, input_item_array_t)
103
104 enum input_item_type_e
105 {
106     ITEM_TYPE_UNKNOWN,
107     ITEM_TYPE_FILE,
108     ITEM_TYPE_DIRECTORY,
109     ITEM_TYPE_DISC,
110     ITEM_TYPE_CARD,
111     ITEM_TYPE_STREAM,
112     ITEM_TYPE_PLAYLIST,
113     ITEM_TYPE_NODE,
114
115     /* This one is not a real type but the number of input_item types. */
116     ITEM_TYPE_NUMBER
117 };
118
119 enum input_item_net_type
120 {
121     ITEM_NET_UNKNOWN,
122     ITEM_NET,
123     ITEM_LOCAL
124 };
125
126 typedef int (*input_item_compar_cb)( input_item_t *, input_item_t * );
127
128 struct input_item_node_t
129 {
130     input_item_t *         p_item;
131     int                    i_children;
132     input_item_node_t      **pp_children;
133     input_item_node_t      *p_parent;
134     input_item_compar_cb   compar_cb;
135     bool                   b_can_loop;
136 };
137
138 VLC_API void input_item_CopyOptions( input_item_t *p_child, input_item_t *p_parent );
139 VLC_API void input_item_SetName( input_item_t *p_item, const char *psz_name );
140
141 /**
142  * Add one subitem to this item
143  *
144  * This won't hold the item, but can tell to interested third parties
145  * Like the playlist, that there is a new sub item. With this design
146  * It is not the input item's responsibility to keep all the ref of
147  * the input item children.
148  *
149  * Sends a vlc_InputItemSubItemTreeAdded and a vlc_InputItemSubItemAdded event
150  */
151 VLC_API void input_item_PostSubItem( input_item_t *p_parent, input_item_t *p_child );
152
153 /**
154  * Start adding multiple subitems.
155  *
156  * Create a root node to hold a tree of subitems for given item
157  */
158 VLC_API input_item_node_t * input_item_node_Create( input_item_t *p_input ) VLC_USED;
159
160 /**
161  * Add a new child node to this parent node that will point to this subitem.
162  */
163 VLC_API input_item_node_t * input_item_node_AppendItem( input_item_node_t *p_node, input_item_t *p_item );
164
165 /**
166  * Add an already created node to children of this parent node.
167  */
168 VLC_API void input_item_node_AppendNode( input_item_node_t *p_parent, input_item_node_t *p_child );
169
170 /**
171  * Sort all p_item children of the node recursively.
172  */
173 VLC_API void input_item_node_Sort( input_item_node_t *p_node,
174                                    input_item_compar_cb compar_cb );
175
176 /**
177  * Delete a node created with input_item_node_Create() and all its children.
178  */
179 VLC_API void input_item_node_Delete( input_item_node_t *p_node );
180
181 /**
182  * End adding multiple subitems.
183  *
184  * Sends a vlc_InputItemSubItemTreeAdded event to notify that the item pointed to
185  * by the given root node has created new subitems that are pointed to by all the
186  * children of the node.
187  *
188  * Also sends vlc_InputItemSubItemAdded event for every child under the given root node;
189  *
190  * In the end deletes the node and all its children nodes.
191  */
192 VLC_API void input_item_node_PostAndDelete( input_item_node_t *p_node );
193
194
195 /**
196  * Option flags
197  */
198 enum input_item_option_e
199 {
200     /* Allow VLC to trust the given option.
201      * By default options are untrusted */
202     VLC_INPUT_OPTION_TRUSTED = 0x2,
203
204     /* Add the option, unless the same option
205      * is already present. */
206     VLC_INPUT_OPTION_UNIQUE  = 0x100,
207 };
208
209 /**
210  * This function allows to add an option to an existing input_item_t.
211  */
212 VLC_API int input_item_AddOption(input_item_t *, const char *, unsigned i_flags );
213 /**
214  * This function add several options to an existing input_item_t.
215  */
216 VLC_API int input_item_AddOptions(input_item_t *, int i_options,
217                                   const char *const *ppsz_options,
218                                   unsigned i_flags );
219 VLC_API int input_item_AddOpaque(input_item_t *, const char *, void *);
220
221 void input_item_ApplyOptions(vlc_object_t *, input_item_t *);
222
223 /* */
224 VLC_API bool input_item_HasErrorWhenReading( input_item_t * );
225 VLC_API void input_item_SetMeta( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val );
226 VLC_API bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz );
227 VLC_API char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type ) VLC_USED;
228 VLC_API char * input_item_GetName( input_item_t * p_i ) VLC_USED;
229 VLC_API char * input_item_GetTitleFbName( input_item_t * p_i ) VLC_USED;
230 VLC_API char * input_item_GetURI( input_item_t * p_i ) VLC_USED;
231 VLC_API char * input_item_GetNowPlayingFb( input_item_t *p_item ) VLC_USED;
232 VLC_API void input_item_SetURI( input_item_t * p_i, const char *psz_uri );
233 VLC_API mtime_t input_item_GetDuration( input_item_t * p_i );
234 VLC_API void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration );
235 VLC_API bool input_item_IsPreparsed( input_item_t *p_i );
236 VLC_API bool input_item_IsArtFetched( input_item_t *p_i );
237
238 #define INPUT_META( name ) \
239 static inline \
240 void input_item_Set ## name (input_item_t *p_input, const char *val) \
241 { \
242     input_item_SetMeta (p_input, vlc_meta_ ## name, val); \
243 } \
244 static inline \
245 char *input_item_Get ## name (input_item_t *p_input) \
246 { \
247     return input_item_GetMeta (p_input, vlc_meta_ ## name); \
248 }
249
250 INPUT_META(Title)
251 INPUT_META(Artist)
252 INPUT_META(AlbumArtist)
253 INPUT_META(Genre)
254 INPUT_META(Copyright)
255 INPUT_META(Album)
256 INPUT_META(TrackNumber)
257 INPUT_META(Description)
258 INPUT_META(Rating)
259 INPUT_META(Date)
260 INPUT_META(Setting)
261 INPUT_META(URL)
262 INPUT_META(Language)
263 INPUT_META(NowPlaying)
264 INPUT_META(ESNowPlaying)
265 INPUT_META(Publisher)
266 INPUT_META(EncodedBy)
267 INPUT_META(ArtworkURL)
268 INPUT_META(TrackID)
269 INPUT_META(TrackTotal)
270 INPUT_META(Director)
271 INPUT_META(Season)
272 INPUT_META(Episode)
273 INPUT_META(ShowName)
274 INPUT_META(Actors)
275 INPUT_META(DiscNumber)
276
277 #define input_item_SetTrackNum input_item_SetTrackNumber
278 #define input_item_GetTrackNum input_item_GetTrackNumber
279 #define input_item_SetArtURL   input_item_SetArtworkURL
280 #define input_item_GetArtURL   input_item_GetArtworkURL
281
282 VLC_API char * input_item_GetInfo( input_item_t *p_i, const char *psz_cat,const char *psz_name ) VLC_USED;
283 VLC_API int input_item_AddInfo( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) VLC_FORMAT( 4, 5 );
284 VLC_API int input_item_DelInfo( input_item_t *p_i, const char *psz_cat, const char *psz_name );
285 VLC_API void input_item_ReplaceInfos( input_item_t *, info_category_t * );
286 VLC_API void input_item_MergeInfos( input_item_t *, info_category_t * );
287
288 /**
289  * This function creates a new input_item_t with the provided information.
290  *
291  * XXX You may also use input_item_New, as they need less arguments.
292  */
293 VLC_API input_item_t * input_item_NewExt( const char *psz_uri,
294                                           const char *psz_name,
295                                           mtime_t i_duration, int i_type,
296                                           enum input_item_net_type i_net ) VLC_USED;
297
298 #define input_item_New( psz_uri, psz_name ) \
299     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_UNKNOWN, ITEM_NET_UNKNOWN )
300
301 #define input_item_NewCard( psz_uri, psz_name ) \
302     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_CARD, ITEM_LOCAL )
303
304 #define input_item_NewDisc( psz_uri, psz_name, i_duration ) \
305     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_DISC, ITEM_LOCAL )
306
307 #define input_item_NewStream( psz_uri, psz_name, i_duration ) \
308     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_STREAM, ITEM_NET )
309
310 #define input_item_NewDirectory( psz_uri, psz_name, i_net ) \
311     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_DIRECTORY, i_net )
312
313 #define input_item_NewFile( psz_uri, psz_name, i_duration, i_net ) \
314     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_FILE, i_net )
315
316 /**
317  * This function creates a new input_item_t as a copy of another.
318  */
319 VLC_API input_item_t * input_item_Copy(input_item_t * ) VLC_USED;
320
321 /** Holds an input item, i.e. creates a new reference. */
322 VLC_API input_item_t *input_item_Hold(input_item_t *);
323
324 /** Releases an input item, i.e. decrements its reference counter. */
325 VLC_API void input_item_Release(input_item_t *);
326
327 /* Historical hack... */
328 #define vlc_gc_incref(i) input_item_Hold(i)
329 #define vlc_gc_decref(i) input_item_Release(i)
330
331 typedef enum input_item_meta_request_option_t
332 {
333     META_REQUEST_OPTION_NONE          = 0x00,
334     META_REQUEST_OPTION_SCOPE_LOCAL   = 0x01,
335     META_REQUEST_OPTION_SCOPE_NETWORK = 0x02,
336     META_REQUEST_OPTION_SCOPE_ANY     = 0x03,
337     META_REQUEST_OPTION_DO_INTERACT   = 0x04
338 } input_item_meta_request_option_t;
339
340 /* status of the vlc_InputItemPreparseEnded event */
341 enum input_item_preparse_status
342 {
343     ITEM_PREPARSE_SKIPPED,
344     ITEM_PREPARSE_FAILED,
345     ITEM_PREPARSE_DONE
346 };
347
348 VLC_API int libvlc_MetaRequest(libvlc_int_t *, input_item_t *,
349                                input_item_meta_request_option_t );
350 VLC_API int libvlc_ArtRequest(libvlc_int_t *, input_item_t *,
351                               input_item_meta_request_option_t );
352
353 /******************
354  * Input stats
355  ******************/
356 struct input_stats_t
357 {
358     vlc_mutex_t         lock;
359
360     /* Input */
361     int64_t i_read_packets;
362     int64_t i_read_bytes;
363     float f_input_bitrate;
364     float f_average_input_bitrate;
365
366     /* Demux */
367     int64_t i_demux_read_packets;
368     int64_t i_demux_read_bytes;
369     float f_demux_bitrate;
370     float f_average_demux_bitrate;
371     int64_t i_demux_corrupted;
372     int64_t i_demux_discontinuity;
373
374     /* Decoders */
375     int64_t i_decoded_audio;
376     int64_t i_decoded_video;
377
378     /* Vout */
379     int64_t i_displayed_pictures;
380     int64_t i_lost_pictures;
381
382     /* Sout */
383     int64_t i_sent_packets;
384     int64_t i_sent_bytes;
385     float f_send_bitrate;
386
387     /* Aout */
388     int64_t i_played_abuffers;
389     int64_t i_lost_abuffers;
390 };
391
392 #endif