X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_input.h;h=9cd84a2526a0195638831bc8ee20dde35aafe10a;hb=3118165aefce584687fd67953e477fbbdf7e1bcb;hp=205aa06932b8e34bac86352783a18c2ebacd69fc;hpb=01aca2cc006e2c2ef00bc5ca723180e27ab15a76;p=vlc diff --git a/include/vlc_input.h b/include/vlc_input.h index 205aa06932..9cd84a2526 100644 --- a/include/vlc_input.h +++ b/include/vlc_input.h @@ -1,8 +1,8 @@ /***************************************************************************** - * vlc_input.h: + * vlc_input.h: Core input structures ***************************************************************************** - * Copyright (C) 1999-2004 VideoLAN - * $Id: input_ext-intf.h 7954 2004-06-07 22:19:12Z fenrir $ + * Copyright (C) 1999-2006 the VideoLAN team + * $Id$ * * Authors: Christophe Massiot * Laurent Aimar @@ -19,140 +19,60 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ /* __ is need because conflict with */ -#ifndef _VLC__INPUT_H -#define _VLC__INPUT_H 1 +#ifndef VLC_INPUT_H +#define VLC_INPUT_H 1 -/***************************************************************************** - * input_item_t: Describes an input and is used to spawn input_thread_t objects - *****************************************************************************/ -struct info_t -{ - char *psz_name; /**< Name of this info */ - char *psz_value; /**< Value of the info */ -}; - -struct info_category_t -{ - char *psz_name; /**< Name of this category */ - int i_infos; /**< Number of infos in the category */ - struct info_t **pp_infos; /**< Pointer to an array of infos */ -}; - -struct input_item_t -{ - char *psz_name; /**< text describing this item */ - char *psz_uri; /**< mrl of this item */ +/** + * \file + * This file defines functions, structures and enums for input objects in vlc + */ - int i_options; /**< Number of input options */ - char **ppsz_options; /**< Array of input options */ +#include +#include +#include +#include +#include - mtime_t i_duration; /**< A hint about the duration of this - * item, in milliseconds*/ +#include - int i_id; /**< Identifier of the item */ - uint8_t i_type; /**< Type (file, disc, ...) */ - - int i_categories; /**< Number of info categories */ - info_category_t **pp_categories; /**< Pointer to the first info category */ - - int i_es; /**< Number of es format descriptions */ - es_format_t **es; /**< Pointer to an array of es formats */ - - vlc_bool_t b_fixed_name; /**< Can the interface change the name ?*/ - - vlc_mutex_t lock; /**< Item cannot be changed without this lock */ -}; - -#define ITEM_TYPE_UNKNOWN 0 -#define ITEM_TYPE_FILE 1 -#define ITEM_TYPE_DIRECTORY 2 -#define ITEM_TYPE_DISC 3 -#define ITEM_TYPE_CARD 4 -#define ITEM_TYPE_NET 5 -#define ITEM_TYPE_PLAYLIST 6 - -static inline void vlc_input_item_Init( vlc_object_t *p_o, input_item_t *p_i ) +/***************************************************************************** + * Meta data helpers + *****************************************************************************/ +static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst, + const vlc_meta_t *p_meta ) { - memset( p_i, 0, sizeof(input_item_t) ); - p_i->i_options = 0; - p_i->i_es = 0; - p_i->i_categories = 0 ; - p_i->psz_name = 0; - p_i->psz_uri = 0; - p_i->ppsz_options = 0; - p_i->pp_categories = 0; - p_i->es = 0; - p_i->i_type = ITEM_TYPE_UNKNOWN; - p_i->b_fixed_name = VLC_TRUE; - vlc_mutex_init( p_o, &p_i->lock ); -} + const char * psz_value; -static inline void vlc_input_item_CopyOptions( input_item_t *p_parent, - input_item_t *p_child ) -{ - int i; - for( i = 0 ; i< p_parent->i_options; i++ ) + if( !p_meta ) + return; + + if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_GAIN")) || + (psz_value = vlc_meta_GetExtra(p_meta, "RG_RADIO")) ) { - char *psz_option= strdup( p_parent->ppsz_options[i] ); - p_child->i_options++; - p_child->ppsz_options = (char **)realloc( p_child->ppsz_options, - p_child->i_options * - sizeof( char * ) ); - p_child->ppsz_options[p_child->i_options-1] = psz_option; + p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true; + p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value ); } -} - -static inline void vlc_input_item_Clean( input_item_t *p_i ) -{ - if( p_i->psz_name ) free( p_i->psz_name ); - if( p_i->psz_uri ) free( p_i->psz_uri ); - p_i->psz_name = 0; - p_i->psz_uri = 0; - - while( p_i->i_options ) + else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_PEAK" )) || + (psz_value = vlc_meta_GetExtra(p_meta, "RG_PEAK" )) ) { - p_i->i_options--; - if( p_i->ppsz_options[p_i->i_options] ) - free( p_i->ppsz_options[p_i->i_options] ); - if( !p_i->i_options ) free( p_i->ppsz_options ); + p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true; + p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value ); } - - while( p_i->i_es ) + else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_GAIN" )) || + (psz_value = vlc_meta_GetExtra(p_meta, "RG_AUDIOPHILE" )) ) { - p_i->i_es--; - es_format_Clean( p_i->es[p_i->i_es] ); - if( !p_i->i_es ) free( p_i->es ); + p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true; + p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value ); } - - while( p_i->i_categories ) + else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_PEAK" )) ) { - info_category_t *p_category = - p_i->pp_categories[--(p_i->i_categories)]; - - while( p_category->i_infos ) - { - p_category->i_infos--; - - if( p_category->pp_infos[p_category->i_infos]->psz_name ) - free( p_category->pp_infos[p_category->i_infos]->psz_name); - if( p_category->pp_infos[p_category->i_infos]->psz_value ) - free( p_category->pp_infos[p_category->i_infos]->psz_value ); - free( p_category->pp_infos[p_category->i_infos] ); - - if( !p_category->i_infos ) free( p_category->pp_infos ); - } - - if( p_category->psz_name ) free( p_category->psz_name ); - free( p_category ); - - if( !p_i->i_categories ) free( p_i->pp_categories ); + p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true; + p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value ); } - - vlc_mutex_destroy( &p_i->lock ); } /***************************************************************************** @@ -163,13 +83,15 @@ struct seekpoint_t int64_t i_byte_offset; int64_t i_time_offset; char *psz_name; + int i_level; }; static inline seekpoint_t *vlc_seekpoint_New( void ) { seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) ); point->i_byte_offset = - point->i_time_offset = 0; + point->i_time_offset = -1; + point->i_level = 0; point->psz_name = NULL; return point; } @@ -177,11 +99,11 @@ static inline seekpoint_t *vlc_seekpoint_New( void ) static inline void vlc_seekpoint_Delete( seekpoint_t *point ) { if( !point ) return; - if( point->psz_name ) free( point->psz_name ); + free( point->psz_name ); free( point ); } -static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src ) +static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src ) { seekpoint_t *point = vlc_seekpoint_New(); if( src->psz_name ) point->psz_name = strdup( src->psz_name ); @@ -197,7 +119,7 @@ typedef struct { char *psz_name; - vlc_bool_t b_menu; /* Is it a menu or a normal entry */ + bool b_menu; /* Is it a menu or a normal entry */ int64_t i_length; /* Length(microsecond) if known, else 0 */ int64_t i_size; /* Size (bytes) if known, else 0 */ @@ -208,12 +130,12 @@ typedef struct } input_title_t; -static inline input_title_t *vlc_input_title_New( ) +static inline input_title_t *vlc_input_title_New(void) { input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) ); t->psz_name = NULL; - t->b_menu = VLC_FALSE; + t->b_menu = false; t->i_length = 0; t->i_size = 0; t->i_seekpoint = 0; @@ -228,17 +150,17 @@ static inline void vlc_input_title_Delete( input_title_t *t ) if( t == NULL ) return; - if( t->psz_name ) free( t->psz_name ); + free( t->psz_name ); for( i = 0; i < t->i_seekpoint; i++ ) { - if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name ); + free( t->seekpoint[i]->psz_name ); free( t->seekpoint[i] ); } - if( t->seekpoint ) free( t->seekpoint ); + free( t->seekpoint ); free( t ); } -static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t ) +static inline input_title_t *vlc_input_title_Duplicate( const input_title_t *t ) { input_title_t *dup = vlc_input_title_New( ); int i; @@ -263,56 +185,60 @@ static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t ) } /***************************************************************************** - * input defines/constants. + * Attachments *****************************************************************************/ - -/* "state" value */ -enum input_state_e +struct input_attachment_t { - INIT_S, - PLAYING_S, - PAUSE_S, - END_S, -}; + char *psz_name; + char *psz_mime; + char *psz_description; -/* "rate" default, min/max */ -#define INPUT_RATE_DEFAULT 1000 -#define INPUT_RATE_MIN 125 /* Up to 8/1 */ -#define INPUT_RATE_MAX 8000 /* Up to 1/8 */ + int i_data; + void *p_data; +}; -/* input_source_t: gathers all information per input source */ -typedef struct +static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name, + const char *psz_mime, + const char *psz_description, + const void *p_data, + int i_data ) { - /* Input item description */ - input_item_t *p_item; - - /* Access/Stream/Demux plugins */ - access_t *p_access; - stream_t *p_stream; - demux_t *p_demux; - - /* Title infos for that input */ - vlc_bool_t b_title_demux; /* Titles/Seekpoints provided by demux */ - int i_title; - input_title_t **title; - - int i_title_offset; - int i_seekpoint_offset; - - int i_title_start; - int i_title_end; - int i_seekpoint_start; - int i_seekpoint_end; - - /* Properties */ - vlc_bool_t b_can_pace_control; - vlc_bool_t b_can_pause; - vlc_bool_t b_eof; /* eof of demuxer */ - - /* Clock average variation */ - int i_cr_average; + input_attachment_t *a = + (input_attachment_t*)malloc( sizeof(input_attachment_t) ); + if( !a ) + return NULL; + a->psz_name = strdup( psz_name ? psz_name : "" ); + a->psz_mime = strdup( psz_mime ? psz_mime : "" ); + a->psz_description = strdup( psz_description ? psz_description : "" ); + a->i_data = i_data; + a->p_data = NULL; + if( i_data > 0 ) + { + a->p_data = malloc( i_data ); + if( a->p_data && p_data ) + memcpy( a->p_data, p_data, i_data ); + } + return a; +} +static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a ) +{ + return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description, + a->p_data, a->i_data ); +} +static inline void vlc_input_attachment_Delete( input_attachment_t *a ) +{ + if( !a ) + return; + free( a->psz_name ); + free( a->psz_mime ); + free( a->psz_description ); + free( a->p_data ); + free( a ); +} -} input_source_t; +/***************************************************************************** + * input defines/constants. + *****************************************************************************/ /* i_update field of access_t/demux_t */ #define INPUT_UPDATE_NONE 0x0000 @@ -320,89 +246,204 @@ typedef struct #define INPUT_UPDATE_TITLE 0x0010 #define INPUT_UPDATE_SEEKPOINT 0x0020 #define INPUT_UPDATE_META 0x0040 - -/* Input control XXX: internal */ -#define INPUT_CONTROL_FIFO_SIZE 100 - -/***************************************************************************** - * input_thread_t - ***************************************************************************** - * XXX: this strucrures is *PRIVATE* so nobody can touch it out of src/input. - * I plan to move it to src/input/input_internal.h anyway - * - * XXX: look at src/input/input.c:input_CreateThread for accessible variables - * YOU CANNOT HAVE ACCESS TO THE CONTENT OF input_thread_t except - * p_input->input.p_item (and it's only temporary). - * XXX: move the docs somewhere (better than src/input ) - *****************************************************************************/ +#define INPUT_UPDATE_SIGNAL 0x0080 + +/** + * This defines private core storage for an input. + */ +typedef struct input_thread_private_t input_thread_private_t; + +/** + * This defines an opaque input resource handler. + */ +typedef struct input_resource_t input_resource_t; + +/** + * Main structure representing an input thread. This structure is mostly + * private. The only public fields are READ-ONLY. You must use the helpers + * to modify them + */ struct input_thread_t { VLC_COMMON_MEMBERS - /* Global properties */ - vlc_bool_t b_eof; - vlc_bool_t b_can_pace_control; - vlc_bool_t b_can_pause; - - /* Global state */ - int i_state; - int i_rate; - - /* */ - int64_t i_start; /* :start-time,0 by default */ - int64_t i_time; /* Current time */ - int64_t i_stop; /* :stop-time, 0 if none */ + bool b_error; + bool b_eof; + bool b_preparsing; + bool b_dead; - /* Title infos FIXME multi-input (not easy) ? */ - int i_title; - input_title_t **title; - - int i_title_offset; - int i_seekpoint_offset; - - /* User bookmarks FIXME won't be easy with multiples input */ - int i_bookmark; - seekpoint_t **bookmark; - - /* Global meta datas FIXME move to input_item_t ? */ - vlc_meta_t *p_meta; - - /* Output */ - es_out_t *p_es_out; - sout_instance_t *p_sout; /* XXX Move it to es_out ? */ - vlc_bool_t b_out_pace_control; /* idem ? */ - - /* Internal caching common for all inputs */ - int64_t i_pts_delay; - - /* Main input properties */ - input_source_t input; - - /* Slave demuxers (subs, and others) */ - int i_slave; - input_source_t **slave; - - /* Buffer of pending actions */ - vlc_mutex_t lock_control; - int i_control; - struct - { - /* XXX: val isn't duplicated so it won't works with string */ - int i_type; - vlc_value_t val; - } control[INPUT_CONTROL_FIFO_SIZE]; + /* All other data is input_thread is PRIVATE. You can't access it + * outside of src/input */ + input_thread_private_t *p; }; +/** + * Record prefix string. + * TODO make it configurable. + */ +#define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p" + /***************************************************************************** - * Prototypes + * Input events and variables *****************************************************************************/ -#define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b) -VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) ); -#define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b) -VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) ); -VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) ); -VLC_EXPORT( void, input_DestroyThread, ( input_thread_t * ) ); +/** + * \defgroup inputvariable Input variables + * + * The input provides multiples variable you can write to and/or read from. + * + * TODO complete the documentation. + * The read only variables are: + * - "length" + * - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown + * or not, for that check position != 0.0) + * - "can-pause" + * - "can-rate" + * - "can-rewind" + * - "can-record" (if a stream can be recorded while playing) + * - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the + * variable value being the one currently selected, -1 if no teletext) + * - "signal-quality" + * - "signal-strength" + * - "program-scrambled" (if the current program is scrambled) + * - "cache" (level of data cached [0 .. 1]) + * + * The read-write variables are: + * - state (\see input_state_e) + * - rate, rate-slower, rate-faster + * - position, position-offset + * - time, time-offset + * - title, next-title, prev-title + * - chapter, next-chapter, next-chapter-prev + * - program, audio-es, video-es, spu-es + * - audio-delay, spu-delay + * - bookmark (bookmark list) + * - record + * - frame-next + * - navigation (list of "title %2i") + * - "title %2i" + * + * The variable used for event is + * - intf-event (\see input_event_type_e) + */ + +/** + * Input state + * + * This enum is used by the variable "state" + */ +typedef enum input_state_e +{ + INIT_S = 0, + OPENING_S, + PLAYING_S, + PAUSE_S, + END_S, + ERROR_S, +} input_state_e; + +/** + * Input rate. + * + * It is an float used by the variable "rate" in the + * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MAX] + * the default value being 1. It represents the ratio of playback speed to + * nominal speed (bigger is faster). + * + * Internally, the rate is stored as a value in the range + * [INPUT_RATE_MIN, INPUT_RATE_MAX]. + * internal rate = INPUT_RATE_DEFAULT / rate variable + */ + +/** + * Default rate value + */ +#define INPUT_RATE_DEFAULT 1000 +/** + * Minimal rate value + */ +#define INPUT_RATE_MIN 32 /* Up to 32/1 */ +/** + * Maximal rate value + */ +#define INPUT_RATE_MAX 32000 /* Up to 1/32 */ + +/** + * Input events + * + * You can catch input event by adding a callback on the variable "intf-event". + * This variable is an integer that will hold a input_event_type_e value. + */ +typedef enum input_event_type_e +{ + /* "state" has changed */ + INPUT_EVENT_STATE, + /* b_dead is true */ + INPUT_EVENT_DEAD, + /* a *user* abort has been requested */ + INPUT_EVENT_ABORT, + + /* "rate" has changed */ + INPUT_EVENT_RATE, + + /* At least one of "position" or "time" */ + INPUT_EVENT_POSITION, + + /* "length" has changed */ + INPUT_EVENT_LENGTH, + + /* A title has been added or removed or selected. + * It imply that chapter has changed (not chapter event is sent) */ + INPUT_EVENT_TITLE, + /* A chapter has been added or removed or selected. */ + INPUT_EVENT_CHAPTER, + + /* A program ("program") has been added or removed or selected, + * or "program-scrambled" has changed.*/ + INPUT_EVENT_PROGRAM, + /* A ES has been added or removed or selected */ + INPUT_EVENT_ES, + /* "teletext-es" has changed */ + INPUT_EVENT_TELETEXT, + + /* "record" has changed */ + INPUT_EVENT_RECORD, + + /* input_item_t media has changed */ + INPUT_EVENT_ITEM_META, + /* input_item_t info has changed */ + INPUT_EVENT_ITEM_INFO, + /* input_item_t name has changed */ + INPUT_EVENT_ITEM_NAME, + /* input_item_t epg has changed */ + INPUT_EVENT_ITEM_EPG, + + /* Input statistics have been updated */ + INPUT_EVENT_STATISTICS, + /* At least one of "signal-quality" or "signal-strength" has changed */ + INPUT_EVENT_SIGNAL, + + /* "audio-delay" has changed */ + INPUT_EVENT_AUDIO_DELAY, + /* "spu-delay" has changed */ + INPUT_EVENT_SUBTITLE_DELAY, + + /* "bookmark" has changed */ + INPUT_EVENT_BOOKMARK, + + /* cache" has changed */ + INPUT_EVENT_CACHE, + + /* A aout_instance_t object has been created/deleted by *the input* */ + INPUT_EVENT_AOUT, + /* A vout_thread_t object has been created/deleted by *the input* */ + INPUT_EVENT_VOUT, + +} input_event_type_e; + +/** + * Input queries + */ enum input_query_e { /* input variable "position" */ @@ -416,7 +457,7 @@ enum input_query_e INPUT_GET_TIME, /* arg1= int64_t * res= */ INPUT_SET_TIME, /* arg1= int64_t res=can fail */ - /* input variable "rate" (1 is DEFAULT_RATE) */ + /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */ INPUT_GET_RATE, /* arg1= int * res= */ INPUT_SET_RATE, /* arg1= int res=can fail */ @@ -424,25 +465,28 @@ enum input_query_e INPUT_GET_STATE, /* arg1= int * res= */ INPUT_SET_STATE, /* arg1= int res=can fail */ - /* input variable "audio-delay" and "spu-delay" */ + /* input variable "audio-delay" and "sub-delay" */ INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */ INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */ INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */ INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */ /* Meta datas */ - INPUT_ADD_INFO, /* arg1= char * arg2= char * arg3=... res=can fail */ - INPUT_GET_INFO, /* arg1= char * arg2= char * arg3= char ** res=can fail*/ - INPUT_SET_NAME, /* arg1= char * res=can fail */ + INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */ + INPUT_REPLACE_INFOS,/* arg1= info_category_t * res=cannot fail */ + INPUT_MERGE_INFOS,/* arg1= info_category_t * res=cannot fail */ + INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */ + INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */ + INPUT_SET_NAME, /* arg1= char* res=can fail */ /* Input config options */ INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/ /* Input properties */ - INPUT_GET_BYTE_POSITION, /* arg1= int64_t * res= */ - INPUT_SET_BYTE_SIZE, /* arg1= int64_t * res= */ + INPUT_GET_VIDEO_FPS, /* arg1= double * res=can fail */ /* bookmarks */ + INPUT_GET_BOOKMARK, /* arg1= seekpoint_t * res=can fail */ INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */ INPUT_CLEAR_BOOKMARKS, /* res=can fail */ INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */ @@ -450,15 +494,187 @@ enum input_query_e INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */ INPUT_SET_BOOKMARK, /* arg1= int res=can fail */ + /* Attachments */ + INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int* res=can fail */ + INPUT_GET_ATTACHMENT, /* arg1=input_attachment_t**, arg2=char* res=can fail */ + /* On the fly input slave */ - INPUT_ADD_SLAVE, /* arg1= char * */ + INPUT_ADD_SLAVE, /* arg1= const char * */ + INPUT_ADD_SUBTITLE, /* arg1= const char *, arg2=bool b_check_extension */ + + /* On the fly record while playing */ + INPUT_SET_RECORD_STATE, /* arg1=bool res=can fail */ + INPUT_GET_RECORD_STATE, /* arg1=bool* res=can fail */ + + /* ES */ + INPUT_RESTART_ES, /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */ + + /* Input ressources + * XXX You must call vlc_object_release as soon as possible */ + INPUT_GET_AOUT, /* arg1=aout_instance_t ** res=can fail */ + INPUT_GET_VOUTS, /* arg1=vout_thread_t ***, size_t * res=can fail */ + INPUT_GET_ES_OBJECTS, /* arg1=int id, vlc_object_t **dec, vout_thread_t **, aout_instance_t ** */ + + /* External clock managments */ + INPUT_GET_PCR_SYSTEM, /* arg1=mtime_t *, arg2=mtime_t * res=can fail */ + INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t res=can fail */ }; +/** @}*/ + +/***************************************************************************** + * Prototypes + *****************************************************************************/ + +VLC_EXPORT( input_thread_t *, input_Create, ( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) LIBVLC_USED ); +#define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d) + +VLC_EXPORT( input_thread_t *, input_CreateAndStart, ( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) LIBVLC_USED ); +#define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c) + +VLC_EXPORT( int, input_Start, ( input_thread_t * ) ); + +VLC_EXPORT( void, input_Stop, ( input_thread_t *, bool b_abort ) ); + +VLC_EXPORT( int, input_Read, ( vlc_object_t *, input_item_t * ) ); +#define input_Read(a,b) input_Read(VLC_OBJECT(a),b) + VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) ); + VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) ); -VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) ); +/** + * Get the input item for an input thread + * + * You have to keep a reference to the input or to the input_item_t until + * you do not need it anymore. + */ +VLC_EXPORT( input_item_t*, input_GetItem, ( input_thread_t * ) LIBVLC_USED ); + +/** + * It will return the current state of the input. + * Provided for convenience. + */ +static inline input_state_e input_GetState( input_thread_t * p_input ) +{ + input_state_e state = INIT_S; + input_Control( p_input, INPUT_GET_STATE, &state ); + return state; +} +/** + * It will add a new subtitle source to the input. + * Provided for convenience. + */ +static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension ) +{ + return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension ); +} + +/** + * Return one of the video output (if any). If possible, you should use + * INPUT_GET_VOUTS directly and process _all_ video outputs instead. + * @param p_input an input thread from which to get a video output + * @return NULL on error, or a video output thread pointer (which needs to be + * released with vlc_object_release()). + */ +static inline vout_thread_t *input_GetVout( input_thread_t *p_input ) +{ + vout_thread_t **pp_vout, *p_vout; + size_t i_vout; + + if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) ) + return NULL; + + for( size_t i = 1; i < i_vout; i++ ) + vlc_object_release( (vlc_object_t *)(pp_vout[i]) ); + + p_vout = (i_vout >= 1) ? pp_vout[0] : NULL; + free( pp_vout ); + return p_vout; +} + +/** + * Return the audio output (if any) associated with an input. + * @param p_input an input thread + * @return NULL on error, or the audio output (which needs to be + * released with vlc_object_release()). + */ +static inline aout_instance_t *input_GetAout( input_thread_t *p_input ) +{ + aout_instance_t *p_aout; + return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout; +} + +/** + * Returns the objects associated to an ES. + * + * You must release all non NULL object using vlc_object_release. + * You may set pointer of pointer to NULL to avoid retreiving it. + */ +static inline int input_GetEsObjects( input_thread_t *p_input, int i_id, + vlc_object_t **pp_decoder, + vout_thread_t **pp_vout, aout_instance_t **pp_aout ) +{ + return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id, + pp_decoder, pp_vout, pp_aout ); +} + +/** + * \see input_clock_GetSystemOrigin + */ +static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay ) +{ + return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay ); +} +/** + * \see input_clock_ChangeSystemOrigin + */ +static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, mtime_t i_system ) +{ + return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system ); +} + +/* */ +typedef struct input_clock_t input_clock_t; +VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, input_clock_t *, sout_instance_t * ) LIBVLC_USED ); VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) ); -VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) ); +VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t *, bool b_do_pace ) ); + +/** + * This function allows to split a MRL into access, demux and path part. + * + * You should not write into access and demux string as they may not point into + * the provided buffer. + * The buffer provided by psz_dup will be modified. + */ +VLC_EXPORT( void, input_SplitMRL, ( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup ) ); + +/** + * This function creates a sane filename path. + */ +VLC_EXPORT( char *, input_CreateFilename, ( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) LIBVLC_USED ); + +/** + * It creates an empty input resource handler. + * + * The given object MUST stay alive as long as the input_resource_t is + * not deleted. + */ +VLC_EXPORT( input_resource_t *, input_resource_New, ( vlc_object_t * ) LIBVLC_USED ); + +/** + * It releases an input resource. + */ +VLC_EXPORT(void, input_resource_Release, ( input_resource_t * ) ); + +/** + * Forcefully destroys the video output (e.g. when the playlist is stopped). + */ +VLC_EXPORT(void, input_resource_TerminateVout, ( input_resource_t * ) ); + +/** + * This function releases all resources (object). + */ +VLC_EXPORT( void, input_resource_Terminate, ( input_resource_t * ) ); #endif