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
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 input_ItemInit( 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;
110 vlc_mutex_init( p_o, &p_i->lock );
113 static inline void input_ItemCopyOptions( input_item_t *p_parent,
114 input_item_t *p_child )
117 for( i = 0 ; i< p_parent->i_options; i++ )
119 char *psz_option= strdup( p_parent->ppsz_options[i] );
120 p_child->i_options++;
121 p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
124 p_child->ppsz_options[p_child->i_options-1] = psz_option;
128 VLC_EXPORT( void, input_ItemAddOption,( input_item_t *, const char * ) );
129 VLC_EXPORT( void, input_ItemAddOptionNoDup,( input_item_t *, const char * ) );
131 static inline void input_ItemClean( input_item_t *p_i )
133 free( p_i->psz_name );
134 free( p_i->psz_uri );
137 vlc_mutex_destroy( &p_i->p_stats->lock );
138 free( p_i->p_stats );
141 if( p_i->p_meta ) vlc_meta_Delete( p_i->p_meta );
143 while( p_i->i_options )
146 if( p_i->ppsz_options[p_i->i_options] )
147 free( p_i->ppsz_options[p_i->i_options] );
148 if( !p_i->i_options ) free( p_i->ppsz_options );
154 es_format_Clean( p_i->es[p_i->i_es] );
155 if( !p_i->i_es ) free( p_i->es );
158 while( p_i->i_categories )
160 info_category_t *p_category =
161 p_i->pp_categories[--(p_i->i_categories)];
163 while( p_category->i_infos )
165 p_category->i_infos--;
167 if( p_category->pp_infos[p_category->i_infos]->psz_name )
168 free( p_category->pp_infos[p_category->i_infos]->psz_name);
169 if( p_category->pp_infos[p_category->i_infos]->psz_value )
170 free( p_category->pp_infos[p_category->i_infos]->psz_value );
171 free( p_category->pp_infos[p_category->i_infos] );
173 if( !p_category->i_infos ) free( p_category->pp_infos );
176 if( p_category->psz_name ) free( p_category->psz_name );
179 if( !p_i->i_categories ) free( p_i->pp_categories );
182 vlc_mutex_destroy( &p_i->lock );
185 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
186 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
188 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
189 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
190 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, int) );
191 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, int, int ) );
193 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
195 /*****************************************************************************
196 * Seek point: (generalisation of chapters)
197 *****************************************************************************/
200 int64_t i_byte_offset;
201 int64_t i_time_offset;
206 static inline seekpoint_t *vlc_seekpoint_New( void )
208 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
209 point->i_byte_offset =
210 point->i_time_offset = -1;
212 point->psz_name = NULL;
216 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
219 if( point->psz_name ) free( point->psz_name );
223 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
225 seekpoint_t *point = vlc_seekpoint_New();
226 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
227 point->i_time_offset = src->i_time_offset;
228 point->i_byte_offset = src->i_byte_offset;
232 /*****************************************************************************
234 *****************************************************************************/
239 vlc_bool_t b_menu; /* Is it a menu or a normal entry */
241 int64_t i_length; /* Length(microsecond) if known, else 0 */
242 int64_t i_size; /* Size (bytes) if known, else 0 */
244 /* Title seekpoint */
246 seekpoint_t **seekpoint;
250 static inline input_title_t *vlc_input_title_New(void)
252 input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
255 t->b_menu = VLC_FALSE;
264 static inline void vlc_input_title_Delete( input_title_t *t )
270 if( t->psz_name ) free( t->psz_name );
271 for( i = 0; i < t->i_seekpoint; i++ )
273 if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
274 free( t->seekpoint[i] );
276 if( t->seekpoint ) free( t->seekpoint );
280 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
282 input_title_t *dup = vlc_input_title_New( );
285 if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
286 dup->b_menu = t->b_menu;
287 dup->i_length = t->i_length;
288 dup->i_size = t->i_size;
289 dup->i_seekpoint = t->i_seekpoint;
290 if( t->i_seekpoint > 0 )
292 dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
293 sizeof(seekpoint_t*) );
295 for( i = 0; i < t->i_seekpoint; i++ )
297 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
304 /*****************************************************************************
305 * input defines/constants.
306 *****************************************************************************/
320 /* "rate" default, min/max
321 * A rate below 1000 plays the movie faster,
322 * A rate above 1000 plays the movie slower.
324 #define INPUT_RATE_DEFAULT 1000
325 #define INPUT_RATE_MIN 125 /* Up to 8/1 */
326 #define INPUT_RATE_MAX 8000 /* Up to 1/8 */
328 /* i_update field of access_t/demux_t */
329 #define INPUT_UPDATE_NONE 0x0000
330 #define INPUT_UPDATE_SIZE 0x0001
331 #define INPUT_UPDATE_TITLE 0x0010
332 #define INPUT_UPDATE_SEEKPOINT 0x0020
333 #define INPUT_UPDATE_META 0x0040
335 /* Input control XXX: internal */
336 #define INPUT_CONTROL_FIFO_SIZE 100
338 /** Get the input item for an input thread */
339 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
341 typedef struct input_thread_private_t input_thread_private_t;
344 * Main structure representing an input thread. This structure is mostly
345 * private. The only public fields are READ-ONLY. You must use the helpers
348 struct input_thread_t
353 vlc_bool_t b_preparsing;
355 int64_t i_time; /* Current time */
356 /* Internal caching common to all inputs */
359 /* All other data is input_thread is PRIVATE. You can't access it
360 * outside of src/input */
361 input_thread_private_t *p;
364 /*****************************************************************************
366 *****************************************************************************/
367 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
368 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
369 #define input_CreateThread2(a,b,c) __input_CreateThread2(VLC_OBJECT(a),b,c)
370 VLC_EXPORT( input_thread_t *, __input_CreateThread2, ( vlc_object_t *, input_item_t *, char * ) );
371 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
372 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
374 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
375 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
376 VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) );
377 VLC_EXPORT( void, input_DestroyThread, ( input_thread_t * ) );
381 /* input variable "position" */
382 INPUT_GET_POSITION, /* arg1= double * res= */
383 INPUT_SET_POSITION, /* arg1= double res=can fail */
385 /* input variable "length" */
386 INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
388 /* input variable "time" */
389 INPUT_GET_TIME, /* arg1= int64_t * res= */
390 INPUT_SET_TIME, /* arg1= int64_t res=can fail */
392 /* input variable "rate" (1 is DEFAULT_RATE) */
393 INPUT_GET_RATE, /* arg1= int * res= */
394 INPUT_SET_RATE, /* arg1= int res=can fail */
396 /* input variable "state" */
397 INPUT_GET_STATE, /* arg1= int * res= */
398 INPUT_SET_STATE, /* arg1= int res=can fail */
400 /* input variable "audio-delay" and "sub-delay" */
401 INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
402 INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
403 INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
404 INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
407 INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
408 INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
409 INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
410 INPUT_SET_NAME, /* arg1= char* res=can fail */
412 /* Input config options */
413 INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/
415 /* Input properties */
416 INPUT_GET_BYTE_POSITION, /* arg1= int64_t * res= */
417 INPUT_SET_BYTE_SIZE, /* arg1= int64_t * res= */
420 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
421 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
422 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
423 INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
424 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
425 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
427 /* On the fly input slave */
428 INPUT_ADD_SLAVE /* arg1= char * */
431 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
432 VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) );
434 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
435 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
436 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
438 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );