vlc_demux.h 16.9 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_demux.h: Demuxer descriptor, queries and methods
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2005 VLC authors and VideoLAN
5
 * $Id$
6 7 8
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12 13 14 15
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

24 25
#ifndef VLC_DEMUX_H
#define VLC_DEMUX_H 1
26

27 28 29
#include <stdlib.h>
#include <string.h>

30 31 32 33
#include <vlc_es.h>
#include <vlc_stream.h>
#include <vlc_es_out.h>

34
/**
35 36 37
 * \defgroup demux Demultiplexer
 * \ingroup input
 * Demultiplexers (file format parsers)
38
 * @{
39 40
 * \file
 * Demultiplexer modules interface
41 42 43 44 45 46 47 48 49 50 51 52
 */

struct demux_t
{
    VLC_COMMON_MEMBERS

    /* Module properties */
    module_t    *p_module;

    /* eg informative but needed (we can have access+demux) */
    char        *psz_access;
    char        *psz_demux;
53 54
    char        *psz_location;
    char        *psz_file;
55

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
    union {
        /**
         * Input stream
         *
         * Depending on the module capability:
         * - "demux": input byte stream (not NULL)
         * - "access_demux": a NULL pointer
         * - "demux_filter": undefined
         */
        stream_t *s;
        /**
         * Input demuxer
         *
         * If the module capability is "demux_filter", this is the upstream
         * demuxer or demux filter. Otherwise, this is undefined.
         */
        demux_t *p_next;
73
    };
74 75

    /* es output */
76
    es_out_t    *out;   /* our p_es_out */
77

78 79
    bool         b_preparsing; /* True if the demux is used to preparse */

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
    /* set by demuxer */
    int (*pf_demux)  ( demux_t * );   /* demux one frame only */
    int (*pf_control)( demux_t *, int i_query, va_list args);

    /* Demux has to maintain them uptodate
     * when it is responsible of seekpoint/title */
    struct
    {
        unsigned int i_update;  /* Demux sets them on change,
                                   Input removes them once take into account*/
        /* Seekpoint/Title at demux level */
        int          i_title;       /* idem, start from 0 (could be menu) */
        int          i_seekpoint;   /* idem, start from 0 */
    } info;
    demux_sys_t *p_sys;
95 96 97

    /* Weak link to parent input */
    input_thread_t *p_input;
98 99
};

100 101 102 103 104
/* pf_demux return values */
#define VLC_DEMUXER_EOF       0
#define VLC_DEMUXER_EGENERIC -1
#define VLC_DEMUXER_SUCCESS   1

105 106 107 108 109
/* demux_t.info.i_update field */
#define INPUT_UPDATE_TITLE      0x0010
#define INPUT_UPDATE_SEEKPOINT  0x0020
#define INPUT_UPDATE_META       0x0040
#define INPUT_UPDATE_TITLE_LIST 0x0100
110 111

/* demux_meta_t is returned by "meta reader" module to the demuxer */
112
typedef struct demux_meta_t
113
{
114
    VLC_COMMON_MEMBERS
115 116
    input_item_t *p_item; /***< the input item that is being read */

117 118 119 120
    vlc_meta_t *p_meta;                 /**< meta data */

    int i_attachments;                  /**< number of attachments */
    input_attachment_t **attachments;    /**< array of attachments */
121
} demux_meta_t;
122

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
/**
 * Control query identifiers for use with demux_t.pf_control
 *
 * In the individual identifier description, the input stream refers to
 * demux_t.s if non-NULL, and the output refers to demux_t.out.
 *
 * A demuxer is synchronous if it only accesses its input stream and the
 * output from within its demux_t callbacks, i.e. demux.pf_demux and
 * demux_t.pf_control.
 *
 * A demuxer is threaded if it accesses either or both input and output
 * asynchronously.
 *
 * An access-demuxer is a demuxer without input, i.e. demux_t.s == NULL).
 */
138 139
enum demux_query_e
{
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
    /** Checks whether the stream supports seeking.
     * Can fail if seeking is not supported (same as returning false).
     * \bug Failing should not be allowed.
     *
     * arg1 = bool * */
    DEMUX_CAN_SEEK,

    /** Checks whether (long) pause then stream resumption is supported.
     * Can fail only if synchronous and <b>not</b> an access-demuxer. The
     * underlying input stream then determines if pause is supported.
     * \bug Failing should not be allowed.
     *
     * arg1= bool * */
    DEMUX_CAN_PAUSE = 0x002,

    /** Whether the stream can be read at an arbitrary pace.
     * Cannot fail.
     *
     * arg1= bool * */
    DEMUX_CAN_CONTROL_PACE,

