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>
39 #include <vlc_vout_osd.h>
43 /*****************************************************************************
44 * Seek point: (generalisation of chapters)
45 *****************************************************************************/
48 int64_t i_byte_offset;
49 int64_t i_time_offset;
53 static inline seekpoint_t *vlc_seekpoint_New( void )
55 seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
56 point->i_byte_offset =
57 point->i_time_offset = -1;
58 point->psz_name = NULL;
62 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
65 free( point->psz_name );
69 static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src )
71 seekpoint_t *point = vlc_seekpoint_New();
72 if( src->psz_name ) point->psz_name = strdup( src->psz_name );
73 point->i_time_offset = src->i_time_offset;
74 point->i_byte_offset = src->i_byte_offset;
78 /*****************************************************************************
80 *****************************************************************************/
81 typedef struct input_title_t
85 bool b_menu; /* Is it a menu or a normal entry */
87 int64_t i_length; /* Length(microsecond) if known, else 0 */
88 int64_t i_size; /* Size (bytes) if known, else 0 */
92 seekpoint_t **seekpoint;
96 static inline input_title_t *vlc_input_title_New(void)
98 input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
110 static inline void vlc_input_title_Delete( input_title_t *t )
117 for( i = 0; i < t->i_seekpoint; i++ )
119 free( t->seekpoint[i]->psz_name );
120 free( t->seekpoint[i] );
122 free( t->seekpoint );
126 static inline input_title_t *vlc_input_title_Duplicate( const input_title_t *t )
128 input_title_t *dup = vlc_input_title_New( );
131 if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
132 dup->b_menu = t->b_menu;
133 dup->i_length = t->i_length;
134 dup->i_size = t->i_size;
135 dup->i_seekpoint = t->i_seekpoint;
136 if( t->i_seekpoint > 0 )
138 dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
139 sizeof(seekpoint_t*) );
141 for( i = 0; i < t->i_seekpoint; i++ )
143 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
150 /*****************************************************************************
152 *****************************************************************************/
153 struct input_attachment_t
157 char *psz_description;
163 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
164 const char *psz_mime,
165 const char *psz_description,
169 input_attachment_t *a =
170 (input_attachment_t*)malloc( sizeof(input_attachment_t) );
173 a->psz_name = strdup( psz_name ? psz_name : "" );
174 a->psz_mime = strdup( psz_mime ? psz_mime : "" );
175 a->psz_description = strdup( psz_description ? psz_description : "" );
180 a->p_data = malloc( i_data );
181 if( a->p_data && p_data )
182 memcpy( a->p_data, p_data, i_data );
186 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
188 return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
189 a->p_data, a->i_data );
191 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
197 free( a->psz_description );
202 /*****************************************************************************
203 * input defines/constants.
204 *****************************************************************************/
207 * This defines private core storage for an input.
209 typedef struct input_thread_private_t input_thread_private_t;
212 * This defines an opaque input resource handler.
214 typedef struct input_resource_t input_resource_t;
217 * Main structure representing an input thread. This structure is mostly
218 * private. The only public fields are READ-ONLY. You must use the helpers
221 struct input_thread_t
230 /* All other data is input_thread is PRIVATE. You can't access it
231 * outside of src/input */
232 input_thread_private_t *p;
236 * Record prefix string.
237 * TODO make it configurable.
239 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
241 /*****************************************************************************
242 * Input events and variables
243 *****************************************************************************/
246 * \defgroup inputvariable Input variables
248 * The input provides multiples variable you can write to and/or read from.
250 * TODO complete the documentation.
251 * The read only variables are:
253 * - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
254 * or not, for that check position != 0.0)
258 * - "can-record" (if a stream can be recorded while playing)
259 * - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
260 * variable value being the one currently selected, -1 if no teletext)
262 * - "signal-strength"
263 * - "program-scrambled" (if the current program is scrambled)
264 * - "cache" (level of data cached [0 .. 1])
266 * The read-write variables are:
267 * - state (\see input_state_e)
269 * - position, position-offset
270 * - time, time-offset
271 * - title, next-title, prev-title
272 * - chapter, next-chapter, next-chapter-prev
273 * - program, audio-es, video-es, spu-es
274 * - audio-delay, spu-delay
275 * - bookmark (bookmark list)
278 * - navigation (list of "title %2i")
281 * The variable used for event is
282 * - intf-event (\see input_event_type_e)
288 * This enum is used by the variable "state"
290 typedef enum input_state_e
303 * It is an float used by the variable "rate" in the
304 * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
305 * the default value being 1. It represents the ratio of playback speed to
306 * nominal speed (bigger is faster).
308 * Internally, the rate is stored as a value in the range
309 * [INPUT_RATE_MIN, INPUT_RATE_MAX].
310 * internal rate = INPUT_RATE_DEFAULT / rate variable
316 #define INPUT_RATE_DEFAULT 1000
320 #define INPUT_RATE_MIN 32 /* Up to 32/1 */
324 #define INPUT_RATE_MAX 32000 /* Up to 1/32 */
329 * You can catch input event by adding a callback on the variable "intf-event".
330 * This variable is an integer that will hold a input_event_type_e value.
332 typedef enum input_event_type_e
334 /* "state" has changed */
339 /* "rate" has changed */
342 /* At least one of "position" or "time" */
343 INPUT_EVENT_POSITION,
345 /* "length" has changed */
348 /* A title has been added or removed or selected.
349 * It imply that chapter has changed (not chapter event is sent) */
351 /* A chapter has been added or removed or selected. */
354 /* A program ("program") has been added or removed or selected,
355 * or "program-scrambled" has changed.*/
357 /* A ES has been added or removed or selected */
359 /* "teletext-es" has changed */
360 INPUT_EVENT_TELETEXT,
362 /* "record" has changed */
365 /* input_item_t media has changed */
366 INPUT_EVENT_ITEM_META,
367 /* input_item_t info has changed */
368 INPUT_EVENT_ITEM_INFO,
369 /* input_item_t name has changed */
370 INPUT_EVENT_ITEM_NAME,
371 /* input_item_t epg has changed */
372 INPUT_EVENT_ITEM_EPG,
374 /* Input statistics have been updated */
375 INPUT_EVENT_STATISTICS,
376 /* At least one of "signal-quality" or "signal-strength" has changed */
379 /* "audio-delay" has changed */
380 INPUT_EVENT_AUDIO_DELAY,
381 /* "spu-delay" has changed */
382 INPUT_EVENT_SUBTITLE_DELAY,
384 /* "bookmark" has changed */
385 INPUT_EVENT_BOOKMARK,
387 /* cache" has changed */
390 /* A audio_output_t object has been created/deleted by *the input* */
392 /* A vout_thread_t object has been created/deleted by *the input* */
395 } input_event_type_e;
402 /* input variable "position" */
403 INPUT_GET_POSITION, /* arg1= double * res= */
404 INPUT_SET_POSITION, /* arg1= double res=can fail */
406 /* input variable "length" */
407 INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
409 /* input variable "time" */
410 INPUT_GET_TIME, /* arg1= int64_t * res= */
411 INPUT_SET_TIME, /* arg1= int64_t res=can fail */
413 /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
414 INPUT_GET_RATE, /* arg1= int * res= */
415 INPUT_SET_RATE, /* arg1= int res=can fail */
417 /* input variable "state" */
418 INPUT_GET_STATE, /* arg1= int * res= */
419 INPUT_SET_STATE, /* arg1= int res=can fail */
421 /* input variable "audio-delay" and "sub-delay" */
422 INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
423 INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
424 INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
425 INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
427 /* Menu navigation */
435 INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
436 INPUT_REPLACE_INFOS,/* arg1= info_category_t * res=cannot fail */
437 INPUT_MERGE_INFOS,/* arg1= info_category_t * res=cannot fail */
438 INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
439 INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
440 INPUT_SET_NAME, /* arg1= char* res=can fail */
442 /* Input properties */
443 INPUT_GET_VIDEO_FPS, /* arg1= double * res=can fail */
446 INPUT_GET_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
447 INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
448 INPUT_CLEAR_BOOKMARKS, /* res=can fail */
449 INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
450 INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
451 INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
452 INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
455 INPUT_GET_TITLE_INFO, /* arg1=input_title_t** arg2= int * res=can fail */
458 INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int* res=can fail */
459 INPUT_GET_ATTACHMENT, /* arg1=input_attachment_t**, arg2=char* res=can fail */
461 /* On the fly input slave */
462 INPUT_ADD_SLAVE, /* arg1= const char * */
463 INPUT_ADD_SUBTITLE, /* arg1= const char *, arg2=bool b_check_extension */
465 /* On the fly record while playing */
466 INPUT_SET_RECORD_STATE, /* arg1=bool res=can fail */
467 INPUT_GET_RECORD_STATE, /* arg1=bool* res=can fail */
470 INPUT_RESTART_ES, /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
473 * XXX You must call vlc_object_release as soon as possible */
474 INPUT_GET_AOUT, /* arg1=audio_output_t ** res=can fail */
475 INPUT_GET_VOUTS, /* arg1=vout_thread_t ***, size_t * res=can fail */
476 INPUT_GET_ES_OBJECTS, /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
478 /* External clock managments */
479 INPUT_GET_PCR_SYSTEM, /* arg1=mtime_t *, arg2=mtime_t * res=can fail */
480 INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t res=can fail */
485 /*****************************************************************************
487 *****************************************************************************/
489 VLC_API input_thread_t * input_Create( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) VLC_USED;
490 #define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d)
492 VLC_API input_thread_t * input_CreateAndStart( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) VLC_USED;
493 #define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)
495 VLC_API int input_Start( input_thread_t * );
497 VLC_API void input_Stop( input_thread_t * );
499 VLC_API int input_Read( vlc_object_t *, input_item_t * );
500 #define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
502 VLC_API int input_vaControl( input_thread_t *, int i_query, va_list );
504 VLC_API int input_Control( input_thread_t *, int i_query, ... );
506 VLC_API void input_Close( input_thread_t * );
507 void input_Join( input_thread_t * );
508 void input_Release( input_thread_t * );
511 * Get the input item for an input thread
513 * You have to keep a reference to the input or to the input_item_t until
514 * you do not need it anymore.
516 VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
519 * It will return the current state of the input.
520 * Provided for convenience.
522 static inline input_state_e input_GetState( input_thread_t * p_input )
524 input_state_e state = INIT_S;
525 input_Control( p_input, INPUT_GET_STATE, &state );
530 * Return one of the video output (if any). If possible, you should use
531 * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
532 * @param p_input an input thread from which to get a video output
533 * @return NULL on error, or a video output thread pointer (which needs to be
534 * released with vlc_object_release()).
536 static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
538 vout_thread_t **pp_vout, *p_vout;
541 if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
544 for( size_t i = 1; i < i_vout; i++ )
545 vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
547 p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
553 * It will add a new subtitle source to the input.
554 * Provided for convenience.
556 static inline int input_AddSubtitleOSD( input_thread_t *p_input, const char *psz_url,
557 bool b_check_extension, bool b_osd )
559 int i_result = input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
560 if( i_result != VLC_SUCCESS || !b_osd )
563 vout_thread_t *p_vout = input_GetVout( p_input );
566 vout_OSDMessage(p_vout, SPU_DEFAULT_CHANNEL, "%s",
567 vlc_gettext("Subtitle track added") );
568 vlc_object_release( (vlc_object_t *)p_vout );
572 #define input_AddSubtitle(a, b, c) input_AddSubtitleOSD(a, b, c, false)
576 * Return the audio output (if any) associated with an input.
577 * @param p_input an input thread
578 * @return NULL on error, or the audio output (which needs to be
579 * released with vlc_object_release()).
581 static inline audio_output_t *input_GetAout( input_thread_t *p_input )
583 audio_output_t *p_aout;
584 return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
588 * Returns the objects associated to an ES.
590 * You must release all non NULL object using vlc_object_release.
591 * You may set pointer of pointer to NULL to avoid retreiving it.
593 static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
594 vlc_object_t **pp_decoder,
595 vout_thread_t **pp_vout, audio_output_t **pp_aout )
597 return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
598 pp_decoder, pp_vout, pp_aout );
602 * \see input_clock_GetSystemOrigin
604 static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay )
606 return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
609 * \see input_clock_ChangeSystemOrigin
611 static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, mtime_t i_system )
613 return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
617 VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, es_format_t *, input_resource_t * ) VLC_USED;
618 VLC_API void input_DecoderDelete( decoder_t * );
619 VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace );
622 * This function creates a sane filename path.
624 VLC_API char * input_CreateFilename( input_thread_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) VLC_USED;
627 * It creates an empty input resource handler.
629 * The given object MUST stay alive as long as the input_resource_t is
632 VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
635 * It releases an input resource.
637 VLC_API void input_resource_Release( input_resource_t * );
640 * Forcefully destroys the video output (e.g. when the playlist is stopped).
642 VLC_API void input_resource_TerminateVout( input_resource_t * );
645 * This function releases all resources (object).
647 VLC_API void input_resource_Terminate( input_resource_t * );
650 * \return the current audio output if any.
651 * Use vlc_object_release() to drop the reference.
653 VLC_API audio_output_t *input_resource_HoldAout( input_resource_t * );
656 * This function creates or recycles an audio output.
658 VLC_API audio_output_t *input_resource_GetAout( input_resource_t * );
661 * This function retains or destroys an audio output.
663 VLC_API void input_resource_PutAout( input_resource_t *, audio_output_t * );
666 * Prevents the existing audio output (if any) from being recycled.
668 VLC_API void input_resource_ResetAout( input_resource_t * );