]> git.sesse.net Git - vlc/blobdiff - include/vlc_input.h
input: Export input_GetState().
[vlc] / include / vlc_input.h
index 060effc410a4ed1ac551e9fff8b938ed33c1d0f7..900c3f353e7c4a2dbbe0d4edff6b684eb5b3573b 100644 (file)
  * 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
@@ -62,15 +58,16 @@ struct input_item_t
 
     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*/
 
     int        i_categories;         /**< Number of info categories */
     info_category_t **pp_categories; /**< Pointer to the first info category */
@@ -81,6 +78,8 @@ struct input_item_t
     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;
@@ -99,29 +98,6 @@ struct input_item_t
 #define ITEM_TYPE_NODE          8
 #define ITEM_TYPE_NUMBER        9
 
-static inline void input_ItemInit( vlc_object_t *p_o, input_item_t *p_i )
-{
-    memset( p_i, 0, sizeof(input_item_t) );
-    p_i->psz_name = NULL;
-    p_i->psz_uri = NULL;
-    TAB_INIT( p_i->i_es, p_i->es );
-    TAB_INIT( p_i->i_options, p_i->ppsz_options );
-    TAB_INIT( p_i->i_categories, p_i->pp_categories );
-
-    p_i->i_type = ITEM_TYPE_UNKNOWN;
-    p_i->b_fixed_name = VLC_TRUE;
-
-    p_i->p_stats = NULL;
-    p_i->p_meta = NULL;
-
-    vlc_mutex_init( p_o, &p_i->lock );
-    vlc_event_manager_init( &p_i->event_manager, p_i, p_o );
-    vlc_event_manager_register_event_type( &p_i->event_manager,
-        vlc_InputItemMetaChanged );
-    vlc_event_manager_register_event_type( &p_i->event_manager,
-        vlc_InputItemSubItemAdded );
-}
-
 static inline void input_ItemCopyOptions( input_item_t *p_parent,
                                           input_item_t *p_child )
 {
@@ -129,17 +105,26 @@ static inline void input_ItemCopyOptions( input_item_t *p_parent,
     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 )
 {
-    if( p_item->psz_name ) free( p_item->psz_name );
+    free( p_item->psz_name );
     p_item->psz_name = strdup( psz_name );
 }
 
@@ -160,91 +145,39 @@ static inline void input_ItemAddSubItem( input_item_t *p_parent,
     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 );
+/* Flags handled past input_ItemAddOpt() */
+#define VLC_INPUT_OPTION_TRUSTED 0x2
 
-    for( i = 0; i < p_i->i_categories; i++ )
-    {
-        info_category_t *p_category = p_i->pp_categories[i];
-        int j;
+/* Flags handled within input_ItemAddOpt() */
+#define VLC_INPUT_OPTION_UNIQUE  0x100
 
-        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_EXPORT( int, input_ItemAddOpt, ( input_item_t *, const char *str, unsigned flags ) );
 
-    vlc_mutex_destroy( &p_i->lock );
+static inline
+int input_ItemAddOption (input_item_t *item, const char *str)
+{
+    return input_ItemAddOpt (item, str, VLC_INPUT_OPTION_TRUSTED);
 }
 
-static inline void input_item_SetMeta( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val )
+static inline
+int input_ItemHasErrorWhenReading (input_item_t *item)
 {
-    vlc_event_t event;
+    return item->b_error_when_reading;
+}
 
-    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 );
-}
+VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ));
 
-static inline vlc_bool_t input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz )
+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 VLC_FALSE;
+        return false;
     }
     const char * meta = vlc_meta_Get( p_i->p_meta, meta_type );
-    vlc_bool_t ret = meta && strcasestr( meta, psz );
+    bool ret = meta && strcasestr( meta, psz );
     vlc_mutex_unlock( &p_i->lock );
 
     return ret;
@@ -287,8 +220,8 @@ static inline char * input_item_GetURI( input_item_t * p_i )
 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 );
+    free( p_i->psz_uri );
+    p_i->psz_uri = strdup( psz_uri );
     vlc_mutex_unlock( &p_i->lock );
 }
 
@@ -302,70 +235,36 @@ static inline mtime_t input_item_GetDuration( input_item_t * p_i )
 
 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 );
-    p_i->i_duration = i_duration;
+    if( p_i->i_duration != i_duration )
+    {
+        p_i->i_duration = i_duration;
+        send_event = true;
+    }
     vlc_mutex_unlock( &p_i->lock );
-    return;
-}
-
-static inline void input_item_SetPreparsed( input_item_t *p_i, vlc_bool_t preparsed )
-{
-    if( !p_i->p_meta )
-        p_i->p_meta = vlc_meta_New();
-
-    if( preparsed )
-        p_i->p_meta->i_status |= ITEM_PREPARSED;
-    else
-        p_i->p_meta->i_status &= ~ITEM_PREPARSED;
-}
 
-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 void input_item_SetMetaFetched( input_item_t *p_i, vlc_bool_t metafetched )
-{
-    if( !p_i->p_meta )
-        p_i->p_meta = vlc_meta_New();
-
-    if( metafetched )
-        p_i->p_meta->i_status |= ITEM_META_FETCHED;
-    else
-        p_i->p_meta->i_status &= ~ITEM_META_FETCHED;
-}
+    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 );
+    }
 
-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 ;
+    return;
 }
 
 
-static inline void input_item_SetArtNotFound( input_item_t *p_i, vlc_bool_t notfound )
-{
-    if( !p_i->p_meta )
-        p_i->p_meta = vlc_meta_New();
-
-    if( notfound )
-        p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
-    else
-        p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
-}
-
-static inline void input_item_SetArtFetched( input_item_t *p_i, vlc_bool_t artfetched )
+static inline bool input_item_IsPreparsed( input_item_t *p_i )
 {
-    if( !p_i->p_meta )
-        p_i->p_meta = vlc_meta_New();
-
-    if( artfetched )
-        p_i->p_meta->i_status |= ITEM_ART_FETCHED;
-    else
-        p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
+    return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : false ;
 }
 
-static inline vlc_bool_t input_item_IsArtFetched( input_item_t *p_i )
+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 : VLC_FALSE ;
+    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 )
@@ -422,14 +321,15 @@ static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p
 #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(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( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
+#define input_ItemGetById(a,b) __input_ItemGetById( VLC_OBJECT(a),b )
+VLC_EXPORT( input_item_t *, __input_ItemGetById, (vlc_object_t *, int ) );
 
 /*****************************************************************************
  * Meta data helpers
@@ -445,24 +345,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 );
     }
 }
@@ -491,7 +391,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 );
 }
 
@@ -511,7 +411,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 */
@@ -527,7 +427,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;
@@ -542,13 +442,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 );
 }
 
@@ -575,6 +475,7 @@ static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 
     return dup;
 }
+
 /*****************************************************************************
  * Attachments
  *****************************************************************************/
@@ -587,6 +488,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,
@@ -622,25 +524,30 @@ 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
+/* 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,
@@ -674,15 +581,15 @@ struct input_thread_t
 {
     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 */
@@ -692,15 +599,18 @@ struct input_thread_t
 /*****************************************************************************
  * 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
 {
@@ -762,10 +672,18 @@ enum input_query_e
 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 *, bool b_force_decoder ) );
 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 * ) );
 
 #endif