input/item: add slave entries
[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 typedef struct input_item_slave input_item_slave_t;
41
42 struct info_t
43 {
44     char *psz_name;            /**< Name of this info */
45     char *psz_value;           /**< Value of the info */
46 };
47
48 struct info_category_t
49 {
50     char   *psz_name;      /**< Name of this category */
51     int    i_infos;        /**< Number of infos in the category */
52     struct info_t **pp_infos;     /**< Pointer to an array of infos */
53 };
54
55 /**
56  * Describes an input and is used to spawn input_thread_t objects.
57  */
58 struct input_item_t
59 {
60     int        i_id;                 /**< Identifier of the item */
61
62     char       *psz_name;            /**< text describing this item */
63     char       *psz_uri;             /**< mrl of this item */
64
65     int        i_options;            /**< Number of input options */
66     char       **ppsz_options;       /**< Array of input options */
67     uint8_t    *optflagv;            /**< Some flags of input options */
68     unsigned   optflagc;
69     input_item_opaque_t *opaques;    /**< List of opaque pointer values */
70
71     mtime_t    i_duration;           /**< Duration in microseconds */
72
73
74     int        i_categories;         /**< Number of info categories */
75     info_category_t **pp_categories; /**< Pointer to the first info category */
76
77     int         i_es;                /**< Number of es format descriptions */
78     es_format_t **es;                /**< Es formats */
79
80     input_stats_t *p_stats;          /**< Statistics */
81
82     vlc_meta_t *p_meta;
83
84     int         i_epg;               /**< Number of EPG entries */
85     vlc_epg_t   **pp_epg;            /**< EPG entries */
86
87     int         i_slaves;            /**< Number of slaves */
88     input_item_slave_t **pp_slaves;  /**< Slave entries that will be loaded by
89                                           the input_thread */
90
91     vlc_event_manager_t event_manager;
92
93     vlc_mutex_t lock;                 /**< Lock for the item */
94
95     uint8_t     i_type;              /**< Type (file, disc, ... see input_item_type_e) */
96     bool        b_net;               /**< Net: always true for TYPE_STREAM, it
97                                           depends for others types */
98     bool        b_error_when_reading;/**< Error When Reading */
99
100     int         i_preparse_depth;    /**< How many level of sub items can be preparsed:
101                                           -1: recursive, 0: none, >0: n levels */
102
103     bool        b_preparse_interact; /**< Force interaction with the user when
104                                           preparsing.*/
105 };
106
107 TYPEDEF_ARRAY(input_item_t*, input_item_array_t)
108
109 enum input_item_type_e
110 {
111     ITEM_TYPE_UNKNOWN,
112     ITEM_TYPE_FILE,
113     ITEM_TYPE_DIRECTORY,
114     ITEM_TYPE_DISC,
115     ITEM_TYPE_CARD,
116     ITEM_TYPE_STREAM,
117     ITEM_TYPE_PLAYLIST,
118     ITEM_TYPE_NODE,
119
120     /* This one is not a real type but the number of input_item types. */
121     ITEM_TYPE_NUMBER
122 };
123
124 enum input_item_net_type
125 {
126     ITEM_NET_UNKNOWN,
127     ITEM_NET,
128     ITEM_LOCAL
129 };
130
131 enum slave_type
132 {
133     SLAVE_TYPE_SPU,
134     SLAVE_TYPE_AUDIO,
135 };
136
137 enum slave_priority
138 {
139     SLAVE_PRIORITY_MATCH_NONE = 1,
140     SLAVE_PRIORITY_MATCH_RIGHT,
141     SLAVE_PRIORITY_MATCH_LEFT,
142     SLAVE_PRIORITY_MATCH_ALL,
143     SLAVE_PRIORITY_USER
144 };
145
146 #define SLAVE_SPU_EXTENSIONS \
147     "idx", "sub",  "srt", \
148     "ssa", "ass",  "smi", \
149     "utf", "utf8", "utf-8", \
150     "rt",   "aqt", "txt", \
151     "usf", "jss",  "cdg", \
152     "psb", "mpsub","mpl2", \
153     "pjs", "dks", "stl", \
154     "vtt", "sbv"
155 #define SLAVE_AUDIO_EXTENSIONS \
156     "ac3", "m4a"
157
158 struct input_item_slave
159 {
160     enum slave_type     i_type;     /**< Slave type (spu, audio) */
161     enum slave_priority i_priority; /**< Slave priority */
162     char                psz_uri[];  /**< Slave mrl */
163 };
164
165 typedef int (*input_item_compar_cb)( input_item_t *, input_item_t * );
166
167 struct input_item_node_t
168 {
169     input_item_t *         p_item;
170     int                    i_children;
171     input_item_node_t      **pp_children;
172     input_item_node_t      *p_parent;
173     input_item_compar_cb   compar_cb;
174     bool                   b_can_loop;
175 };
176
177 VLC_API void input_item_CopyOptions( input_item_t *p_child, input_item_t *p_parent );
178 VLC_API void input_item_SetName( input_item_t *p_item, const char *psz_name );
179
180 /**
181  * Add one subitem to this item
182  *
183  * This won't hold the item, but can tell to interested third parties
184  * Like the playlist, that there is a new sub item. With this design
185  * It is not the input item's responsibility to keep all the ref of
186  * the input item children.
187  *
188  * Sends a vlc_InputItemSubItemTreeAdded and a vlc_InputItemSubItemAdded event
189  */
190 VLC_API void input_item_PostSubItem( input_item_t *p_parent, input_item_t *p_child );
191
192 /**
193  * Start adding multiple subitems.
194  *
195  * Create a root node to hold a tree of subitems for given item
196  */
197 VLC_API input_item_node_t * input_item_node_Create( input_item_t *p_input ) VLC_USED;
198
199 /**
200  * Add a new child node to this parent node that will point to this subitem.
201  */
202 VLC_API input_item_node_t * input_item_node_AppendItem( input_item_node_t *p_node, input_item_t *p_item );
203
204 /**
205  * Add an already created node to children of this parent node.
206  */
207 VLC_API void input_item_node_AppendNode( input_item_node_t *p_parent, input_item_node_t *p_child );
208
209 /**
210  * Sort all p_item children of the node recursively.
211  */
212 VLC_API void input_item_node_Sort( input_item_node_t *p_node,
213                                    input_item_compar_cb compar_cb );
214
215 /**
216  * Delete a node created with input_item_node_Create() and all its children.
217  */
218 VLC_API void input_item_node_Delete( input_item_node_t *p_node );
219
220 /**
221  * End adding multiple subitems.
222  *
223  * Sends a vlc_InputItemSubItemTreeAdded event to notify that the item pointed to
224  * by the given root node has created new subitems that are pointed to by all the
225  * children of the node.
226  *
227  * Also sends vlc_InputItemSubItemAdded event for every child under the given root node;
228  *
229  * In the end deletes the node and all its children nodes.
230  */
231 VLC_API void input_item_node_PostAndDelete( input_item_node_t *p_node );
232
233
234 /**
235  * Option flags
236  */
237 enum input_item_option_e
238 {
239     /* Allow VLC to trust the given option.
240      * By default options are untrusted */
241     VLC_INPUT_OPTION_TRUSTED = 0x2,
242
243     /* Add the option, unless the same option
244      * is already present. */
245     VLC_INPUT_OPTION_UNIQUE  = 0x100,
246 };
247
248 /**
249  * This function allows to add an option to an existing input_item_t.
250  */
251 VLC_API int input_item_AddOption(input_item_t *, const char *, unsigned i_flags );
252 /**
253  * This function add several options to an existing input_item_t.
254  */
255 VLC_API int input_item_AddOptions(input_item_t *, int i_options,
256                                   const char *const *ppsz_options,
257                                   unsigned i_flags );
258 VLC_API int input_item_AddOpaque(input_item_t *, const char *, void *);
259
260 void input_item_ApplyOptions(vlc_object_t *, input_item_t *);
261
262 VLC_API bool input_item_slave_GetType(const char *, enum slave_type *);
263
264 VLC_API input_item_slave_t *input_item_slave_New(const char *, enum slave_type,
265                                                enum slave_priority);
266 #define input_item_slave_Delete(p_slave) free(p_slave)
267
268 /**
269  * This function allows adding a slave to an existing input item.
270  * The slave is owned by the input item after this call.
271  */
272 VLC_API int input_item_AddSlave(input_item_t *, input_item_slave_t *);
273
274 /* */
275 VLC_API bool input_item_HasErrorWhenReading( input_item_t * );
276 VLC_API void input_item_SetMeta( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val );
277 VLC_API bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz );
278 VLC_API char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type ) VLC_USED;
279 VLC_API char * input_item_GetName( input_item_t * p_i ) VLC_USED;
280 VLC_API char * input_item_GetTitleFbName( input_item_t * p_i ) VLC_USED;
281 VLC_API char * input_item_GetURI( input_item_t * p_i ) VLC_USED;
282 VLC_API char * input_item_GetNowPlayingFb( input_item_t *p_item ) VLC_USED;
283 VLC_API void input_item_SetURI( input_item_t * p_i, const char *psz_uri );
284 VLC_API mtime_t input_item_GetDuration( input_item_t * p_i );
285 VLC_API void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration );
286 VLC_API bool input_item_IsPreparsed( input_item_t *p_i );
287 VLC_API bool input_item_IsArtFetched( input_item_t *p_i );
288
289 #define INPUT_META( name ) \
290 static inline \
291 void input_item_Set ## name (input_item_t *p_input, const char *val) \
292 { \
293     input_item_SetMeta (p_input, vlc_meta_ ## name, val); \
294 } \
295 static inline \
296 char *input_item_Get ## name (input_item_t *p_input) \
297 { \
298     return input_item_GetMeta (p_input, vlc_meta_ ## name); \
299 }
300
301 INPUT_META(Title)
302 INPUT_META(Artist)
303 INPUT_META(AlbumArtist)
304 INPUT_META(Genre)
305 INPUT_META(Copyright)
306 INPUT_META(Album)
307 INPUT_META(TrackNumber)
308 INPUT_META(Description)
309 INPUT_META(Rating)
310 INPUT_META(Date)
311 INPUT_META(Setting)
312 INPUT_META(URL)
313 INPUT_META(Language)
314 INPUT_META(NowPlaying)
315 INPUT_META(ESNowPlaying)
316 INPUT_META(Publisher)
317 INPUT_META(EncodedBy)
318 INPUT_META(ArtworkURL)
319 INPUT_META(TrackID)
320 INPUT_META(TrackTotal)
321 INPUT_META(Director)
322 INPUT_META(Season)
323 INPUT_META(Episode)
324 INPUT_META(ShowName)
325 INPUT_META(Actors)
326 INPUT_META(DiscNumber)
327
328 #define input_item_SetTrackNum input_item_SetTrackNumber
329 #define input_item_GetTrackNum input_item_GetTrackNumber
330 #define input_item_SetArtURL   input_item_SetArtworkURL
331 #define input_item_GetArtURL   input_item_GetArtworkURL
332
333 VLC_API char * input_item_GetInfo( input_item_t *p_i, const char *psz_cat,const char *psz_name ) VLC_USED;
334 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 );
335 VLC_API int input_item_DelInfo( input_item_t *p_i, const char *psz_cat, const char *psz_name );
336 VLC_API void input_item_ReplaceInfos( input_item_t *, info_category_t * );
337 VLC_API void input_item_MergeInfos( input_item_t *, info_category_t * );
338
339 /**
340  * This function creates a new input_item_t with the provided information.
341  *
342  * XXX You may also use input_item_New, as they need less arguments.
343  */
344 VLC_API input_item_t * input_item_NewExt( const char *psz_uri,
345                                           const char *psz_name,
346                                           mtime_t i_duration, int i_type,
347                                           enum input_item_net_type i_net ) VLC_USED;
348
349 #define input_item_New( psz_uri, psz_name ) \
350     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_UNKNOWN, ITEM_NET_UNKNOWN )
351
352 #define input_item_NewCard( psz_uri, psz_name ) \
353     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_CARD, ITEM_LOCAL )
354
355 #define input_item_NewDisc( psz_uri, psz_name, i_duration ) \
356     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_DISC, ITEM_LOCAL )
357
358 #define input_item_NewStream( psz_uri, psz_name, i_duration ) \
359     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_STREAM, ITEM_NET )
360
361 #define input_item_NewDirectory( psz_uri, psz_name, i_net ) \
362     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_DIRECTORY, i_net )
363
364 #define input_item_NewFile( psz_uri, psz_name, i_duration, i_net ) \
365     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_FILE, i_net )
366
367 /**
368  * This function creates a new input_item_t as a copy of another.
369  */
370 VLC_API input_item_t * input_item_Copy(input_item_t * ) VLC_USED;
371
372 /** Holds an input item, i.e. creates a new reference. */
373 VLC_API input_item_t *input_item_Hold(input_item_t *);
374
375 /** Releases an input item, i.e. decrements its reference counter. */
376 VLC_API void input_item_Release(input_item_t *);
377
378 /* Historical hack... */
379 #define vlc_gc_incref(i) input_item_Hold(i)
380 #define vlc_gc_decref(i) input_item_Release(i)
381
382 typedef enum input_item_meta_request_option_t
383 {
384     META_REQUEST_OPTION_NONE          = 0x00,
385     META_REQUEST_OPTION_SCOPE_LOCAL   = 0x01,
386     META_REQUEST_OPTION_SCOPE_NETWORK = 0x02,
387     META_REQUEST_OPTION_SCOPE_ANY     = 0x03,
388     META_REQUEST_OPTION_DO_INTERACT   = 0x04
389 } input_item_meta_request_option_t;
390
391 /* status of the vlc_InputItemPreparseEnded event */
392 enum input_item_preparse_status
393 {
394     ITEM_PREPARSE_SKIPPED,
395     ITEM_PREPARSE_FAILED,
396     ITEM_PREPARSE_DONE
397 };
398
399 VLC_API int libvlc_MetaRequest(libvlc_int_t *, input_item_t *,
400                                input_item_meta_request_option_t );
401 VLC_API int libvlc_ArtRequest(libvlc_int_t *, input_item_t *,
402                               input_item_meta_request_option_t );
403
404 /******************
405  * Input stats
406  ******************/
407 struct input_stats_t
408 {
409     vlc_mutex_t         lock;
410
411     /* Input */
412     int64_t i_read_packets;
413     int64_t i_read_bytes;
414     float f_input_bitrate;
415     float f_average_input_bitrate;
416
417     /* Demux */
418     int64_t i_demux_read_packets;
419     int64_t i_demux_read_bytes;
420     float f_demux_bitrate;
421     float f_average_demux_bitrate;
422     int64_t i_demux_corrupted;
423     int64_t i_demux_discontinuity;
424
425     /* Decoders */
426     int64_t i_decoded_audio;
427     int64_t i_decoded_video;
428
429     /* Vout */
430     int64_t i_displayed_pictures;
431     int64_t i_lost_pictures;
432
433     /* Sout */
434     int64_t i_sent_packets;
435     int64_t i_sent_bytes;
436     float f_send_bitrate;
437
438     /* Aout */
439     int64_t i_played_abuffers;
440     int64_t i_lost_abuffers;
441 };
442
443 #endif