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 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
189 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
191 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
192 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
193 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration ) );
194 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
196 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
198 /*****************************************************************************
200 *****************************************************************************/
201 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
202 const vlc_meta_t *p_meta )
209 if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
210 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
212 p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
213 p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
215 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
216 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
218 p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
219 p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
221 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
222 (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
224 p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
225 p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
227 else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
229 p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
230 p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
234 /*****************************************************************************
235 * Seek point: (generalisation of chapters)
236 *****************************************************************************/
239 int64_t i_byte_offset;
240 int64_t i_time_offset;
245 static inline seekpoint_t *vlc_seekpoint_New( void )
247 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
248 point->i_byte_offset =
249 point->i_time_offset = -1;
251 point->psz_name = NULL;
255 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
258 if( point->psz_name ) free( point->psz_name );
262 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
264 seekpoint_t *point = vlc_seekpoint_New();
265 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
266 point->i_time_offset = src->i_time_offset;
267 point->i_byte_offset = src->i_byte_offset;
271 /*****************************************************************************
273 *****************************************************************************/
278 vlc_bool_t b_menu; /* Is it a menu or a normal entry */
280 int64_t i_length; /* Length(microsecond) if known, else 0 */
281 int64_t i_size; /* Size (bytes) if known, else 0 */
283 /* Title seekpoint */
285 seekpoint_t **seekpoint;
289 static inline input_title_t *vlc_input_title_New(void)
291 input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
294 t->b_menu = VLC_FALSE;
303 static inline void vlc_input_title_Delete( input_title_t *t )
309 if( t->psz_name ) free( t->psz_name );
310 for( i = 0; i < t->i_seekpoint; i++ )
312 if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
313 free( t->seekpoint[i] );
315 if( t->seekpoint ) free( t->seekpoint );
319 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
321 input_title_t *dup = vlc_input_title_New( );
324 if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
325 dup->b_menu = t->b_menu;
326 dup->i_length = t->i_length;
327 dup->i_size = t->i_size;
328 dup->i_seekpoint = t->i_seekpoint;
329 if( t->i_seekpoint > 0 )
331 dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
332 sizeof(seekpoint_t*) );
334 for( i = 0; i < t->i_seekpoint; i++ )
336 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
342 /*****************************************************************************
344 *****************************************************************************/
345 struct input_attachment_t
349 char *psz_description;
354 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
355 const char *psz_mime,
356 const char *psz_description,
360 input_attachment_t *a =
361 (input_attachment_t*)malloc( sizeof(input_attachment_t) );
364 a->psz_name = strdup( psz_name ? psz_name : "" );
365 a->psz_mime = strdup( psz_mime ? psz_mime : "" );
366 a->psz_description = strdup( psz_description ? psz_description : "" );
371 a->p_data = malloc( i_data );
372 if( a->p_data && p_data )
373 memcpy( a->p_data, p_data, i_data );
377 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
379 return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
380 a->p_data, a->i_data );
382 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
388 free( a->psz_description );
393 /*****************************************************************************
394 * input defines/constants.
395 *****************************************************************************/
409 /* "rate" default, min/max
410 * A rate below 1000 plays the movie faster,
411 * A rate above 1000 plays the movie slower.
413 #define INPUT_RATE_DEFAULT 1000
414 #define INPUT_RATE_MIN 125 /* Up to 8/1 */
415 #define INPUT_RATE_MAX 32000 /* Up to 1/32 */
417 /* i_update field of access_t/demux_t */
418 #define INPUT_UPDATE_NONE 0x0000
419 #define INPUT_UPDATE_SIZE 0x0001
420 #define INPUT_UPDATE_TITLE 0x0010
421 #define INPUT_UPDATE_SEEKPOINT 0x0020
422 #define INPUT_UPDATE_META 0x0040
424 /* Input control XXX: internal */
425 #define INPUT_CONTROL_FIFO_SIZE 100
427 /** Get the input item for an input thread */
428 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
430 typedef struct input_thread_private_t input_thread_private_t;
433 * Main structure representing an input thread. This structure is mostly
434 * private. The only public fields are READ-ONLY. You must use the helpers
437 struct input_thread_t
442 vlc_bool_t b_preparsing;
445 vlc_bool_t b_can_pace_control;
446 int64_t i_time; /* Current time */
448 /* Internal caching common to all inputs */
451 /* All other data is input_thread is PRIVATE. You can't access it
452 * outside of src/input */
453 input_thread_private_t *p;
456 /*****************************************************************************
458 *****************************************************************************/
459 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
460 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
461 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
462 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
464 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
465 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
466 VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) );
467 VLC_EXPORT( void, input_DestroyThread, ( input_thread_t * ) );
471 /* input variable "position" */
472 INPUT_GET_POSITION, /* arg1= double * res= */
473 INPUT_SET_POSITION, /* arg1= double res=can fail */
475 /* input variable "length" */
476 INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
478 /* input variable "time" */
479 INPUT_GET_TIME, /* arg1= int64_t * res= */
480 INPUT_SET_TIME, /* arg1= int64_t res=can fail */
482 /* input variable "rate" (1 is DEFAULT_RATE) */
483 INPUT_GET_RATE, /* arg1= int * res= */
484 INPUT_SET_RATE, /* arg1= int res=can fail */
486 /* input variable "state" */
487 INPUT_GET_STATE, /* arg1= int * res= */
488 INPUT_SET_STATE, /* arg1= int res=can fail */
490 /* input variable "audio-delay" and "sub-delay" */
491 INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
492 INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
493 INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
494 INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
497 INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
498 INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
499 INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
500 INPUT_SET_NAME, /* arg1= char* res=can fail */
502 /* Input config options */
503 INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/
505 /* Input properties */
506 INPUT_GET_BYTE_POSITION, /* arg1= int64_t * res= */
507 INPUT_SET_BYTE_SIZE, /* arg1= int64_t * res= */
510 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
511 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
512 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
513 INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
514 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
515 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
518 INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int* res=can fail */
519 INPUT_GET_ATTACHMENT, /* arg1=input_attachment_t**, arg2=char* res=can fail */
521 /* On the fly input slave */
522 INPUT_ADD_SLAVE /* arg1= char * */
525 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
526 VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) );
528 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
529 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
530 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
532 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );