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