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 #include <stdlib.h>
  28 #include <string.h>
  29
  30 #include <vlc_es.h>
  31 #include <vlc_stream.h>
  32 #include <vlc_es_out.h>
  33
  34 /**
  35  * \defgroup demux Demultiplexer
  36  * \ingroup input
  37  * Demultiplexers (file format parsers)
  38  * @{
  39  * \file
  40  * Demultiplexer modules interface
  41  */
  42
  43 /* pf_demux return values */
  44 #define VLC_DEMUXER_EOF       0
  45 #define VLC_DEMUXER_EGENERIC -1
  46 #define VLC_DEMUXER_SUCCESS   1
  47
  48 /* DEMUX_TEST_AND_CLEAR flags */
  49 #define INPUT_UPDATE_TITLE      0x0010
  50 #define INPUT_UPDATE_SEEKPOINT  0x0020
  51 #define INPUT_UPDATE_META       0x0040
  52 #define INPUT_UPDATE_TITLE_LIST 0x0100
  53
  54 /* demux_meta_t is returned by "meta reader" module to the demuxer */
  55 typedef struct demux_meta_t
  56 {
  57     struct vlc_common_members obj;
  58     input_item_t *p_item; /***< the input item that is being read */
  59
  60     vlc_meta_t *p_meta;                 /**< meta data */
  61
  62     int i_attachments;                  /**< number of attachments */
  63     input_attachment_t **attachments;    /**< array of attachments */
  64 } demux_meta_t;
  65
  66 /**
  67  * Control query identifiers for use with demux_t.pf_control
  68  *
  69  * In the individual identifier description, the input stream refers to
  70  * demux_t.s if non-NULL, and the output refers to demux_t.out.
  71  *
  72  * A demuxer is synchronous if it only accesses its input stream and the
  73  * output from within its demux_t callbacks, i.e. demux.pf_demux and
  74  * demux_t.pf_control.
  75  *
  76  * A demuxer is threaded if it accesses either or both input and output
  77  * asynchronously.
  78  *
  79  * An access-demuxer is a demuxer without input, i.e. demux_t.s == NULL).
  80  */
  81 enum demux_query_e
  82 {
  83     /** Checks whether the stream supports seeking.
  84      * Can fail if seeking is not supported (same as returning false).
  85      * \bug Failing should not be allowed.
  86      *
  87      * arg1 = bool * */
  88     DEMUX_CAN_SEEK,
  89
  90     /** Checks whether (long) pause then stream resumption is supported.
  91      * Can fail only if synchronous and <b>not</b> an access-demuxer. The
  92      * underlying input stream then determines if pause is supported.
  93      * \bug Failing should not be allowed.
  94      *
  95      * arg1= bool * */
  96     DEMUX_CAN_PAUSE = 0x002,
  97
  98     /** Whether the stream can be read at an arbitrary pace.
  99      * Cannot fail.
 100      *
 101      * arg1= bool * */
 102     DEMUX_CAN_CONTROL_PACE,
 103
 104     /** Retrieves the PTS delay (roughly the default buffer duration).
 105      * Can fail only if synchronous and <b>not</b> an access-demuxer. The
 106      * underlying input stream then determines the PTS delay.
 107      *
 108      * arg1= vlc_tick_t * */
 109     DEMUX_GET_PTS_DELAY = 0x101,
 110
 111     /** Retrieves stream meta-data.
 112      * Should fail if no meta-data were retrieved.
 113      *
 114      * arg1= vlc_meta_t * */
 115     DEMUX_GET_META = 0x105,
 116
 117     /** Retrieves an estimate of signal quality and strength.
 118      * Can fail.
 119      *
 120      * arg1=double *quality, arg2=double *strength */
 121     DEMUX_GET_SIGNAL = 0x107,
 122
 123     /** Sets the paused or playing/resumed state.
 124      *
 125      * Streams are initially in playing state. The control always specifies a
 126      * change from paused to playing (false) or from playing to paused (true)
 127      * and streams are initially playing; a no-op cannot be requested.
 128      *
 129      * The control is never used if DEMUX_CAN_PAUSE fails.
 130      * Can fail.
 131      *
 132      * arg1= bool */
 133     DEMUX_SET_PAUSE_STATE = 0x200,
 134
 135     /** Seeks to the beginning of a title.
 136      *
 137      * The control is never used if DEMUX_GET_TITLE_INFO fails.
 138      * Can fail.
 139      *
 140      * arg1= int */
 141     DEMUX_SET_TITLE,
 142
 143     /** Seeks to the beginning of a chapter of the current title.
 144      *
 145      * The control is never used if DEMUX_GET_TITLE_INFO fails.
 146      * Can fail.
 147      *
 148      * arg1= int */
 149     DEMUX_SET_SEEKPOINT,        /* arg1= int            can fail */
 150
 151     /** Check which INPUT_UPDATE_XXX flag is set and reset the ones set.
 152      *
 153      * The unsigned* argument is set with the flags needed to be checked,
 154      * on return it contains the values that were reset during the call
 155      *
 156      * arg1= unsigned * */
 157     DEMUX_TEST_AND_CLEAR_FLAGS, /* arg1= unsigned*      can fail */
 158
 159     /** Read the title number currently playing
 160      *
 161      * Can fail.
 162      *
 163      * arg1= int * */
 164     DEMUX_GET_TITLE,            /* arg1= int*           can fail */
 165
 166     /* Read the seekpoint/chapter currently playing
 167      *
 168      * Can fail.
 169      *
 170      * arg1= int * */
 171     DEMUX_GET_SEEKPOINT,        /* arg1= int*           can fail */
 172
 173     /* I. Common queries to access_demux and demux */
 174     /* POSITION double between 0.0 and 1.0 */
 175     DEMUX_GET_POSITION = 0x300, /* arg1= double *       res=    */
 176     DEMUX_SET_POSITION,         /* arg1= double arg2= bool b_precise    res=can fail    */
 177
 178     /* LENGTH/TIME in microsecond, 0 if unknown */
 179     DEMUX_GET_LENGTH,           /* arg1= int64_t *      res=    */
 180     DEMUX_GET_TIME,             /* arg1= int64_t *      res=    */
 181     DEMUX_SET_TIME,             /* arg1= int64_t arg2= bool b_precise   res=can fail    */
 182
 183     /**
 184      * \todo Document
 185      *
 186      * \warning The prototype is different from STREAM_GET_TITLE_INFO
 187      *
 188      * Can fail, meaning there is only one title and one chapter.
 189      *
 190      * arg1= input_title_t ***, arg2=int *, arg3=int *pi_title_offset(0),
 191      * arg4= int *pi_seekpoint_offset(0) */
 192     DEMUX_GET_TITLE_INFO,
 193
 194     /* DEMUX_SET_GROUP_* / DEMUX_SET_ES is only a hint for demuxer (mainly DVB)
 195      * to avoid parsing everything (you should not use this to call
 196      * es_out_Control()).
 197      * If you don't know what to do with it, just IGNORE it: it is safe(r). */
 198     DEMUX_SET_GROUP_DEFAULT,
 199     DEMUX_SET_GROUP_ALL,
 200     DEMUX_SET_GROUP_LIST,       /* arg1= size_t, arg2= const int *, can fail */
 201     DEMUX_SET_ES,               /* arg1= int                            can fail */
 202
 203     /* Ask the demux to demux until the given date at the next pf_demux call
 204      * but not more (and not less, at the precision available of course).
 205      * XXX: not mandatory (except for subtitle demux) but will help a lot
 206      * for multi-input
 207      */
 208     DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= vlc_tick_t     can fail */
 209     /* FPS for correct subtitles handling */
 210     DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */
 211
 212     /* Meta data */
 213     DEMUX_HAS_UNSUPPORTED_META, /* arg1= bool *   res can fail    */
 214
 215     /* Attachments */
 216     DEMUX_GET_ATTACHMENTS,      /* arg1=input_attachment_t***, int* res=can fail */
 217
 218     /* RECORD you are ensured that it is never called twice with the same state
 219      * you should accept it only if the stream can be recorded without
 220      * any modification or header addition. */
 221     DEMUX_CAN_RECORD,           /* arg1=bool*   res=can fail(assume false) */
 222     /**
 223      * \todo Document
 224      *
 225      * \warning The prototype is different from STREAM_SET_RECORD_STATE
 226      *
 227      * The control is never used if DEMUX_CAN_RECORD fails or returns false.
 228      * Can fail.
 229      *
 230      * arg1= bool */
 231     DEMUX_SET_RECORD_STATE,
 232
 233     /* II. Specific access_demux queries */
 234
 235     /* DEMUX_CAN_CONTROL_RATE is called only if DEMUX_CAN_CONTROL_PACE has
 236      *  returned false. *pb_rate should be true when the rate can be changed
 237      * (using DEMUX_SET_RATE). */
 238     DEMUX_CAN_CONTROL_RATE,     /* arg1= bool*pb_rate */
 239     /* DEMUX_SET_RATE is called only if DEMUX_CAN_CONTROL_RATE has returned true.
 240      * It should return the value really used in *pi_rate */
 241     DEMUX_SET_RATE,             /* arg1= int*pi_rate                                        can fail */
 242
 243     /** Checks whether the stream is actually a playlist, rather than a real
 244      * stream.
 245      *
 246      * Can fail if the stream is not a playlist (same as returning false).
 247      *
 248      * arg1= bool * */
 249     DEMUX_IS_PLAYLIST,
 250
 251     /* Menu (VCD/DVD/BD) Navigation */
 252     /** Activate the navigation item selected. Can fail */
 253     DEMUX_NAV_ACTIVATE,
 254     /** Use the up arrow to select a navigation item above. Can fail */
 255     DEMUX_NAV_UP,
 256     /** Use the down arrow to select a navigation item under. Can fail */
 257     DEMUX_NAV_DOWN,
 258     /** Use the left arrow to select a navigation item on the left. Can fail */
 259     DEMUX_NAV_LEFT,
 260     /** Use the right arrow to select a navigation item on the right. Can fail */
 261     DEMUX_NAV_RIGHT,
 262     /** Activate the popup Menu (for BD). Can fail */
 263     DEMUX_NAV_POPUP,
 264     /** Activate disc Root Menu. Can fail */
 265     DEMUX_NAV_MENU,            /* res=can fail */
 266     /** Enable/Disable a demux filter
 267      * \warning This has limited support, and is likely to break if more than
 268      * a single demux_filter is present in the chain. This is not guaranteed to
 269      * work in future VLC versions, nor with all demux filters
 270      */
 271     DEMUX_FILTER_ENABLE,
 272     DEMUX_FILTER_DISABLE
 273 };
 274
 275 /*************************************************************************
 276  * Main Demux
 277  *************************************************************************/
 278
 279 VLC_API demux_t *demux_New( vlc_object_t *p_obj, const char *psz_name,
 280                             stream_t *s, es_out_t *out );
 281
 282 static inline void demux_Delete(demux_t *demux)
 283 {
 284     vlc_stream_Delete(demux);
 285 }
 286
 287 VLC_API int demux_vaControlHelper( stream_t *, int64_t i_start, int64_t i_end,
 288                                    int64_t i_bitrate, int i_align, int i_query, va_list args );
 289
 290 VLC_USED static inline int demux_Demux( demux_t *p_demux )
 291 {
 292     if( !p_demux->pf_demux )
 293         return VLC_DEMUXER_SUCCESS;
 294
 295     return p_demux->pf_demux( p_demux );
 296 }
 297
 298 VLC_API int demux_vaControl( demux_t *p_demux, int i_query, va_list args );
 299
 300 static inline int demux_Control( demux_t *p_demux, int i_query, ... )
 301 {
 302     va_list args;
 303     int     i_result;
 304
 305     va_start( args, i_query );
 306     i_result = demux_vaControl( p_demux, i_query, args );
 307     va_end( args );
 308     return i_result;
 309 }
 310
 311 /*************************************************************************
 312  * Miscellaneous helpers for demuxers
 313  *************************************************************************/
 314
 315 #ifndef __cplusplus
 316 static inline void demux_UpdateTitleFromStream( demux_t *demux,
 317     int *restrict titlep, int *restrict seekpointp,
 318     unsigned *restrict updatep )
 319 {
 320     stream_t *s = demux->s;
 321     unsigned title, seekpoint;
 322
 323     if( vlc_stream_Control( s, STREAM_GET_TITLE, &title ) == VLC_SUCCESS
 324      && title != (unsigned)*titlep )
 325     {
 326         *titlep = title;
 327         *updatep |= INPUT_UPDATE_TITLE;
 328     }
 329
 330     if( vlc_stream_Control( s, STREAM_GET_SEEKPOINT,
 331                             &seekpoint ) == VLC_SUCCESS
 332      && seekpoint != (unsigned)*seekpointp )
 333     {
 334         *seekpointp = seekpoint;
 335         *updatep |= INPUT_UPDATE_SEEKPOINT;
 336     }
 337 }
 338 # define demux_UpdateTitleFromStream(demux) \
 339      demux_UpdateTitleFromStream(demux, \
 340          &((demux_sys_t *)((demux)->p_sys))->current_title, \
 341          &((demux_sys_t *)((demux)->p_sys))->current_seekpoint, \
 342          &((demux_sys_t *)((demux)->p_sys))->updates)
 343 #endif
 344
 345 VLC_USED
 346 static inline bool demux_IsPathExtension( demux_t *p_demux, const char *psz_extension )
 347 {
 348     const char *name = (p_demux->psz_filepath != NULL) ? p_demux->psz_filepath
 349                                                        : p_demux->psz_location;
 350     const char *psz_ext = strrchr ( name, '.' );
 351     if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
 352         return false;
 353     return true;
 354 }
 355
 356 VLC_USED
 357 static inline bool demux_IsContentType(demux_t *demux, const char *type)
 358 {
 359     return stream_IsMimeType(demux->s, type);
 360 }
 361
 362 VLC_USED
 363 static inline bool demux_IsForced( demux_t *p_demux, const char *psz_name )
 364 {
 365    if( p_demux->psz_name == NULL || strcmp( p_demux->psz_name, psz_name ) )
 366         return false;
 367     return true;
 368 }
 369
 370 /**
 371  * This function will create a packetizer suitable for a demuxer that parses
 372  * elementary stream.
 373  *
 374  * The provided es_format_t will be cleaned on error or by
 375  * demux_PacketizerDestroy.
 376  */
 377 VLC_API decoder_t * demux_PacketizerNew( demux_t *p_demux, es_format_t *p_fmt, const char *psz_msg ) VLC_USED;
 378
 379 /**
 380  * This function will destroy a packetizer create by demux_PacketizerNew.
 381  */
 382 VLC_API void demux_PacketizerDestroy( decoder_t *p_packetizer );
 383
 384 /* */
 385 #define DEMUX_INIT_COMMON() do {            \
 386     p_demux->pf_control = Control;          \
 387     p_demux->pf_demux = Demux;              \
 388     p_demux->p_sys = calloc( 1, sizeof( demux_sys_t ) ); \
 389     if( !p_demux->p_sys ) return VLC_ENOMEM;\
 390     } while(0)
 391
 392 /**
 393  * \defgroup chained_demux Chained demultiplexer
 394  * Demultiplexers wrapped by another demultiplexer
 395  * @{
 396  */
 397
 398 typedef struct vlc_demux_chained_t vlc_demux_chained_t;
 399
 400 /**
 401  * Creates a chained demuxer.
 402  *
 403  * This creates a thread running a demuxer whose input stream is generated
 404  * directly by the caller. This typically handles some sort of stream within a
 405  * stream, e.g. MPEG-TS within something else.
 406  *
 407  * \note There are a number of limitations to this approach. The chained
 408  * demuxer is run asynchronously in a separate thread. Most demuxer controls
 409  * are synchronous and therefore unavailable in this case. Also the input
 410  * stream is a simple FIFO, so the chained demuxer cannot perform seeks.
 411  * Lastly, most errors cannot be detected.
 412  *
 413  * \param parent parent VLC object
 414  * \param name chained demux module name (e.g. "ts")
 415  * \param out elementary stream output for the chained demux
 416  * \return a non-NULL pointer on success, NULL on failure.
 417  */
 418 VLC_API vlc_demux_chained_t *vlc_demux_chained_New(vlc_object_t *parent,
 419                                                    const char *name,
 420                                                    es_out_t *out);
 421
 422 /**
 423  * Destroys a chained demuxer.
 424  *
 425  * Sends an end-of-stream to the chained demuxer, and releases all underlying
 426  * allocated resources.
 427  */
 428 VLC_API void vlc_demux_chained_Delete(vlc_demux_chained_t *);
 429
 430 /**
 431  * Sends data to a chained demuxer.
 432  *
 433  * This queues data for a chained demuxer to consume.
 434  *
 435  * \param block data block to queue
 436  */
 437 VLC_API void vlc_demux_chained_Send(vlc_demux_chained_t *, block_t *block);
 438
 439 /**
 440  * Controls a chained demuxer.
 441  *
 442  * This performs a <b>demux</b> (i.e. DEMUX_...) control request on a chained
 443  * demux.
 444  *
 445  * \note In most cases, vlc_demux_chained_Control() should be used instead.
 446  * \warning As per vlc_demux_chained_New(), most demux controls are not, and
 447  * cannot be, supported; VLC_EGENERIC is returned.
 448  *
 449  * \param query demux control (see \ref demux_query_e)
 450  * \param args variable arguments (depending on the query)
 451  */
 452 VLC_API int vlc_demux_chained_ControlVa(vlc_demux_chained_t *, int query,
 453                                         va_list args);
 454
 455 static inline int vlc_demux_chained_Control(vlc_demux_chained_t *dc, int query,
 456                                             ...)
 457 {
 458     va_list ap;
 459     int ret;
 460
 461     va_start(ap, query);
 462     ret = vlc_demux_chained_ControlVa(dc, query, ap);
 463     va_end(ap);
 464     return ret;
 465 }
 466
 467 /**
 468  * @}
 469  */
 470
 471 /**
 472  * @}
 473  */
 474
 475 #endif