1 /*****************************************************************************
2 * vlc_input.h: Core input structures
3 *****************************************************************************
4 * Copyright (C) 1999-2006 the VideoLAN team
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8 * Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
25 #if !defined( __LIBVLC__ )
26 #error You are not libvlc or one of its plugins. You cannot include this file
29 /* __ is need because conflict with <vlc/input.h> */
31 #define _VLC__INPUT_H 1
39 /*****************************************************************************
40 * input_item_t: Describes an input and is used to spawn input_thread_t objects
41 *****************************************************************************/
44 char *psz_name; /**< Name of this info */
45 char *psz_value; /**< Value of the info */
48 struct info_category_t
50 char *psz_name; /**< Name of this category */
51 int i_infos; /**< Number of infos in the category */
52 struct info_t **pp_infos; /**< Pointer to an array of infos */
58 int i_id; /**< Identifier of the item */
60 char *psz_name; /**< text describing this item */
61 char *psz_uri; /**< mrl of this item */
62 vlc_bool_t b_fixed_name; /**< Can the interface change the name ?*/
64 int i_options; /**< Number of input options */
65 char **ppsz_options; /**< Array of input options */
67 mtime_t i_duration; /**< Duration in milliseconds*/
69 uint8_t i_type; /**< Type (file, disc, ...) */
70 vlc_bool_t b_prefers_tree; /**< Do we prefer being displayed as tree*/
72 int i_categories; /**< Number of info categories */
73 info_category_t **pp_categories; /**< Pointer to the first info category */
75 int i_es; /**< Number of es format descriptions */
76 es_format_t **es; /**< Es formats */
78 input_stats_t *p_stats; /**< Statistics */
79 int i_nb_played; /**< Number of times played */
83 vlc_mutex_t lock; /**< Lock for the item */
86 #define ITEM_TYPE_UNKNOWN 0
87 #define ITEM_TYPE_AFILE 1
88 #define ITEM_TYPE_VFILE 2
89 #define ITEM_TYPE_DIRECTORY 3
90 #define ITEM_TYPE_DISC 4
91 #define ITEM_TYPE_CDDA 5
92 #define ITEM_TYPE_CARD 6
93 #define ITEM_TYPE_NET 7
94 #define ITEM_TYPE_PLAYLIST 8
95 #define ITEM_TYPE_NODE 9
96 #define ITEM_TYPE_NUMBER 10
98 static inline void input_ItemInit( vlc_object_t *p_o, input_item_t *p_i )
100 memset( p_i, 0, sizeof(input_item_t) );
101 p_i->psz_name = NULL;
103 TAB_INIT( p_i->i_es, p_i->es );
104 TAB_INIT( p_i->i_options, p_i->ppsz_options );
105 TAB_INIT( p_i->i_categories, p_i->pp_categories );
107 p_i->i_type = ITEM_TYPE_UNKNOWN;
108 p_i->b_fixed_name = VLC_TRUE;
113 vlc_mutex_init( p_o, &p_i->lock );
116 static inline void input_ItemCopyOptions( input_item_t *p_parent,
117 input_item_t *p_child )
120 for( i = 0 ; i< p_parent->i_options; i++ )
122 char *psz_option= strdup( p_parent->ppsz_options[i] );
123 p_child->i_options++;
124 p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
127 p_child->ppsz_options[p_child->i_options-1] = psz_option;
131 VLC_EXPORT( void, input_ItemAddOption,( input_item_t *, const char * ) );
132 VLC_EXPORT( void, input_ItemAddOptionNoDup,( input_item_t *, const char * ) );
134 static inline void input_ItemClean( input_item_t *p_i )
138 free( p_i->psz_name );
139 free( p_i->psz_uri );
142 vlc_mutex_destroy( &p_i->p_stats->lock );
143 free( p_i->p_stats );
147 vlc_meta_Delete( p_i->p_meta );
149 for( i = 0; i < p_i->i_options; i++ )
151 if( p_i->ppsz_options[i] )
152 free( p_i->ppsz_options[i] );
154 TAB_CLEAN( p_i->i_options, p_i->ppsz_options );
156 for( i = 0; i < p_i->i_es; i++ )
158 es_format_Clean( p_i->es[i] );
161 TAB_CLEAN( p_i->i_es, p_i->es );
163 for( i = 0; i < p_i->i_categories; i++ )
165 info_category_t *p_category = p_i->pp_categories[i];
168 for( j = 0; j < p_category->i_infos; j++ )
170 struct info_t *p_info = p_category->pp_infos[j];
172 if( p_info->psz_name )
173 free( p_info->psz_name);
174 if( p_info->psz_value )
175 free( p_info->psz_value );
178 TAB_CLEAN( p_category->i_infos, p_category->pp_infos );
180 if( p_category->psz_name ) free( p_category->psz_name );
183 TAB_CLEAN( p_i->i_categories, p_i->pp_categories );
185 vlc_mutex_destroy( &p_i->lock );
188 static inline void input_item_SetMeta( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val )
191 p_i->p_meta = vlc_meta_New();
192 vlc_meta_Set( p_i->p_meta, meta_type, psz_val );
195 static inline const char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
199 return vlc_meta_Get( p_i->p_meta, meta_type );
202 static inline void input_item_SetPreparsed( input_item_t *p_i, vlc_bool_t preparsed )
205 p_i->p_meta = vlc_meta_New();
208 p_i->p_meta->i_status |= ITEM_PREPARSED;
210 p_i->p_meta->i_status &= ~ITEM_PREPARSED;
213 static inline vlc_bool_t input_item_IsPreparsed( input_item_t *p_i )
215 return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : VLC_FALSE ;
218 static inline void input_item_SetMetaFetched( input_item_t *p_i, vlc_bool_t metafetched )
221 p_i->p_meta = vlc_meta_New();
224 p_i->p_meta->i_status |= ITEM_META_FETCHED;
226 p_i->p_meta->i_status &= ~ITEM_META_FETCHED;
229 static inline vlc_bool_t input_item_IsMetaFetched( input_item_t *p_i )
231 return p_i->p_meta ? p_i->p_meta->i_status & ITEM_META_FETCHED : VLC_FALSE ;
235 static inline void input_item_SetArtNotFound( input_item_t *p_i, vlc_bool_t notfound )
238 p_i->p_meta = vlc_meta_New();
241 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
243 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
246 static inline void input_item_SetArtFetched( input_item_t *p_i, vlc_bool_t artfetched )
249 p_i->p_meta = vlc_meta_New();
252 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
254 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
257 static inline vlc_bool_t input_item_IsArtFetched( input_item_t *p_i )
259 return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : VLC_FALSE ;
262 static inline const vlc_meta_t * input_item_GetMetaObject( input_item_t *p_i )
265 p_i->p_meta = vlc_meta_New();
270 static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p_new_meta )
273 p_i->p_meta = vlc_meta_New();
275 vlc_meta_Merge( p_i->p_meta, p_new_meta );
278 #define input_item_SetTitle( item, b ) input_item_SetMeta( item, vlc_meta_Title, b )
279 #define input_item_SetArtist( item, b ) input_item_SetMeta( item, vlc_meta_Artist, b )
280 #define input_item_SetGenre( item, b ) input_item_SetMeta( item, vlc_meta_Genre, b )
281 #define input_item_SetCopyright( item, b ) input_item_SetMeta( item, vlc_meta_Copyright, b )
282 #define input_item_SetAlbum( item, b ) input_item_SetMeta( item, vlc_meta_Album, b )
283 #define input_item_SetTrackNum( item, b ) input_item_SetMeta( item, vlc_meta_TrackNumber, b )
284 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
285 #define input_item_SetRating( item, b ) input_item_SetMeta( item, vlc_meta_Rating, b )
286 #define input_item_SetDate( item, b ) input_item_SetMeta( item, vlc_meta_Date, b )
287 #define input_item_SetSetting( item, b ) input_item_SetMeta( item, vlc_meta_Setting, b )
288 #define input_item_SetURL( item, b ) input_item_SetMeta( item, vlc_meta_URL, b )
289 #define input_item_SetLanguage( item, b ) input_item_SetMeta( item, vlc_meta_Language, b )
290 #define input_item_SetNowPlaying( item, b ) input_item_SetMeta( item, vlc_meta_NowPlaying, b )
291 #define input_item_SetPublisher( item, b ) input_item_SetMeta( item, vlc_meta_Publisher, b )
292 #define input_item_SetEncodedBy( item, b ) input_item_SetMeta( item, vlc_meta_EncodedBy, b )
293 #define input_item_SetArtURL( item, b ) input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
294 #define input_item_SetTrackID( item, b ) input_item_SetMeta( item, vlc_meta_TrackID, b )
296 #define input_item_GetTitle( item ) input_item_GetMeta( item, vlc_meta_Title )
297 #define input_item_GetArtist( item ) input_item_GetMeta( item, vlc_meta_Artist )
298 #define input_item_GetGenre( item ) input_item_GetMeta( item, vlc_meta_Genre )
299 #define input_item_GetCopyright( item ) input_item_GetMeta( item, vlc_meta_Copyright )
300 #define input_item_GetAlbum( item ) input_item_GetMeta( item, vlc_meta_Album )
301 #define input_item_GetTrackNum( item ) input_item_GetMeta( item, vlc_meta_TrackNumber )
302 #define input_item_GetDescription( item ) input_item_GetMeta( item, vlc_meta_Description )
303 #define input_item_GetRating( item ) input_item_GetMeta( item, vlc_meta_Rating )
304 #define input_item_GetDate( item ) input_item_GetMeta( item, vlc_meta_Date )
305 #define input_item_GetGetting( item ) input_item_GetMeta( item, vlc_meta_Getting )
306 #define input_item_GetURL( item ) input_item_GetMeta( item, vlc_meta_URL )
307 #define input_item_GetLanguage( item ) input_item_GetMeta( item, vlc_meta_Language )
308 #define input_item_GetNowPlaying( item ) input_item_GetMeta( item, vlc_meta_NowPlaying )
309 #define input_item_GetPublisher( item ) input_item_GetMeta( item, vlc_meta_Publisher )
310 #define input_item_GetEncodedBy( item ) input_item_GetMeta( item, vlc_meta_EncodedBy )
311 #define input_item_GetArtURL( item ) input_item_GetMeta( item, vlc_meta_ArtworkURL )
312 #define input_item_GetTrackID( item ) input_item_GetMeta( item, vlc_meta_TrackID )
314 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
315 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
317 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
318 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
319 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration ) );
320 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
322 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
324 /*****************************************************************************
326 *****************************************************************************/
327 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
328 const vlc_meta_t *p_meta )
335 if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
336 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
338 p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
339 p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
341 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
342 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
344 p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
345 p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
347 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
348 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
350 p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
351 p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
353 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
355 p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
356 p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
360 /*****************************************************************************
361 * Seek point: (generalisation of chapters)
362 *****************************************************************************/
365 int64_t i_byte_offset;
366 int64_t i_time_offset;
371 static inline seekpoint_t *vlc_seekpoint_New( void )
373 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
374 point->i_byte_offset =
375 point->i_time_offset = -1;
377 point->psz_name = NULL;
381 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
384 if( point->psz_name ) free( point->psz_name );
388 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
390 seekpoint_t *point = vlc_seekpoint_New();
391 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
392 point->i_time_offset = src->i_time_offset;
393 point->i_byte_offset = src->i_byte_offset;
397 /*****************************************************************************
399 *****************************************************************************/
404 vlc_bool_t b_menu; /* Is it a menu or a normal entry */
406 int64_t i_length; /* Length(microsecond) if known, else 0 */
407 int64_t i_size; /* Size (bytes) if known, else 0 */
409 /* Title seekpoint */
411 seekpoint_t **seekpoint;
415 static inline input_title_t *vlc_input_title_New(void)
417 input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
420 t->b_menu = VLC_FALSE;
429 static inline void vlc_input_title_Delete( input_title_t *t )
435 if( t->psz_name ) free( t->psz_name );
436 for( i = 0; i < t->i_seekpoint; i++ )
438 if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
439 free( t->seekpoint[i] );
441 if( t->seekpoint ) free( t->seekpoint );
445 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
447 input_title_t *dup = vlc_input_title_New( );
450 if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
451 dup->b_menu = t->b_menu;
452 dup->i_length = t->i_length;
453 dup->i_size = t->i_size;
454 dup->i_seekpoint = t->i_seekpoint;
455 if( t->i_seekpoint > 0 )
457 dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
458 sizeof(seekpoint_t*) );
460 for( i = 0; i < t->i_seekpoint; i++ )
462 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
468 /*****************************************************************************
470 *****************************************************************************/
471 struct input_attachment_t
475 char *psz_description;
480 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
481 const char *psz_mime,
482 const char *psz_description,
486 input_attachment_t *a =
487 (input_attachment_t*)malloc( sizeof(input_attachment_t) );
490 a->psz_name = strdup( psz_name ? psz_name : "" );
491 a->psz_mime = strdup( psz_mime ? psz_mime : "" );
492 a->psz_description = strdup( psz_description ? psz_description : "" );
497 a->p_data = malloc( i_data );
498 if( a->p_data && p_data )
499 memcpy( a->p_data, p_data, i_data );
503 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
505 return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
506 a->p_data, a->i_data );
508 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
514 free( a->psz_description );
519 /*****************************************************************************
520 * input defines/constants.
521 *****************************************************************************/
535 /* "rate" default, min/max
536 * A rate below 1000 plays the movie faster,
537 * A rate above 1000 plays the movie slower.
539 #define INPUT_RATE_DEFAULT 1000
540 #define INPUT_RATE_MIN 125 /* Up to 8/1 */
541 #define INPUT_RATE_MAX 32000 /* Up to 1/32 */
543 /* i_update field of access_t/demux_t */
544 #define INPUT_UPDATE_NONE 0x0000
545 #define INPUT_UPDATE_SIZE 0x0001
546 #define INPUT_UPDATE_TITLE 0x0010
547 #define INPUT_UPDATE_SEEKPOINT 0x0020
548 #define INPUT_UPDATE_META 0x0040
550 /* Input control XXX: internal */
551 #define INPUT_CONTROL_FIFO_SIZE 100
553 /** Get the input item for an input thread */
554 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
556 typedef struct input_thread_private_t input_thread_private_t;
559 * Main structure representing an input thread. This structure is mostly
560 * private. The only public fields are READ-ONLY. You must use the helpers
563 struct input_thread_t
568 vlc_bool_t b_preparsing;
571 vlc_bool_t b_can_pace_control;
572 int64_t i_time; /* Current time */
574 /* Internal caching common to all inputs */
577 /* All other data is input_thread is PRIVATE. You can't access it
578 * outside of src/input */
579 input_thread_private_t *p;
582 /*****************************************************************************
584 *****************************************************************************/
585 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
586 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
587 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
588 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
590 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
591 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
592 VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) );
593 VLC_EXPORT( void, input_DestroyThread, ( input_thread_t * ) );
597 /* input variable "position" */
598 INPUT_GET_POSITION, /* arg1= double * res= */
599 INPUT_SET_POSITION, /* arg1= double res=can fail */
601 /* input variable "length" */
602 INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
604 /* input variable "time" */
605 INPUT_GET_TIME, /* arg1= int64_t * res= */
606 INPUT_SET_TIME, /* arg1= int64_t res=can fail */
608 /* input variable "rate" (1 is DEFAULT_RATE) */
609 INPUT_GET_RATE, /* arg1= int * res= */
610 INPUT_SET_RATE, /* arg1= int res=can fail */
612 /* input variable "state" */
613 INPUT_GET_STATE, /* arg1= int * res= */
614 INPUT_SET_STATE, /* arg1= int res=can fail */
616 /* input variable "audio-delay" and "sub-delay" */
617 INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
618 INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
619 INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
620 INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
623 INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
624 INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
625 INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
626 INPUT_SET_NAME, /* arg1= char* res=can fail */
628 /* Input config options */
629 INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/
631 /* Input properties */
632 INPUT_GET_BYTE_POSITION, /* arg1= int64_t * res= */
633 INPUT_SET_BYTE_SIZE, /* arg1= int64_t * res= */
636 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
637 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
638 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
639 INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
640 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
641 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
644 INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int* res=can fail */
645 INPUT_GET_ATTACHMENT, /* arg1=input_attachment_t**, arg2=char* res=can fail */
647 /* On the fly input slave */
648 INPUT_ADD_SLAVE /* arg1= char * */
651 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
652 VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) );
654 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
655 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
656 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
658 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );