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