vlc_demux.h 10.6 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
enum demux_query_e
{
    /* I. Common queries to access_demux and demux */
    /* POSITION double between 0.0 and 1.0 */
    DEMUX_GET_POSITION,         /* arg1= double *       res=    */
107
    DEMUX_SET_POSITION,         /* arg1= double arg2= bool b_precise    res=can fail    */
108 109 110 111

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

    /* TITLE_INFO only if more than 1 title or 1 chapter */
115
    DEMUX_GET_TITLE_INFO,       /* arg1=input_title_t*** arg2=int*
Laurent Aimar's avatar
Laurent Aimar committed
116
                                   arg3=int*pi_title_offset(0), arg4=int*pi_seekpoint_offset(0) can fail */
117 118 119 120
    /* TITLE/SEEKPOINT, only when TITLE_INFO succeed */
    DEMUX_SET_TITLE,            /* arg1= int            can fail */
    DEMUX_SET_SEEKPOINT,        /* arg1= int            can fail */

121
    /* DEMUX_SET_GROUP/SET_ES only a hint for demuxer (mainly DVB) to allow not
122 123 124
     * 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
125
    DEMUX_SET_GROUP,            /* arg1= int, arg2=const vlc_list_t *   can fail */
126
    DEMUX_SET_ES,               /* arg1= int                            can fail */
127

128
    /* 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
129
     * but not more (and not less, at the precision available of course).
Rémi Denis-Courmont's avatar
Typos  
Rémi Denis-Courmont committed
130
     * XXX: not mandatory (except for subtitle demux) but will help a lot
131 132
     * for multi-input
     */
133
    DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= int64_t        can fail */
134
    /* FPS for correct subtitles handling */
135
    DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */
Laurent Aimar's avatar
Laurent Aimar committed
136

137 138
    /* Meta data */
    DEMUX_GET_META,             /* arg1= vlc_meta_t **  res=can fail    */
139
    DEMUX_HAS_UNSUPPORTED_META, /* arg1= bool *   res can fail    */
140

Laurent Aimar's avatar
Laurent Aimar committed
141 142
    /* Attachments */
    DEMUX_GET_ATTACHMENTS,      /* arg1=input_attachment_t***, int* res=can fail */
143

144 145
    /* 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
146 147 148 149
     * any modification or header addition. */
    DEMUX_CAN_RECORD,           /* arg1=bool*   res=can fail(assume false) */
    DEMUX_SET_RECORD_STATE,     /* arg1=bool    res=can fail */

150 151
    DEMUX_GET_SIGNAL, /* arg1=double *pf_quality, arg2=double *pf_strength
                         res=can fail */
152

153
    /* II. Specific access_demux queries */
154
    /* PAUSE you are ensured that it is never called twice with the same state */
155
    DEMUX_CAN_PAUSE = 0x1000,   /* arg1= bool*    can fail (assume false)*/
156
    DEMUX_SET_PAUSE_STATE,      /* arg1= bool     can fail */
157

158
    DEMUX_GET_PTS_DELAY,        /* arg1= int64_t*       cannot fail */
159 160 161

    /* DEMUX_CAN_CONTROL_PACE returns true (*pb_pace) if we can read the
     * data at our pace */
162
    DEMUX_CAN_CONTROL_PACE,     /* arg1= bool*pb_pace    can fail (assume false) */
163 164 165 166

    /* 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 */
167
    DEMUX_CAN_CONTROL_RATE,     /* arg1= bool*pb_rate arg2= bool*pb_ts_rescale  can fail(assume false) */
168 169 170
    /* 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 */
171

172
    DEMUX_CAN_SEEK,            /* arg1= bool*    can fail (assume false)*/
173

174 175 176 177
    /* DEMUX_IS_PLAYLIST returns true if the demux is a playlist
     * (an archive, a directory or a network share is also a playlist) */
    DEMUX_IS_PLAYLIST,  /* arg1= bool*    can fail (assume false)*/

178 179 180 181 182 183
    /* Navigation */
    DEMUX_NAV_ACTIVATE,        /* res=can fail */
    DEMUX_NAV_UP,              /* res=can fail */
    DEMUX_NAV_DOWN,            /* res=can fail */
    DEMUX_NAV_LEFT,            /* res=can fail */
    DEMUX_NAV_RIGHT,           /* res=can fail */
184 185
};

François Cartegnie's avatar
François Cartegnie committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
/*************************************************************************
 * 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 );
}

static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
{
    return p_demux->pf_control( p_demux, i_query, args );
}

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

228 229 230 231 232 233 234 235 236
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
237
        demux->info.i_update |= INPUT_UPDATE_TITLE;
238 239 240 241 242 243
    }

    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
244
        demux->info.i_update |= INPUT_UPDATE_SEEKPOINT;
245 246 247
    }
}

248
VLC_USED
249
static inline bool demux_IsPathExtension( demux_t *p_demux, const char *psz_extension )
250
{
251 252 253
    const char *name = (p_demux->psz_file != NULL) ? p_demux->psz_file
                                                   : p_demux->psz_location;
    const char *psz_ext = strrchr ( name, '.' );
254
    if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
255 256
        return false;
    return true;
257
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
258

259
VLC_USED
260
static inline bool demux_IsForced( demux_t *p_demux, const char *psz_name )
261
{
Laurent Aimar's avatar
Laurent Aimar committed
262
   if( !p_demux->psz_demux || strcmp( p_demux->psz_demux, psz_name ) )
263 264
        return false;
    return true;
265 266
}

267 268 269 270 271 272 273
/**
 * 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.
 */
274
VLC_API decoder_t * demux_PacketizerNew( demux_t *p_demux, es_format_t *p_fmt, const char *psz_msg ) VLC_USED;
275 276 277 278

/**
 * This function will destroy a packetizer create by demux_PacketizerNew.
 */
279
VLC_API void demux_PacketizerDestroy( decoder_t *p_packetizer );
280 281

/* */
282 283 284
#define DEMUX_INIT_COMMON() do {            \
    p_demux->pf_control = Control;          \
    p_demux->pf_demux = Demux;              \
285
    p_demux->p_sys = calloc( 1, sizeof( demux_sys_t ) ); \
286
    if( !p_demux->p_sys ) return VLC_ENOMEM;\
287
    } while(0)
288

289 290 291 292 293
/**
 * @}
 */

#endif