]> git.sesse.net Git - vlc/blobdiff - include/ninput.h
Minor fix.
[vlc] / include / ninput.h
index dd82569d1236f2133f4b694bd85e398d8566c0b1..5ddba82bcc7d9ec0ed49a4caee4ee8778d2acd22 100644 (file)
@@ -2,7 +2,7 @@
  * ninput.h
  *****************************************************************************
  * Copyright (C) 1999-2001 VideoLAN
- * $Id: ninput.h,v 1.3 2003/08/02 19:16:04 fenrir Exp $
+ * $Id: ninput.h,v 1.13 2003/10/01 22:44:58 hartman Exp $
  *
  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
  *
 #ifndef _NINPUT_H
 #define _NINPUT_H 1
 
-/*
- * Stream (stream_t)
- * -----------------
- *  This will allow you to easily handle read/seek in demuxer modules.
+enum es_extra_type_e
+{
+    ES_EXTRA_TYPE_UNKNOWN,
+    ES_EXTRA_TYPE_WAVEFORMATEX,
+    ES_EXTRA_TYPE_BITMAPINFOHEADER
+};
+
+typedef struct
+{
+    int             i_cat;
+    vlc_fourcc_t    i_codec;
+
+    int             i_group;    /* -1 : standalone
+                                   >= 0 then a "group" (program) is created
+                                        for each value */
+    int             i_priority; /*  -2 : mean not selectable by the users
+                                    -1 : mean not selected by default even
+                                        when no other stream
+                                    >=0: priority */
+    char            *psz_language;
+    char            *psz_description;
+
+    struct
+    {
+        int i_samplerate;
+        int i_channels;
+        int i_bitrate;
+        int i_blockalign;
+        int i_bitspersample;
+    } audio;
+
+    struct
+    {
+        int i_width;
+        int i_height;
+        int i_display_width;
+        int i_display_height;
+    } video;
+
+    struct
+    {
+        char *psz_encoding;
+    } subs;
+
+    int     i_extra_type;
+    int     i_extra;
+    void    *p_extra;
+} es_format_t;
+
+static inline void es_format_Init( es_format_t *fmt,
+                                   int i_cat, vlc_fourcc_t i_codec )
+{
+    fmt->i_cat                  = i_cat;
+    fmt->i_codec                = i_codec;
+    fmt->i_group                = 0;
+    fmt->i_priority             = 0;
+    fmt->psz_language           = NULL;
+    fmt->psz_description        = NULL;
+
+    fmt->audio.i_samplerate     = 0;
+    fmt->audio.i_channels       = 0;
+    fmt->audio.i_bitrate        = 0;
+    fmt->audio.i_blockalign     = 0;
+    fmt->audio.i_bitspersample  = 0;
+
+    fmt->video.i_width          = 0;
+    fmt->video.i_height         = 0;
+    fmt->video.i_display_width  = 0;
+    fmt->video.i_display_height = 0;
+
+    fmt->subs.psz_encoding      = NULL;
+
+    fmt->i_extra_type           = ES_EXTRA_TYPE_UNKNOWN;
+    fmt->i_extra                = 0;
+    fmt->p_extra                = NULL;
+}
+
+enum es_out_query_e
+{
+    ES_OUT_SET_SELECT,  /* arg1= es_out_id_t* arg2=vlc_bool_t   */
+    ES_OUT_GET_SELECT   /* arg1= es_out_id_t* arg2=vlc_bool_t*  */
+};
+
+struct es_out_t
+{
+    es_out_id_t *(*pf_add)    ( es_out_t *, es_format_t * );
+    int          (*pf_send)   ( es_out_t *, es_out_id_t *, pes_packet_t * );
+    void         (*pf_del)    ( es_out_t *, es_out_id_t * );
+    int          (*pf_control)( es_out_t *, int i_query, va_list );
+
+    es_out_sys_t    *p_sys;
+};
+
+static inline es_out_id_t * es_out_Add( es_out_t *out, es_format_t *fmt )
+{
+    return out->pf_add( out, fmt );
+}
+static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
+{
+    out->pf_del( out, id );
+}
+static inline int es_out_Send( es_out_t *out, es_out_id_t *id, pes_packet_t *p_pes )
+{
+    return out->pf_send( out, id, p_pes );
+}
+static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
+{
+    return out->pf_control( out, i_query, args );
+}
+static inline int es_out_Control( es_out_t *out, int i_query, ... )
+{
+    va_list args;
+    int     i_result;
+
+    va_start( args, i_query );
+    i_result = es_out_vaControl( out, i_query, args );
+    va_end( args );
+    return i_result;
+}
+
+/**
+ * \defgroup stream Stream
  *
- * - stream_OpenInput
- *      create a "stream_t *" from an "input_thread_t *".
- * - stream_Release
- *      destroy a previously "stream_t *" instances.
- * - stream_Read
- *      Try to read "i_read" bytes into a buffer pointed by "p_read".
- *      If "p_read" is NULL then data are skipped instead of read.
- *      The return value is the real numbers of bytes read/skip. If
- *      this value is less than i_read that means that it's the end
- *      of the stream.
- * - stream_Peek
- *      Store in pp_peek a pointer to the next "i_peek" bytes in the
- *      stream
- *      The return value is the real numbers of valid bytes, if it's
- *      less or equal to 0, *pp_peek is invalid.
- *      XXX: it's a pointer to internal buffer and it will be invalid
- *      as soons as other stream_* functions are called.
- *      be 0 (then *pp_peek isn't valid).
- *      XXX: due to input limitation, it could be less than i_peek without
- *      meaning the end of the stream (but only when you have
- *      i_peek >= p_input->i_bufsize)
- * - stream_PesPacket
- *      Read "i_size" bytes and store them in a pes_packet_t.
- *      Only fields p_first, p_last, i_nb_data, and i_pes_size are set.
- *      (Of course, you need to fill i_dts, i_pts, ... )
- *      If only less than "i_size" bytes are available NULL is returned.
- * - stream_vaControl, stream_Control
- *      Use to control the "stream_t *". Look at stream_query_e for possible
- *      "i_query" value and format arguments.
- *      Return VLC_SUCCESS if ... succeed ;) and VLC_EGENERIC if failed or
- *      unimplemented
+ *  This will allow you to easily handle read/seek in demuxer modules.
+ * @{
  */
 