    /** Retrieves the PTS delay (roughly the default buffer duration).
     * Can fail only if synchronous and <b>not</b> an access-demuxer. The
     * underlying input stream then determines the PTS delay.
     *
     * arg1= int64_t * */
    DEMUX_GET_PTS_DELAY = 0x101,

    /** Retrieves stream meta-data.
     * Should fail if no meta-data were retrieved.
     *
     * arg1= vlc_meta_t * */
    DEMUX_GET_META = 0x105,

    /** Retrieves an estimate of signal quality and strength.
     * Can fail.
     *
     * arg1=double *quality, arg2=double *strength */
    DEMUX_GET_SIGNAL = 0x107,

    /** Sets the paused or playing/resumed state.
     *
     * Streams are initially in playing state. The control always specifies a
     * change from paused to playing (false) or from playing to paused (true)
     * and streams are initially playing; a no-op cannot be requested.
     *
     * The control is never used if DEMUX_CAN_PAUSE fails.
     * Can fail.
     *
     * arg1= bool */
    DEMUX_SET_PAUSE_STATE = 0x200,

    /** Seeks to the beginning of a title.
     *
     * The control is never used if DEMUX_GET_TITLE_INFO fails.
     * Can fail.
     *
     * arg1= int */
    DEMUX_SET_TITLE,

    /** Seeks to the beginning of a chapter of the current title.
     *
     * The control is never used if DEMUX_GET_TITLE_INFO fails.
     * Can fail.
     *
     * arg1= int */
    DEMUX_SET_SEEKPOINT,        /* arg1= int            can fail */

208 209 210
    /** Check which INPUT_UPDATE_XXX flag is set and reset the ones set.
     *
     * The unsigned* argument is set with the flags needed to be checked,
211
     * on return it contains the values that were reset during the call
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
     *
     * This can can fail, in which case flags from demux_t.info.i_update
     * are read/reset
     *
     * arg1= unsigned * */
    DEMUX_TEST_AND_CLEAR_FLAGS, /* arg1= unsigned*      can fail */

    /** Read the title number currently playing
     *
     * Can fail, in which case demux_t.info.i_title is used
     *
     * arg1= int * */
    DEMUX_GET_TITLE,            /* arg1= int*           can fail */

    /* Read the seekpoint/chapter currently playing
     *
     * Can fail, in which case demux_t.info.i_seekpoint is used
     *
     * arg1= int * */
    DEMUX_GET_SEEKPOINT,        /* arg1= int*           can fail */

233 234
    /* I. Common queries to access_demux and demux */
    /* POSITION double between 0.0 and 1.0 */
235
    DEMUX_GET_POSITION = 0x300, /* arg1= double *       res=    */
236
    DEMUX_SET_POSITION,         /* arg1= double arg2= bool b_precise    res=can fail    */
237 238 239 240

