X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_input.h;h=4bac4d5a4acbfea0792890d0d3268d24e82180a8;hb=ca81e5783901f5a492d31596ec3f6998e3456958;hp=314543f276d1062c92b2c4c5b2e16c9523dc71fe;hpb=7b9e1799ee5a6330222f62801abb29f15750611c;p=vlc diff --git a/include/vlc_input.h b/include/vlc_input.h index 314543f276..4bac4d5a4a 100644 --- a/include/vlc_input.h +++ b/include/vlc_input.h @@ -22,365 +22,22 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#if !defined( __LIBVLC__ ) - #error You are not libvlc or one of its plugins. You cannot include this file -#endif - /* __ is need because conflict with */ -#ifndef _VLC__INPUT_H -#define _VLC__INPUT_H 1 +#ifndef VLC__INPUT_H +#define VLC__INPUT_H 1 + +/** + * \file + * This file defines functions, structures and enums for input objects in vlc + */ #include #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 */ - vlc_bool_t b_fixed_name; /**< Can the interface change the name ?*/ - - int i_options; /**< Number of input options */ - char **ppsz_options; /**< Array of input options */ - - mtime_t i_duration; /**< Duration in milliseconds*/ - - uint8_t i_type; /**< Type (file, disc, ...) */ - vlc_bool_t b_prefers_tree; /**< Do we prefer being displayed as tree*/ - - 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 */ - - 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 - -static inline void input_ItemCopyOptions( input_item_t *p_parent, - input_item_t *p_child ) -{ - int i; - for( i = 0 ; i< p_parent->i_options; i++ ) - { - 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; - } -} - -static inline void input_item_SetName( input_item_t *p_item, const char *psz_name ) -{ - if( p_item->psz_name ) free( p_item->psz_name ); - p_item->psz_name = strdup( 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. */ -static inline void input_ItemAddSubItem( input_item_t *p_parent, - input_item_t *p_child, - vlc_bool_t b_node ) -{ - vlc_event_t event; - - p_parent->i_type = ITEM_TYPE_PLAYLIST; - - /* Notify interested third parties */ - event.type = vlc_InputItemSubItemAdded; - event.u.input_item_subitem_added.p_new_child = p_child; - event.u.input_item_subitem_added.b_node = b_node; - vlc_event_send( &p_parent->event_manager, &event ); -} - -VLC_EXPORT( void, input_ItemAddOption,( input_item_t *, const char * ) ); -VLC_EXPORT( void, input_ItemAddOptionNoDup,( input_item_t *, const char * ) ); - -static inline void input_ItemClean( input_item_t *p_i ) -{ - int i; - - vlc_event_manager_fini( &p_i->event_manager ); - - free( p_i->psz_name ); - free( p_i->psz_uri ); - if( p_i->p_stats ) - { - vlc_mutex_destroy( &p_i->p_stats->lock ); - free( p_i->p_stats ); - } - - if( p_i->p_meta ) - vlc_meta_Delete( p_i->p_meta ); - - for( i = 0; i < p_i->i_options; i++ ) - { - if( p_i->ppsz_options[i] ) - free( p_i->ppsz_options[i] ); - } - TAB_CLEAN( p_i->i_options, p_i->ppsz_options ); - - for( i = 0; i < p_i->i_es; i++ ) - { - es_format_Clean( p_i->es[i] ); - free( p_i->es[i] ); - } - TAB_CLEAN( p_i->i_es, p_i->es ); - - for( i = 0; i < p_i->i_categories; i++ ) - { - info_category_t *p_category = p_i->pp_categories[i]; - int j; - - for( j = 0; j < p_category->i_infos; j++ ) - { - struct info_t *p_info = p_category->pp_infos[j]; - - if( p_info->psz_name ) - free( p_info->psz_name); - if( p_info->psz_value ) - free( p_info->psz_value ); - free( p_info ); - } - TAB_CLEAN( p_category->i_infos, p_category->pp_infos ); - - if( p_category->psz_name ) free( p_category->psz_name ); - free( p_category ); - } - TAB_CLEAN( p_i->i_categories, p_i->pp_categories ); - - vlc_mutex_destroy( &p_i->lock ); -} - -static inline void input_item_SetMeta( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ) -{ - vlc_event_t event; - - vlc_mutex_lock( &p_i->lock ); - if( !p_i->p_meta ) - p_i->p_meta = vlc_meta_New(); - vlc_meta_Set( p_i->p_meta, meta_type, psz_val ); - vlc_mutex_unlock( &p_i->lock ); - - /* Notify interested third parties */ - event.type = vlc_InputItemMetaChanged; - event.u.input_item_meta_changed.meta_type = meta_type; - vlc_event_send( &p_i->event_manager, &event ); -} - -static inline vlc_bool_t input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ) -{ - vlc_mutex_lock( &p_i->lock ); - if( !p_i->p_meta ) - { - vlc_mutex_unlock( &p_i->lock ); - return VLC_FALSE; - } - const char * meta = vlc_meta_Get( p_i->p_meta, meta_type ); - vlc_bool_t ret = meta && strcasestr( meta, psz ); - vlc_mutex_unlock( &p_i->lock ); - - return ret; -} - -static inline char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type ) -{ - char * psz = NULL; - vlc_mutex_lock( &p_i->lock ); - - if( !p_i->p_meta ) - { - vlc_mutex_unlock( &p_i->lock ); - return NULL; - } - - if( vlc_meta_Get( p_i->p_meta, meta_type ) ) - psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) ); - - vlc_mutex_unlock( &p_i->lock ); - return psz; -} - -static inline char * input_item_GetName( input_item_t * p_i ) -{ - vlc_mutex_lock( &p_i->lock ); - char *psz_s = p_i->psz_name ? strdup( p_i->psz_name ) : NULL; - vlc_mutex_unlock( &p_i->lock ); - return psz_s; -} - -static inline char * input_item_GetURI( input_item_t * p_i ) -{ - vlc_mutex_lock( &p_i->lock ); - char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL; - vlc_mutex_unlock( &p_i->lock ); - return psz_s; -} - -static inline void input_item_SetURI( input_item_t * p_i, char * psz_uri ) -{ - vlc_mutex_lock( &p_i->lock ); - if( p_i->psz_uri ) free( p_i->psz_uri ); - p_i->psz_uri = strdup( psz_uri ); - vlc_mutex_unlock( &p_i->lock ); -} - -static inline mtime_t input_item_GetDuration( input_item_t * p_i ) -{ - vlc_mutex_lock( &p_i->lock ); - mtime_t i_duration = p_i->i_duration; - vlc_mutex_unlock( &p_i->lock ); - return i_duration; -} - -static inline void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration ) -{ - vlc_bool_t send_event = VLC_FALSE; - - vlc_mutex_lock( &p_i->lock ); - if( p_i->i_duration != i_duration ) - { - p_i->i_duration = i_duration; - send_event = VLC_TRUE; - } - vlc_mutex_unlock( &p_i->lock ); - - if ( send_event == VLC_TRUE ) - { - vlc_event_t event; - event.type = vlc_InputItemDurationChanged; - event.u.input_item_duration_changed.new_duration = i_duration; - vlc_event_send( &p_i->event_manager, &event ); - } - - return; -} - - -static inline vlc_bool_t input_item_IsPreparsed( input_item_t *p_i ) -{ - return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : VLC_FALSE ; -} - -static inline vlc_bool_t input_item_IsMetaFetched( input_item_t *p_i ) -{ - return p_i->p_meta ? p_i->p_meta->i_status & ITEM_META_FETCHED : VLC_FALSE ; -} - - -static inline vlc_bool_t input_item_IsArtFetched( input_item_t *p_i ) -{ - return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : VLC_FALSE ; -} - -static inline const vlc_meta_t * input_item_GetMetaObject( input_item_t *p_i ) -{ - if( !p_i->p_meta ) - p_i->p_meta = vlc_meta_New(); - - return p_i->p_meta; -} - -static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p_new_meta ) -{ - if( !p_i->p_meta ) - p_i->p_meta = vlc_meta_New(); - - vlc_meta_Merge( p_i->p_meta, 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_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) ); -VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) ATTRIBUTE_FORMAT( 4, 5 ) ); - -#define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 ) -#define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f) -VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration ) ); -VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) ); - -VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) ); +#include /***************************************************************************** * Meta data helpers @@ -396,24 +53,24 @@ static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_d 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" )) ) { - p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE; + 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" )) ) { - p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE; + 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" )) ) { - p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE; + 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" )) ) { - p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE; + p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true; p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value ); } } @@ -442,7 +99,7 @@ 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 ); } @@ -462,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 */ @@ -478,7 +135,7 @@ 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; @@ -493,13 +150,13 @@ 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 ); } @@ -526,6 +183,7 @@ static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t ) return dup; } + /***************************************************************************** * Attachments *****************************************************************************/ @@ -538,6 +196,7 @@ struct input_attachment_t int i_data; void *p_data; }; + static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name, const char *psz_mime, const char *psz_description, @@ -573,45 +232,26 @@ static inline void vlc_input_attachment_Delete( input_attachment_t *a ) free( a->psz_name ); free( a->psz_mime ); free( a->psz_description ); - if( a->p_data ) - free( a->p_data ); + free( a->p_data ); free( a ); } + /***************************************************************************** * input defines/constants. *****************************************************************************/ -/* "state" value */ -enum input_state_e -{ - INIT_S, - OPENING_S, - BUFFERING_S, - PLAYING_S, - PAUSE_S, - END_S, - ERROR_S -}; - -/* "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 */ +/** Get the input item for an input thread + * FIXME see src/input/item.c but is is unsafe unless + * you hold p_input + */ VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*)); typedef struct input_thread_private_t input_thread_private_t; @@ -625,33 +265,197 @@ struct input_thread_t { VLC_COMMON_MEMBERS; - vlc_bool_t b_eof; - vlc_bool_t b_preparsing; - - int i_state; - vlc_bool_t b_can_pace_control; - int64_t i_time; /* Current time */ - - /* Internal caching common to all inputs */ - int i_pts_delay; + bool b_eof; + bool b_preparsing; + 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-%H:%M:%S-$ N-$ p" + +/***************************************************************************** + * Input events and variables + *****************************************************************************/ + +/** + * \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 integer used by the variable "rate" in the + * range [INPUT_RATE_MIN, INPUT_RATE_MAX] the default value + * being INPUT_RATE_DEFAULT. + * + * A value lower than INPUT_RATE_DEFAULT plays faster. + * A value higher than INPUT_RATE_DEFAULT plays slower. + */ + +/** + * 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" or "length" has changed */ + INPUT_EVENT_TIMES, + + /* 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 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; + +/** @}*/ + /***************************************************************************** * Prototypes *****************************************************************************/ + +/** + * It will create a new input thread. + * + * You must call input_StopThread() on it and then 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 * ) ); -#define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b) -VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) ); + +/** + * It will ask a input_thread_t to stop. + * + * b_abort must be true when a user stop is requested and not because you have + * detected an error or an eof. It will be used to properly send the + * INPUT_EVENT_ABORT event. + */ +VLC_EXPORT( void, input_StopThread, ( input_thread_t *, bool b_abort ) ); #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c) -VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) ); -VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) ); -VLC_EXPORT( void, input_DestroyThread, ( input_thread_t * ) ); +VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) ); enum input_query_e { @@ -690,11 +494,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 */ @@ -707,16 +510,97 @@ 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 ***, int * res=can fail */ }; 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 ) ); +/** + * 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; + unsigned i_vout; + + if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) ) + return NULL; + + for( unsigned 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; +} + +/* */ +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 * ) ); VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) ); VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) ); -VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) ); +/** + * 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 ) ); #endif