vlc_demux.h 12.9 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_demux.h: Demuxer descriptor, queries and methods
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
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
LGPL  
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
LGPL  
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
LGPL  
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

Clément Stenac's avatar
Clément Stenac committed
27 28 29 30
#include <vlc_es.h>
#include <vlc_stream.h>
#include <vlc_es_out.h>

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

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;
50 51
    char        *psz_location;
    char        *psz_file;
52 53 54 55 56

    /* input stream */
    stream_t    *s;     /* NULL in case of a access+demux in one */

    /* es output */
57
    es_out_t    *out;   /* our p_es_out */
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

    /* 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;
74 75 76

    /* Weak link to parent input */
    input_thread_t *p_input;
77 78
};

79 80 81 82 83
/* pf_demux return values */
#define VLC_DEMUXER_EOF       0
#define VLC_DEMUXER_EGENERIC -1
#define VLC_DEMUXER_SUCCESS   1

84 85 86 87 88
/* 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
89 90

/* demux_meta_t is returned by "meta reader" module to the demuxer */
91
typedef struct demux_meta_t
92
{
93
    VLC_COMMON_MEMBERS
94 95
    input_item_t *p_item; /***< the input item that is being read */

96 97 98 99
    vlc_meta_t *p_meta;                 /**< meta data */

    int i_attachments;                  /**< number of attachments */
    input_attachment_t **attachments;    /**< array of attachments */
100
} demux_meta_t;
101

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
/**
 * 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).
 */
117 118
enum demux_query_e
{
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 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
    /** 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 */

187 188
    /* I. Common queries to access_demux and demux */
    /* POSITION double between 0.0 and 1.0 */
189
    DEMUX_GET_POSITION = 0x300, /* arg1= double *       res=    */
190
    DEMUX_SET_POSITION,         /* arg1= double arg2= bool b_precise    res=can fail    */
191 192 193 194

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

197 198 199 200 201 202 203 204 205 206
    /**
     * \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,
207

208
    /* DEMUX_SET_GROUP/SET_ES only a hint for demuxer (mainly DVB) to allow not
209 210 211
     * 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
212
    DEMUX_SET_GROUP,            /* arg1= int, arg2=const vlc_list_t *   can fail */
213
    DEMUX_SET_ES,               /* arg1= int                            can fail */
214

215
    /* 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
216
     * but not more (and not less, at the precision available of course).
Rémi Denis-Courmont's avatar
Typos  
Rémi Denis-Courmont committed
217
     * XXX: not mandatory (except for subtitle demux) but will help a lot
218 219
     * for multi-input
     */
220
    DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= int64_t        can fail */
221
    /* FPS for correct subtitles handling */
222
    DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */
Laurent Aimar's avatar
Laurent Aimar committed
223

224
    /* Meta data */
225
    DEMUX_HAS_UNSUPPORTED_META, /* arg1= bool *   res can fail    */
226

Laurent Aimar's avatar
Laurent Aimar committed
227 228
    /* Attachments */
    DEMUX_GET_ATTACHMENTS,      /* arg1=input_attachment_t***, int* res=can fail */
229

230 231
    /* 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
232 233
     * any modification or header addition. */
    DEMUX_CAN_RECORD,           /* arg1=bool*   res=can fail(assume false) */
234 235 236 237 238 239 240 241 242 243
    /**
     * \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,
244

245
    /* II. Specific access_demux queries */
246 247 248 249

    /* 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)
     * *pb_ts_rescale should be true when the timestamps (pts/dts/pcr) have to be rescaled */
250
    DEMUX_CAN_CONTROL_RATE,     /* arg1= bool*pb_rate arg2= bool*pb_ts_rescale  can fail(assume false) */
251 252 253
    /* 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 */
254

255 256 257 258 259 260 261 262 263
    /** 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,
264

265 266 267 268 269 270 271 272 273 274 275 276 277
    /* 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,
278 279
};

François Cartegnie's avatar
François Cartegnie committed
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
/*************************************************************************
 * 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 )
        return 1;

    return p_demux->pf_demux( p_demux );
}

302
VLC_API int demux_vaControl( demux_t *p_demux, int i_query, va_list args );
François Cartegnie's avatar
François Cartegnie committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317

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

319 320 321 322 323 324 325 326 327
static inline void demux_UpdateTitleFromStream( demux_t *demux )
{
    stream_t *s = demux->s;
    unsigned title, seekpoint;

    if( stream_Control( s, STREAM_GET_TITLE, &title ) == VLC_SUCCESS
     && title != (unsigned)demux->info.i_title )
    {
        demux->info.i_title = title;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
328
        demux->info.i_update |= INPUT_UPDATE_TITLE;
329 330 331 332 333 334
    }

    if( stream_Control( s, STREAM_GET_SEEKPOINT, &seekpoint ) == VLC_SUCCESS
     && seekpoint != (unsigned)demux->info.i_seekpoint )
    {
        demux->info.i_seekpoint = seekpoint;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
335
        demux->info.i_update |= INPUT_UPDATE_SEEKPOINT;
336 337 338
    }
}

339
VLC_USED
340
static inline bool demux_IsPathExtension( demux_t *p_demux, const char *psz_extension )
341
{
342 343 344
    const char *name = (p_demux->psz_file != NULL) ? p_demux->psz_file
                                                   : p_demux->psz_location;
    const char *psz_ext = strrchr ( name, '.' );
345
    if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
346 347
        return false;
    return true;
348
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
349

350
VLC_USED
351
static inline bool demux_IsForced( demux_t *p_demux, const char *psz_name )
352
{
Laurent Aimar's avatar
Laurent Aimar committed
353
   if( !p_demux->psz_demux || strcmp( p_demux->psz_demux, psz_name ) )
354 355
        return false;
    return true;
356 357
}

358 359 360 361 362 363 364
/**
 * 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.
 */
365
VLC_API decoder_t * demux_PacketizerNew( demux_t *p_demux, es_format_t *p_fmt, const char *psz_msg ) VLC_USED;
366 367 368 369

/**
 * This function will destroy a packetizer create by demux_PacketizerNew.
 */
370
VLC_API void demux_PacketizerDestroy( decoder_t *p_packetizer );
371 372

/* */
373 374 375
#define DEMUX_INIT_COMMON() do {            \
    p_demux->pf_control = Control;          \
    p_demux->pf_demux = Demux;              \
376
    p_demux->p_sys = calloc( 1, sizeof( demux_sys_t ) ); \
377
    if( !p_demux->p_sys ) return VLC_ENOMEM;\
378
    } while(0)
379

380 381 382 383 384
/**
 * @}
 */

#endif