git.sesse.net Git - vlc/blob - include/vlc_demux.h

   1 /*****************************************************************************
   2  * vlc_demux.h: Demuxer descriptor, queries and methods
   3  *****************************************************************************
   4  * Copyright (C) 1999-2005 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_DEMUX_H
  25 #define VLC_DEMUX_H 1
  26
  27 /**
  28  * \file
  29  * This files defines functions and structures used by demux objects in vlc
  30  */
  31
  32 #include <vlc_es.h>
  33 #include <vlc_stream.h>
  34 #include <vlc_es_out.h>
  35
  36 /**
  37  * \defgroup demux Demux
  38  * @{
  39  */
  40
  41 struct demux_t
  42 {
  43     VLC_COMMON_MEMBERS
  44
  45     /* Module properties */
  46     module_t    *p_module;
  47
  48     /* eg informative but needed (we can have access+demux) */
  49     char        *psz_access;
  50     char        *psz_demux;
  51     char        *psz_location;
  52     char        *psz_file;
  53
  54     /* input stream */
  55     stream_t    *s;     /* NULL in case of a access+demux in one */
  56
  57     /* es output */
  58     es_out_t    *out;   /* our p_es_out */
  59
  60     /* set by demuxer */
  61     int (*pf_demux)  ( demux_t * );   /* demux one frame only */
  62     int (*pf_control)( demux_t *, int i_query, va_list args);
  63
  64     /* Demux has to maintain them uptodate
  65      * when it is responsible of seekpoint/title */
  66     struct
  67     {
  68         unsigned int i_update;  /* Demux sets them on change,
  69                                    Input removes them once take into account*/
  70         /* Seekpoint/Title at demux level */
  71         int          i_title;       /* idem, start from 0 (could be menu) */
  72         int          i_seekpoint;   /* idem, start from 0 */
  73     } info;
  74     demux_sys_t *p_sys;
  75
  76     /* Weak link to parent input */
  77     input_thread_t *p_input;
  78 };
  79
  80 /* pf_demux return values */
  81 #define VLC_DEMUXER_EOF       0
  82 #define VLC_DEMUXER_EGENERIC -1
  83 #define VLC_DEMUXER_SUCCESS   1
  84
  85 /* demux_t.info.i_update field */
  86 #define INPUT_UPDATE_TITLE      0x0010
  87 #define INPUT_UPDATE_SEEKPOINT  0x0020
  88 #define INPUT_UPDATE_META       0x0040
  89 #define INPUT_UPDATE_TITLE_LIST 0x0100
  90
  91 /* demux_meta_t is returned by "meta reader" module to the demuxer */
  92 typedef struct demux_meta_t
  93 {
  94     VLC_COMMON_MEMBERS
  95     demux_t *p_demux; /** FIXME: use stream_t instead? */
  96     input_item_t *p_item; /***< the input item that is being read */
  97
  98     vlc_meta_t *p_meta;                 /**< meta data */
  99
 100     int i_attachments;                  /**< number of attachments */
 101     input_attachment_t **attachments;    /**< array of attachments */
 102 } demux_meta_t;
 103
 104 enum demux_query_e
 105 {
 106     /* I. Common queries to access_demux and demux */
 107     /* POSITION double between 0.0 and 1.0 */
 108     DEMUX_GET_POSITION,         /* arg1= double *       res=    */
 109     DEMUX_SET_POSITION,         /* arg1= double arg2= bool b_precise    res=can fail    */
 110
 111     /* LENGTH/TIME in microsecond, 0 if unknown */
 112     DEMUX_GET_LENGTH,           /* arg1= int64_t *      res=    */
 113     DEMUX_GET_TIME,             /* arg1= int64_t *      res=    */
 114     DEMUX_SET_TIME,             /* arg1= int64_t arg2= bool b_precise   res=can fail    */
 115
 116     /* TITLE_INFO only if more than 1 title or 1 chapter */
 117     DEMUX_GET_TITLE_INFO,       /* arg1=input_title_t*** arg2=int*
 118                                    arg3=int*pi_title_offset(0), arg4=int*pi_seekpoint_offset(0) can fail */
 119     /* TITLE/SEEKPOINT, only when TITLE_INFO succeed */
 120     DEMUX_SET_TITLE,            /* arg1= int            can fail */
 121     DEMUX_SET_SEEKPOINT,        /* arg1= int            can fail */
 122
 123     /* DEMUX_SET_GROUP/SET_ES only a hint for demuxer (mainly DVB) to allow not
 124      * reading everything (you should not use this to call es_out_Control)
 125      * if you don't know what to do with it, just IGNORE it, it is safe(r)
 126      * -1 means all group, 0 default group (first es added) */
 127     DEMUX_SET_GROUP,            /* arg1= int, arg2=const vlc_list_t *   can fail */
 128     DEMUX_SET_ES,               /* arg1= int                            can fail */
 129
 130     /* Ask the demux to demux until the given date at the next pf_demux call
 131      * but not more (and not less, at the precision available of course).
 132      * XXX: not mandatory (except for subtitle demux) but will help a lot
 133      * for multi-input
 134      */
 135     DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= int64_t        can fail */
 136     /* FPS for correct subtitles handling */
 137     DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */
 138
 139     /* Meta data */
 140     DEMUX_GET_META,             /* arg1= vlc_meta_t **  res=can fail    */
 141     DEMUX_HAS_UNSUPPORTED_META, /* arg1= bool *   res can fail    */
 142
 143     /* Attachments */
 144     DEMUX_GET_ATTACHMENTS,      /* arg1=input_attachment_t***, int* res=can fail */
 145
 146     /* RECORD you are ensured that it is never called twice with the same state
 147      * you should accept it only if the stream can be recorded without
 148      * any modification or header addition. */
 149     DEMUX_CAN_RECORD,           /* arg1=bool*   res=can fail(assume false) */
 150     DEMUX_SET_RECORD_STATE,     /* arg1=bool    res=can fail */
 151
 152     DEMUX_GET_SIGNAL, /* arg1=double *pf_quality, arg2=double *pf_strength
 153                          res=can fail */
 154
 155     /* II. Specific access_demux queries */
 156     /* PAUSE you are ensured that it is never called twice with the same state */
 157     DEMUX_CAN_PAUSE = 0x1000,   /* arg1= bool*    can fail (assume false)*/
 158     DEMUX_SET_PAUSE_STATE,      /* arg1= bool     can fail */
 159
 160     DEMUX_GET_PTS_DELAY,        /* arg1= int64_t*       cannot fail */
 161
 162     /* DEMUX_CAN_CONTROL_PACE returns true (*pb_pace) if we can read the
 163      * data at our pace */
 164     DEMUX_CAN_CONTROL_PACE,     /* arg1= bool*pb_pace    can fail (assume false) */
 165
 166     /* DEMUX_CAN_CONTROL_RATE is called only if DEMUX_CAN_CONTROL_PACE has returned false.
 167      * *pb_rate should be true when the rate can be changed (using DEMUX_SET_RATE)
 168      * *pb_ts_rescale should be true when the timestamps (pts/dts/pcr) have to be rescaled */
 169     DEMUX_CAN_CONTROL_RATE,     /* arg1= bool*pb_rate arg2= bool*pb_ts_rescale  can fail(assume false) */
 170     /* DEMUX_SET_RATE is called only if DEMUX_CAN_CONTROL_RATE has returned true.
 171      * It should return the value really used in *pi_rate */
 172     DEMUX_SET_RATE,             /* arg1= int*pi_rate                                        can fail */
 173
 174     DEMUX_CAN_SEEK,            /* arg1= bool*    can fail (assume false)*/
 175
 176     /* DEMUX_IS_PLAYLIST returns true if the demux is a playlist
 177      * (an archive, a directory or a network share is also a playlist) */
 178     DEMUX_IS_PLAYLIST,  /* arg1= bool*    can fail (assume false)*/
 179
 180     /* Navigation */
 181     DEMUX_NAV_ACTIVATE,        /* res=can fail */
 182     DEMUX_NAV_UP,              /* res=can fail */
 183     DEMUX_NAV_DOWN,            /* res=can fail */
 184     DEMUX_NAV_LEFT,            /* res=can fail */
 185     DEMUX_NAV_RIGHT,           /* res=can fail */
 186 };
 187
 188 VLC_API int demux_vaControlHelper( stream_t *, int64_t i_start, int64_t i_end, int64_t i_bitrate, int i_align, int i_query, va_list args );
 189
 190 static inline void demux_UpdateTitleFromStream( demux_t *demux )
 191 {
 192     stream_t *s = demux->s;
 193     unsigned title, seekpoint;
 194
 195     if( stream_Control( s, STREAM_GET_TITLE, &title ) == VLC_SUCCESS
 196      && title != (unsigned)demux->info.i_title )
 197     {
 198         demux->info.i_title = title;
 199         demux->info.i_update |= INPUT_UPDATE_TITLE;
 200     }
 201
 202     if( stream_Control( s, STREAM_GET_SEEKPOINT, &seekpoint ) == VLC_SUCCESS
 203      && seekpoint != (unsigned)demux->info.i_seekpoint )
 204     {
 205         demux->info.i_seekpoint = seekpoint;
 206         demux->info.i_update |= INPUT_UPDATE_SEEKPOINT;
 207     }
 208 }
 209
 210 /*************************************************************************
 211  * Miscellaneous helpers for demuxers
 212  *************************************************************************/
 213
 214 VLC_USED
 215 static inline bool demux_IsPathExtension( demux_t *p_demux, const char *psz_extension )
 216 {
 217     const char *name = (p_demux->psz_file != NULL) ? p_demux->psz_file
 218                                                    : p_demux->psz_location;
 219     const char *psz_ext = strrchr ( name, '.' );
 220     if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
 221         return false;
 222     return true;
 223 }
 224
 225 VLC_USED
 226 static inline bool demux_IsForced( demux_t *p_demux, const char *psz_name )
 227 {
 228    if( !p_demux->psz_demux || strcmp( p_demux->psz_demux, psz_name ) )
 229         return false;
 230     return true;
 231 }
 232
 233 /**
 234  * This function will create a packetizer suitable for a demuxer that parses
 235  * elementary stream.
 236  *
 237  * The provided es_format_t will be cleaned on error or by
 238  * demux_PacketizerDestroy.
 239  */
 240 VLC_API decoder_t * demux_PacketizerNew( demux_t *p_demux, es_format_t *p_fmt, const char *psz_msg ) VLC_USED;
 241
 242 /**
 243  * This function will destroy a packetizer create by demux_PacketizerNew.
 244  */
 245 VLC_API void demux_PacketizerDestroy( decoder_t *p_packetizer );
 246
 247 /**
 248  * This function will return the parent input of this demux.
 249  * It is retained. Can return NULL.
 250  */
 251 VLC_API input_thread_t * demux_GetParentInput( demux_t *p_demux ) VLC_USED;
 252
 253 /* */
 254 #define DEMUX_INIT_COMMON() do {            \
 255     p_demux->pf_control = Control;          \
 256     p_demux->pf_demux = Demux;              \
 257     p_demux->p_sys = calloc( 1, sizeof( demux_sys_t ) ); \
 258     if( !p_demux->p_sys ) return VLC_ENOMEM;\
 259     } while(0)
 260
 261 /**
 262  * @}
 263  */
 264
 265 #endif