1 /*****************************************************************************
2 * vlc_input.h: Core input structures
3 *****************************************************************************
4 * Copyright (C) 1999-2015 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 *****************************************************************************/
29 * \defgroup input Input
34 * Input thread interface
40 #include <vlc_events.h>
41 #include <vlc_input_item.h>
43 #include <vlc_vout_osd.h>
47 /*****************************************************************************
48 * Seek point: (generalisation of chapters)
49 *****************************************************************************/
52 int64_t i_time_offset
;
56 static inline seekpoint_t
*vlc_seekpoint_New( void )
58 seekpoint_t
*point
= (seekpoint_t
*)malloc( sizeof( seekpoint_t
) );
61 point
->i_time_offset
= -1;
62 point
->psz_name
= NULL
;
66 static inline void vlc_seekpoint_Delete( seekpoint_t
*point
)
69 free( point
->psz_name
);
73 static inline seekpoint_t
*vlc_seekpoint_Duplicate( const seekpoint_t
*src
)
75 seekpoint_t
*point
= vlc_seekpoint_New();
78 if( src
->psz_name
) point
->psz_name
= strdup( src
->psz_name
);
79 point
->i_time_offset
= src
->i_time_offset
;
84 /*****************************************************************************
86 *****************************************************************************/
88 /* input_title_t.i_flags field */
89 #define INPUT_TITLE_MENU 0x01 /* Menu title */
90 #define INPUT_TITLE_INTERACTIVE 0x02 /* Interactive title. Playback position has no meaning. */
92 typedef struct input_title_t
96 vlc_tick_t i_length
; /* Length(microsecond) if known, else 0 */
98 unsigned i_flags
; /* Is it a menu or a normal entry */
100 /* Title seekpoint */
102 seekpoint_t
**seekpoint
;
105 static inline input_title_t
*vlc_input_title_New(void)
107 input_title_t
*t
= (input_title_t
*)malloc( sizeof( input_title_t
) );
120 static inline void vlc_input_title_Delete( input_title_t
*t
)
127 for( i
= 0; i
< t
->i_seekpoint
; i
++ )
128 vlc_seekpoint_Delete( t
->seekpoint
[i
] );
129 free( t
->seekpoint
);
133 static inline input_title_t
*vlc_input_title_Duplicate( const input_title_t
*t
)
135 input_title_t
*dup
= vlc_input_title_New( );
136 if( dup
== NULL
) return NULL
;
138 if( t
->psz_name
) dup
->psz_name
= strdup( t
->psz_name
);
139 dup
->i_flags
= t
->i_flags
;
140 dup
->i_length
= t
->i_length
;
141 if( t
->i_seekpoint
> 0 )
143 dup
->seekpoint
= (seekpoint_t
**)vlc_alloc( t
->i_seekpoint
, sizeof(seekpoint_t
*) );
144 if( likely(dup
->seekpoint
) )
146 for( int i
= 0; i
< t
->i_seekpoint
; i
++ )
147 dup
->seekpoint
[i
] = vlc_seekpoint_Duplicate( t
->seekpoint
[i
] );
148 dup
->i_seekpoint
= t
->i_seekpoint
;
155 /*****************************************************************************
157 *****************************************************************************/
158 struct input_attachment_t
162 char *psz_description
;
168 static inline void vlc_input_attachment_Delete( input_attachment_t
*a
)
174 free( a
->psz_description
);
180 static inline input_attachment_t
*vlc_input_attachment_New( const char *psz_name
,
181 const char *psz_mime
,
182 const char *psz_description
,
186 input_attachment_t
*a
= (input_attachment_t
*)malloc( sizeof (*a
) );
187 if( unlikely(a
== NULL
) )
190 a
->psz_name
= strdup( psz_name
? psz_name
: "" );
191 a
->psz_mime
= strdup( psz_mime
? psz_mime
: "" );
192 a
->psz_description
= strdup( psz_description
? psz_description
: "" );
194 a
->p_data
= malloc( i_data
);
195 if( i_data
> 0 && likely(a
->p_data
!= NULL
) )
196 memcpy( a
->p_data
, p_data
, i_data
);
198 if( unlikely(a
->psz_name
== NULL
|| a
->psz_mime
== NULL
199 || a
->psz_description
== NULL
|| (i_data
> 0 && a
->p_data
== NULL
)) )
201 vlc_input_attachment_Delete( a
);
207 static inline input_attachment_t
*vlc_input_attachment_Duplicate( const input_attachment_t
*a
)
209 return vlc_input_attachment_New( a
->psz_name
, a
->psz_mime
, a
->psz_description
,
210 a
->p_data
, a
->i_data
);
213 /*****************************************************************************
214 * input defines/constants.
215 *****************************************************************************/
218 * This defines an opaque input resource handler.
220 typedef struct input_resource_t input_resource_t
;
223 * Main structure representing an input thread. This structure is mostly
224 * private. The only public fields are read-only and constant.
226 struct input_thread_t
228 struct vlc_common_members obj
;
232 * Record prefix string.
233 * TODO make it configurable.
235 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
237 /*****************************************************************************
238 * Input events and variables
239 *****************************************************************************/
242 * \defgroup inputvariable Input variables
244 * The input provides multiples variable you can write to and/or read from.
246 * TODO complete the documentation.
247 * The read only variables are:
249 * - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
250 * or not, for that check position != 0.0)
254 * - "can-record" (if a stream can be recorded while playing)
255 * - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
256 * variable value being the one currently selected, -1 if no teletext)
258 * - "signal-strength"
259 * - "program-scrambled" (if the current program is scrambled)
260 * - "cache" (level of data cached [0 .. 1])
262 * The read-write variables are:
263 * - state (\see input_state_e)
266 * - time, time-offset
267 * - title, next-title, prev-title
268 * - chapter, next-chapter, next-chapter-prev
269 * - program, audio-es, video-es, spu-es
270 * - audio-delay, spu-delay
271 * - bookmark (bookmark list)
274 * - navigation (list of "title %2i")
277 * The variable used for event is
278 * - intf-event (\see input_event_type_e)
284 * This enum is used by the variable "state"
286 typedef enum input_state_e
299 * It is an float used by the variable "rate" in the
300 * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
301 * the default value being 1. It represents the ratio of playback speed to
302 * nominal speed (bigger is faster).
304 * Internally, the rate is stored as a value in the range
305 * [INPUT_RATE_MIN, INPUT_RATE_MAX].
306 * internal rate = INPUT_RATE_DEFAULT / rate variable
312 #define INPUT_RATE_DEFAULT 1000
316 #define INPUT_RATE_MIN 32 /* Up to 32/1 */
320 #define INPUT_RATE_MAX 32000 /* Up to 1/32 */
325 * You can catch input event by adding a callback on the variable "intf-event".
326 * This variable is an integer that will hold a input_event_type_e value.
328 typedef enum input_event_type_e
330 /* "state" has changed */
335 /* "rate" has changed */
338 /* "capabilities" has changed */
339 INPUT_EVENT_CAPABILITIES
,
341 /* At least one of "position" or "time" */
342 INPUT_EVENT_POSITION
,
344 /* "length" has changed */
347 /* A title has been added or removed or selected.
348 * It implies that the chapter has changed (no chapter event is sent) */
350 /* A chapter has been added or removed or selected. */
353 /* A program ("program") has been added or removed or selected,
354 * or "program-scrambled" has changed.*/
356 /* A ES has been added or removed or selected */
358 /* "teletext-es" has changed */
359 INPUT_EVENT_TELETEXT
,
361 /* "record" has changed */
364 /* input_item_t media has changed */
365 INPUT_EVENT_ITEM_META
,
366 /* input_item_t info has changed */
367 INPUT_EVENT_ITEM_INFO
,
368 /* input_item_t epg has changed */
369 INPUT_EVENT_ITEM_EPG
,
371 /* Input statistics have been updated */
372 INPUT_EVENT_STATISTICS
,
373 /* At least one of "signal-quality" or "signal-strength" has changed */
376 /* "audio-delay" has changed */
377 INPUT_EVENT_AUDIO_DELAY
,
378 /* "spu-delay" has changed */
379 INPUT_EVENT_SUBTITLE_DELAY
,
381 /* "bookmark" has changed */
382 INPUT_EVENT_BOOKMARK
,
384 /* cache" has changed */
387 /* A audio_output_t object has been created/deleted by *the input* */
389 /* A vout_thread_t object has been created/deleted by *the input* */
392 } input_event_type_e
;
394 #define VLC_INPUT_CAPABILITIES_SEEKABLE (1<<0)
395 #define VLC_INPUT_CAPABILITIES_PAUSEABLE (1<<1)
396 #define VLC_INPUT_CAPABILITIES_CHANGE_RATE (1<<2)
397 #define VLC_INPUT_CAPABILITIES_REWINDABLE (1<<3)
398 #define VLC_INPUT_CAPABILITIES_RECORDABLE (1<<4)
400 struct vlc_input_event
402 input_event_type_e type
;
405 /* INPUT_EVENT_STATE */
407 /* INPUT_EVENT_RATE */
409 /* INPUT_EVENT_CAPABILITIES */
410 int capabilities
; /**< cf. VLC_INPUT_CAPABILITIES_* bitwise flags */
411 /* INPUT_EVENT_POSITION */
416 /* INPUT_EVENT_LENGTH */
418 /* INPUT_EVENT_TITLE */
420 /* INPUT_EVENT_CHAPTER */
425 /* INPUT_EVENT_PROGRAM */
428 VLC_INPUT_PROGRAM_ADDED
,
429 VLC_INPUT_PROGRAM_DELETED
,
430 VLC_INPUT_PROGRAM_SELECTED
,
431 VLC_INPUT_PROGRAM_SCRAMBLED
,
443 VLC_INPUT_ES_DELETED
,
444 VLC_INPUT_ES_SELECTED
,
446 enum es_format_category_e cat
;
447 int id
; /**< id == -1 will unselect */
450 /* INPUT_EVENT_TELETEXT */
453 VLC_INPUT_TELETEXT_ADDED
,
454 VLC_INPUT_TELETEXT_DELETED
,
455 VLC_INPUT_TELETEXT_SELECTED
,
457 int id
; /**< id == -1 will unselect */
460 /* INPUT_EVENT_RECORD */
462 /* INPUT_EVENT_SIGNAL */
467 /* INPUT_EVENT_AUDIO_DELAY */
468 vlc_tick_t audio_delay
;
469 /* INPUT_EVENT_SUBTITLE_DELAY */
470 vlc_tick_t subtitle_delay
;
471 /* INPUT_EVENT_CACHE */
476 typedef void (*input_thread_events_cb
)( input_thread_t
*input
, void *user_data
,
477 const struct vlc_input_event
*event
);
484 /* Menu (VCD/DVD/BD) Navigation */
485 /** Activate the navigation item selected. res=can fail */
487 /** Use the up arrow to select a navigation item above. res=can fail */
489 /** Use the down arrow to select a navigation item under. res=can fail */
491 /** Use the left arrow to select a navigation item on the left. res=can fail */
493 /** Use the right arrow to select a navigation item on the right. res=can fail */
495 /** Activate the popup Menu (for BD). res=can fail */
497 /** Activate disc Root Menu. res=can fail */
501 INPUT_ADD_INFO
, /* arg1= char* arg2= char* arg3=... res=can fail */
502 INPUT_REPLACE_INFOS
,/* arg1= info_category_t * res=cannot fail */
503 INPUT_MERGE_INFOS
,/* arg1= info_category_t * res=cannot fail */
504 INPUT_DEL_INFO
, /* arg1= char* arg2= char* res=can fail */
507 INPUT_GET_BOOKMARK
, /* arg1= seekpoint_t * res=can fail */
508 INPUT_GET_BOOKMARKS
, /* arg1= seekpoint_t *** arg2= int * res=can fail */
509 INPUT_CLEAR_BOOKMARKS
, /* res=can fail */
510 INPUT_ADD_BOOKMARK
, /* arg1= seekpoint_t * res=can fail */
511 INPUT_CHANGE_BOOKMARK
, /* arg1= seekpoint_t * arg2= int * res=can fail */
512 INPUT_DEL_BOOKMARK
, /* arg1= seekpoint_t * res=can fail */
513 INPUT_SET_BOOKMARK
, /* arg1= int res=can fail */
516 INPUT_GET_FULL_TITLE_INFO
, /* arg1=input_title_t*** arg2= int * res=can fail */
519 INPUT_GET_ATTACHMENTS
, /* arg1=input_attachment_t***, arg2=int* res=can fail */
520 INPUT_GET_ATTACHMENT
, /* arg1=input_attachment_t**, arg2=char* res=can fail */
522 /* On the fly input slave */
523 INPUT_ADD_SLAVE
, /* arg1= enum slave_type, arg2= const char *,
524 * arg3= bool forced, arg4= bool notify,
525 * arg5= bool check_extension */
528 INPUT_RESTART_ES
, /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
531 INPUT_UPDATE_VIEWPOINT
, /* arg1=(const vlc_viewpoint_t*), arg2=bool b_absolute */
532 INPUT_SET_INITIAL_VIEWPOINT
, /* arg1=(const vlc_viewpoint_t*) */
535 * XXX You must call vlc_object_release as soon as possible */
536 INPUT_GET_AOUT
, /* arg1=audio_output_t ** res=can fail */
537 INPUT_GET_VOUTS
, /* arg1=vout_thread_t ***, size_t * res=can fail */
538 INPUT_GET_ES_OBJECTS
, /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
541 INPUT_SET_RENDERER
, /* arg1=vlc_renderer_item_t* */
543 /* External clock managments */
544 INPUT_GET_PCR_SYSTEM
, /* arg1=vlc_tick_t *, arg2=vlc_tick_t * res=can fail */
545 INPUT_MODIFY_PCR_SYSTEM
,/* arg1=int absolute, arg2=vlc_tick_t res=can fail */
550 /*****************************************************************************
552 *****************************************************************************/
553 VLC_API input_thread_t
* input_Create( vlc_object_t
*p_parent
,
554 input_thread_events_cb event_cb
, void *events_data
,
555 input_item_t
*, const char *psz_log
, input_resource_t
*,
556 vlc_renderer_item_t
* p_renderer
) VLC_USED
;
557 #define input_Create(a,b,c,d,e,f,g) input_Create(VLC_OBJECT(a),b,c,d,e,f,g)
561 * Creates an item preparser.
563 * Creates an input thread to preparse an item. The input needs to be started
564 * with input_Start() afterwards.
566 * @param obj parent object
567 * @param item input item to preparse
568 * @return an input thread or NULL on error
570 VLC_API input_thread_t
*input_CreatePreparser(vlc_object_t
*obj
,
571 input_thread_events_cb events_cb
,
572 void *events_data
, input_item_t
*item
)
575 VLC_API
int input_Start( input_thread_t
* );
577 VLC_API
void input_Stop( input_thread_t
* );
579 VLC_API
int input_Read( vlc_object_t
*, input_item_t
* );
580 #define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
582 VLC_API
int input_vaControl( input_thread_t
*, int i_query
, va_list );
584 VLC_API
int input_Control( input_thread_t
*, int i_query
, ... );
586 VLC_API
void input_Close( input_thread_t
* );
588 VLC_API
void input_SetTime( input_thread_t
*, vlc_tick_t i_time
, bool b_fast
);
590 VLC_API
void input_SetPosition( input_thread_t
*, float f_position
, bool b_fast
);
592 VLC_API
void input_LegacyEvents(input_thread_t
*, void *, const struct vlc_input_event
* );
593 VLC_API
void input_LegacyVarInit ( input_thread_t
* );
596 * Get the input item for an input thread
598 * You have to keep a reference to the input or to the input_item_t until
599 * you do not need it anymore.
601 VLC_API input_item_t
* input_GetItem( input_thread_t
* ) VLC_USED
;
604 * Return one of the video output (if any). If possible, you should use
605 * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
606 * @param p_input an input thread from which to get a video output
607 * @return NULL on error, or a video output thread pointer (which needs to be
608 * released with vlc_object_release()).
610 static inline vout_thread_t
*input_GetVout( input_thread_t
*p_input
)
612 vout_thread_t
**pp_vout
, *p_vout
;
615 if( input_Control( p_input
, INPUT_GET_VOUTS
, &pp_vout
, &i_vout
) )
618 for( size_t i
= 1; i
< i_vout
; i
++ )
619 vlc_object_release( (vlc_object_t
*)(pp_vout
[i
]) );
621 p_vout
= (i_vout
>= 1) ? pp_vout
[0] : NULL
;
626 static inline int input_AddSlave( input_thread_t
*p_input
, enum slave_type type
,
627 const char *psz_uri
, bool b_forced
,
628 bool b_notify
, bool b_check_ext
)
630 return input_Control( p_input
, INPUT_ADD_SLAVE
, type
, psz_uri
, b_forced
,
631 b_notify
, b_check_ext
);
635 * Update the viewpoint of the input thread. The viewpoint will be applied to
636 * all vouts and aouts.
638 * @param p_input an input thread
639 * @param p_viewpoint the viewpoint value
640 * @param b_absolute if true replace the old viewpoint with the new one. If
641 * false, increase/decrease it.
642 * @return VLC_SUCCESS or a VLC error code
644 static inline int input_UpdateViewpoint( input_thread_t
*p_input
,
645 const vlc_viewpoint_t
*p_viewpoint
,
648 return input_Control( p_input
, INPUT_UPDATE_VIEWPOINT
, p_viewpoint
,
653 * Return the audio output (if any) associated with an input.
654 * @param p_input an input thread
655 * @return NULL on error, or the audio output (which needs to be
656 * released with vlc_object_release()).
658 static inline audio_output_t
*input_GetAout( input_thread_t
*p_input
)
660 audio_output_t
*p_aout
;
661 return input_Control( p_input
, INPUT_GET_AOUT
, &p_aout
) ? NULL
: p_aout
;
665 * Returns the objects associated to an ES.
667 * You must release all non NULL object using vlc_object_release.
668 * You may set pointer of pointer to NULL to avoid retreiving it.
670 static inline int input_GetEsObjects( input_thread_t
*p_input
, int i_id
,
671 vlc_object_t
**pp_decoder
,
672 vout_thread_t
**pp_vout
, audio_output_t
**pp_aout
)
674 return input_Control( p_input
, INPUT_GET_ES_OBJECTS
, i_id
,
675 pp_decoder
, pp_vout
, pp_aout
);
679 * \see input_clock_GetSystemOrigin
681 static inline int input_GetPcrSystem( input_thread_t
*p_input
, vlc_tick_t
*pi_system
, vlc_tick_t
*pi_delay
)
683 return input_Control( p_input
, INPUT_GET_PCR_SYSTEM
, pi_system
, pi_delay
);
686 * \see input_clock_ChangeSystemOrigin
688 static inline int input_ModifyPcrSystem( input_thread_t
*p_input
, bool b_absolute
, vlc_tick_t i_system
)
690 return input_Control( p_input
, INPUT_MODIFY_PCR_SYSTEM
, b_absolute
, i_system
);
694 VLC_API decoder_t
* input_DecoderCreate( vlc_object_t
*, const es_format_t
*, input_resource_t
* ) VLC_USED
;
695 VLC_API
void input_DecoderDelete( decoder_t
* );
696 VLC_API
void input_DecoderDecode( decoder_t
*, block_t
*, bool b_do_pace
);
697 VLC_API
void input_DecoderDrain( decoder_t
* );
698 VLC_API
void input_DecoderFlush( decoder_t
* );
701 * This function creates a sane filename path.
703 VLC_API
char * input_CreateFilename( input_thread_t
*, const char *psz_path
, const char *psz_prefix
, const char *psz_extension
) VLC_USED
;
706 * It creates an empty input resource handler.
708 * The given object MUST stay alive as long as the input_resource_t is
711 VLC_API input_resource_t
* input_resource_New( vlc_object_t
* ) VLC_USED
;
714 * It releases an input resource.
716 VLC_API
void input_resource_Release( input_resource_t
* );
719 * Forcefully destroys the video output (e.g. when the playlist is stopped).
721 VLC_API
void input_resource_TerminateVout( input_resource_t
* );
724 * This function releases all resources (object).
726 VLC_API
void input_resource_Terminate( input_resource_t
* );
729 * \return the current audio output if any.
730 * Use vlc_object_release() to drop the reference.
732 VLC_API audio_output_t
*input_resource_HoldAout( input_resource_t
* );
735 * This function creates or recycles an audio output.
737 VLC_API audio_output_t
*input_resource_GetAout( input_resource_t
* );
740 * This function retains or destroys an audio output.
742 VLC_API
void input_resource_PutAout( input_resource_t
*, audio_output_t
* );
745 * Prevents the existing audio output (if any) from being recycled.
747 VLC_API
void input_resource_ResetAout( input_resource_t
* );