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 #include <vlc_playlist.h>
34 /*****************************************************************************
35 * input_item_t: Describes an input and is used to spawn input_thread_t objects
36 *****************************************************************************/
39 char *psz_name; /**< Name of this info */
40 char *psz_value; /**< Value of the info */
43 struct info_category_t
45 char *psz_name; /**< Name of this category */
46 int i_infos; /**< Number of infos in the category */
47 struct info_t **pp_infos; /**< Pointer to an array of infos */
53 int i_id; /**< Identifier of the item */
55 char *psz_name; /**< text describing this item */
56 char *psz_uri; /**< mrl of this item */
57 vlc_bool_t b_fixed_name; /**< Can the interface change the name ?*/
59 int i_options; /**< Number of input options */
60 char **ppsz_options; /**< Array of input options */
62 mtime_t i_duration; /**< Duration in milliseconds*/
64 uint8_t i_type; /**< Type (file, disc, ...) */
65 vlc_bool_t b_prefers_tree; /**< Do we prefer being displayed as tree*/
67 int i_categories; /**< Number of info categories */
68 info_category_t **pp_categories; /**< Pointer to the first info category */
70 int i_es; /**< Number of es format descriptions */
71 es_format_t **es; /**< Es formats */
73 input_stats_t *p_stats; /**< Statistics */
74 int i_nb_played; /**< Number of times played */
78 vlc_mutex_t lock; /**< Lock for the item */
81 #define ITEM_TYPE_UNKNOWN 0
82 #define ITEM_TYPE_AFILE 1
83 #define ITEM_TYPE_VFILE 2
84 #define ITEM_TYPE_DIRECTORY 3
85 #define ITEM_TYPE_DISC 4
86 #define ITEM_TYPE_CDDA 5
87 #define ITEM_TYPE_CARD 6
88 #define ITEM_TYPE_NET 7
89 #define ITEM_TYPE_PLAYLIST 8
90 #define ITEM_TYPE_NODE 9
91 #define ITEM_TYPE_NUMBER 10
93 static inline void vlc_input_item_Init( vlc_object_t *p_o, input_item_t *p_i )
95 memset( p_i, 0, sizeof(input_item_t) );
101 p_i->ppsz_options = 0;
102 p_i->i_categories = 0 ;
103 p_i->pp_categories = 0;
104 p_i->i_type = ITEM_TYPE_UNKNOWN;
105 p_i->b_fixed_name = VLC_TRUE;
107 p_i->p_stats = (input_stats_t*) malloc( sizeof( input_stats_t ) );
109 vlc_mutex_init( p_o, &p_i->p_stats->lock );
111 vlc_mutex_init( p_o, &p_i->lock );
114 static inline void vlc_input_item_CopyOptions( input_item_t *p_parent,
115 input_item_t *p_child )
118 for( i = 0 ; i< p_parent->i_options; i++ )
120 char *psz_option= strdup( p_parent->ppsz_options[i] );
121 p_child->i_options++;
122 p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
125 p_child->ppsz_options[p_child->i_options-1] = psz_option;
129 VLC_EXPORT( void, vlc_input_item_AddOption, ( input_item_t *p_input, const char *psz_option ) );
131 static inline void vlc_input_item_Clean( input_item_t *p_i )
133 if( p_i->psz_name ) free( p_i->psz_name );
134 if( p_i->psz_uri ) free( p_i->psz_uri );
135 if( p_i->p_stats ) free( p_i->p_stats );
139 if( p_i->p_meta ) vlc_meta_Delete( p_i->p_meta );
141 while( p_i->i_options )
144 if( p_i->ppsz_options[p_i->i_options] )
145 free( p_i->ppsz_options[p_i->i_options] );
146 if( !p_i->i_options ) free( p_i->ppsz_options );
152 es_format_Clean( p_i->es[p_i->i_es] );
153 if( !p_i->i_es ) free( p_i->es );
156 while( p_i->i_categories )
158 info_category_t *p_category =
159 p_i->pp_categories[--(p_i->i_categories)];
161 while( p_category->i_infos )
163 p_category->i_infos--;
165 if( p_category->pp_infos[p_category->i_infos]->psz_name )
166 free( p_category->pp_infos[p_category->i_infos]->psz_name);
167 if( p_category->pp_infos[p_category->i_infos]->psz_value )
168 free( p_category->pp_infos[p_category->i_infos]->psz_value );
169 free( p_category->pp_infos[p_category->i_infos] );
171 if( !p_category->i_infos ) free( p_category->pp_infos );
174 if( p_category->psz_name ) free( p_category->psz_name );
177 if( !p_i->i_categories ) free( p_i->pp_categories );
180 vlc_mutex_destroy( &p_i->lock );
183 VLC_EXPORT( char *, vlc_input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
184 VLC_EXPORT(int, vlc_input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
186 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
187 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
188 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char **, int) );
189 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char **, int, int ) );
191 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
194 /*****************************************************************************
195 * Seek point: (generalisation of chapters)
196 *****************************************************************************/
199 int64_t i_byte_offset;
200 int64_t i_time_offset;
205 static inline seekpoint_t *vlc_seekpoint_New( void )
207 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
208 point->i_byte_offset =
209 point->i_time_offset = -1;
211 point->psz_name = NULL;
215 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
218 if( point->psz_name ) free( point->psz_name );
222 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
224 seekpoint_t *point = vlc_seekpoint_New();
225 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
226 point->i_time_offset = src->i_time_offset;
227 point->i_byte_offset = src->i_byte_offset;
231 /*****************************************************************************
233 *****************************************************************************/
238 vlc_bool_t b_menu; /* Is it a menu or a normal entry */
240 int64_t i_length; /* Length(microsecond) if known, else 0 */
241 int64_t i_size; /* Size (bytes) if known, else 0 */
243 /* Title seekpoint */
245 seekpoint_t **seekpoint;
249 static inline input_title_t *vlc_input_title_New( )
251 input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
254 t->b_menu = VLC_FALSE;
263 static inline void vlc_input_title_Delete( input_title_t *t )
269 if( t->psz_name ) free( t->psz_name );
270 for( i = 0; i < t->i_seekpoint; i++ )
272 if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
273 free( t->seekpoint[i] );
275 if( t->seekpoint ) free( t->seekpoint );
279 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
281 input_title_t *dup = vlc_input_title_New( );
284 if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
285 dup->b_menu = t->b_menu;
286 dup->i_length = t->i_length;
287 dup->i_size = t->i_size;
288 dup->i_seekpoint = t->i_seekpoint;
289 if( t->i_seekpoint > 0 )
291 dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
292 sizeof(seekpoint_t*) );
294 for( i = 0; i < t->i_seekpoint; i++ )
296 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
303 /*****************************************************************************
304 * input defines/constants.
305 *****************************************************************************/
318 /* "rate" default, min/max
319 * A rate below 1000 plays the movie faster,
320 * A rate above 1000 plays the movie slower.
322 #define INPUT_RATE_DEFAULT 1000
323 #define INPUT_RATE_MIN 125 /* Up to 8/1 */
324 #define INPUT_RATE_MAX 8000 /* Up to 1/8 */
326 /* input_source_t: gathers all information per input source */
329 /* Input item description */
330 input_item_t *p_item;
332 /* Access/Stream/Demux plugins */
337 /* Title infos for that input */
338 vlc_bool_t b_title_demux; /* Titles/Seekpoints provided by demux */
340 input_title_t **title;
343 int i_seekpoint_offset;
347 int i_seekpoint_start;
351 vlc_bool_t b_can_pace_control;
352 vlc_bool_t b_can_pause;
353 vlc_bool_t b_eof; /* eof of demuxer */
355 /* Clock average variation */
360 /* i_update field of access_t/demux_t */
361 #define INPUT_UPDATE_NONE 0x0000
362 #define INPUT_UPDATE_SIZE 0x0001
363 #define INPUT_UPDATE_TITLE 0x0010
364 #define INPUT_UPDATE_SEEKPOINT 0x0020
365 #define INPUT_UPDATE_META 0x0040
367 /* Input control XXX: internal */
368 #define INPUT_CONTROL_FIFO_SIZE 100
370 /*****************************************************************************
372 *****************************************************************************
373 * XXX: this strucrures is *PRIVATE* so nobody can touch it out of src/input.
374 * I plan to move it to src/input/input_internal.h anyway
376 * XXX: look at src/input/input.c:input_CreateThread for accessible variables
377 * YOU CANNOT HAVE ACCESS TO THE CONTENT OF input_thread_t except
378 * p_input->input.p_item (and it's only temporary).
379 * XXX: move the docs somewhere (better than src/input )
380 *****************************************************************************/
381 struct input_thread_t
385 /* Global properties */
387 vlc_bool_t b_can_pace_control;
388 vlc_bool_t b_can_pause;
395 int64_t i_start; /* :start-time,0 by default */
396 int64_t i_time; /* Current time */
397 int64_t i_stop; /* :stop-time, 0 if none */
399 /* Title infos FIXME multi-input (not easy) ? */
401 input_title_t **title;
404 int i_seekpoint_offset;
406 /* User bookmarks FIXME won't be easy with multiples input */
408 seekpoint_t **bookmark;
410 /* Global meta datas FIXME move to input_item_t ? */
415 sout_instance_t *p_sout; /* XXX Move it to es_out ? */
416 vlc_bool_t b_out_pace_control; /* idem ? */
418 /* Internal caching common for all inputs */
421 /* Main input properties */
422 input_source_t input;
424 /* Slave demuxers (subs, and others) */
426 input_source_t **slave;
430 counter_t *p_read_packets;
431 counter_t *p_read_bytes;
432 counter_t *p_input_bitrate;
433 counter_t *p_demux_read;
434 counter_t *p_demux_bitrate;
435 counter_t *p_decoded_audio;
436 counter_t *p_decoded_video;
437 counter_t *p_decoded_sub;
438 counter_t *p_sout_sent_packets;
439 counter_t *p_sout_sent_bytes;
440 counter_t *p_sout_send_bitrate;
441 counter_t *p_played_abuffers;
442 counter_t *p_lost_abuffers;
443 counter_t *p_displayed_pictures;
444 counter_t *p_lost_pictures;
445 vlc_mutex_t counters_lock;
448 /* Buffer of pending actions */
449 vlc_mutex_t lock_control;
453 /* XXX: val isn't duplicated so it won't works with string */
456 } control[INPUT_CONTROL_FIFO_SIZE];
459 /*****************************************************************************
461 *****************************************************************************/
462 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
463 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
464 #define input_CreateThread2(a,b,c) __input_CreateThread2(VLC_OBJECT(a),b,c)
465 VLC_EXPORT( input_thread_t *, __input_CreateThread2, ( vlc_object_t *, input_item_t *, char * ) );
466 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
467 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
469 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
470 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
471 VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) );
472 VLC_EXPORT( void, input_DestroyThread, ( 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= */
515 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
516 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
517 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
518 INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
519 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
520 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
522 /* On the fly input slave */
523 INPUT_ADD_SLAVE /* arg1= char * */
526 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
527 VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) );
529 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
530 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
531 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
533 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );