vlc_demux.h 15.6 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
/* pf_demux return values */
#define VLC_DEMUXER_EOF       0
#define VLC_DEMUXER_EGENERIC -1
#define VLC_DEMUXER_SUCCESS   1

48
/* DEMUX_TEST_AND_CLEAR flags */
49 50 51 52
#define INPUT_UPDATE_TITLE      0x0010
#define INPUT_UPDATE_SEEKPOINT  0x0020
#define INPUT_UPDATE_META       0x0040
#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 59
    input_item_t *p_item; /***< the input item that is being read */

60 61 62 63
    vlc_meta_t *p_meta;                 /**< meta data */

    int i_attachments;                  /**< number of attachments */
    input_attachment_t **attachments;    /**< array of attachments */
64
} demux_meta_t;
65

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
/**
 * 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).
 */
81 82
enum demux_query_e
{
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
    /** 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 */

151 152 153
    /** 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,
154
     * on return it contains the values that were reset during the call
155 156 157 158 159 160
     *
     * arg1= unsigned * */
    DEMUX_TEST_AND_CLEAR_FLAGS, /* arg1= unsigned*      can fail */

    /** Read the title number currently playing
     *
161
     * Can fail.
162 163 164 165 166 167
     *
     * arg1= int * */
    DEMUX_GET_TITLE,            /* arg1= int*           can fail */

    /* Read the seekpoint/chapter currently playing
     *
168
     * Can fail.
169 170 171 172
     *
     * arg1= int * */
    DEMUX_GET_SEEKPOINT,        /* arg1= int*           can fail */

173 174
    /* I. Common queries to access_demux and demux */
    /* 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 179 180

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

183 184 185 186 187 188 189 190 191 192
    /**
     * \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,
193

194
    /* DEMUX_SET_GROUP/SET_ES only a hint for demuxer (mainly DVB) to allow not
195 196 197
     * 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
198
    DEMUX_SET_GROUP,            /* arg1= int, arg2=const vlc_list_t *   can fail */
199
    DEMUX_SET_ES,               /* arg1= int                            can fail */
200

201
    /* 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
202
     * but not more (and not less, at the precision available of course).
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
203
     * XXX: not mandatory (except for subtitle demux) but will help a lot
204 205
     * for multi-input
     */
206
    DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= int64_t        can fail */
207
    /* FPS for correct subtitles handling */
208
    DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */
209

210
    /* Meta data */
211
    DEMUX_HAS_UNSUPPORTED_META, /* arg1= bool *   res can fail    */
212

213 214
    /* Attachments */
    DEMUX_GET_ATTACHMENTS,      /* arg1=input_attachment_t***, int* res=can fail */
215

216 217
    /* 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
218 219
     * any modification or header addition. */
    DEMUX_CAN_RECORD,           /* arg1=bool*   res=can fail(assume false) */
220 221 222 223 224 225 226 227 228 229
    /**
     * \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,
230

231
    /* II. Specific access_demux queries */
232

233 234 235 236
    /* 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 */
237 238 239
    /* 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 */
240

241 242 243 244 245 246 247
    /** Checks whether the stream is actually a playlist, rather than a real
     * stream.
     *
     * Can fail if the stream is not a playlist (same as returning false).
     *
     * arg1= bool * */
    DEMUX_IS_PLAYLIST,
248

249 250 251 252 253 254 255 256 257 258 259 260 261
    /* 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,
262 263
    /** Activate disc Root Menu. Can fail */
    DEMUX_NAV_MENU,            /* res=can fail */
264 265 266 267 268 269 270
    /** Enable/Disable a demux filter
     * \warning This has limited support, and is likely to break if more than
     * a single demux_filter is present in the chain. This is not guaranteed to
     * work in future VLC versions, nor with all demux filters
     */
    DEMUX_FILTER_ENABLE,
    DEMUX_FILTER_DISABLE
271 272
};

François Cartegnie's avatar
François Cartegnie committed
273 274 275 276 277
/*************************************************************************
 * Main Demux
 *************************************************************************/

VLC_API demux_t *demux_New( vlc_object_t *p_obj, const char *psz_name,
278
                            stream_t *s, es_out_t *out );
François Cartegnie's avatar
François Cartegnie committed
279

280 281 282 283
static inline void demux_Delete(demux_t *demux)
{
    vlc_stream_Delete(demux);
}
François Cartegnie's avatar
François Cartegnie committed
284 285 286 287 288 289 290

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 )
291
        return VLC_DEMUXER_SUCCESS;
François Cartegnie's avatar
François Cartegnie committed
292 293 294 295

    return p_demux->pf_demux( p_demux );
}

296
VLC_API int demux_vaControl( demux_t *p_demux, int i_query, va_list args );
François Cartegnie's avatar
François Cartegnie committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311

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
 *************************************************************************/
312

313 314
#ifndef __cplusplus
static inline void demux_UpdateTitleFromStream( demux_t *demux,
315 316
    int *restrict titlep, int *restrict seekpointp,
    unsigned *restrict updatep )
317 318 319 320
{
    stream_t *s = demux->s;
    unsigned title, seekpoint;

321
    if( vlc_stream_Control( s, STREAM_GET_TITLE, &title ) == VLC_SUCCESS
322
     && title != (unsigned)*titlep )
323
    {
324
        *titlep = title;
325
        *updatep |= INPUT_UPDATE_TITLE;
326 327
    }

328 329
    if( vlc_stream_Control( s, STREAM_GET_SEEKPOINT,
                            &seekpoint ) == VLC_SUCCESS
330
     && seekpoint != (unsigned)*seekpointp )
331
    {
332
        *seekpointp = seekpoint;
333
        *updatep |= INPUT_UPDATE_SEEKPOINT;
334 335
    }
}
336
# define demux_UpdateTitleFromStream(demux) \
337 338
     demux_UpdateTitleFromStream(demux, \
         &((demux_sys_t *)((demux)->p_sys))->current_title, \
339 340
         &((demux_sys_t *)((demux)->p_sys))->current_seekpoint, \
         &((demux_sys_t *)((demux)->p_sys))->updates)
341
#endif
342

343
VLC_USED
344
static inline bool demux_IsPathExtension( demux_t *p_demux, const char *psz_extension )
345
{
346 347
    const char *name = (p_demux->psz_filepath != NULL) ? p_demux->psz_filepath
                                                       : p_demux->psz_location;
348
    const char *psz_ext = strrchr ( name, '.' );
349
    if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
350 351
        return false;
    return true;
352
}
353

354 355 356
VLC_USED
static inline bool demux_IsContentType(demux_t *demux, const char *type)
{
357
    return stream_IsMimeType(demux->s, type);
358 359
}

360
VLC_USED
361
static inline bool demux_IsForced( demux_t *p_demux, const char *psz_name )
362
{
363
   if( p_demux->psz_name == NULL || strcmp( p_demux->psz_name, psz_name ) )
364 365
        return false;
    return true;
366 367
}

368 369 370 371 372 373 374
/**
 * 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.
 */
375
VLC_API decoder_t * demux_PacketizerNew( demux_t *p_demux, es_format_t *p_fmt, const char *psz_msg ) VLC_USED;
376 377 378 379

/**
 * This function will destroy a packetizer create by demux_PacketizerNew.
 */
380
VLC_API void demux_PacketizerDestroy( decoder_t *p_packetizer );
381 382

/* */
383 384 385
#define DEMUX_INIT_COMMON() do {            \
    p_demux->pf_control = Control;          \
    p_demux->pf_demux = Demux;              \
386
    p_demux->p_sys = calloc( 1, sizeof( demux_sys_t ) ); \
387
    if( !p_demux->p_sys ) return VLC_ENOMEM;\
388
    } while(0)
389

390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 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
/**
 * \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;
}

/**
 * @}
 */

469 470 471 472 473
/**
 * @}
 */

#endif