X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_input.h;h=9cd84a2526a0195638831bc8ee20dde35aafe10a;hb=12ade3e3bc975d5426ba4af155b7372c31093b31;hp=a244677e894fd918535a74bd0dc384553a82cfca;hpb=7b3f256f61c28c871978ddb6317c97af526dfdec;p=vlc diff --git a/include/vlc_input.h b/include/vlc_input.h index a244677e89..9cd84a2526 100644 --- a/include/vlc_input.h +++ b/include/vlc_input.h @@ -23,8 +23,8 @@ *****************************************************************************/ /* __ is need because conflict with */ -#ifndef VLC__INPUT_H -#define VLC__INPUT_H 1 +#ifndef VLC_INPUT_H +#define VLC_INPUT_H 1 /** * \file @@ -35,158 +35,9 @@ #include #include #include +#include -#include /* strcasestr() */ - -struct vlc_meta_t; - -/***************************************************************************** - * 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 -{ - VLC_GC_MEMBERS - int i_id; /**< Identifier of the item */ - - char *psz_name; /**< text describing this item */ - char *psz_uri; /**< mrl of this item */ - bool b_fixed_name; /**< Can the interface change the name ?*/ - - int i_options; /**< Number of input options */ - char **ppsz_options; /**< Array of input options */ - uint8_t *optflagv; /**< Some flags of input options */ - unsigned optflagc; - - mtime_t i_duration; /**< Duration in milliseconds*/ - - 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; /**< Es formats */ - - input_stats_t *p_stats; /**< Statistics */ - int i_nb_played; /**< Number of times played */ - - bool b_error_when_reading; /**< Error When Reading */ - - vlc_meta_t *p_meta; - - vlc_event_manager_t event_manager; - - vlc_mutex_t lock; /**< Lock for the item */ -}; - -#define ITEM_TYPE_UNKNOWN 0 -#define ITEM_TYPE_FILE 1 -#define ITEM_TYPE_DIRECTORY 2 -#define ITEM_TYPE_DISC 3 -#define ITEM_TYPE_CDDA 4 -#define ITEM_TYPE_CARD 5 -#define ITEM_TYPE_NET 6 -#define ITEM_TYPE_PLAYLIST 7 -#define ITEM_TYPE_NODE 8 -#define ITEM_TYPE_NUMBER 9 - -VLC_EXPORT( void, input_item_CopyOptions, ( input_item_t *p_parent, input_item_t *p_child ) ); -VLC_EXPORT( void, input_item_SetName, ( input_item_t *p_item, const char *psz_name ) ); - -/* This won't hold the item, but can tell to interested third parties - * Like the playlist, that there is a new sub item. With this design - * It is not the input item's responsability to keep all the ref of - * the input item children. */ -VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) ); - - -/* Flags handled past input_item_AddOpt() */ -#define VLC_INPUT_OPTION_TRUSTED 0x2 - -/* Flags handled within input_item_AddOpt() */ -#define VLC_INPUT_OPTION_UNIQUE 0x100 - -VLC_EXPORT( int, input_item_AddOpt, ( input_item_t *, const char *str, unsigned flags ) ); -VLC_EXPORT( int, input_item_AddOption, (input_item_t *item, const char *str) ); -VLC_EXPORT( int ,input_item_AddOption, (input_item_t *item, const char *str) ); -VLC_EXPORT( bool,input_item_HasErrorWhenReading, (input_item_t *item) ); -VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val )); - -VLC_EXPORT( bool,input_item_HasErrorWhenReading, (input_item_t *item) ); - -VLC_EXPORT( bool,input_item_MetaMatch, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ) ); -VLC_EXPORT( char *, input_item_GetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type ) ); -VLC_EXPORT( char *, input_item_GetName, ( input_item_t * p_i ) ); -VLC_EXPORT( char *, input_item_GetURI, ( input_item_t * p_i ) ); -VLC_EXPORT( void, input_item_SetURI, ( input_item_t * p_i, char * psz_uri )); -VLC_EXPORT(mtime_t, input_item_GetDuration, ( input_item_t * p_i ) ); -VLC_EXPORT( void, input_item_SetDuration, ( input_item_t * p_i, mtime_t i_duration )); -VLC_EXPORT( bool, input_item_IsPreparsed, ( input_item_t *p_i )); -VLC_EXPORT( bool, input_item_IsArtFetched, ( input_item_t *p_i )); -VLC_EXPORT( const vlc_meta_t *, input_item_GetMetaObject, ( input_item_t *p_i )); -VLC_EXPORT( void, input_item_MetaMerge, ( input_item_t *p_i, const vlc_meta_t * p_new_meta )); - - -#define input_item_SetTitle( item, b ) input_item_SetMeta( item, vlc_meta_Title, b ) -#define input_item_SetArtist( item, b ) input_item_SetMeta( item, vlc_meta_Artist, b ) -#define input_item_SetGenre( item, b ) input_item_SetMeta( item, vlc_meta_Genre, b ) -#define input_item_SetCopyright( item, b ) input_item_SetMeta( item, vlc_meta_Copyright, b ) -#define input_item_SetAlbum( item, b ) input_item_SetMeta( item, vlc_meta_Album, b ) -#define input_item_SetTrackNum( item, b ) input_item_SetMeta( item, vlc_meta_TrackNumber, b ) -#define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b ) -#define input_item_SetRating( item, b ) input_item_SetMeta( item, vlc_meta_Rating, b ) -#define input_item_SetDate( item, b ) input_item_SetMeta( item, vlc_meta_Date, b ) -#define input_item_SetSetting( item, b ) input_item_SetMeta( item, vlc_meta_Setting, b ) -#define input_item_SetURL( item, b ) input_item_SetMeta( item, vlc_meta_URL, b ) -#define input_item_SetLanguage( item, b ) input_item_SetMeta( item, vlc_meta_Language, b ) -#define input_item_SetNowPlaying( item, b ) input_item_SetMeta( item, vlc_meta_NowPlaying, b ) -#define input_item_SetPublisher( item, b ) input_item_SetMeta( item, vlc_meta_Publisher, b ) -#define input_item_SetEncodedBy( item, b ) input_item_SetMeta( item, vlc_meta_EncodedBy, b ) -#define input_item_SetArtURL( item, b ) input_item_SetMeta( item, vlc_meta_ArtworkURL, b ) -#define input_item_SetTrackID( item, b ) input_item_SetMeta( item, vlc_meta_TrackID, b ) - -#define input_item_GetTitle( item ) input_item_GetMeta( item, vlc_meta_Title ) -#define input_item_GetArtist( item ) input_item_GetMeta( item, vlc_meta_Artist ) -#define input_item_GetGenre( item ) input_item_GetMeta( item, vlc_meta_Genre ) -#define input_item_GetCopyright( item ) input_item_GetMeta( item, vlc_meta_Copyright ) -#define input_item_GetAlbum( item ) input_item_GetMeta( item, vlc_meta_Album ) -#define input_item_GetTrackNum( item ) input_item_GetMeta( item, vlc_meta_TrackNumber ) -#define input_item_GetDescription( item ) input_item_GetMeta( item, vlc_meta_Description ) -#define input_item_GetRating( item ) input_item_GetMeta( item, vlc_meta_Rating ) -#define input_item_GetDate( item ) input_item_GetMeta( item, vlc_meta_Date ) -#define input_item_GetGetting( item ) input_item_GetMeta( item, vlc_meta_Getting ) -#define input_item_GetURL( item ) input_item_GetMeta( item, vlc_meta_URL ) -#define input_item_GetLanguage( item ) input_item_GetMeta( item, vlc_meta_Language ) -#define input_item_GetNowPlaying( item ) input_item_GetMeta( item, vlc_meta_NowPlaying ) -#define input_item_GetPublisher( item ) input_item_GetMeta( item, vlc_meta_Publisher ) -#define input_item_GetEncodedBy( item ) input_item_GetMeta( item, vlc_meta_EncodedBy ) -#define input_item_GetArtURL( item ) input_item_GetMeta( item, vlc_meta_ArtworkURL ) -#define input_item_GetTrackID( item ) input_item_GetMeta( item, vlc_meta_TrackID ) -#define input_item_GetSetting( item ) input_item_GetMeta( item, vlc_meta_Setting ) - -VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) ); -VLC_EXPORT(int, input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) LIBVLC_FORMAT( 4, 5 ) ); - -#define input_item_New( a,b,c ) input_item_NewExt( a, b, c, 0, NULL, -1 ) -#define input_item_NewExt(a,b,c,d,e,f) __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f) -VLC_EXPORT( input_item_t *, __input_item_NewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration ) ); -VLC_EXPORT( input_item_t *, input_item_NewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) ); - -#define input_item_GetById(a,b) __input_item_GetById( VLC_OBJECT(a),b ) -VLC_EXPORT( input_item_t *, __input_item_GetById, (vlc_object_t *, int ) ); +#include /***************************************************************************** * Meta data helpers @@ -194,30 +45,30 @@ VLC_EXPORT( input_item_t *, __input_item_GetById, (vlc_object_t *, int ) ); static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst, const vlc_meta_t *p_meta ) { - char * psz_value; + const char * psz_value; if( !p_meta ) return; - if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) || - (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) ) + if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_GAIN")) || + (psz_value = vlc_meta_GetExtra(p_meta, "RG_RADIO")) ) { p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true; p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value ); } - else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) || - (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) ) + else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_PEAK" )) || + (psz_value = vlc_meta_GetExtra(p_meta, "RG_PEAK" )) ) { p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true; p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value ); } - else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) || - (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) ) + else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_GAIN" )) || + (psz_value = vlc_meta_GetExtra(p_meta, "RG_AUDIOPHILE" )) ) { p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true; p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value ); } - else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) ) + else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_PEAK" )) ) { p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true; p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value ); @@ -252,7 +103,7 @@ static inline void vlc_seekpoint_Delete( seekpoint_t *point ) 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 ); @@ -309,7 +160,7 @@ static inline void vlc_input_title_Delete( input_title_t *t ) 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; @@ -389,46 +240,24 @@ static inline void vlc_input_attachment_Delete( input_attachment_t *a ) * input defines/constants. *****************************************************************************/ -/* "state" value */ -/* NOTE: you need to update ppsz_input_state in the RC interface - * if you modify this list. */ -typedef enum input_state_e -{ - INIT_S = 0, - OPENING_S, - BUFFERING_S, - PLAYING_S, - PAUSE_S, - STOP_S, - FORWARD_S, - BACKWARD_S, - END_S, - ERROR_S, -} input_state_e; - -/* "rate" default, min/max - * A rate below 1000 plays the movie faster, - * A rate above 1000 plays the movie slower. - */ -#define INPUT_RATE_DEFAULT 1000 -#define INPUT_RATE_MIN 125 /* Up to 8/1 */ -#define INPUT_RATE_MAX 32000 /* Up to 1/32 */ - /* i_update field of access_t/demux_t */ #define INPUT_UPDATE_NONE 0x0000 #define INPUT_UPDATE_SIZE 0x0001 #define INPUT_UPDATE_TITLE 0x0010 #define INPUT_UPDATE_SEEKPOINT 0x0020 #define INPUT_UPDATE_META 0x0040 +#define INPUT_UPDATE_SIGNAL 0x0080 -/* Input control XXX: internal */ -#define INPUT_CONTROL_FIFO_SIZE 100 - -/** Get the input item for an input thread */ -VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*)); - +/** + * 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 @@ -436,39 +265,185 @@ typedef struct input_thread_private_t input_thread_private_t; */ struct input_thread_t { - VLC_COMMON_MEMBERS; + VLC_COMMON_MEMBERS - bool b_eof; + bool b_error; + bool b_eof; bool b_preparsing; - - int i_state; - bool b_can_pace_control; - int64_t i_time; /* Current time */ - - /* Internal caching common to all inputs */ - mtime_t i_pts_delay; + bool b_dead; /* 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 *****************************************************************************/ -/* input_CreateThread - * Release the returned input_thread_t using vlc_object_release() */ -#define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b) -VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_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) + */ -#define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b) -VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) ); +/** + * 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; -#define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c) -VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) ); -VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) ); +/** + * 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" */ @@ -482,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 */ @@ -498,6 +473,8 @@ enum input_query_e /* Meta datas */ 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 */ @@ -506,11 +483,10 @@ enum input_query_e 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 */ @@ -523,24 +499,182 @@ enum input_query_e 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, ... ) ); +/** + * 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; } -VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, bool b_force_decoder ) ); +/** + * 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 * ) ); -VLC_EXPORT( bool, input_AddSubtitles, ( input_thread_t *, char *, bool ) ); +/** + * Forcefully destroys the video output (e.g. when the playlist is stopped). + */ +VLC_EXPORT(void, input_resource_TerminateVout, ( input_resource_t * ) ); -VLC_EXPORT( vlc_event_manager_t *, input_get_event_manager, ( input_thread_t * ) ); +/** + * This function releases all resources (object). + */ +VLC_EXPORT( void, input_resource_Terminate, ( input_resource_t * ) ); #endif