* 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 <vlc/input.h> */
-#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 <vlc_es.h>
#include <vlc_meta.h>
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 ?*/
+ 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, ...) */
- vlc_bool_t b_prefers_tree; /**< Do we prefer being displayed as tree*/
+ 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 */
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;
#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 );
-}
+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_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 );
-}
+VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
-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 );
+/* Flags handled past input_item_AddOpt() */
+#define VLC_INPUT_OPTION_TRUSTED 0x2
- 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 );
- }
+/* Flags handled within input_item_AddOpt() */
+#define VLC_INPUT_OPTION_UNIQUE 0x100
- return;
-}
+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) );
-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 ;
-}
+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 ));
-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_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 ) );
+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_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 ) );
+#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 ) );
-VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, 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 ) );
/*****************************************************************************
* Meta data helpers
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 );
}
}
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 );
}
{
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 */
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;
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 );
}
return dup;
}
+
/*****************************************************************************
* Attachments
*****************************************************************************/
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,
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
+/* NOTE: you need to update ppsz_input_state in the RC interface
+ * if you modify this list. */
+typedef enum input_state_e
{
- INIT_S,
+ INIT_S = 0,
OPENING_S,
BUFFERING_S,
PLAYING_S,
PAUSE_S,
+ STOP_S,
+ FORWARD_S,
+ BACKWARD_S,
END_S,
- ERROR_S
-};
+ ERROR_S,
+} input_state_e;
/* "rate" default, min/max
* A rate below 1000 plays the movie faster,
{
VLC_COMMON_MEMBERS;
- vlc_bool_t b_eof;
- vlc_bool_t b_preparsing;
+ bool b_eof;
+ bool b_preparsing;
int i_state;
- vlc_bool_t b_can_pace_control;
+ bool b_can_pace_control;
int64_t i_time; /* Current time */
/* Internal caching common to all inputs */
- int i_pts_delay;
+ mtime_t i_pts_delay;
/* All other data is input_thread is PRIVATE. You can't access it
* outside of src/input */
/*****************************************************************************
* Prototypes
*****************************************************************************/
+
+/* 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 * ) );
+
#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 *, vlc_bool_t ) );
+VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) );
-VLC_EXPORT( void, input_DestroyThread, ( input_thread_t * ) );
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= char * */
+
+ /* 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) */
};
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 ) );
+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 *, 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 ) );
+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.
+ *
+ * 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 ) );
#endif