X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_input.h;h=d1619a5c0d3934d67fdbf57f4910e14d292bc7e8;hb=c777b5549a25fb17b8094f84bbc221c3aa6a97fb;hp=94ce851f7774de8c3d4ae014bafe9cfaa5c259ef;hpb=4d60f5b6a736b07736e6f1c83bd3f59962a1adcc;p=vlc diff --git a/include/vlc_input.h b/include/vlc_input.h index 94ce851f77..d1619a5c0d 100644 --- a/include/vlc_input.h +++ b/include/vlc_input.h @@ -35,151 +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, ...) */ - bool 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 */ - - 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 *, const char * ) ); -VLC_EXPORT( bool, input_item_HasErrorWhenReading, ( input_item_t * ) ); -VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val )); -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 )); - - -#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 ) ); -VLC_EXPORT( int, input_item_DelInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name ) ); - -#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 ) ); +#include /***************************************************************************** * Meta data helpers @@ -411,18 +269,17 @@ struct input_thread_t bool b_preparsing; bool b_dead; - 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; - /* 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 *****************************************************************************/ @@ -435,7 +292,6 @@ struct input_thread_t * TODO complete the documentation. * The read only variables are: * - "length" - * - "bookmarks" * - "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" @@ -445,6 +301,7 @@ struct input_thread_t * - "teletext-es" to get the index of spu track that is teletext -1 if no teletext) * - "signal-quality" * - "signal-strength" + * - "cache" (level of data cached [0 .. 1]) * * The read-write variables are: * - state (\see input_state_e) @@ -455,7 +312,7 @@ struct input_thread_t * - chapter, next-chapter, next-chapter-prev * - program, audio-es, video-es, spu-es * - audio-delay, spu-delay - * - bookmark + * - bookmark (bookmark list) * - record * - frame-next * - navigation (list of "title %2i") @@ -469,18 +326,13 @@ struct input_thread_t * Input state * * This enum is used by the variable "state" - * - * 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, END_S, ERROR_S, } input_state_e; @@ -519,8 +371,12 @@ typedef enum input_event_type_e { /* "state" has changed */ INPUT_EVENT_STATE, + /* b_dead is true */ + INPUT_EVENT_DEAD, + /* "rate" has changed */ INPUT_EVENT_RATE, + /* At least one of "position" or "time" or "length" has changed */ INPUT_EVENT_TIMES, @@ -540,9 +396,6 @@ typedef enum input_event_type_e /* "record" has changed */ INPUT_EVENT_RECORD, - /* A vout has been created/deleted by *the input* */ - INPUT_EVENT_VOUT, - /* input_item_t media has changed */ INPUT_EVENT_ITEM_META, /* input_item_t info has changed */ @@ -560,6 +413,17 @@ typedef enum input_event_type_e /* "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; /** @}*/ @@ -573,12 +437,13 @@ typedef enum input_event_type_e #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b) VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) ); +VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) ); + #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b) VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) ); #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 * ) ); enum input_query_e { @@ -633,7 +498,8 @@ 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 */ @@ -641,27 +507,41 @@ enum input_query_e /* 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, ... ) ); +/** + * 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 ); +} +/* */ 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( bool, input_AddSubtitles, ( input_thread_t *, char *, bool ) ); - -VLC_EXPORT( vlc_event_manager_t *, input_get_event_manager, ( input_thread_t * ) ); - /** * This function allows to split a MRL into access, demux and path part. * @@ -671,4 +551,9 @@ VLC_EXPORT( vlc_event_manager_t *, input_get_event_manager, ( input_thread_t * ) */ 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