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
31 * This file defines functions, structures and enums for input objects in vlc
37 #include <vlc_events.h>
39 #include <string.h> /* strcasestr() */
43 /*****************************************************************************
44 * input_item_t: Describes an input and is used to spawn input_thread_t objects
45 *****************************************************************************/
48 char *psz_name; /**< Name of this info */
49 char *psz_value; /**< Value of the info */
52 struct info_category_t
54 char *psz_name; /**< Name of this category */
55 int i_infos; /**< Number of infos in the category */
56 struct info_t **pp_infos; /**< Pointer to an array of infos */
62 int i_id; /**< Identifier of the item */
64 char *psz_name; /**< text describing this item */
65 char *psz_uri; /**< mrl of this item */
66 bool b_fixed_name; /**< Can the interface change the name ?*/
68 int i_options; /**< Number of input options */
69 char **ppsz_options; /**< Array of input options */
70 uint8_t *optflagv; /**< Some flags of input options */
73 mtime_t i_duration; /**< Duration in milliseconds*/
75 uint8_t i_type; /**< Type (file, disc, ...) */
76 bool b_prefers_tree; /**< Do we prefer being displayed as tree*/
78 int i_categories; /**< Number of info categories */
79 info_category_t **pp_categories; /**< Pointer to the first info category */
81 int i_es; /**< Number of es format descriptions */
82 es_format_t **es; /**< Es formats */
84 input_stats_t *p_stats; /**< Statistics */
85 int i_nb_played; /**< Number of times played */
87 bool b_error_when_reading; /**< Error When Reading */
91 vlc_event_manager_t event_manager;
93 vlc_mutex_t lock; /**< Lock for the item */
96 #define ITEM_TYPE_UNKNOWN 0
97 #define ITEM_TYPE_FILE 1
98 #define ITEM_TYPE_DIRECTORY 2
99 #define ITEM_TYPE_DISC 3
100 #define ITEM_TYPE_CDDA 4
101 #define ITEM_TYPE_CARD 5
102 #define ITEM_TYPE_NET 6
103 #define ITEM_TYPE_PLAYLIST 7
104 #define ITEM_TYPE_NODE 8
105 #define ITEM_TYPE_NUMBER 9
107 VLC_EXPORT( void, input_item_CopyOptions, ( input_item_t *p_parent, input_item_t *p_child ) );
108 VLC_EXPORT( void, input_item_SetName, ( input_item_t *p_item, const char *psz_name ) );
110 /* This won't hold the item, but can tell to interested third parties
111 * Like the playlist, that there is a new sub item. With this design
112 * It is not the input item's responsability to keep all the ref of
113 * the input item children. */
114 VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
117 /* Flags handled past input_item_AddOpt() */
118 #define VLC_INPUT_OPTION_TRUSTED 0x2
120 /* Flags handled within input_item_AddOpt() */
121 #define VLC_INPUT_OPTION_UNIQUE 0x100
123 VLC_EXPORT( int, input_item_AddOpt, ( input_item_t *, const char *str, unsigned flags ) );
124 VLC_EXPORT( int, input_item_AddOption, (input_item_t *item, const char *str) );
125 VLC_EXPORT( int ,input_item_AddOption, (input_item_t *item, const char *str) );
126 VLC_EXPORT( bool,input_item_HasErrorWhenReading, (input_item_t *item) );
127 VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ));
129 VLC_EXPORT( bool,input_item_HasErrorWhenReading, (input_item_t *item) );
131 VLC_EXPORT( bool,input_item_MetaMatch, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ) );
132 VLC_EXPORT( char *, input_item_GetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type ) );
133 VLC_EXPORT( char *, input_item_GetName, ( input_item_t * p_i ) );
134 VLC_EXPORT( char *, input_item_GetURI, ( input_item_t * p_i ) );
135 VLC_EXPORT( void, input_item_SetURI, ( input_item_t * p_i, char * psz_uri ));
136 VLC_EXPORT(mtime_t, input_item_GetDuration, ( input_item_t * p_i ) );
137 VLC_EXPORT( void, input_item_SetDuration, ( input_item_t * p_i, mtime_t i_duration ));
138 VLC_EXPORT( bool, input_item_IsPreparsed, ( input_item_t *p_i ));
139 VLC_EXPORT( bool, input_item_IsArtFetched, ( input_item_t *p_i ));
140 VLC_EXPORT( const vlc_meta_t *, input_item_GetMetaObject, ( input_item_t *p_i ));
141 VLC_EXPORT( void, input_item_MetaMerge, ( input_item_t *p_i, const vlc_meta_t * p_new_meta ));
144 #define input_item_SetTitle( item, b ) input_item_SetMeta( item, vlc_meta_Title, b )
145 #define input_item_SetArtist( item, b ) input_item_SetMeta( item, vlc_meta_Artist, b )
146 #define input_item_SetGenre( item, b ) input_item_SetMeta( item, vlc_meta_Genre, b )
147 #define input_item_SetCopyright( item, b ) input_item_SetMeta( item, vlc_meta_Copyright, b )
148 #define input_item_SetAlbum( item, b ) input_item_SetMeta( item, vlc_meta_Album, b )
149 #define input_item_SetTrackNum( item, b ) input_item_SetMeta( item, vlc_meta_TrackNumber, b )
150 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
151 #define input_item_SetRating( item, b ) input_item_SetMeta( item, vlc_meta_Rating, b )
152 #define input_item_SetDate( item, b ) input_item_SetMeta( item, vlc_meta_Date, b )
153 #define input_item_SetSetting( item, b ) input_item_SetMeta( item, vlc_meta_Setting, b )
154 #define input_item_SetURL( item, b ) input_item_SetMeta( item, vlc_meta_URL, b )
155 #define input_item_SetLanguage( item, b ) input_item_SetMeta( item, vlc_meta_Language, b )
156 #define input_item_SetNowPlaying( item, b ) input_item_SetMeta( item, vlc_meta_NowPlaying, b )
157 #define input_item_SetPublisher( item, b ) input_item_SetMeta( item, vlc_meta_Publisher, b )
158 #define input_item_SetEncodedBy( item, b ) input_item_SetMeta( item, vlc_meta_EncodedBy, b )
159 #define input_item_SetArtURL( item, b ) input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
160 #define input_item_SetTrackID( item, b ) input_item_SetMeta( item, vlc_meta_TrackID, b )
162 #define input_item_GetTitle( item ) input_item_GetMeta( item, vlc_meta_Title )
163 #define input_item_GetArtist( item ) input_item_GetMeta( item, vlc_meta_Artist )
164 #define input_item_GetGenre( item ) input_item_GetMeta( item, vlc_meta_Genre )
165 #define input_item_GetCopyright( item ) input_item_GetMeta( item, vlc_meta_Copyright )
166 #define input_item_GetAlbum( item ) input_item_GetMeta( item, vlc_meta_Album )
167 #define input_item_GetTrackNum( item ) input_item_GetMeta( item, vlc_meta_TrackNumber )
168 #define input_item_GetDescription( item ) input_item_GetMeta( item, vlc_meta_Description )
169 #define input_item_GetRating( item ) input_item_GetMeta( item, vlc_meta_Rating )
170 #define input_item_GetDate( item ) input_item_GetMeta( item, vlc_meta_Date )
171 #define input_item_GetGetting( item ) input_item_GetMeta( item, vlc_meta_Getting )
172 #define input_item_GetURL( item ) input_item_GetMeta( item, vlc_meta_URL )
173 #define input_item_GetLanguage( item ) input_item_GetMeta( item, vlc_meta_Language )
174 #define input_item_GetNowPlaying( item ) input_item_GetMeta( item, vlc_meta_NowPlaying )
175 #define input_item_GetPublisher( item ) input_item_GetMeta( item, vlc_meta_Publisher )
176 #define input_item_GetEncodedBy( item ) input_item_GetMeta( item, vlc_meta_EncodedBy )
177 #define input_item_GetArtURL( item ) input_item_GetMeta( item, vlc_meta_ArtworkURL )
178 #define input_item_GetTrackID( item ) input_item_GetMeta( item, vlc_meta_TrackID )
179 #define input_item_GetSetting( item ) input_item_GetMeta( item, vlc_meta_Setting )
181 VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
182 VLC_EXPORT(int, input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) LIBVLC_FORMAT( 4, 5 ) );
184 #define input_item_New( a,b,c ) input_item_NewExt( a, b, c, 0, NULL, -1 )
185 #define input_item_NewExt(a,b,c,d,e,f) __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f)
186 VLC_EXPORT( input_item_t *, __input_item_NewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration ) );
187 VLC_EXPORT( input_item_t *, input_item_NewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
189 #define input_item_GetById(a,b) __input_item_GetById( VLC_OBJECT(a),b )
190 VLC_EXPORT( input_item_t *, __input_item_GetById, (vlc_object_t *, int ) );
192 /*****************************************************************************
194 *****************************************************************************/
195 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
196 const vlc_meta_t *p_meta )
203 if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
204 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
206 p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
207 p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
209 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
210 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
212 p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
213 p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
215 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
216 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
218 p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
219 p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
221 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
223 p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
224 p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
228 /*****************************************************************************
229 * Seek point: (generalisation of chapters)
230 *****************************************************************************/
233 int64_t i_byte_offset;
234 int64_t i_time_offset;
239 static inline seekpoint_t *vlc_seekpoint_New( void )
241 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
242 point->i_byte_offset =
243 point->i_time_offset = -1;
245 point->psz_name = NULL;
249 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
252 free( point->psz_name );
256 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
258 seekpoint_t *point = vlc_seekpoint_New();
259 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
260 point->i_time_offset = src->i_time_offset;
261 point->i_byte_offset = src->i_byte_offset;
265 /*****************************************************************************
267 *****************************************************************************/
272 bool b_menu; /* Is it a menu or a normal entry */
274 int64_t i_length; /* Length(microsecond) if known, else 0 */
275 int64_t i_size; /* Size (bytes) if known, else 0 */
277 /* Title seekpoint */
279 seekpoint_t **seekpoint;
283 static inline input_title_t *vlc_input_title_New(void)
285 input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
297 static inline void vlc_input_title_Delete( input_title_t *t )
304 for( i = 0; i < t->i_seekpoint; i++ )
306 free( t->seekpoint[i]->psz_name );
307 free( t->seekpoint[i] );
309 free( t->seekpoint );
313 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
315 input_title_t *dup = vlc_input_title_New( );
318 if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
319 dup->b_menu = t->b_menu;
320 dup->i_length = t->i_length;
321 dup->i_size = t->i_size;
322 dup->i_seekpoint = t->i_seekpoint;
323 if( t->i_seekpoint > 0 )
325 dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
326 sizeof(seekpoint_t*) );
328 for( i = 0; i < t->i_seekpoint; i++ )
330 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
337 /*****************************************************************************
339 *****************************************************************************/
340 struct input_attachment_t
344 char *psz_description;
350 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
351 const char *psz_mime,
352 const char *psz_description,
356 input_attachment_t *a =
357 (input_attachment_t*)malloc( sizeof(input_attachment_t) );
360 a->psz_name = strdup( psz_name ? psz_name : "" );
361 a->psz_mime = strdup( psz_mime ? psz_mime : "" );
362 a->psz_description = strdup( psz_description ? psz_description : "" );
367 a->p_data = malloc( i_data );
368 if( a->p_data && p_data )
369 memcpy( a->p_data, p_data, i_data );
373 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
375 return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
376 a->p_data, a->i_data );
378 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
384 free( a->psz_description );
389 /*****************************************************************************
390 * input defines/constants.
391 *****************************************************************************/
394 /* NOTE: you need to update ppsz_input_state in the RC interface
395 * if you modify this list. */
396 typedef enum input_state_e
410 /* "rate" default, min/max
411 * A rate below 1000 plays the movie faster,
412 * A rate above 1000 plays the movie slower.
414 #define INPUT_RATE_DEFAULT 1000
415 #define INPUT_RATE_MIN 125 /* Up to 8/1 */
416 #define INPUT_RATE_MAX 32000 /* Up to 1/32 */
418 /* i_update field of access_t/demux_t */
419 #define INPUT_UPDATE_NONE 0x0000
420 #define INPUT_UPDATE_SIZE 0x0001
421 #define INPUT_UPDATE_TITLE 0x0010
422 #define INPUT_UPDATE_SEEKPOINT 0x0020
423 #define INPUT_UPDATE_META 0x0040
425 /* Input control XXX: internal */
426 #define INPUT_CONTROL_FIFO_SIZE 100
428 /** Get the input item for an input thread */
429 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
431 typedef struct input_thread_private_t input_thread_private_t;
434 * Main structure representing an input thread. This structure is mostly
435 * private. The only public fields are READ-ONLY. You must use the helpers
438 struct input_thread_t
447 bool b_can_pace_control;
448 int64_t i_time; /* Current time */
450 /* Internal caching common to all inputs */
453 /* All other data is input_thread is PRIVATE. You can't access it
454 * outside of src/input */
455 input_thread_private_t *p;
458 /*****************************************************************************
460 *****************************************************************************/
462 /* input_CreateThread
463 * Release the returned input_thread_t using vlc_object_release() */
464 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
465 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
467 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
468 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
470 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
471 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
472 VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) );
476 /* input variable "position" */
477 INPUT_GET_POSITION, /* arg1= double * res= */
478 INPUT_SET_POSITION, /* arg1= double res=can fail */
480 /* input variable "length" */
481 INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
483 /* input variable "time" */
484 INPUT_GET_TIME, /* arg1= int64_t * res= */
485 INPUT_SET_TIME, /* arg1= int64_t res=can fail */
487 /* input variable "rate" (1 is DEFAULT_RATE) */
488 INPUT_GET_RATE, /* arg1= int * res= */
489 INPUT_SET_RATE, /* arg1= int res=can fail */
491 /* input variable "state" */
492 INPUT_GET_STATE, /* arg1= int * res= */
493 INPUT_SET_STATE, /* arg1= int res=can fail */
495 /* input variable "audio-delay" and "sub-delay" */
496 INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
497 INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
498 INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
499 INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
502 INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
503 INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
504 INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
505 INPUT_SET_NAME, /* arg1= char* res=can fail */
507 /* Input config options */
508 INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/
510 /* Input properties */
511 INPUT_GET_BYTE_POSITION, /* arg1= int64_t * res= */
512 INPUT_SET_BYTE_SIZE, /* arg1= int64_t * res= */
513 INPUT_GET_VIDEO_FPS, /* arg1= double * res=can fail */
516 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
517 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
518 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
519 INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
520 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
521 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
524 INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int* res=can fail */
525 INPUT_GET_ATTACHMENT, /* arg1=input_attachment_t**, arg2=char* res=can fail */
527 /* On the fly input slave */
528 INPUT_ADD_SLAVE, /* arg1= char * */
530 /* On the fly record while playing */
531 INPUT_SET_RECORD_STATE, /* arg1=bool res=can fail */
532 INPUT_GET_RECORD_STATE, /* arg1=bool* res=can fail */
535 INPUT_RESTART_ES, /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
538 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
539 VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) );
541 static inline input_state_e input_GetState( input_thread_t * p_input )
543 input_state_e state = INIT_S;
544 input_Control( p_input, INPUT_GET_STATE, &state );
547 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, sout_instance_t * ) );
548 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
549 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
551 VLC_EXPORT( bool, input_AddSubtitles, ( input_thread_t *, char *, bool ) );
553 VLC_EXPORT( vlc_event_manager_t *, input_get_event_manager, ( input_thread_t * ) );
556 * This function allows to split a MRL into access, demux and path part.
558 * You should not write into access and demux string as they may not point into
559 * the provided buffer.
560 * The buffer provided by psz_dup will be modified.
562 VLC_EXPORT( void, input_SplitMRL, ( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup ) );