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 */
#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] );
- if( !strcmp( psz_option, "meta-file" ) )
- {
- free( psz_option );
- continue;
- }
- 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_child->optflagc++;
- p_child->optflagv = (uint8_t *)realloc( p_child->optflagv,
- p_child->optflagc );
- p_child->optflagv[p_child->optflagc - 1] = p_parent->optflagv[i];
- }
-}
-
-static inline void input_item_SetName( input_item_t *p_item, const char *psz_name )
-{
- free( p_item->psz_name );
- p_item->psz_name = strdup( psz_name );
-}
+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. */
-static inline void input_ItemAddSubItem( input_item_t *p_parent,
- input_item_t *p_child )
-{
- vlc_event_t event;
+VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
- 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;
- vlc_event_send( &p_parent->event_manager, &event );
-}
-
-/* Flags handled past input_ItemAddOpt() */
+/* Flags handled past input_item_AddOpt() */
#define VLC_INPUT_OPTION_TRUSTED 0x2
-/* Flags handled within input_ItemAddOpt() */
+/* Flags handled within input_item_AddOpt() */
#define VLC_INPUT_OPTION_UNIQUE 0x100
-VLC_EXPORT( int, input_ItemAddOpt, ( input_item_t *, const char *str, unsigned flags ) );
-
-static inline
-int input_ItemAddOption (input_item_t *item, const char *str)
-{
- return input_ItemAddOpt (item, str, VLC_INPUT_OPTION_TRUSTED);
-}
-
-static inline
-int input_ItemHasErrorWhenReading (input_item_t *item)
-{
- return item->b_error_when_reading;
-}
-
-
-VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ));
+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, const 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 ));
-static inline bool 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 false;
- }
- const char * meta = vlc_meta_Get( p_i->p_meta, meta_type );
- bool 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 );
- 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 )
-{
- bool send_event = false;
-
- vlc_mutex_lock( &p_i->lock );
- if( p_i->i_duration != i_duration )
- {
- p_i->i_duration = i_duration;
- send_event = true;
- }
- vlc_mutex_unlock( &p_i->lock );
-
- if ( send_event == 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 bool input_item_IsPreparsed( input_item_t *p_i )
-{
- return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : false ;
-}
-
-static inline bool input_item_IsArtFetched( input_item_t *p_i )
-{
- return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : 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_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, ... ) LIBVLC_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( 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_ItemGetById(a,b) __input_ItemGetById( VLC_OBJECT(a),b )
-VLC_EXPORT( input_item_t *, __input_ItemGetById, (vlc_object_t *, int ) );
+#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 ) );
/*****************************************************************************
* Meta data helpers
* 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 */
+/** 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;
{
VLC_COMMON_MEMBERS;
- bool b_eof;
+ bool b_eof;
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
+ *****************************************************************************/
+
+/**
+ * \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" 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)
+ * - 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,
+
+ /* "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 has been added or removed or selected */
+ 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
*****************************************************************************/
#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
{
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 */
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, ... ) );
+/**
+ * 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 );
+}
+
+/* */
+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 ) );
+/**
+ * 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 ) );
-VLC_EXPORT( vlc_event_manager_t *, input_get_event_manager, ( input_thread_t * ) );
+/**
+ * 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
projects / vlc / blobdiff