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 /*****************************************************************************
199 * Seek point: (generalisation of chapters)
200 *****************************************************************************/
203 int64_t i_byte_offset;
204 int64_t i_time_offset;
209 static inline seekpoint_t *vlc_seekpoint_New( void )
211 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
212 point->i_byte_offset =
213 point->i_time_offset = -1;
215 point->psz_name = NULL;
219 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
222 if( point->psz_name ) free( point->psz_name );
226 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
228 seekpoint_t *point = vlc_seekpoint_New();
229 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
230 point->i_time_offset = src->i_time_offset;
231 point->i_byte_offset = src->i_byte_offset;
235 /*****************************************************************************
237 *****************************************************************************/
242 vlc_bool_t b_menu; /* Is it a menu or a normal entry */
244 int64_t i_length; /* Length(microsecond) if known, else 0 */
245 int64_t i_size; /* Size (bytes) if known, else 0 */
247 /* Title seekpoint */
249 seekpoint_t **seekpoint;
253 static inline input_title_t *vlc_input_title_New(void)
255 input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
258 t->b_menu = VLC_FALSE;
267 static inline void vlc_input_title_Delete( input_title_t *t )
273 if( t->psz_name ) free( t->psz_name );
274 for( i = 0; i < t->i_seekpoint; i++ )
276 if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
277 free( t->seekpoint[i] );
279 if( t->seekpoint ) free( t->seekpoint );
283 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
285 input_title_t *dup = vlc_input_title_New( );
288 if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
289 dup->b_menu = t->b_menu;
290 dup->i_length = t->i_length;
291 dup->i_size = t->i_size;
292 dup->i_seekpoint = t->i_seekpoint;
293 if( t->i_seekpoint > 0 )
295 dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
296 sizeof(seekpoint_t*) );
298 for( i = 0; i < t->i_seekpoint; i++ )
300 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
307 /*****************************************************************************
308 * input defines/constants.
309 *****************************************************************************/
323 /* "rate" default, min/max
324 * A rate below 1000 plays the movie faster,
325 * A rate above 1000 plays the movie slower.
327 #define INPUT_RATE_DEFAULT 1000
328 #define INPUT_RATE_MIN 125 /* Up to 8/1 */
329 #define INPUT_RATE_MAX 32000 /* Up to 1/32 */
331 /* i_update field of access_t/demux_t */
332 #define INPUT_UPDATE_NONE 0x0000
333 #define INPUT_UPDATE_SIZE 0x0001
334 #define INPUT_UPDATE_TITLE 0x0010
335 #define INPUT_UPDATE_SEEKPOINT 0x0020
336 #define INPUT_UPDATE_META 0x0040
338 /* Input control XXX: internal */
339 #define INPUT_CONTROL_FIFO_SIZE 100
341 /** Get the input item for an input thread */
342 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
344 typedef struct input_thread_private_t input_thread_private_t;
347 * Main structure representing an input thread. This structure is mostly
348 * private. The only public fields are READ-ONLY. You must use the helpers
351 struct input_thread_t
356 vlc_bool_t b_preparsing;
359 vlc_bool_t b_can_pace_control;
360 int64_t i_time; /* Current time */
362 /* Internal caching common to all inputs */
365 /* All other data is input_thread is PRIVATE. You can't access it
366 * outside of src/input */
367 input_thread_private_t *p;
370 /*****************************************************************************
372 *****************************************************************************/
373 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
374 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
375 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
376 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
378 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
379 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
380 VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) );
381 VLC_EXPORT( void, input_DestroyThread, ( input_thread_t * ) );
385 /* input variable "position" */
386 INPUT_GET_POSITION, /* arg1= double * res= */
387 INPUT_SET_POSITION, /* arg1= double res=can fail */
389 /* input variable "length" */
390 INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
392 /* input variable "time" */
393 INPUT_GET_TIME, /* arg1= int64_t * res= */
394 INPUT_SET_TIME, /* arg1= int64_t res=can fail */
396 /* input variable "rate" (1 is DEFAULT_RATE) */
397 INPUT_GET_RATE, /* arg1= int * res= */
398 INPUT_SET_RATE, /* arg1= int res=can fail */
400 /* input variable "state" */
401 INPUT_GET_STATE, /* arg1= int * res= */
402 INPUT_SET_STATE, /* arg1= int res=can fail */
404 /* input variable "audio-delay" and "sub-delay" */
405 INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
406 INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
407 INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
408 INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
411 INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
412 INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
413 INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
414 INPUT_SET_NAME, /* arg1= char* res=can fail */
416 /* Input config options */
417 INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/
419 /* Input properties */
420 INPUT_GET_BYTE_POSITION, /* arg1= int64_t * res= */
421 INPUT_SET_BYTE_SIZE, /* arg1= int64_t * res= */
424 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
425 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
426 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
427 INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
428 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
429 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
431 /* On the fly input slave */
432 INPUT_ADD_SLAVE /* arg1= char * */
435 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
436 VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) );
438 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
439 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
440 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
442 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );