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 /* __ is need because conflict with <vlc/input.h> */
27 #define _VLC__INPUT_H 1
32 #include <vlc_events.h>
34 #include <string.h> /* strstr() */
38 /*****************************************************************************
39 * input_item_t: Describes an input and is used to spawn input_thread_t objects
40 *****************************************************************************/
43 char *psz_name; /**< Name of this info */
44 char *psz_value; /**< Value of the info */
47 struct info_category_t
49 char *psz_name; /**< Name of this category */
50 int i_infos; /**< Number of infos in the category */
51 struct info_t **pp_infos; /**< Pointer to an array of infos */
57 int i_id; /**< Identifier of the item */
59 char *psz_name; /**< text describing this item */
60 char *psz_uri; /**< mrl of this item */
61 bool b_fixed_name; /**< Can the interface change the name ?*/
63 int i_options; /**< Number of input options */
64 char **ppsz_options; /**< Array of input options */
65 uint8_t *optflagv; /**< Some flags of input options */
68 mtime_t i_duration; /**< Duration in milliseconds*/
70 uint8_t i_type; /**< Type (file, disc, ...) */
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_event_manager_t event_manager;
85 vlc_mutex_t lock; /**< Lock for the item */
88 #define ITEM_TYPE_UNKNOWN 0
89 #define ITEM_TYPE_FILE 1
90 #define ITEM_TYPE_DIRECTORY 2
91 #define ITEM_TYPE_DISC 3
92 #define ITEM_TYPE_CDDA 4
93 #define ITEM_TYPE_CARD 5
94 #define ITEM_TYPE_NET 6
95 #define ITEM_TYPE_PLAYLIST 7
96 #define ITEM_TYPE_NODE 8
97 #define ITEM_TYPE_NUMBER 9
99 static inline void input_ItemCopyOptions( input_item_t *p_parent,
100 input_item_t *p_child )
103 for( i = 0 ; i< p_parent->i_options; i++ )
105 char *psz_option= strdup( p_parent->ppsz_options[i] );
106 if( !strcmp( psz_option, "meta-file" ) )
111 p_child->i_options++;
112 p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
115 p_child->ppsz_options[p_child->i_options-1] = psz_option;
117 p_child->optflagv = (uint8_t *)realloc( p_child->optflagv,
119 p_child->optflagv[p_child->optflagc - 1] = p_parent->optflagv[i];
123 static inline void input_item_SetName( input_item_t *p_item, const char *psz_name )
125 free( p_item->psz_name );
126 p_item->psz_name = strdup( psz_name );
129 /* This won't hold the item, but can tell to interested third parties
130 * Like the playlist, that there is a new sub item. With this design
131 * It is not the input item's responsability to keep all the ref of
132 * the input item children. */
133 static inline void input_ItemAddSubItem( input_item_t *p_parent,
134 input_item_t *p_child )
138 p_parent->i_type = ITEM_TYPE_PLAYLIST;
140 /* Notify interested third parties */
141 event.type = vlc_InputItemSubItemAdded;
142 event.u.input_item_subitem_added.p_new_child = p_child;
143 vlc_event_send( &p_parent->event_manager, &event );
146 /* Flags handled past input_ItemAddOpt() */
147 #define VLC_INPUT_OPTION_TRUSTED 0x2
149 /* Flags handled within input_ItemAddOpt() */
150 #define VLC_INPUT_OPTION_UNIQUE 0x100
152 VLC_EXPORT( int, input_ItemAddOpt, ( input_item_t *, const char *str, unsigned flags ) );
155 int input_ItemAddOption (input_item_t *item, const char *str)
157 return input_ItemAddOpt (item, str, VLC_INPUT_OPTION_TRUSTED);
161 VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ));
163 static inline bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz )
165 vlc_mutex_lock( &p_i->lock );
168 vlc_mutex_unlock( &p_i->lock );
171 const char * meta = vlc_meta_Get( p_i->p_meta, meta_type );
172 bool ret = meta && strstr( meta, psz );
173 vlc_mutex_unlock( &p_i->lock );
178 static inline char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
181 vlc_mutex_lock( &p_i->lock );
185 vlc_mutex_unlock( &p_i->lock );
189 if( vlc_meta_Get( p_i->p_meta, meta_type ) )
190 psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );
192 vlc_mutex_unlock( &p_i->lock );
196 static inline char * input_item_GetName( input_item_t * p_i )
198 vlc_mutex_lock( &p_i->lock );
199 char *psz_s = p_i->psz_name ? strdup( p_i->psz_name ) : NULL;
200 vlc_mutex_unlock( &p_i->lock );
204 static inline char * input_item_GetURI( input_item_t * p_i )
206 vlc_mutex_lock( &p_i->lock );
207 char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL;
208 vlc_mutex_unlock( &p_i->lock );
212 static inline void input_item_SetURI( input_item_t * p_i, char * psz_uri )
214 vlc_mutex_lock( &p_i->lock );
215 free( p_i->psz_uri );
216 p_i->psz_uri = strdup( psz_uri );
217 vlc_mutex_unlock( &p_i->lock );
220 static inline mtime_t input_item_GetDuration( input_item_t * p_i )
222 vlc_mutex_lock( &p_i->lock );
223 mtime_t i_duration = p_i->i_duration;
224 vlc_mutex_unlock( &p_i->lock );
228 static inline void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration )
230 bool send_event = false;
232 vlc_mutex_lock( &p_i->lock );
233 if( p_i->i_duration != i_duration )
235 p_i->i_duration = i_duration;
238 vlc_mutex_unlock( &p_i->lock );
240 if ( send_event == true )
243 event.type = vlc_InputItemDurationChanged;
244 event.u.input_item_duration_changed.new_duration = i_duration;
245 vlc_event_send( &p_i->event_manager, &event );
252 static inline bool input_item_IsPreparsed( input_item_t *p_i )
254 return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : false ;
257 static inline bool input_item_IsArtFetched( input_item_t *p_i )
259 return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : 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 )
313 #define input_item_GetSetting( item ) input_item_GetMeta( item, vlc_meta_Setting )
315 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
316 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) LIBVLC_FORMAT( 4, 5 ) );
318 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
319 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
320 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration ) );
321 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
323 #define input_ItemGetById(a,b) __input_ItemGetById( VLC_OBJECT(a),b )
324 VLC_EXPORT( input_item_t *, __input_ItemGetById, (vlc_object_t *, int ) );
326 /*****************************************************************************
328 *****************************************************************************/
329 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
330 const vlc_meta_t *p_meta )
337 if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
338 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
340 p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
341 p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
343 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
344 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
346 p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
347 p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
349 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
350 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
352 p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
353 p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
355 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
357 p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
358 p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
362 /*****************************************************************************
363 * Seek point: (generalisation of chapters)
364 *****************************************************************************/
367 int64_t i_byte_offset;
368 int64_t i_time_offset;
373 static inline seekpoint_t *vlc_seekpoint_New( void )
375 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
376 point->i_byte_offset =
377 point->i_time_offset = -1;
379 point->psz_name = NULL;
383 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
386 free( point->psz_name );
390 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
392 seekpoint_t *point = vlc_seekpoint_New();
393 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
394 point->i_time_offset = src->i_time_offset;
395 point->i_byte_offset = src->i_byte_offset;
399 /*****************************************************************************
401 *****************************************************************************/
406 bool b_menu; /* Is it a menu or a normal entry */
408 int64_t i_length; /* Length(microsecond) if known, else 0 */
409 int64_t i_size; /* Size (bytes) if known, else 0 */
411 /* Title seekpoint */
413 seekpoint_t **seekpoint;
417 static inline input_title_t *vlc_input_title_New(void)
419 input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
431 static inline void vlc_input_title_Delete( input_title_t *t )
438 for( i = 0; i < t->i_seekpoint; i++ )
440 free( t->seekpoint[i]->psz_name );
441 free( t->seekpoint[i] );
443 free( t->seekpoint );
447 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
449 input_title_t *dup = vlc_input_title_New( );
452 if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
453 dup->b_menu = t->b_menu;
454 dup->i_length = t->i_length;
455 dup->i_size = t->i_size;
456 dup->i_seekpoint = t->i_seekpoint;
457 if( t->i_seekpoint > 0 )
459 dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
460 sizeof(seekpoint_t*) );
462 for( i = 0; i < t->i_seekpoint; i++ )
464 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
470 /*****************************************************************************
472 *****************************************************************************/
473 struct input_attachment_t
477 char *psz_description;
482 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
483 const char *psz_mime,
484 const char *psz_description,
488 input_attachment_t *a =
489 (input_attachment_t*)malloc( sizeof(input_attachment_t) );
492 a->psz_name = strdup( psz_name ? psz_name : "" );
493 a->psz_mime = strdup( psz_mime ? psz_mime : "" );
494 a->psz_description = strdup( psz_description ? psz_description : "" );
499 a->p_data = malloc( i_data );
500 if( a->p_data && p_data )
501 memcpy( a->p_data, p_data, i_data );
505 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
507 return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
508 a->p_data, a->i_data );
510 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
516 free( a->psz_description );
520 /*****************************************************************************
521 * input defines/constants.
522 *****************************************************************************/
536 /* "rate" default, min/max
537 * A rate below 1000 plays the movie faster,
538 * A rate above 1000 plays the movie slower.
540 #define INPUT_RATE_DEFAULT 1000
541 #define INPUT_RATE_MIN 125 /* Up to 8/1 */
542 #define INPUT_RATE_MAX 32000 /* Up to 1/32 */
544 /* i_update field of access_t/demux_t */
545 #define INPUT_UPDATE_NONE 0x0000
546 #define INPUT_UPDATE_SIZE 0x0001
547 #define INPUT_UPDATE_TITLE 0x0010
548 #define INPUT_UPDATE_SEEKPOINT 0x0020
549 #define INPUT_UPDATE_META 0x0040
551 /* Input control XXX: internal */
552 #define INPUT_CONTROL_FIFO_SIZE 100
554 /** Get the input item for an input thread */
555 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
557 typedef struct input_thread_private_t input_thread_private_t;
560 * Main structure representing an input thread. This structure is mostly
561 * private. The only public fields are READ-ONLY. You must use the helpers
564 struct input_thread_t
572 bool b_can_pace_control;
573 int64_t i_time; /* Current time */
575 /* Internal caching common to all inputs */
578 /* All other data is input_thread is PRIVATE. You can't access it
579 * outside of src/input */
580 input_thread_private_t *p;
583 /*****************************************************************************
585 *****************************************************************************/
587 /* input_CreateThread
588 * Release the returned input_thread_t using vlc_object_release() */
589 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
590 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
592 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
593 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
595 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
596 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
597 VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) );
601 /* input variable "position" */
602 INPUT_GET_POSITION, /* arg1= double * res= */
603 INPUT_SET_POSITION, /* arg1= double res=can fail */
605 /* input variable "length" */
606 INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
608 /* input variable "time" */
609 INPUT_GET_TIME, /* arg1= int64_t * res= */
610 INPUT_SET_TIME, /* arg1= int64_t res=can fail */
612 /* input variable "rate" (1 is DEFAULT_RATE) */
613 INPUT_GET_RATE, /* arg1= int * res= */
614 INPUT_SET_RATE, /* arg1= int res=can fail */
616 /* input variable "state" */
617 INPUT_GET_STATE, /* arg1= int * res= */
618 INPUT_SET_STATE, /* arg1= int res=can fail */
620 /* input variable "audio-delay" and "sub-delay" */
621 INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
622 INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
623 INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
624 INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
627 INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
628 INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
629 INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
630 INPUT_SET_NAME, /* arg1= char* res=can fail */
632 /* Input config options */
633 INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/
635 /* Input properties */
636 INPUT_GET_BYTE_POSITION, /* arg1= int64_t * res= */
637 INPUT_SET_BYTE_SIZE, /* arg1= int64_t * res= */
638 INPUT_GET_VIDEO_FPS, /* arg1= double * res=can fail */
641 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
642 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
643 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
644 INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
645 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
646 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
649 INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int* res=can fail */
650 INPUT_GET_ATTACHMENT, /* arg1=input_attachment_t**, arg2=char* res=can fail */
652 /* On the fly input slave */
653 INPUT_ADD_SLAVE /* arg1= char * */
656 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
657 VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) );
659 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, bool b_force_decoder ) );
660 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
661 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
663 VLC_EXPORT( bool, input_AddSubtitles, ( input_thread_t *, char *, bool ) );