    /* LENGTH/TIME in microsecond, 0 if unknown */
    DEMUX_GET_LENGTH,           /* arg1= int64_t *      res=    */
    DEMUX_GET_TIME,             /* arg1= int64_t *      res=    */
241
    DEMUX_SET_TIME,             /* arg1= int64_t arg2= bool b_precise   res=can fail    */
242

243 244 245 246 247 248 249 250 251 252
    /**
     * \todo Document
     *
     * \warning The prototype is different from STREAM_GET_TITLE_INFO
     *
     * Can fail, meaning there is only one title and one chapter.
     *
     * arg1= input_title_t ***, arg2=int *, arg3=int *pi_title_offset(0),
     * arg4= int *pi_seekpoint_offset(0) */
    DEMUX_GET_TITLE_INFO,
253

254
    /* DEMUX_SET_GROUP/SET_ES only a hint for demuxer (mainly DVB) to allow not
255 256 257
     * reading everything (you should not use this to call es_out_Control)
     * if you don't know what to do with it, just IGNORE it, it is safe(r)
     * -1 means all group, 0 default group (first es added) */
Laurent Aimar's avatar
Laurent Aimar committed
258
    DEMUX_SET_GROUP,            /* arg1= int, arg2=const vlc_list_t *   can fail */
259
    DEMUX_SET_ES,               /* arg1= int                            can fail */
260

261
    /* Ask the demux to demux until the given date at the next pf_demux call
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
262
     * but not more (and not less, at the precision available of course).
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
263
     * XXX: not mandatory (except for subtitle demux) but will help a lot
264 265
     * for multi-input
     */
266
    DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= int64_t        can fail */
267
    /* FPS for correct subtitles handling */
268
    DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */
269

270
    /* Meta data */
271
    DEMUX_HAS_UNSUPPORTED_META, /* arg1= bool *   res can fail    */
272

273 274
    /* Attachments */
    DEMUX_GET_ATTACHMENTS,      /* arg1=input_attachment_t***, int* res=can fail */
275

276 277
    /* RECORD you are ensured that it is never called twice with the same state
     * you should accept it only if the stream can be recorded without
278 279
     * any modification or header addition. */
    DEMUX_CAN_RECORD,           /* arg1=bool*   res=can fail(assume false) */
280 281 282 283 284 285 286 287 288 289
    /**
     * \todo Document
     *
     * \warning The prototype is different from STREAM_SET_RECORD_STATE
     *
     * The control is never used if DEMUX_CAN_RECORD fails or returns false.
     * Can fail.
     *
     * arg1= bool */
    DEMUX_SET_RECORD_STATE,
290

291
    /* II. Specific access_demux queries */
292

293 294 295 296
    /* DEMUX_CAN_CONTROL_RATE is called only if DEMUX_CAN_CONTROL_PACE has
     *  returned false. *pb_rate should be true when the rate can be changed
     * (using DEMUX_SET_RATE). */
    DEMUX_CAN_CONTROL_RATE,     /* arg1= bool*pb_rate */
297 298 299
    /* DEMUX_SET_RATE is called only if DEMUX_CAN_CONTROL_RATE has returned true.
     * It should return the value really used in *pi_rate */
    DEMUX_SET_RATE,             /* arg1= int*pi_rate                                        can fail */
300

301 302 303 304 305 306 307 308 309
    /** Checks whether the stream is actually a playlist, rather than a real
     * stream.
     *
     * \warning The prototype is different from STREAM_IS_DIRECTORY.
     *
     * Can fail if the stream is not a playlist (same as returning false).
     *
     * arg1= bool * */
    DEMUX_IS_PLAYLIST,
310

311 312 313 314 315 316 317 318 319 320 321 322 323
    /* Menu (VCD/DVD/BD) Navigation */
    /** Activate the navigation item selected. Can fail */
    DEMUX_NAV_ACTIVATE,
    /** Use the up arrow to select a navigation item above. Can fail */
    DEMUX_NAV_UP,
    /** Use the down arrow to select a navigation item under. Can fail */
    DEMUX_NAV_DOWN,
    /** Use the left arrow to select a navigation item on the left. Can fail */
    DEMUX_NAV_LEFT,
    /** Use the right arrow to select a navigation item on the right. Can fail */
    DEMUX_NAV_RIGHT,
    /** Activate the popup Menu (for BD). Can fail */
    DEMUX_NAV_POPUP,
324 325
    /** Activate disc Root Menu. Can fail */
    DEMUX_NAV_MENU,            /* res=can fail */
326 327
};

François Cartegnie's avatar
François Cartegnie committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
/*************************************************************************
 * Main Demux
 *************************************************************************/

/* stream_t *s could be null and then it mean a access+demux in one */
VLC_API demux_t *demux_New( vlc_object_t *p_obj, const char *psz_name,
                            const char *psz_path, stream_t *s, es_out_t *out );

VLC_API void demux_Delete( demux_t * );


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 );

VLC_USED static inline int demux_Demux( demux_t *p_demux )
{
    if( !p_demux->pf_demux )
345
        return VLC_DEMUXER_SUCCESS;
François Cartegnie's avatar
François Cartegnie committed
346 347 348 349

    return p_demux->pf_demux( p_demux );
}

350
VLC_API int demux_vaControl( demux_t *p_demux, int i_query, va_list args );
François Cartegnie's avatar
François Cartegnie committed
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365

static inline int demux_Control( demux_t *p_demux, int i_query, ... )
{
    va_list args;
    int     i_result;

    va_start( args, i_query );
    i_result = demux_vaControl( p_demux, i_query, args );
    va_end( args );
    return i_result;
}

/*************************************************************************
 * Miscellaneous helpers for demuxers
 *************************************************************************/
366

367 368 369 370 371
static inline void demux_UpdateTitleFromStream( demux_t *demux )
{
    stream_t *s = demux->s;
    unsigned title, seekpoint;

372
    if( vlc_stream_Control( s, STREAM_GET_TITLE, &title ) == VLC_SUCCESS
373 374 375
     && title != (unsigned)demux->info.i_title )
    {
        demux->info.i_title = title;
376
        demux->info.i_update |= INPUT_UPDATE_TITLE;
377 378
    }

379 380
    if( vlc_stream_Control( s, STREAM_GET_SEEKPOINT,
                            &seekpoint ) == VLC_SUCCESS
381 382 383
     && seekpoint != (unsigned)demux->info.i_seekpoint )
    {
        demux->info.i_seekpoint = seekpoint;
384
        demux->info.i_update |= INPUT_UPDATE_SEEKPOINT;
385 386 387
    }
}

