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_SIGNAL 0x0080
210 #define INPUT_UPDATE_TITLE_LIST 0x0100
213 * This defines private core storage for an input.
215 typedef struct input_thread_private_t input_thread_private_t
;
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. You must use the helpers
227 struct input_thread_t
236 /* All other data is input_thread is PRIVATE. You can't access it
237 * outside of src/input */
238 input_thread_private_t
*p
;
242 * Record prefix string.
243 * TODO make it configurable.
245 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
247 /*****************************************************************************
248 * Input events and variables
249 *****************************************************************************/
252 * \defgroup inputvariable Input variables
254 * The input provides multiples variable you can write to and/or read from.
256 * TODO complete the documentation.
257 * The read only variables are:
259 * - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
260 * or not, for that check position != 0.0)
264 * - "can-record" (if a stream can be recorded while playing)
265 * - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
266 * variable value being the one currently selected, -1 if no teletext)
268 * - "signal-strength"
269 * - "program-scrambled" (if the current program is scrambled)
270 * - "cache" (level of data cached [0 .. 1])
272 * The read-write variables are:
273 * - state (\see input_state_e)
275 * - position, position-offset
276 * - time, time-offset
277 * - title, next-title, prev-title
278 * - chapter, next-chapter, next-chapter-prev
279 * - program, audio-es, video-es, spu-es
280 * - audio-delay, spu-delay
281 * - bookmark (bookmark list)
284 * - navigation (list of "title %2i")
287 * The variable used for event is
288 * - intf-event (\see input_event_type_e)
294 * This enum is used by the variable "state"
296 typedef enum input_state_e
309 * It is an float used by the variable "rate" in the
310 * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
311 * the default value being 1. It represents the ratio of playback speed to
312 * nominal speed (bigger is faster).
314 * Internally, the rate is stored as a value in the range
315 * [INPUT_RATE_MIN, INPUT_RATE_MAX].
316 * internal rate = INPUT_RATE_DEFAULT / rate variable
322 #define INPUT_RATE_DEFAULT 1000
326 #define INPUT_RATE_MIN 32 /* Up to 32/1 */
330 #define INPUT_RATE_MAX 32000 /* Up to 1/32 */
335 * You can catch input event by adding a callback on the variable "intf-event".
336 * This variable is an integer that will hold a input_event_type_e value.
338 typedef enum input_event_type_e
340 /* "state" has changed */
344 /* a *user* abort has been requested */
347 /* "rate" has changed */
350 /* At least one of "position" or "time" */
351 INPUT_EVENT_POSITION
,
353 /* "length" has changed */
356 /* A title has been added or removed or selected.
357 * It imply that chapter has changed (not chapter event is sent) */
359 /* A chapter has been added or removed or selected. */
362 /* A program ("program") has been added or removed or selected,
363 * or "program-scrambled" has changed.*/
365 /* A ES has been added or removed or selected */
367 /* "teletext-es" has changed */
368 INPUT_EVENT_TELETEXT
,
370 /* "record" has changed */
373 /* input_item_t media has changed */
374 INPUT_EVENT_ITEM_META
,
375 /* input_item_t info has changed */
376 INPUT_EVENT_ITEM_INFO
,
377 /* input_item_t name has changed */
378 INPUT_EVENT_ITEM_NAME
,
379 /* input_item_t epg has changed */
380 INPUT_EVENT_ITEM_EPG
,
382 /* Input statistics have been updated */
383 INPUT_EVENT_STATISTICS
,
384 /* At least one of "signal-quality" or "signal-strength" has changed */
387 /* "audio-delay" has changed */
388 INPUT_EVENT_AUDIO_DELAY
,
389 /* "spu-delay" has changed */
390 INPUT_EVENT_SUBTITLE_DELAY
,
392 /* "bookmark" has changed */
393 INPUT_EVENT_BOOKMARK
,
395 /* cache" has changed */
398 /* A audio_output_t object has been created/deleted by *the input* */
400 /* A vout_thread_t object has been created/deleted by *the input* */
403 } input_event_type_e
;
410 /* input variable "position" */
411 INPUT_GET_POSITION
, /* arg1= double * res= */
412 INPUT_SET_POSITION
, /* arg1= double res=can fail */
414 /* input variable "length" */
415 INPUT_GET_LENGTH
, /* arg1= int64_t * res=can fail */
417 /* input variable "time" */
418 INPUT_GET_TIME
, /* arg1= int64_t * res= */
419 INPUT_SET_TIME
, /* arg1= int64_t res=can fail */
421 /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
422 INPUT_GET_RATE
, /* arg1= int * res= */
423 INPUT_SET_RATE
, /* arg1= int res=can fail */
425 /* input variable "state" */
426 INPUT_GET_STATE
, /* arg1= int * res= */
427 INPUT_SET_STATE
, /* arg1= int res=can fail */
429 /* input variable "audio-delay" and "sub-delay" */
430 INPUT_GET_AUDIO_DELAY
, /* arg1 = int* res=can fail */
431 INPUT_SET_AUDIO_DELAY
, /* arg1 = int res=can fail */
432 INPUT_GET_SPU_DELAY
, /* arg1 = int* res=can fail */
433 INPUT_SET_SPU_DELAY
, /* arg1 = int res=can fail */
435 /* Menu navigation */
443 INPUT_ADD_INFO
, /* arg1= char* arg2= char* arg3=... res=can fail */
444 INPUT_REPLACE_INFOS
,/* arg1= info_category_t * res=cannot fail */
445 INPUT_MERGE_INFOS
,/* arg1= info_category_t * res=cannot fail */
446 INPUT_GET_INFO
, /* arg1= char* arg2= char* arg3= char** res=can fail */
447 INPUT_DEL_INFO
, /* arg1= char* arg2= char* res=can fail */
448 INPUT_SET_NAME
, /* arg1= char* res=can fail */
450 /* Input properties */
451 INPUT_GET_VIDEO_FPS
, /* arg1= double * res=can fail */
454 INPUT_GET_BOOKMARK
, /* arg1= seekpoint_t * res=can fail */
455 INPUT_GET_BOOKMARKS
, /* arg1= seekpoint_t *** arg2= int * res=can fail */
456 INPUT_CLEAR_BOOKMARKS
, /* res=can fail */
457 INPUT_ADD_BOOKMARK
, /* arg1= seekpoint_t * res=can fail */
458 INPUT_CHANGE_BOOKMARK
, /* arg1= seekpoint_t * arg2= int * res=can fail */
459 INPUT_DEL_BOOKMARK
, /* arg1= seekpoint_t * res=can fail */
460 INPUT_SET_BOOKMARK
, /* arg1= int res=can fail */
463 INPUT_GET_TITLE_INFO
, /* arg1=input_title_t** arg2= int * res=can fail */
466 INPUT_GET_ATTACHMENTS
, /* arg1=input_attachment_t***, arg2=int* res=can fail */
467 INPUT_GET_ATTACHMENT
, /* arg1=input_attachment_t**, arg2=char* res=can fail */
469 /* On the fly input slave */
470 INPUT_ADD_SLAVE
, /* arg1= const char * */
471 INPUT_ADD_SUBTITLE
, /* arg1= const char *, arg2=bool b_check_extension */
473 /* On the fly record while playing */
474 INPUT_SET_RECORD_STATE
, /* arg1=bool res=can fail */
475 INPUT_GET_RECORD_STATE
, /* arg1=bool* res=can fail */
478 INPUT_RESTART_ES
, /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
481 * XXX You must call vlc_object_release as soon as possible */
482 INPUT_GET_AOUT
, /* arg1=audio_output_t ** res=can fail */
483 INPUT_GET_VOUTS
, /* arg1=vout_thread_t ***, size_t * res=can fail */
484 INPUT_GET_ES_OBJECTS
, /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
486 /* External clock managments */
487 INPUT_GET_PCR_SYSTEM
, /* arg1=mtime_t *, arg2=mtime_t * res=can fail */
488 INPUT_MODIFY_PCR_SYSTEM
,/* arg1=int absolute, arg2=mtime_t res=can fail */
493 /*****************************************************************************
495 *****************************************************************************/
497 VLC_API input_thread_t
* input_Create( vlc_object_t
*p_parent
, input_item_t
*, const char *psz_log
, input_resource_t
* ) VLC_USED
;
498 #define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d)
500 VLC_API input_thread_t
* input_CreateAndStart( vlc_object_t
*p_parent
, input_item_t
*, const char *psz_log
) VLC_USED
;
501 #define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)
503 VLC_API
int input_Start( input_thread_t
* );
505 VLC_API
void input_Stop( input_thread_t
*, bool b_abort
);
507 VLC_API
int input_Read( vlc_object_t
*, input_item_t
* );
508 #define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
510 VLC_API
int input_vaControl( input_thread_t
*, int i_query
, va_list );
512 VLC_API
int input_Control( input_thread_t
*, int i_query
, ... );
514 VLC_API
void input_Close( input_thread_t
* );
515 void input_Join( input_thread_t
* );
516 void input_Release( input_thread_t
* );
519 * Get the input item for an input thread
521 * You have to keep a reference to the input or to the input_item_t until
522 * you do not need it anymore.
524 VLC_API input_item_t
* input_GetItem( input_thread_t
* ) VLC_USED
;
527 * It will return the current state of the input.
528 * Provided for convenience.
530 static inline input_state_e
input_GetState( input_thread_t
* p_input
)
532 input_state_e state
= INIT_S
;
533 input_Control( p_input
, INPUT_GET_STATE
, &state
);
537 * It will add a new subtitle source to the input.
538 * Provided for convenience.
540 static inline int input_AddSubtitle( input_thread_t
*p_input
, const char *psz_url
, bool b_check_extension
)
542 return input_Control( p_input
, INPUT_ADD_SUBTITLE
, psz_url
, b_check_extension
);
546 * Return one of the video output (if any). If possible, you should use
547 * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
548 * @param p_input an input thread from which to get a video output
549 * @return NULL on error, or a video output thread pointer (which needs to be
550 * released with vlc_object_release()).
552 static inline vout_thread_t
*input_GetVout( input_thread_t
*p_input
)
554 vout_thread_t
**pp_vout
, *p_vout
;
557 if( input_Control( p_input
, INPUT_GET_VOUTS
, &pp_vout
, &i_vout
) )
560 for( size_t i
= 1; i
< i_vout
; i
++ )
561 vlc_object_release( (vlc_object_t
*)(pp_vout
[i
]) );
563 p_vout
= (i_vout
>= 1) ? pp_vout
[0] : NULL
;
569 * Return the audio output (if any) associated with an input.
570 * @param p_input an input thread
571 * @return NULL on error, or the audio output (which needs to be
572 * released with vlc_object_release()).
574 static inline audio_output_t
*input_GetAout( input_thread_t
*p_input
)
576 audio_output_t
*p_aout
;
577 return input_Control( p_input
, INPUT_GET_AOUT
, &p_aout
) ? NULL
: p_aout
;
581 * Returns the objects associated to an ES.
583 * You must release all non NULL object using vlc_object_release.
584 * You may set pointer of pointer to NULL to avoid retreiving it.
586 static inline int input_GetEsObjects( input_thread_t
*p_input
, int i_id
,
587 vlc_object_t
**pp_decoder
,
588 vout_thread_t
**pp_vout
, audio_output_t
**pp_aout
)
590 return input_Control( p_input
, INPUT_GET_ES_OBJECTS
, i_id
,
591 pp_decoder
, pp_vout
, pp_aout
);
595 * \see input_clock_GetSystemOrigin
597 static inline int input_GetPcrSystem( input_thread_t
*p_input
, mtime_t
*pi_system
, mtime_t
*pi_delay
)
599 return input_Control( p_input
, INPUT_GET_PCR_SYSTEM
, pi_system
, pi_delay
);
602 * \see input_clock_ChangeSystemOrigin
604 static inline int input_ModifyPcrSystem( input_thread_t
*p_input
, bool b_absolute
, mtime_t i_system
)
606 return input_Control( p_input
, INPUT_MODIFY_PCR_SYSTEM
, b_absolute
, i_system
);
610 VLC_API decoder_t
* input_DecoderCreate( vlc_object_t
*, es_format_t
*, input_resource_t
* ) VLC_USED
;
611 VLC_API
void input_DecoderDelete( decoder_t
* );
612 VLC_API
void input_DecoderDecode( decoder_t
*, block_t
*, bool b_do_pace
);
615 * This function creates a sane filename path.
617 VLC_API
char * input_CreateFilename( vlc_object_t
*, const char *psz_path
, const char *psz_prefix
, const char *psz_extension
) VLC_USED
;
620 * It creates an empty input resource handler.
622 * The given object MUST stay alive as long as the input_resource_t is
625 VLC_API input_resource_t
* input_resource_New( vlc_object_t
* ) VLC_USED
;
628 * It releases an input resource.
630 VLC_API
void input_resource_Release( input_resource_t
* );
633 * Forcefully destroys the video output (e.g. when the playlist is stopped).
635 VLC_API
void input_resource_TerminateVout( input_resource_t
* );
638 * This function releases all resources (object).
640 VLC_API
void input_resource_Terminate( input_resource_t
* );
643 * \return the current audio output if any.
644 * Use vlc_object_release() to drop the reference.
646 VLC_API audio_output_t
*input_resource_HoldAout( input_resource_t
* );