1 /*****************************************************************************
2 * vlc_input.h: Core input structures
3 *****************************************************************************
4 * Copyright (C) 1999-2006 VLC authors and VideoLAN
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 it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /* __ is need because conflict with <vlc/input.h> */
31 * This file defines functions, structures and enums for input objects in vlc
37 #include <vlc_events.h>
38 #include <vlc_input_item.h>
42 /*****************************************************************************
43 * Seek point: (generalisation of chapters)
44 *****************************************************************************/
47 int64_t i_byte_offset;
48 int64_t i_time_offset;
52 static inline seekpoint_t *vlc_seekpoint_New( void )
54 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
55 point->i_byte_offset =
56 point->i_time_offset = -1;
57 point->psz_name = NULL;
61 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
64 free( point->psz_name );
68 static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src )
70 seekpoint_t *point = vlc_seekpoint_New();
71 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
72 point->i_time_offset = src->i_time_offset;
73 point->i_byte_offset = src->i_byte_offset;
77 /*****************************************************************************
79 *****************************************************************************/
84 bool b_menu; /* Is it a menu or a normal entry */
86 int64_t i_length; /* Length(microsecond) if known, else 0 */
87 int64_t i_size; /* Size (bytes) if known, else 0 */
91 seekpoint_t **seekpoint;
95 static inline input_title_t *vlc_input_title_New(void)
97 input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
109 static inline void vlc_input_title_Delete( input_title_t *t )
116 for( i = 0; i < t->i_seekpoint; i++ )
118 free( t->seekpoint[i]->psz_name );
119 free( t->seekpoint[i] );
121 free( t->seekpoint );
125 static inline input_title_t *vlc_input_title_Duplicate( const input_title_t *t )
127 input_title_t *dup = vlc_input_title_New( );
130 if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
131 dup->b_menu = t->b_menu;
132 dup->i_length = t->i_length;
133 dup->i_size = t->i_size;
134 dup->i_seekpoint = t->i_seekpoint;
135 if( t->i_seekpoint > 0 )
137 dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
138 sizeof(seekpoint_t*) );
140 for( i = 0; i < t->i_seekpoint; i++ )
142 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
149 /*****************************************************************************
151 *****************************************************************************/
152 struct input_attachment_t
156 char *psz_description;
162 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
163 const char *psz_mime,
164 const char *psz_description,
168 input_attachment_t *a =
169 (input_attachment_t*)malloc( sizeof(input_attachment_t) );
172 a->psz_name = strdup( psz_name ? psz_name : "" );
173 a->psz_mime = strdup( psz_mime ? psz_mime : "" );
174 a->psz_description = strdup( psz_description ? psz_description : "" );
179 a->p_data = malloc( i_data );
180 if( a->p_data && p_data )
181 memcpy( a->p_data, p_data, i_data );
185 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
187 return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
188 a->p_data, a->i_data );
190 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
196 free( a->psz_description );
201 /*****************************************************************************
202 * input defines/constants.
203 *****************************************************************************/
205 /* i_update field of access_t/demux_t */
206 #define INPUT_UPDATE_TITLE 0x0010
207 #define INPUT_UPDATE_SEEKPOINT 0x0020
208 #define INPUT_UPDATE_META 0x0040
209 #define INPUT_UPDATE_TITLE_LIST 0x0100
212 * This defines private core storage for an input.
214 typedef struct input_thread_private_t input_thread_private_t;
217 * This defines an opaque input resource handler.
219 typedef struct input_resource_t input_resource_t;
222 * Main structure representing an input thread. This structure is mostly
223 * private. The only public fields are READ-ONLY. You must use the helpers
226 struct input_thread_t
235 /* All other data is input_thread is PRIVATE. You can't access it
236 * outside of src/input */
237 input_thread_private_t *p;
241 * Record prefix string.
242 * TODO make it configurable.
244 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
246 /*****************************************************************************
247 * Input events and variables
248 *****************************************************************************/
251 * \defgroup inputvariable Input variables
253 * The input provides multiples variable you can write to and/or read from.
255 * TODO complete the documentation.
256 * The read only variables are:
258 * - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
259 * or not, for that check position != 0.0)
263 * - "can-record" (if a stream can be recorded while playing)
264 * - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
265 * variable value being the one currently selected, -1 if no teletext)
267 * - "signal-strength"
268 * - "program-scrambled" (if the current program is scrambled)
269 * - "cache" (level of data cached [0 .. 1])
271 * The read-write variables are:
272 * - state (\see input_state_e)
274 * - position, position-offset
275 * - time, time-offset
276 * - title, next-title, prev-title
277 * - chapter, next-chapter, next-chapter-prev
278 * - program, audio-es, video-es, spu-es
279 * - audio-delay, spu-delay
280 * - bookmark (bookmark list)
283 * - navigation (list of "title %2i")
286 * The variable used for event is
287 * - intf-event (\see input_event_type_e)
293 * This enum is used by the variable "state"
295 typedef enum input_state_e
308 * It is an float used by the variable "rate" in the
309 * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
310 * the default value being 1. It represents the ratio of playback speed to
311 * nominal speed (bigger is faster).
313 * Internally, the rate is stored as a value in the range
314 * [INPUT_RATE_MIN, INPUT_RATE_MAX].
315 * internal rate = INPUT_RATE_DEFAULT / rate variable
321 #define INPUT_RATE_DEFAULT 1000
325 #define INPUT_RATE_MIN 32 /* Up to 32/1 */
329 #define INPUT_RATE_MAX 32000 /* Up to 1/32 */
334 * You can catch input event by adding a callback on the variable "intf-event".
335 * This variable is an integer that will hold a input_event_type_e value.
337 typedef enum input_event_type_e
339 /* "state" has changed */
343 /* a *user* abort has been requested */
346 /* "rate" has changed */
349 /* At least one of "position" or "time" */
350 INPUT_EVENT_POSITION,
352 /* "length" has changed */
355 /* A title has been added or removed or selected.
356 * It imply that chapter has changed (not chapter event is sent) */
358 /* A chapter has been added or removed or selected. */
361 /* A program ("program") has been added or removed or selected,
362 * or "program-scrambled" has changed.*/
364 /* A ES has been added or removed or selected */
366 /* "teletext-es" has changed */
367 INPUT_EVENT_TELETEXT,
369 /* "record" has changed */
372 /* input_item_t media has changed */
373 INPUT_EVENT_ITEM_META,
374 /* input_item_t info has changed */
375 INPUT_EVENT_ITEM_INFO,
376 /* input_item_t name has changed */
377 INPUT_EVENT_ITEM_NAME,
378 /* input_item_t epg has changed */
379 INPUT_EVENT_ITEM_EPG,
381 /* Input statistics have been updated */
382 INPUT_EVENT_STATISTICS,
383 /* At least one of "signal-quality" or "signal-strength" has changed */
386 /* "audio-delay" has changed */
387 INPUT_EVENT_AUDIO_DELAY,
388 /* "spu-delay" has changed */
389 INPUT_EVENT_SUBTITLE_DELAY,
391 /* "bookmark" has changed */
392 INPUT_EVENT_BOOKMARK,
394 /* cache" has changed */
397 /* A audio_output_t object has been created/deleted by *the input* */
399 /* A vout_thread_t object has been created/deleted by *the input* */
402 } input_event_type_e;
409 /* input variable "position" */
410 INPUT_GET_POSITION, /* arg1= double * res= */
411 INPUT_SET_POSITION, /* arg1= double res=can fail */
413 /* input variable "length" */
414 INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
416 /* input variable "time" */
417 INPUT_GET_TIME, /* arg1= int64_t * res= */
418 INPUT_SET_TIME, /* arg1= int64_t res=can fail */
420 /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
421 INPUT_GET_RATE, /* arg1= int * res= */
422 INPUT_SET_RATE, /* arg1= int res=can fail */
424 /* input variable "state" */
425 INPUT_GET_STATE, /* arg1= int * res= */
426 INPUT_SET_STATE, /* arg1= int res=can fail */
428 /* input variable "audio-delay" and "sub-delay" */
429 INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
430 INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
431 INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
432 INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
434 /* Menu navigation */
442 INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
443 INPUT_REPLACE_INFOS,/* arg1= info_category_t * res=cannot fail */
444 INPUT_MERGE_INFOS,/* arg1= info_category_t * res=cannot fail */
445 INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
446 INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
447 INPUT_SET_NAME, /* arg1= char* res=can fail */
449 /* Input properties */
450 INPUT_GET_VIDEO_FPS, /* arg1= double * res=can fail */
453 INPUT_GET_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
454 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
455 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
456 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
457 INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
458 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
459 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
462 INPUT_GET_TITLE_INFO, /* arg1=input_title_t** arg2= int * res=can fail */
465 INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int* res=can fail */
466 INPUT_GET_ATTACHMENT, /* arg1=input_attachment_t**, arg2=char* res=can fail */
468 /* On the fly input slave */
469 INPUT_ADD_SLAVE, /* arg1= const char * */
470 INPUT_ADD_SUBTITLE, /* arg1= const char *, arg2=bool b_check_extension */
472 /* On the fly record while playing */
473 INPUT_SET_RECORD_STATE, /* arg1=bool res=can fail */
474 INPUT_GET_RECORD_STATE, /* arg1=bool* res=can fail */
477 INPUT_RESTART_ES, /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
480 * XXX You must call vlc_object_release as soon as possible */
481 INPUT_GET_AOUT, /* arg1=audio_output_t ** res=can fail */
482 INPUT_GET_VOUTS, /* arg1=vout_thread_t ***, size_t * res=can fail */
483 INPUT_GET_ES_OBJECTS, /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
485 /* External clock managments */
486 INPUT_GET_PCR_SYSTEM, /* arg1=mtime_t *, arg2=mtime_t * res=can fail */
487 INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t res=can fail */
492 /*****************************************************************************
494 *****************************************************************************/
496 VLC_API input_thread_t * input_Create( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) VLC_USED;
497 #define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d)
499 VLC_API input_thread_t * input_CreateAndStart( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) VLC_USED;
500 #define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)
502 VLC_API int input_Start( input_thread_t * );
504 VLC_API void input_Stop( input_thread_t *, bool b_abort );
506 VLC_API int input_Read( vlc_object_t *, input_item_t * );
507 #define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
509 VLC_API int input_vaControl( input_thread_t *, int i_query, va_list );
511 VLC_API int input_Control( input_thread_t *, int i_query, ... );
513 VLC_API void input_Close( input_thread_t * );
514 void input_Join( input_thread_t * );
515 void input_Release( input_thread_t * );
518 * Get the input item for an input thread
520 * You have to keep a reference to the input or to the input_item_t until
521 * you do not need it anymore.
523 VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
526 * It will return the current state of the input.
527 * Provided for convenience.
529 static inline input_state_e input_GetState( input_thread_t * p_input )
531 input_state_e state = INIT_S;
532 input_Control( p_input, INPUT_GET_STATE, &state );
536 * It will add a new subtitle source to the input.
537 * Provided for convenience.
539 static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension )
541 return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
545 * Return one of the video output (if any). If possible, you should use
546 * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
547 * @param p_input an input thread from which to get a video output
548 * @return NULL on error, or a video output thread pointer (which needs to be
549 * released with vlc_object_release()).
551 static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
553 vout_thread_t **pp_vout, *p_vout;
556 if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
559 for( size_t i = 1; i < i_vout; i++ )
560 vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
562 p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
568 * Return the audio output (if any) associated with an input.
569 * @param p_input an input thread
570 * @return NULL on error, or the audio output (which needs to be
571 * released with vlc_object_release()).
573 static inline audio_output_t *input_GetAout( input_thread_t *p_input )
575 audio_output_t *p_aout;
576 return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
580 * Returns the objects associated to an ES.
582 * You must release all non NULL object using vlc_object_release.
583 * You may set pointer of pointer to NULL to avoid retreiving it.
585 static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
586 vlc_object_t **pp_decoder,
587 vout_thread_t **pp_vout, audio_output_t **pp_aout )
589 return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
590 pp_decoder, pp_vout, pp_aout );
594 * \see input_clock_GetSystemOrigin
596 static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay )
598 return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
601 * \see input_clock_ChangeSystemOrigin
603 static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, mtime_t i_system )
605 return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
609 VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, es_format_t *, input_resource_t * ) VLC_USED;
610 VLC_API void input_DecoderDelete( decoder_t * );
611 VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace );
614 * This function creates a sane filename path.
616 VLC_API char * input_CreateFilename( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) VLC_USED;
619 * It creates an empty input resource handler.
621 * The given object MUST stay alive as long as the input_resource_t is
624 VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
627 * It releases an input resource.
629 VLC_API void input_resource_Release( input_resource_t * );
632 * Forcefully destroys the video output (e.g. when the playlist is stopped).
634 VLC_API void input_resource_TerminateVout( input_resource_t * );
637 * This function releases all resources (object).
639 VLC_API void input_resource_Terminate( input_resource_t * );
642 * \return the current audio output if any.
643 * Use vlc_object_release() to drop the reference.
645 VLC_API audio_output_t *input_resource_HoldAout( input_resource_t * );