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
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 /*****************************************************************************
44 *****************************************************************************/
45 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t
*p_dst
,
46 const vlc_meta_t
*p_meta
)
53 if( (psz_value
= (char *)vlc_dictionary_value_for_key( &p_meta
->extra_tags
, "REPLAYGAIN_TRACK_GAIN" )) ||
54 (psz_value
= (char *)vlc_dictionary_value_for_key( &p_meta
->extra_tags
, "RG_RADIO" )) )
56 p_dst
->pb_gain
[AUDIO_REPLAY_GAIN_TRACK
] = true;
57 p_dst
->pf_gain
[AUDIO_REPLAY_GAIN_TRACK
] = atof( psz_value
);
59 else if( (psz_value
= (char *)vlc_dictionary_value_for_key( &p_meta
->extra_tags
, "REPLAYGAIN_TRACK_PEAK" )) ||
60 (psz_value
= (char *)vlc_dictionary_value_for_key( &p_meta
->extra_tags
, "RG_PEAK" )) )
62 p_dst
->pb_peak
[AUDIO_REPLAY_GAIN_TRACK
] = true;
63 p_dst
->pf_peak
[AUDIO_REPLAY_GAIN_TRACK
] = atof( psz_value
);
65 else if( (psz_value
= (char *)vlc_dictionary_value_for_key( &p_meta
->extra_tags
, "REPLAYGAIN_ALBUM_GAIN" )) ||
66 (psz_value
= (char *)vlc_dictionary_value_for_key( &p_meta
->extra_tags
, "RG_AUDIOPHILE" )) )
68 p_dst
->pb_gain
[AUDIO_REPLAY_GAIN_ALBUM
] = true;
69 p_dst
->pf_gain
[AUDIO_REPLAY_GAIN_ALBUM
] = atof( psz_value
);
71 else if( (psz_value
= (char *)vlc_dictionary_value_for_key( &p_meta
->extra_tags
, "REPLAYGAIN_ALBUM_PEAK" )) )
73 p_dst
->pb_peak
[AUDIO_REPLAY_GAIN_ALBUM
] = true;
74 p_dst
->pf_peak
[AUDIO_REPLAY_GAIN_ALBUM
] = atof( psz_value
);
78 /*****************************************************************************
79 * Seek point: (generalisation of chapters)
80 *****************************************************************************/
83 int64_t i_byte_offset
;
84 int64_t i_time_offset
;
89 static inline seekpoint_t
*vlc_seekpoint_New( void )
91 seekpoint_t
*point
= (seekpoint_t
*)malloc( sizeof( seekpoint_t
) );
92 point
->i_byte_offset
=
93 point
->i_time_offset
= -1;
95 point
->psz_name
= NULL
;
99 static inline void vlc_seekpoint_Delete( seekpoint_t
*point
)
102 free( point
->psz_name
);
106 static inline seekpoint_t
*vlc_seekpoint_Duplicate( seekpoint_t
*src
)
108 seekpoint_t
*point
= vlc_seekpoint_New();
109 if( src
->psz_name
) point
->psz_name
= strdup( src
->psz_name
);
110 point
->i_time_offset
= src
->i_time_offset
;
111 point
->i_byte_offset
= src
->i_byte_offset
;
115 /*****************************************************************************
117 *****************************************************************************/
122 bool b_menu
; /* Is it a menu or a normal entry */
124 int64_t i_length
; /* Length(microsecond) if known, else 0 */
125 int64_t i_size
; /* Size (bytes) if known, else 0 */
127 /* Title seekpoint */
129 seekpoint_t
**seekpoint
;
133 static inline input_title_t
*vlc_input_title_New(void)
135 input_title_t
*t
= (input_title_t
*)malloc( sizeof( input_title_t
) );
147 static inline void vlc_input_title_Delete( input_title_t
*t
)
154 for( i
= 0; i
< t
->i_seekpoint
; i
++ )
156 free( t
->seekpoint
[i
]->psz_name
);
157 free( t
->seekpoint
[i
] );
159 free( t
->seekpoint
);
163 static inline input_title_t
*vlc_input_title_Duplicate( input_title_t
*t
)
165 input_title_t
*dup
= vlc_input_title_New( );
168 if( t
->psz_name
) dup
->psz_name
= strdup( t
->psz_name
);
169 dup
->b_menu
= t
->b_menu
;
170 dup
->i_length
= t
->i_length
;
171 dup
->i_size
= t
->i_size
;
172 dup
->i_seekpoint
= t
->i_seekpoint
;
173 if( t
->i_seekpoint
> 0 )
175 dup
->seekpoint
= (seekpoint_t
**)calloc( t
->i_seekpoint
,
176 sizeof(seekpoint_t
*) );
178 for( i
= 0; i
< t
->i_seekpoint
; i
++ )
180 dup
->seekpoint
[i
] = vlc_seekpoint_Duplicate( t
->seekpoint
[i
] );
187 /*****************************************************************************
189 *****************************************************************************/
190 struct input_attachment_t
194 char *psz_description
;
200 static inline input_attachment_t
*vlc_input_attachment_New( const char *psz_name
,
201 const char *psz_mime
,
202 const char *psz_description
,
206 input_attachment_t
*a
=
207 (input_attachment_t
*)malloc( sizeof(input_attachment_t
) );
210 a
->psz_name
= strdup( psz_name
? psz_name
: "" );
211 a
->psz_mime
= strdup( psz_mime
? psz_mime
: "" );
212 a
->psz_description
= strdup( psz_description
? psz_description
: "" );
217 a
->p_data
= malloc( i_data
);
218 if( a
->p_data
&& p_data
)
219 memcpy( a
->p_data
, p_data
, i_data
);
223 static inline input_attachment_t
*vlc_input_attachment_Duplicate( const input_attachment_t
*a
)
225 return vlc_input_attachment_New( a
->psz_name
, a
->psz_mime
, a
->psz_description
,
226 a
->p_data
, a
->i_data
);
228 static inline void vlc_input_attachment_Delete( input_attachment_t
*a
)
234 free( a
->psz_description
);
239 /*****************************************************************************
240 * input defines/constants.
241 *****************************************************************************/
243 /* i_update field of access_t/demux_t */
244 #define INPUT_UPDATE_NONE 0x0000
245 #define INPUT_UPDATE_SIZE 0x0001
246 #define INPUT_UPDATE_TITLE 0x0010
247 #define INPUT_UPDATE_SEEKPOINT 0x0020
248 #define INPUT_UPDATE_META 0x0040
249 #define INPUT_UPDATE_SIGNAL 0x0080
252 * This defines private core storage for an input.
254 typedef struct input_thread_private_t input_thread_private_t
;
257 * This defines an opaque input resource handler.
259 typedef struct input_resource_t input_resource_t
;
262 * Main structure representing an input thread. This structure is mostly
263 * private. The only public fields are READ-ONLY. You must use the helpers
266 struct input_thread_t
274 /* All other data is input_thread is PRIVATE. You can't access it
275 * outside of src/input */
276 input_thread_private_t
*p
;
280 * Record prefix string.
281 * TODO make it configurable.
283 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
285 /*****************************************************************************
286 * Input events and variables
287 *****************************************************************************/
290 * \defgroup inputvariable Input variables
292 * The input provides multiples variable you can write to and/or read from.
294 * TODO complete the documentation.
295 * The read only variables are:
297 * - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
298 * or not, for that check position != 0.0)
302 * - "can-record" (if a stream can be recorded while playing)
303 * - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
304 * variable value being the one currently selected, -1 if no teletext)
306 * - "signal-strength"
307 * - "program-scrambled" (if the current program is scrambled)
308 * - "cache" (level of data cached [0 .. 1])
310 * The read-write variables are:
311 * - state (\see input_state_e)
312 * - rate, rate-slower, rate-faster
313 * - position, position-offset
314 * - time, time-offset
315 * - title, next-title, prev-title
316 * - chapter, next-chapter, next-chapter-prev
317 * - program, audio-es, video-es, spu-es
318 * - audio-delay, spu-delay
319 * - bookmark (bookmark list)
322 * - navigation (list of "title %2i")
325 * The variable used for event is
326 * - intf-event (\see input_event_type_e)
332 * This enum is used by the variable "state"
334 typedef enum input_state_e
347 * It is an float used by the variable "rate" in the
348 * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MAX]
349 * the default value being 1. It represents the ratio of playback speed to
350 * nominal speed (bigger is faster).
352 * Internally, the rate is stored as a value in the range
353 * [INPUT_RATE_MIN, INPUT_RATE_MAX].
354 * internal rate = INPUT_RATE_DEFAULT / rate variable
360 #define INPUT_RATE_DEFAULT 1000
364 #define INPUT_RATE_MIN 32 /* Up to 32/1 */
368 #define INPUT_RATE_MAX 32000 /* Up to 1/32 */
373 * You can catch input event by adding a callback on the variable "intf-event".
374 * This variable is an integer that will hold a input_event_type_e value.
376 typedef enum input_event_type_e
378 /* "state" has changed */
382 /* a *user* abort has been requested */
385 /* "rate" has changed */
388 /* At least one of "position" or "time" */
389 INPUT_EVENT_POSITION
,
391 /* "length" has changed */
394 /* A title has been added or removed or selected.
395 * It imply that chapter has changed (not chapter event is sent) */
397 /* A chapter has been added or removed or selected. */
400 /* A program ("program") has been added or removed or selected,
401 * or "program-scrambled" has changed.*/
403 /* A ES has been added or removed or selected */
405 /* "teletext-es" has changed */
406 INPUT_EVENT_TELETEXT
,
408 /* "record" has changed */
411 /* input_item_t media has changed */
412 INPUT_EVENT_ITEM_META
,
413 /* input_item_t info has changed */
414 INPUT_EVENT_ITEM_INFO
,
415 /* input_item_t name has changed */
416 INPUT_EVENT_ITEM_NAME
,
418 /* Input statistics have been updated */
419 INPUT_EVENT_STATISTICS
,
420 /* At least one of "signal-quality" or "signal-strength" has changed */
423 /* "audio-delay" has changed */
424 INPUT_EVENT_AUDIO_DELAY
,
425 /* "spu-delay" has changed */
426 INPUT_EVENT_SUBTITLE_DELAY
,
428 /* "bookmark" has changed */
429 INPUT_EVENT_BOOKMARK
,
431 /* cache" has changed */
434 /* A aout_instance_t object has been created/deleted by *the input* */
436 /* A vout_thread_t object has been created/deleted by *the input* */
439 } input_event_type_e
;
446 /* input variable "position" */
447 INPUT_GET_POSITION
, /* arg1= double * res= */
448 INPUT_SET_POSITION
, /* arg1= double res=can fail */
450 /* input variable "length" */
451 INPUT_GET_LENGTH
, /* arg1= int64_t * res=can fail */
453 /* input variable "time" */
454 INPUT_GET_TIME
, /* arg1= int64_t * res= */
455 INPUT_SET_TIME
, /* arg1= int64_t res=can fail */
457 /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
458 INPUT_GET_RATE
, /* arg1= int * res= */
459 INPUT_SET_RATE
, /* arg1= int res=can fail */
461 /* input variable "state" */
462 INPUT_GET_STATE
, /* arg1= int * res= */
463 INPUT_SET_STATE
, /* arg1= int res=can fail */
465 /* input variable "audio-delay" and "sub-delay" */
466 INPUT_GET_AUDIO_DELAY
, /* arg1 = int* res=can fail */
467 INPUT_SET_AUDIO_DELAY
, /* arg1 = int res=can fail */
468 INPUT_GET_SPU_DELAY
, /* arg1 = int* res=can fail */
469 INPUT_SET_SPU_DELAY
, /* arg1 = int res=can fail */
472 INPUT_ADD_INFO
, /* arg1= char* arg2= char* arg3=... res=can fail */
473 INPUT_GET_INFO
, /* arg1= char* arg2= char* arg3= char** res=can fail */
474 INPUT_DEL_INFO
, /* arg1= char* arg2= char* res=can fail */
475 INPUT_SET_NAME
, /* arg1= char* res=can fail */
477 /* Input config options */
478 INPUT_ADD_OPTION
, /* arg1= char * arg2= char * res=can fail*/
480 /* Input properties */
481 INPUT_GET_VIDEO_FPS
, /* arg1= double * res=can fail */
484 INPUT_GET_BOOKMARK
, /* arg1= seekpoint_t * res=can fail */
485 INPUT_GET_BOOKMARKS
, /* arg1= seekpoint_t *** arg2= int * res=can fail */
486 INPUT_CLEAR_BOOKMARKS
, /* res=can fail */
487 INPUT_ADD_BOOKMARK
, /* arg1= seekpoint_t * res=can fail */
488 INPUT_CHANGE_BOOKMARK
, /* arg1= seekpoint_t * arg2= int * res=can fail */
489 INPUT_DEL_BOOKMARK
, /* arg1= seekpoint_t * res=can fail */
490 INPUT_SET_BOOKMARK
, /* arg1= int res=can fail */
493 INPUT_GET_ATTACHMENTS
, /* arg1=input_attachment_t***, arg2=int* res=can fail */
494 INPUT_GET_ATTACHMENT
, /* arg1=input_attachment_t**, arg2=char* res=can fail */
496 /* On the fly input slave */
497 INPUT_ADD_SLAVE
, /* arg1= const char * */
498 INPUT_ADD_SUBTITLE
, /* arg1= const char *, arg2=bool b_check_extension */
500 /* On the fly record while playing */
501 INPUT_SET_RECORD_STATE
, /* arg1=bool res=can fail */
502 INPUT_GET_RECORD_STATE
, /* arg1=bool* res=can fail */
505 INPUT_RESTART_ES
, /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
508 * XXX You must call vlc_object_release as soon as possible */
509 INPUT_GET_AOUT
, /* arg1=aout_instance_t ** res=can fail */
510 INPUT_GET_VOUTS
, /* arg1=vout_thread_t ***, int * res=can fail */
515 /*****************************************************************************
517 *****************************************************************************/
519 #define input_Create(a,b,c,d) __input_Create(VLC_OBJECT(a),b,c,d)
520 VLC_EXPORT( input_thread_t
*, __input_Create
, ( vlc_object_t
*p_parent
, input_item_t
*, const char *psz_log
, input_resource_t
* ) );
522 #define input_CreateAndStart(a,b,c) __input_CreateAndStart(VLC_OBJECT(a),b,c)
523 VLC_EXPORT( input_thread_t
*, __input_CreateAndStart
, ( vlc_object_t
*p_parent
, input_item_t
*, const char *psz_log
) );
525 VLC_EXPORT( int, input_Start
, ( input_thread_t
* ) );
527 VLC_EXPORT( void, input_Stop
, ( input_thread_t
*, bool b_abort
) );
529 #define input_Read(a,b) __input_Read(VLC_OBJECT(a),b)
530 VLC_EXPORT( int, __input_Read
, ( vlc_object_t
*, input_item_t
* ) );
532 VLC_EXPORT( int, input_vaControl
,( input_thread_t
*, int i_query
, va_list ) );
534 VLC_EXPORT( int, input_Control
, ( input_thread_t
*, int i_query
, ... ) );
537 * Get the input item for an input thread
539 * You have to keep a reference to the input or to the input_item_t until
540 * you do not need it anymore.
542 VLC_EXPORT( input_item_t
*, input_GetItem
, ( input_thread_t
* ) );
545 * It will return the current state of the input.
546 * Provided for convenience.
548 static inline input_state_e
input_GetState( input_thread_t
* p_input
)
550 input_state_e state
= INIT_S
;
551 input_Control( p_input
, INPUT_GET_STATE
, &state
);
555 * It will add a new subtitle source to the input.
556 * Provided for convenience.
558 static inline int input_AddSubtitle( input_thread_t
*p_input
, const char *psz_url
, bool b_check_extension
)
560 return input_Control( p_input
, INPUT_ADD_SUBTITLE
, psz_url
, b_check_extension
);
564 * Return one of the video output (if any). If possible, you should use
565 * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
566 * @param p_input an input thread from which to get a video output
567 * @return NULL on error, or a video output thread pointer (which needs to be
568 * released with vlc_object_release()).
570 static inline vout_thread_t
*input_GetVout( input_thread_t
*p_input
)
572 vout_thread_t
**pp_vout
, *p_vout
;
575 if( input_Control( p_input
, INPUT_GET_VOUTS
, &pp_vout
, &i_vout
) )
578 for( size_t i
= 1; i
< i_vout
; i
++ )
579 vlc_object_release( (vlc_object_t
*)(pp_vout
[i
]) );
581 p_vout
= (i_vout
>= 1) ? pp_vout
[0] : NULL
;
587 * Return the audio output (if any) associated with an input.
588 * @param p_input an input thread
589 * @return NULL on error, or the audio output (which needs to be
590 * released with vlc_object_release()).
592 static inline aout_instance_t
*input_GetAout( input_thread_t
*p_input
)
594 aout_instance_t
*p_aout
;
595 return input_Control( p_input
, INPUT_GET_AOUT
, &p_aout
) ? NULL
: p_aout
;
599 typedef struct input_clock_t input_clock_t
;
600 VLC_EXPORT( decoder_t
*, input_DecoderNew
, ( input_thread_t
*, es_format_t
*, input_clock_t
*, sout_instance_t
* ) );
601 VLC_EXPORT( void, input_DecoderDelete
, ( decoder_t
* ) );
602 VLC_EXPORT( void, input_DecoderDecode
,( decoder_t
*, block_t
*, bool b_do_pace
) );
605 * This function allows to split a MRL into access, demux and path part.
607 * You should not write into access and demux string as they may not point into
608 * the provided buffer.
609 * The buffer provided by psz_dup will be modified.
611 VLC_EXPORT( void, input_SplitMRL
, ( const char **ppsz_access
, const char **ppsz_demux
, char **ppsz_path
, char *psz_dup
) );
614 * This function creates a sane filename path.
616 VLC_EXPORT( char *, input_CreateFilename
, ( vlc_object_t
*, const char *psz_path
, const char *psz_prefix
, const char *psz_extension
) );
619 * This function detaches resources from a dead input.
621 * It MUST be called on a dead input (p_input->b_dead true) otherwise
623 * It does not support concurrent calls.
625 VLC_EXPORT(input_resource_t
*, input_DetachResource
, ( input_thread_t
* ) );
628 * This function releases the input resource.
630 VLC_EXPORT(void, input_resource_Delete
, ( input_resource_t
* ) );