388
VLC_USED
389
static inline bool demux_IsPathExtension( demux_t *p_demux, const char *psz_extension )
390
{
391 392 393
    const char *name = (p_demux->psz_file != NULL) ? p_demux->psz_file
                                                   : p_demux->psz_location;
    const char *psz_ext = strrchr ( name, '.' );
394
    if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
395 396
        return false;
    return true;
397
}
398

399 400 401
VLC_USED
static inline bool demux_IsContentType(demux_t *demux, const char *type)
{
402
    return stream_IsMimeType(demux->s, type);
403 404
}

405
VLC_USED
406
static inline bool demux_IsForced( demux_t *p_demux, const char *psz_name )
407
{
408
   if( !p_demux->psz_demux || strcmp( p_demux->psz_demux, psz_name ) )
409 410
        return false;
    return true;
411 412
}

413 414 415 416 417 418 419
/**
 * This function will create a packetizer suitable for a demuxer that parses
 * elementary stream.
 *
 * The provided es_format_t will be cleaned on error or by
 * demux_PacketizerDestroy.
 */
420
VLC_API decoder_t * demux_PacketizerNew( demux_t *p_demux, es_format_t *p_fmt, const char *psz_msg ) VLC_USED;
421 422 423 424

/**
 * This function will destroy a packetizer create by demux_PacketizerNew.
 */
425
VLC_API void demux_PacketizerDestroy( decoder_t *p_packetizer );
426 427

/* */
428 429 430
#define DEMUX_INIT_COMMON() do {            \
    p_demux->pf_control = Control;          \
    p_demux->pf_demux = Demux;              \
431
    p_demux->p_sys = calloc( 1, sizeof( demux_sys_t ) ); \
432
    if( !p_demux->p_sys ) return VLC_ENOMEM;\
433
    } while(0)
434

435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
/**
 * \defgroup chained_demux Chained demultiplexer
 * Demultiplexers wrapped by another demultiplexer
 * @{
 */

typedef struct vlc_demux_chained_t vlc_demux_chained_t;

/**
 * Creates a chained demuxer.
 *
 * This creates a thread running a demuxer whose input stream is generated
 * directly by the caller. This typically handles some sort of stream within a
 * stream, e.g. MPEG-TS within something else.
 *
 * \note There are a number of limitations to this approach. The chained
 * demuxer is run asynchronously in a separate thread. Most demuxer controls
 * are synchronous and therefore unavailable in this case. Also the input
 * stream is a simple FIFO, so the chained demuxer cannot perform seeks.
 * Lastly, most errors cannot be detected.
 *
 * \param parent parent VLC object
 * \param name chained demux module name (e.g. "ts")
 * \param out elementary stream output for the chained demux
 * \return a non-NULL pointer on success, NULL on failure.
 */
VLC_API vlc_demux_chained_t *vlc_demux_chained_New(vlc_object_t *parent,
                                                   const char *name,
                                                   es_out_t *out);

/**
 * Destroys a chained demuxer.
 *
 * Sends an end-of-stream to the chained demuxer, and releases all underlying
 * allocated resources.
 */
VLC_API void vlc_demux_chained_Delete(vlc_demux_chained_t *);

/**
 * Sends data to a chained demuxer.
 *
 * This queues data for a chained demuxer to consume.
 *
 * \param block data block to queue
 */
VLC_API void vlc_demux_chained_Send(vlc_demux_chained_t *, block_t *block);

/**
 * Controls a chained demuxer.
 *
 * This performs a <b>demux</b> (i.e. DEMUX_...) control request on a chained
 * demux.
 *
 * \note In most cases, vlc_demux_chained_Control() should be used instead.
 * \warning As per vlc_demux_chained_New(), most demux controls are not, and
 * cannot be, supported; VLC_EGENERIC is returned.
 *
 * \param query demux control (see \ref demux_query_e)
 * \param args variable arguments (depending on the query)
 */
VLC_API int vlc_demux_chained_ControlVa(vlc_demux_chained_t *, int query,
                                        va_list args);

static inline int vlc_demux_chained_Control(vlc_demux_chained_t *dc, int query,
                                            ...)
{
    va_list ap;
    int ret;

    va_start(ap, query);
    ret = vlc_demux_chained_ControlVa(dc, query, ap);
    va_end(ap);
    return ret;
}

/**
 * @}
 */

514 515 516 517 518
/**
 * @}
 */

#endif