70bf2b42caee0662f072da1caeb2215b3653b6d8
[vlc.git] / include / vlc_input.h
1 /*****************************************************************************
2  * vlc_input.h: Core input structures
3  *****************************************************************************
4  * Copyright (C) 1999-2006 the VideoLAN team
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
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 #if !defined( __LIBVLC__ )
26   #error You are not libvlc or one of its plugins. You cannot include this file
27 #endif
28
29 /* __ is need because conflict with <vlc/input.h> */
30 #ifndef _VLC__INPUT_H
31 #define _VLC__INPUT_H 1
32
33 #include <vlc_es.h>
34 #include <vlc_meta.h>
35 #include <vlc_epg.h>
36 #include <vlc_events.h>
37
38 #include <string.h>                                     /* strcasestr() */
39
40 struct vlc_meta_t;
41
42 /*****************************************************************************
43  * input_item_t: Describes an input and is used to spawn input_thread_t objects
44  *****************************************************************************/
45 struct info_t
46 {
47     char *psz_name;            /**< Name of this info */
48     char *psz_value;           /**< Value of the info */
49 };
50
51 struct info_category_t
52 {
53     char   *psz_name;      /**< Name of this category */
54     int    i_infos;        /**< Number of infos in the category */
55     struct info_t **pp_infos;     /**< Pointer to an array of infos */
56 };
57
58 struct input_item_t
59 {
60     VLC_GC_MEMBERS
61     int        i_id;                 /**< Identifier of the item */
62
63     char       *psz_name;            /**< text describing this item */
64     char       *psz_uri;             /**< mrl of this item */
65     bool  b_fixed_name;        /**< Can the interface change the name ?*/
66
67     int        i_options;            /**< Number of input options */
68     char       **ppsz_options;       /**< Array of input options */
69     uint8_t    *optflagv;            /**< Some flags of input options */
70     unsigned   optflagc;
71
72     mtime_t    i_duration;           /**< Duration in milliseconds*/
73
74     uint8_t    i_type;               /**< Type (file, disc, ...) */
75
76     int        i_categories;         /**< Number of info categories */
77     info_category_t **pp_categories; /**< Pointer to the first info category */
78
79     int         i_es;                /**< Number of es format descriptions */
80     es_format_t **es;                /**< Es formats */
81
82     input_stats_t *p_stats;          /**< Statistics */
83     int           i_nb_played;       /**< Number of times played */
84
85     vlc_meta_t *p_meta;
86
87     vlc_event_manager_t event_manager;
88
89     vlc_mutex_t lock;                 /**< Lock for the item */
90 };
91
92 #define ITEM_TYPE_UNKNOWN       0
93 #define ITEM_TYPE_FILE          1
94 #define ITEM_TYPE_DIRECTORY     2
95 #define ITEM_TYPE_DISC          3
96 #define ITEM_TYPE_CDDA          4
97 #define ITEM_TYPE_CARD          5
98 #define ITEM_TYPE_NET           6
99 #define ITEM_TYPE_PLAYLIST      7
100 #define ITEM_TYPE_NODE          8
101 #define ITEM_TYPE_NUMBER        9
102
103 static inline void input_ItemCopyOptions( input_item_t *p_parent,
104                                           input_item_t *p_child )
105 {
106     int i;
107     for( i = 0 ; i< p_parent->i_options; i++ )
108     {
109         char *psz_option= strdup( p_parent->ppsz_options[i] );
110         if( !strcmp( psz_option, "meta-file" ) )
111         {
112             free( psz_option );
113             continue;
114         }
115         p_child->i_options++;
116         p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
117                                                   p_child->i_options *
118                                                   sizeof( char * ) );
119         p_child->ppsz_options[p_child->i_options-1] = psz_option;
120         p_child->optflagc++;
121         p_child->optflagv = (uint8_t *)realloc( p_child->optflagv,
122                                                 p_child->optflagc );
123         p_child->optflagv[p_child->optflagc - 1] = p_parent->optflagv[i];
124     }
125 }
126
127 static inline void input_item_SetName( input_item_t *p_item, const char *psz_name )
128 {
129     free( p_item->psz_name );
130     p_item->psz_name = strdup( psz_name );
131 }
132
133 /* This won't hold the item, but can tell to interested third parties
134  * Like the playlist, that there is a new sub item. With this design
135  * It is not the input item's responsability to keep all the ref of
136  * the input item children. */
137 static inline void input_ItemAddSubItem( input_item_t *p_parent,
138                                          input_item_t *p_child )
139 {
140     vlc_event_t event;
141
142     p_parent->i_type = ITEM_TYPE_PLAYLIST;
143
144     /* Notify interested third parties */
145     event.type = vlc_InputItemSubItemAdded;
146     event.u.input_item_subitem_added.p_new_child = p_child;
147     vlc_event_send( &p_parent->event_manager, &event );
148 }
149
150 /* Flags handled past input_ItemAddOpt() */
151 #define VLC_INPUT_OPTION_TRUSTED 0x2
152
153 /* Flags handled within input_ItemAddOpt() */
154 #define VLC_INPUT_OPTION_UNIQUE  0x100
155
156 VLC_EXPORT( int, input_ItemAddOpt, ( input_item_t *, const char *str, unsigned flags ) );
157
158 static inline
159 int input_ItemAddOption (input_item_t *item, const char *str)
160 {
161     return input_ItemAddOpt (item, str, VLC_INPUT_OPTION_TRUSTED);
162 }
163
164
165 VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ));
166
167 static inline bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz )
168 {
169     vlc_mutex_lock( &p_i->lock );
170     if( !p_i->p_meta )
171     {
172         vlc_mutex_unlock( &p_i->lock );
173         return false;
174     }
175     const char * meta = vlc_meta_Get( p_i->p_meta, meta_type );
176     bool ret = meta && strcasestr( meta, psz );
177     vlc_mutex_unlock( &p_i->lock );
178
179     return ret;
180 }
181
182 static inline char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
183 {
184     char * psz = NULL;
185     vlc_mutex_lock( &p_i->lock );
186
187     if( !p_i->p_meta )
188     {
189         vlc_mutex_unlock( &p_i->lock );
190         return NULL;
191     }
192
193     if( vlc_meta_Get( p_i->p_meta, meta_type ) )
194         psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );
195
196     vlc_mutex_unlock( &p_i->lock );
197     return psz;
198 }
199
200 static inline char * input_item_GetName( input_item_t * p_i )
201 {
202     vlc_mutex_lock( &p_i->lock );
203     char *psz_s = p_i->psz_name ? strdup( p_i->psz_name ) : NULL;
204     vlc_mutex_unlock( &p_i->lock );
205     return psz_s;
206 }
207
208 static inline char * input_item_GetURI( input_item_t * p_i )
209 {
210     vlc_mutex_lock( &p_i->lock );
211     char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL;
212     vlc_mutex_unlock( &p_i->lock );
213     return psz_s;
214 }
215
216 static inline void input_item_SetURI( input_item_t * p_i, char * psz_uri )
217 {
218     vlc_mutex_lock( &p_i->lock );
219     free( p_i->psz_uri );
220     p_i->psz_uri = strdup( psz_uri );
221     vlc_mutex_unlock( &p_i->lock );
222 }
223
224 static inline mtime_t input_item_GetDuration( input_item_t * p_i )
225 {
226     vlc_mutex_lock( &p_i->lock );
227     mtime_t i_duration = p_i->i_duration;
228     vlc_mutex_unlock( &p_i->lock );
229     return i_duration;
230 }
231
232 static inline void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration )
233 {
234     bool send_event = false;
235
236     vlc_mutex_lock( &p_i->lock );
237     if( p_i->i_duration != i_duration )
238     {
239         p_i->i_duration = i_duration;
240         send_event = true;
241     }
242     vlc_mutex_unlock( &p_i->lock );
243
244     if ( send_event == true )
245     {
246         vlc_event_t event;
247         event.type = vlc_InputItemDurationChanged;
248         event.u.input_item_duration_changed.new_duration = i_duration;
249         vlc_event_send( &p_i->event_manager, &event );
250     }
251
252     return;
253 }
254
255
256 static inline bool input_item_IsPreparsed( input_item_t *p_i )
257 {
258     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : false ;
259 }
260
261 static inline bool input_item_IsArtFetched( input_item_t *p_i )
262 {
263     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : false ;
264 }
265
266 static inline const vlc_meta_t * input_item_GetMetaObject( input_item_t *p_i )
267 {
268     if( !p_i->p_meta )
269         p_i->p_meta = vlc_meta_New();
270
271     return p_i->p_meta;
272 }
273
274 static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p_new_meta )
275 {
276     if( !p_i->p_meta )
277         p_i->p_meta = vlc_meta_New();
278
279     vlc_meta_Merge( p_i->p_meta, p_new_meta );
280 }
281
282 #define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
283 #define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
284 #define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
285 #define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
286 #define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
287 #define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
288 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
289 #define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
290 #define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
291 #define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
292 #define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
293 #define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
294 #define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
295 #define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
296 #define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
297 #define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
298 #define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )
299
300 #define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
301 #define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
302 #define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
303 #define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
304 #define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
305 #define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
306 #define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
307 #define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
308 #define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
309 #define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
310 #define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
311 #define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
312 #define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
313 #define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
314 #define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
315 #define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
316 #define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
317 #define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
318
319 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
320 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) LIBVLC_FORMAT( 4, 5 ) );
321
322 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
323 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
324 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
325 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
326
327 #define input_ItemGetById(a,b) __input_ItemGetById( VLC_OBJECT(a),b )
328 VLC_EXPORT( input_item_t *, __input_ItemGetById, (vlc_object_t *, int ) );
329
330 /*****************************************************************************
331  * Meta data helpers
332  *****************************************************************************/
333 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
334                                                         const vlc_meta_t *p_meta )
335 {
336     char * psz_value;
337
338     if( !p_meta )
339         return;
340
341     if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
342         (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
343     {
344         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
345         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
346     }
347     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
348              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
349     {
350         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
351         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
352     }
353     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
354              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
355     {
356         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
357         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
358     }
359     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
360     {
361         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
362         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
363     }
364 }
365
366 /*****************************************************************************
367  * Seek point: (generalisation of chapters)
368  *****************************************************************************/
369 struct seekpoint_t
370 {
371     int64_t i_byte_offset;
372     int64_t i_time_offset;
373     char    *psz_name;
374     int     i_level;
375 };
376
377 static inline seekpoint_t *vlc_seekpoint_New( void )
378 {
379     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
380     point->i_byte_offset =
381     point->i_time_offset = -1;
382     point->i_level = 0;
383     point->psz_name = NULL;
384     return point;
385 }
386
387 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
388 {
389     if( !point ) return;
390     free( point->psz_name );
391     free( point );
392 }
393
394 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
395 {
396     seekpoint_t *point = vlc_seekpoint_New();
397     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
398     point->i_time_offset = src->i_time_offset;
399     point->i_byte_offset = src->i_byte_offset;
400     return point;
401 }
402
403 /*****************************************************************************
404  * Title:
405  *****************************************************************************/
406 typedef struct
407 {
408     char        *psz_name;
409
410     bool  b_menu;      /* Is it a menu or a normal entry */
411
412     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
413     int64_t     i_size;     /* Size (bytes) if known, else 0 */
414
415     /* Title seekpoint */
416     int         i_seekpoint;
417     seekpoint_t **seekpoint;
418
419 } input_title_t;
420
421 static inline input_title_t *vlc_input_title_New(void)
422 {
423     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
424
425     t->psz_name = NULL;
426     t->b_menu = false;
427     t->i_length = 0;
428     t->i_size   = 0;
429     t->i_seekpoint = 0;
430     t->seekpoint = NULL;
431
432     return t;
433 }
434
435 static inline void vlc_input_title_Delete( input_title_t *t )
436 {
437     int i;
438     if( t == NULL )
439         return;
440
441     free( t->psz_name );
442     for( i = 0; i < t->i_seekpoint; i++ )
443     {
444         free( t->seekpoint[i]->psz_name );
445         free( t->seekpoint[i] );
446     }
447     free( t->seekpoint );
448     free( t );
449 }
450
451 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
452 {
453     input_title_t *dup = vlc_input_title_New( );
454     int i;
455
456     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
457     dup->b_menu      = t->b_menu;
458     dup->i_length    = t->i_length;
459     dup->i_size      = t->i_size;
460     dup->i_seekpoint = t->i_seekpoint;
461     if( t->i_seekpoint > 0 )
462     {
463         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
464                                                 sizeof(seekpoint_t*) );
465
466         for( i = 0; i < t->i_seekpoint; i++ )
467         {
468             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
469         }
470     }
471
472     return dup;
473 }
474 /*****************************************************************************
475  * Attachments
476  *****************************************************************************/
477 struct input_attachment_t
478 {
479     char *psz_name;
480     char *psz_mime;
481     char *psz_description;
482
483     int  i_data;
484     void *p_data;
485 };
486 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
487                                                             const char *psz_mime,
488                                                             const char *psz_description,
489                                                             const void *p_data,
490                                                             int i_data )
491 {
492     input_attachment_t *a =
493         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
494     if( !a )
495         return NULL;
496     a->psz_name = strdup( psz_name ? psz_name : "" );
497     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
498     a->psz_description = strdup( psz_description ? psz_description : "" );
499     a->i_data = i_data;
500     a->p_data = NULL;
501     if( i_data > 0 )
502     {
503         a->p_data = malloc( i_data );
504         if( a->p_data && p_data )
505             memcpy( a->p_data, p_data, i_data );
506     }
507     return a;
508 }
509 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
510 {
511     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
512                                      a->p_data, a->i_data );
513 }
514 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
515 {
516     if( !a )
517         return;
518     free( a->psz_name );
519     free( a->psz_mime );
520     free( a->psz_description );
521     free( a->p_data );
522     free( a );
523 }
524 /*****************************************************************************
525  * input defines/constants.
526  *****************************************************************************/
527
528 /* "state" value */
529 enum input_state_e
530 {
531     INIT_S,
532     OPENING_S,
533     BUFFERING_S,
534     PLAYING_S,
535     PAUSE_S,
536     END_S,
537     ERROR_S
538 };
539
540 /* "rate" default, min/max
541  * A rate below 1000 plays the movie faster,
542  * A rate above 1000 plays the movie slower.
543  */
544 #define INPUT_RATE_DEFAULT  1000
545 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
546 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
547
548 /* i_update field of access_t/demux_t */
549 #define INPUT_UPDATE_NONE       0x0000
550 #define INPUT_UPDATE_SIZE       0x0001
551 #define INPUT_UPDATE_TITLE      0x0010
552 #define INPUT_UPDATE_SEEKPOINT  0x0020
553 #define INPUT_UPDATE_META       0x0040
554
555 /* Input control XXX: internal */
556 #define INPUT_CONTROL_FIFO_SIZE    100
557
558 /** Get the input item for an input thread */
559 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
560
561 typedef struct input_thread_private_t input_thread_private_t;
562
563 /**
564  * Main structure representing an input thread. This structure is mostly
565  * private. The only public fields are READ-ONLY. You must use the helpers
566  * to modify them
567  */
568 struct input_thread_t
569 {
570     VLC_COMMON_MEMBERS;
571
572     bool  b_eof;
573     bool b_preparsing;
574
575     int i_state;
576     bool b_can_pace_control;
577     int64_t     i_time;     /* Current time */
578
579     /* Internal caching common to all inputs */
580     int i_pts_delay;
581
582     /* All other data is input_thread is PRIVATE. You can't access it
583      * outside of src/input */
584     input_thread_private_t *p;
585 };
586
587 /*****************************************************************************
588  * Prototypes
589  *****************************************************************************/
590
591 /* input_CreateThread
592  * Release the returned input_thread_t using vlc_object_release() */
593 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
594 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
595
596 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
597 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
598
599 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
600 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
601 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
602
603 enum input_query_e
604 {
605     /* input variable "position" */
606     INPUT_GET_POSITION,         /* arg1= double *       res=    */
607     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
608
609     /* input variable "length" */
610     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
611
612     /* input variable "time" */
613     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
614     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
615
616     /* input variable "rate" (1 is DEFAULT_RATE) */
617     INPUT_GET_RATE,             /* arg1= int *          res=    */
618     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
619
620     /* input variable "state" */
621     INPUT_GET_STATE,            /* arg1= int *          res=    */
622     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
623
624     /* input variable "audio-delay" and "sub-delay" */
625     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
626     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
627     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
628     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
629
630     /* Meta datas */
631     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
632     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
633     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
634     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
635
636     /* Input config options */
637     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
638
639     /* Input properties */
640     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
641     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
642     INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
643
644     /* bookmarks */
645     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
646     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
647     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
648     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
649     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
650     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
651
652     /* Attachments */
653     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
654     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
655
656     /* On the fly input slave */
657     INPUT_ADD_SLAVE        /* arg1= char * */
658 };
659
660 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
661 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
662
663 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, bool b_force_decoder ) );
664 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
665 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
666
667 VLC_EXPORT( bool, input_AddSubtitles, ( input_thread_t *, char *, bool ) );
668
669 #endif