/*****************************************************************************
- * vlc_input.h:
+ * vlc_input.h: Core input structures
*****************************************************************************
- * Copyright (C) 1999-2004 VideoLAN
- * $Id: input_ext-intf.h 7954 2004-06-07 22:19:12Z fenrir $
+ * Copyright (C) 1999-2006 the VideoLAN team
+ * $Id$
*
* Authors: Christophe Massiot <massiot@via.ecp.fr>
* Laurent Aimar <fenrir@via.ecp.fr>
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * 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
+#include <vlc_es.h>
+#include <vlc_meta.h>
+
+struct vlc_meta_t;
+
/*****************************************************************************
* input_item_t: Describes an input and is used to spawn input_thread_t objects
*****************************************************************************/
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 */
+ vlc_bool_t b_fixed_name; /**< Can the interface change the name ?*/
int i_options; /**< Number of input options */
char **ppsz_options; /**< Array of input options */
- mtime_t i_duration; /**< A hint about the duration of this
- * item, in milliseconds*/
+ mtime_t i_duration; /**< Duration in milliseconds*/
- int i_id; /**< Identifier of the item */
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 */
int i_es; /**< Number of es format descriptions */
- es_format_t **es; /**< Pointer to an array of es formats */
+ es_format_t **es; /**< Es formats */
- vlc_bool_t b_fixed_name; /**< Can the interface change the name ?*/
+ input_stats_t *p_stats; /**< Statistics */
+ int i_nb_played; /**< Number of times played */
+
+ vlc_meta_t *p_meta;
- vlc_mutex_t lock; /**< Item cannot be changed without this lock */
+ vlc_mutex_t lock; /**< Lock for the item */
};
#define ITEM_TYPE_UNKNOWN 0
#define ITEM_TYPE_NET 7
#define ITEM_TYPE_PLAYLIST 8
#define ITEM_TYPE_NODE 9
+#define ITEM_TYPE_NUMBER 10
-static inline void vlc_input_item_Init( vlc_object_t *p_o, input_item_t *p_i )
+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->i_options = 0;
- p_i->i_es = 0;
- p_i->i_categories = 0 ;
p_i->psz_name = 0;
p_i->psz_uri = 0;
+ p_i->i_es = 0;
+ p_i->es = 0;
+ p_i->i_options = 0;
p_i->ppsz_options = 0;
+ p_i->i_categories = 0 ;
p_i->pp_categories = 0;
- p_i->es = 0;
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 );
}
-static inline void vlc_input_item_CopyOptions( input_item_t *p_parent,
- input_item_t *p_child )
+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++ )
}
}
-static inline void vlc_input_item_Clean( input_item_t *p_i )
+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 )
{
- if( p_i->psz_name ) free( p_i->psz_name );
- if( p_i->psz_uri ) free( p_i->psz_uri );
- p_i->psz_name = 0;
- p_i->psz_uri = 0;
+ 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 );
while( p_i->i_options )
{
vlc_mutex_destroy( &p_i->lock );
}
-VLC_EXPORT( char *, vlc_input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
-VLC_EXPORT(int, vlc_input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
+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, ... ) );
+
+#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 *, int) );
+VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, int, int ) );
+
+VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
/*****************************************************************************
* Seek point: (generalisation of chapters)
{
seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
point->i_byte_offset =
- point->i_time_offset = 0;
+ point->i_time_offset = -1;
point->i_level = 0;
point->psz_name = NULL;
return point;
} input_title_t;
-static inline input_title_t *vlc_input_title_New( )
+static inline input_title_t *vlc_input_title_New(void)
{
input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
enum input_state_e
{
INIT_S,
+ OPENING_S,
+ BUFFERING_S,
PLAYING_S,
PAUSE_S,
END_S,
+ ERROR_S
};
-/* "rate" default, min/max */
+/* "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 8000 /* Up to 1/8 */
-/* input_source_t: gathers all information per input source */
-typedef struct
-{
- /* Input item description */
- input_item_t *p_item;
-
- /* Access/Stream/Demux plugins */
- access_t *p_access;
- stream_t *p_stream;
- demux_t *p_demux;
-
- /* Title infos for that input */
- vlc_bool_t b_title_demux; /* Titles/Seekpoints provided by demux */
- int i_title;
- input_title_t **title;
-
- int i_title_offset;
- int i_seekpoint_offset;
-
- int i_title_start;
- int i_title_end;
- int i_seekpoint_start;
- int i_seekpoint_end;
-
- /* Properties */
- vlc_bool_t b_can_pace_control;
- vlc_bool_t b_can_pause;
- vlc_bool_t b_eof; /* eof of demuxer */
-
- /* Clock average variation */
- int i_cr_average;
-
-} input_source_t;
-
/* i_update field of access_t/demux_t */
#define INPUT_UPDATE_NONE 0x0000
#define INPUT_UPDATE_SIZE 0x0001
/* Input control XXX: internal */
#define INPUT_CONTROL_FIFO_SIZE 100
-/*****************************************************************************
- * input_thread_t
- *****************************************************************************
- * XXX: this strucrures is *PRIVATE* so nobody can touch it out of src/input.
- * I plan to move it to src/input/input_internal.h anyway
- *
- * XXX: look at src/input/input.c:input_CreateThread for accessible variables
- * YOU CANNOT HAVE ACCESS TO THE CONTENT OF input_thread_t except
- * p_input->input.p_item (and it's only temporary).
- * XXX: move the docs somewhere (better than src/input )
- *****************************************************************************/
+/** Get the input item for an input thread */
+VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
+
+typedef struct input_thread_private_t input_thread_private_t;
+
+/**
+ * Main structure representing an input thread. This structure is mostly
+ * private. The only public fields are READ-ONLY. You must use the helpers
+ * to modify them
+ */
struct input_thread_t
{
- VLC_COMMON_MEMBERS
+ VLC_COMMON_MEMBERS;
- /* Global properties */
vlc_bool_t b_eof;
- vlc_bool_t b_can_pace_control;
- vlc_bool_t b_can_pause;
+ vlc_bool_t b_preparsing;
- /* Global state */
- int i_state;
- int i_rate;
-
- /* */
- int64_t i_start; /* :start-time,0 by default */
+ int i_state;
+ vlc_bool_t b_can_pace_control;
int64_t i_time; /* Current time */
- int64_t i_stop; /* :stop-time, 0 if none */
-
- /* Title infos FIXME multi-input (not easy) ? */
- int i_title;
- input_title_t **title;
-
- int i_title_offset;
- int i_seekpoint_offset;
-
- /* User bookmarks FIXME won't be easy with multiples input */
- int i_bookmark;
- seekpoint_t **bookmark;
- /* Global meta datas FIXME move to input_item_t ? */
- vlc_meta_t *p_meta;
+ /* Internal caching common to all inputs */
+ int i_pts_delay;
- /* Output */
- es_out_t *p_es_out;
- sout_instance_t *p_sout; /* XXX Move it to es_out ? */
- vlc_bool_t b_out_pace_control; /* idem ? */
-
- /* Internal caching common for all inputs */
- int64_t i_pts_delay;
-
- /* Main input properties */
- input_source_t input;
-
- /* Slave demuxers (subs, and others) */
- int i_slave;
- input_source_t **slave;
-
- /* Buffer of pending actions */
- vlc_mutex_t lock_control;
- int i_control;
- struct
- {
- /* XXX: val isn't duplicated so it won't works with string */
- int i_type;
- vlc_value_t val;
- } control[INPUT_CONTROL_FIFO_SIZE];
+ /* All other data is input_thread is PRIVATE. You can't access it
+ * outside of src/input */
+ input_thread_private_t *p;
};
/*****************************************************************************
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( void, input_StopThread, ( input_thread_t * ) );
VLC_EXPORT( void, input_DestroyThread, ( input_thread_t * ) );
INPUT_GET_STATE, /* arg1= int * res= */
INPUT_SET_STATE, /* arg1= int res=can fail */
- /* input variable "audio-delay" and "spu-delay" */
+ /* input variable "audio-delay" and "sub-delay" */
INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
/* Meta datas */
- INPUT_ADD_INFO, /* arg1= char * arg2= char * arg3=... res=can fail */
- INPUT_GET_INFO, /* arg1= char * arg2= char * arg3= char ** res=can fail*/
- INPUT_SET_NAME, /* arg1= char * res=can fail */
+ INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
+ INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
+ INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
+ INPUT_SET_NAME, /* arg1= char* res=can fail */
/* Input config options */
INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/
INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
/* On the fly input slave */
- INPUT_ADD_SLAVE, /* arg1= char * */
+ INPUT_ADD_SLAVE /* arg1= char * */
};
VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
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 ) );
+
#endif