+/**
+ * Possible commands to send to stream_Control() and stream_vaControl()
+ */
 enum stream_query_e
 {
     /* capabilities */
-    STREAM_CAN_SEEK,            /* arg1= vlc_bool_t *   res=cannot fail*/
-    STREAM_CAN_FASTSEEK,        /* arg1= vlc_bool_t *   res=cannot fail*/
+    STREAM_CAN_SEEK,            /**< arg1= vlc_bool_t *   res=cannot fail*/
+    STREAM_CAN_FASTSEEK,        /**< arg1= vlc_bool_t *   res=cannot fail*/
 
     /* */
-    STREAM_SET_POSITION,        /* arg1= int64_t        res=can fail  */
-    STREAM_GET_POSITION,        /* arg1= int64_t *      res=cannot fail*/
+    STREAM_SET_POSITION,        /**< arg1= int64_t        res=can fail  */
+    STREAM_GET_POSITION,        /**< arg1= int64_t *      res=cannot fail*/
 
-    STREAM_GET_SIZE,            /* arg1= int64_t *      res=cannot fail (0 if no sense)*/
+    STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/
 };
 
-/*
- * Demux
- * XXX: don't look at it yet.
+/* Stream */
+VLC_EXPORT( stream_t *,     stream_OpenInput,       ( input_thread_t * ) );
+VLC_EXPORT( void,           stream_Release,         ( stream_t * ) );
+VLC_EXPORT( int,            stream_vaControl,       ( stream_t *, int i_query, va_list ) );
+VLC_EXPORT( int,            stream_Control,         ( stream_t *, int i_query, ... ) );
+VLC_EXPORT( int,            stream_Read,            ( stream_t *, void *p_read, int i_read ) );
+VLC_EXPORT( int,            stream_Peek,            ( stream_t *, uint8_t **pp_peek, int i_peek ) );
+VLC_EXPORT( data_packet_t *,stream_DataPacket,      ( stream_t *, int i_size, vlc_bool_t b_force ) );
+VLC_EXPORT( pes_packet_t *, stream_PesPacket,       ( stream_t *, int i_size ) );
+
+static int64_t inline stream_Tell( stream_t *s )
+{
+    int64_t i_pos;
+    stream_Control( s, STREAM_GET_POSITION, &i_pos );
+
+    return i_pos;
+}
+static int64_t inline stream_Size( stream_t *s )
+{
+    int64_t i_pos;
+    stream_Control( s, STREAM_GET_SIZE, &i_pos );
+
+    return i_pos;
+}
+static int inline stream_Seek( stream_t *s, int64_t i_pos )
+{
+    return stream_Control( s, STREAM_SET_POSITION, i_pos );
+}
+
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup demux Demux
+ * @{
  */
-#define DEMUX_POSITION_MAX  10000
 enum demux_query_e
 {
-    DEMUX_GET_POSITION,         /* arg1= int64_t *      res=    */
-    DEMUX_SET_POSITION,         /* arg1= int64_t        res=can fail    */
+    DEMUX_GET_POSITION,         /* arg1= double *       res=    */
+    DEMUX_SET_POSITION,         /* arg1= double         res=can fail    */
 
     DEMUX_GET_TIME,             /* arg1= int64_t *      res=    */
     DEMUX_SET_TIME,             /* arg1= int64_t        res=can fail    */
 
-    DEMUX_GET_LENGTH            /* arg1= int64_t *      res=can fail    */
+    DEMUX_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
+
+    DEMUX_GET_FPS               /* arg1= float *        res=can fail    */
 };
 
 
-/* Stream */
-VLC_EXPORT( stream_t *,     stream_OpenInput,       ( input_thread_t * ) );
-VLC_EXPORT( void,           stream_Release,         ( stream_t * ) );
-VLC_EXPORT( int,            stream_vaControl,       ( stream_t *, int i_query, va_list ) );
-VLC_EXPORT( int,            stream_Control,         ( stream_t *, int i_query, ... ) );
-VLC_EXPORT( int,            stream_Read,            ( stream_t *, void *p_read, int i_read ) );
-VLC_EXPORT( int,            stream_Peek,            ( stream_t *, uint8_t **pp_peek, int i_peek ) );
-VLC_EXPORT( pes_packet_t *, stream_PesPacket,       ( stream_t *, int i_size ) );
 
 /* Demux */
 VLC_EXPORT( int,            demux_vaControl,        ( input_thread_t *, int i_query, va_list  ) );
 VLC_EXPORT( int,            demux_Control,          ( input_thread_t *, int i_query, ...  ) );
 
+VLC_EXPORT( int,            demux_vaControlDefault, ( input_thread_t *, int i_query, va_list  ) );
+
+/* Subtitles */
+VLC_EXPORT( char **,        subtitles_Detect,       ( input_thread_t *, char* path, char *fname ) );
+
+/**
+ * @}
+ */
+
 #endif