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