1 /*****************************************************************************
2 * vlc_input.h: Core input structures
3 *****************************************************************************
4 * Copyright (C) 1999-2004 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
29 /*****************************************************************************
30 * input_item_t: Describes an input and is used to spawn input_thread_t objects
31 *****************************************************************************/
34 char *psz_name; /**< Name of this info */
35 char *psz_value; /**< Value of the info */
38 struct info_category_t
40 char *psz_name; /**< Name of this category */
41 int i_infos; /**< Number of infos in the category */
42 struct info_t **pp_infos; /**< Pointer to an array of infos */
47 char *psz_name; /**< text describing this item */
48 char *psz_uri; /**< mrl of this item */
50 int i_options; /**< Number of input options */
51 char **ppsz_options; /**< Array of input options */
53 mtime_t i_duration; /**< A hint about the duration of this
54 * item, in milliseconds*/
56 int i_id; /**< Identifier of the item */
57 uint8_t i_type; /**< Type (file, disc, ...) */
59 int i_categories; /**< Number of info categories */
60 info_category_t **pp_categories; /**< Pointer to the first info category */
62 int i_es; /**< Number of es format descriptions */
63 es_format_t **es; /**< Pointer to an array of es formats */
65 vlc_bool_t b_fixed_name; /**< Can the interface change the name ?*/
67 input_stats_t *p_stats; /**< Statistics */
69 vlc_mutex_t lock; /**< Item cannot be changed without this lock */
72 #define ITEM_TYPE_UNKNOWN 0
73 #define ITEM_TYPE_AFILE 1
74 #define ITEM_TYPE_VFILE 2
75 #define ITEM_TYPE_DIRECTORY 3
76 #define ITEM_TYPE_DISC 4
77 #define ITEM_TYPE_CDDA 5
78 #define ITEM_TYPE_CARD 6
79 #define ITEM_TYPE_NET 7
80 #define ITEM_TYPE_PLAYLIST 8
81 #define ITEM_TYPE_NODE 9
83 static inline void vlc_input_item_Init( vlc_object_t *p_o, input_item_t *p_i )
85 memset( p_i, 0, sizeof(input_item_t) );
88 p_i->i_categories = 0 ;
91 p_i->ppsz_options = 0;
92 p_i->pp_categories = 0;
94 p_i->i_type = ITEM_TYPE_UNKNOWN;
95 p_i->b_fixed_name = VLC_TRUE;
97 p_i->p_stats = (input_stats_t*) malloc( sizeof( input_stats_t ) );
98 vlc_mutex_init( p_o, &p_i->p_stats->lock );
100 vlc_mutex_init( p_o, &p_i->lock );
103 static inline void vlc_input_item_CopyOptions( input_item_t *p_parent,
104 input_item_t *p_child )
107 for( i = 0 ; i< p_parent->i_options; i++ )
109 char *psz_option= strdup( p_parent->ppsz_options[i] );
110 p_child->i_options++;
111 p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
114 p_child->ppsz_options[p_child->i_options-1] = psz_option;
118 static inline void vlc_input_item_Clean( input_item_t *p_i )
120 if( p_i->psz_name ) free( p_i->psz_name );
121 if( p_i->psz_uri ) free( p_i->psz_uri );
122 if( p_i->p_stats ) free( p_i->p_stats );
126 while( p_i->i_options )
129 if( p_i->ppsz_options[p_i->i_options] )
130 free( p_i->ppsz_options[p_i->i_options] );
131 if( !p_i->i_options ) free( p_i->ppsz_options );
137 es_format_Clean( p_i->es[p_i->i_es] );
138 if( !p_i->i_es ) free( p_i->es );
141 while( p_i->i_categories )
143 info_category_t *p_category =
144 p_i->pp_categories[--(p_i->i_categories)];
146 while( p_category->i_infos )
148 p_category->i_infos--;
150 if( p_category->pp_infos[p_category->i_infos]->psz_name )
151 free( p_category->pp_infos[p_category->i_infos]->psz_name);
152 if( p_category->pp_infos[p_category->i_infos]->psz_value )
153 free( p_category->pp_infos[p_category->i_infos]->psz_value );
154 free( p_category->pp_infos[p_category->i_infos] );
156 if( !p_category->i_infos ) free( p_category->pp_infos );
159 if( p_category->psz_name ) free( p_category->psz_name );
162 if( !p_i->i_categories ) free( p_i->pp_categories );
165 vlc_mutex_destroy( &p_i->lock );
168 VLC_EXPORT( char *, vlc_input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
169 VLC_EXPORT(int, vlc_input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
171 /*****************************************************************************
172 * Seek point: (generalisation of chapters)
173 *****************************************************************************/
176 int64_t i_byte_offset;
177 int64_t i_time_offset;
182 static inline seekpoint_t *vlc_seekpoint_New( void )
184 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
185 point->i_byte_offset =
186 point->i_time_offset = -1;
188 point->psz_name = NULL;
192 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
195 if( point->psz_name ) free( point->psz_name );
199 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
201 seekpoint_t *point = vlc_seekpoint_New();
202 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
203 point->i_time_offset = src->i_time_offset;
204 point->i_byte_offset = src->i_byte_offset;
208 /*****************************************************************************
210 *****************************************************************************/
215 vlc_bool_t b_menu; /* Is it a menu or a normal entry */
217 int64_t i_length; /* Length(microsecond) if known, else 0 */
218 int64_t i_size; /* Size (bytes) if known, else 0 */
220 /* Title seekpoint */
222 seekpoint_t **seekpoint;
226 static inline input_title_t *vlc_input_title_New( )
228 input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
231 t->b_menu = VLC_FALSE;
240 static inline void vlc_input_title_Delete( input_title_t *t )
246 if( t->psz_name ) free( t->psz_name );
247 for( i = 0; i < t->i_seekpoint; i++ )
249 if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
250 free( t->seekpoint[i] );
252 if( t->seekpoint ) free( t->seekpoint );
256 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
258 input_title_t *dup = vlc_input_title_New( );
261 if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
262 dup->b_menu = t->b_menu;
263 dup->i_length = t->i_length;
264 dup->i_size = t->i_size;
265 dup->i_seekpoint = t->i_seekpoint;
266 if( t->i_seekpoint > 0 )
268 dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
269 sizeof(seekpoint_t*) );
271 for( i = 0; i < t->i_seekpoint; i++ )
273 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
280 /*****************************************************************************
281 * input defines/constants.
282 *****************************************************************************/
293 /* "rate" default, min/max
294 * A rate below 1000 plays the movie faster,
295 * A rate above 1000 plays the movie slower.
297 #define INPUT_RATE_DEFAULT 1000
298 #define INPUT_RATE_MIN 125 /* Up to 8/1 */
299 #define INPUT_RATE_MAX 8000 /* Up to 1/8 */
301 /* input_source_t: gathers all information per input source */
304 /* Input item description */
305 input_item_t *p_item;
307 /* Access/Stream/Demux plugins */
312 /* Title infos for that input */
313 vlc_bool_t b_title_demux; /* Titles/Seekpoints provided by demux */
315 input_title_t **title;
318 int i_seekpoint_offset;
322 int i_seekpoint_start;
326 vlc_bool_t b_can_pace_control;
327 vlc_bool_t b_can_pause;
328 vlc_bool_t b_eof; /* eof of demuxer */
330 /* Clock average variation */
335 /* i_update field of access_t/demux_t */
336 #define INPUT_UPDATE_NONE 0x0000
337 #define INPUT_UPDATE_SIZE 0x0001
338 #define INPUT_UPDATE_TITLE 0x0010
339 #define INPUT_UPDATE_SEEKPOINT 0x0020
340 #define INPUT_UPDATE_META 0x0040
342 /* Input control XXX: internal */
343 #define INPUT_CONTROL_FIFO_SIZE 100
345 /*****************************************************************************
347 *****************************************************************************
348 * XXX: this strucrures is *PRIVATE* so nobody can touch it out of src/input.
349 * I plan to move it to src/input/input_internal.h anyway
351 * XXX: look at src/input/input.c:input_CreateThread for accessible variables
352 * YOU CANNOT HAVE ACCESS TO THE CONTENT OF input_thread_t except
353 * p_input->input.p_item (and it's only temporary).
354 * XXX: move the docs somewhere (better than src/input )
355 *****************************************************************************/
356 struct input_thread_t
360 /* Global properties */
362 vlc_bool_t b_can_pace_control;
363 vlc_bool_t b_can_pause;
370 int64_t i_start; /* :start-time,0 by default */
371 int64_t i_time; /* Current time */
372 int64_t i_stop; /* :stop-time, 0 if none */
374 /* Title infos FIXME multi-input (not easy) ? */
376 input_title_t **title;
379 int i_seekpoint_offset;
381 /* User bookmarks FIXME won't be easy with multiples input */
383 seekpoint_t **bookmark;
385 /* Global meta datas FIXME move to input_item_t ? */
390 sout_instance_t *p_sout; /* XXX Move it to es_out ? */
391 vlc_bool_t b_out_pace_control; /* idem ? */
393 /* Internal caching common for all inputs */
396 /* Main input properties */
397 input_source_t input;
399 /* Slave demuxers (subs, and others) */
401 input_source_t **slave;
403 /* Buffer of pending actions */
404 vlc_mutex_t lock_control;
408 /* XXX: val isn't duplicated so it won't works with string */
411 } control[INPUT_CONTROL_FIFO_SIZE];
414 /*****************************************************************************
416 *****************************************************************************/
417 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
418 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
419 #define input_CreateThread2(a,b,c) __input_CreateThread2(VLC_OBJECT(a),b,c)
420 VLC_EXPORT( input_thread_t *, __input_CreateThread2, ( vlc_object_t *, input_item_t *, char * ) );
421 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
422 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
424 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
425 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
426 VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) );
427 VLC_EXPORT( void, input_DestroyThread, ( input_thread_t * ) );
431 /* input variable "position" */
432 INPUT_GET_POSITION, /* arg1= double * res= */
433 INPUT_SET_POSITION, /* arg1= double res=can fail */
435 /* input variable "length" */
436 INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
438 /* input variable "time" */
439 INPUT_GET_TIME, /* arg1= int64_t * res= */
440 INPUT_SET_TIME, /* arg1= int64_t res=can fail */
442 /* input variable "rate" (1 is DEFAULT_RATE) */
443 INPUT_GET_RATE, /* arg1= int * res= */
444 INPUT_SET_RATE, /* arg1= int res=can fail */
446 /* input variable "state" */
447 INPUT_GET_STATE, /* arg1= int * res= */
448 INPUT_SET_STATE, /* arg1= int res=can fail */
450 /* input variable "audio-delay" and "sub-delay" */
451 INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
452 INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
453 INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
454 INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
457 INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
458 INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
459 INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
460 INPUT_SET_NAME, /* arg1= char* res=can fail */
462 /* Input config options */
463 INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/
465 /* Input properties */
466 INPUT_GET_BYTE_POSITION, /* arg1= int64_t * res= */
467 INPUT_SET_BYTE_SIZE, /* arg1= int64_t * res= */
470 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
471 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
472 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
473 INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
474 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
475 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
477 /* On the fly input slave */
478 INPUT_ADD_SLAVE /* arg1= char * */
481 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
482 VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) );
484 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
485 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
486 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );