]> git.sesse.net Git - vlc/blobdiff - include/vlc_input.h
Allow minimum rate change upto 32/1 in input.
[vlc] / include / vlc_input.h
index 0cec28cb91519e2426214c2f2e2142986c05ca9b..2ea168637b9c2b62212196b4a9c2688abc5dd072 100644 (file)
  *****************************************************************************/
 
 /* __ 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>
 #include <vlc_epg.h>
 #include <vlc_events.h>
 
-#include <string.h>                                     /* strstr() */
+#include <string.h>                                     /* strcasestr() */
 
 struct vlc_meta_t;
 
@@ -68,6 +73,7 @@ struct input_item_t
     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 */
@@ -78,6 +84,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;
@@ -96,184 +104,42 @@ struct input_item_t
 #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;
-
-    p_parent->i_type = ITEM_TYPE_PLAYLIST;
+VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
 
-    /* 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);
-}
-
-
+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 ));
 
-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 && strstr( meta, psz );
-    vlc_mutex_unlock( &p_i->lock );
-
-    return ret;
-}
+VLC_EXPORT( bool,input_item_HasErrorWhenReading, (input_item_t *item) );
 
-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;
-    }
+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 ));
 
-    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 )
@@ -312,16 +178,13 @@ static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p
 #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 ) );
+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_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
@@ -525,25 +388,26 @@ static inline void vlc_input_attachment_Delete( input_attachment_t *a )
  *****************************************************************************/
 
 /* "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 = 0,
     OPENING_S,
     BUFFERING_S,
     PLAYING_S,
     PAUSE_S,
+    STOP_S,
     END_S,
-    FORWARD_S,
-    BACKWARD_S,
-    ERROR_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_MIN        32            /* Up to 32/1 */
 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 
 /* i_update field of access_t/demux_t */
@@ -552,9 +416,7 @@ enum input_state_e
 #define INPUT_UPDATE_TITLE      0x0010
 #define INPUT_UPDATE_SEEKPOINT  0x0020
 #define INPUT_UPDATE_META       0x0040
-
-/* Input control XXX: internal */
-#define INPUT_CONTROL_FIFO_SIZE    100
+#define INPUT_UPDATE_SIGNAL     0x0080
 
 /** Get the input item for an input thread */
 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
@@ -570,8 +432,9 @@ struct input_thread_t
 {
     VLC_COMMON_MEMBERS;
 
-    bool  b_eof;
+    bool b_eof;
     bool b_preparsing;
+    bool b_dead;
 
     int i_state;
     bool b_can_pace_control;
@@ -655,13 +518,28 @@ 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 *, bool 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;
+}
+
+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 * ) );
 
@@ -669,4 +547,13 @@ 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