vlc_demux.h 9.37 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_demux.h: Demuxer descriptor, queries and methods
3
 *****************************************************************************
4
 * Copyright (C) 1999-2005 the VideoLAN team
5
 * $Id$
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

24 25 26 27
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

28 29 30
#ifndef _VLC_DEMUX_H
#define _VLC_DEMUX_H 1

Clément Stenac's avatar
Clément Stenac committed
31 32 33 34
#include <vlc_es.h>
#include <vlc_stream.h>
#include <vlc_es_out.h>

35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
/**
 * \defgroup demux Demux
 * @{
 */

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;
    char        *psz_path;

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

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

    /* 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;
};

75 76 77 78 79 80 81 82 83 84

/* demux_meta_t is returned by "meta reader" module to the demuxer */
struct demux_meta_t
{
    vlc_meta_t *p_meta;                 /**< meta data */

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

85 86 87 88 89 90 91 92 93 94 95 96 97
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=    */
    DEMUX_SET_POSITION,         /* arg1= double         res=can fail    */

    /* LENGTH/TIME in microsecond, 0 if unknown */
    DEMUX_GET_LENGTH,           /* arg1= int64_t *      res=    */
    DEMUX_GET_TIME,             /* arg1= int64_t *      res=    */
    DEMUX_SET_TIME,             /* arg1= int64_t        res=can fail    */

    /* TITLE_INFO only if more than 1 title or 1 chapter */
98
    DEMUX_GET_TITLE_INFO,       /* arg1=input_title_t*** arg2=int*
Laurent Aimar's avatar
Laurent Aimar committed
99
                                   arg3=int*pi_title_offset(0), arg4=int*pi_seekpoint_offset(0) can fail */
100 101 102 103
    /* TITLE/SEEKPOINT, only when TITLE_INFO succeed */
    DEMUX_SET_TITLE,            /* arg1= int            can fail */
    DEMUX_SET_SEEKPOINT,        /* arg1= int            can fail */

104 105 106 107 108 109
    /* DEMUX_SET_GROUP only a hit for demuxer (mainly DVB) to allow not
     * 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) */
    DEMUX_SET_GROUP,            /* arg1= int            can fail */

110 111 112 113 114 115 116
    /* Ask the demux to demux until the given date at the next pf_demux call
     * but not more (and not less, at the precision avaiable of course).
     * XXX: not mandatory (except for subtitle demux) but I will help a lot
     * for multi-input
     */
    DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= int64_t *      can fail */
    /* FPS for correct subtitles handling */
117
    DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */
Laurent Aimar's avatar
Laurent Aimar committed
118

119 120
    /* Meta data */
    DEMUX_GET_META,             /* arg1= vlc_meta_t **  res=can fail    */
121
    DEMUX_HAS_UNSUPPORTED_META, /* arg1= vlc_bool_t *   res can fail    */
122

Laurent Aimar's avatar
Laurent Aimar committed
123 124
    /* Attachments */
    DEMUX_GET_ATTACHMENTS,      /* arg1=input_attachment_t***, int* res=can fail */
125 126

    /* II. Specific access_demux queries */
127 128 129
    DEMUX_CAN_PAUSE,            /* arg1= vlc_bool_t*    can fail (assume false)*/
    DEMUX_SET_PAUSE_STATE,      /* arg1= vlc_bool_t     can fail */

130
    DEMUX_GET_PTS_DELAY,        /* arg1= int64_t*       cannot fail */
131 132 133 134 135 136 137 138 139 140 141 142

    /* DEMUX_CAN_CONTROL_PACE returns true (*pb_pace) if we can read the
     * data at our pace */
    DEMUX_CAN_CONTROL_PACE,     /* arg1= vlc_bool_t*pb_pace    can fail (assume false) */

    /* 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 */
    DEMUX_CAN_CONTROL_RATE,     /* arg1= vlc_bool_t*pb_rate arg2= vlc_bool_t*pb_ts_rescale  can fail(assume false) */
    /* 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 */
143 144 145 146
};

VLC_EXPORT( int,       demux2_vaControlHelper, ( stream_t *, int64_t i_start, int64_t i_end, int i_bitrate, int i_align, int i_query, va_list args ) );

147 148 149 150
/*************************************************************************
 * Miscellaneous helpers for demuxers
 *************************************************************************/

Laurent Aimar's avatar
Laurent Aimar committed
151
static inline vlc_bool_t demux2_IsPathExtension( demux_t *p_demux, const char *psz_extension )
152
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
153
    const char *psz_ext = strrchr ( p_demux->psz_path, '.' );
154
    if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
155 156 157
        return VLC_FALSE;
    return VLC_TRUE;
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
158

Laurent Aimar's avatar
Laurent Aimar committed
159
static inline vlc_bool_t demux2_IsForced( demux_t *p_demux, const char *psz_name )
160
{
Laurent Aimar's avatar
Laurent Aimar committed
161
   if( !p_demux->psz_demux || strcmp( p_demux->psz_demux, psz_name ) )
162 163 164 165
        return VLC_FALSE;
    return VLC_TRUE;
}

166 167 168
#define DEMUX_INIT_COMMON() do {            \
    p_demux->pf_control = Control;          \
    p_demux->pf_demux = Demux;              \
169
    MALLOC_ERR( p_demux->p_sys, demux_sys_t ); \
170
    memset( p_demux->p_sys, 0, sizeof( demux_sys_t ) ); } while(0)
171

172 173 174
#define STANDARD_DEMUX_INIT_MSG( msg ) do { \
    DEMUX_INIT_COMMON();                    \
    msg_Dbg( p_demux, msg ); } while(0)
175 176 177

#define DEMUX_BY_EXTENSION( ext ) \
    demux_t *p_demux = (demux_t *)p_this; \
Laurent Aimar's avatar
Laurent Aimar committed
178
    if( !demux2_IsPathExtension( p_demux, ext ) ) \
179
        return VLC_EGENERIC; \
180
    DEMUX_INIT_COMMON();
181 182 183

#define DEMUX_BY_EXTENSION_MSG( ext, msg ) \
    demux_t *p_demux = (demux_t *)p_this; \
Laurent Aimar's avatar
Laurent Aimar committed
184
    if( !demux2_IsPathExtension( p_demux, ext ) ) \
185 186 187 188 189
        return VLC_EGENERIC; \
    STANDARD_DEMUX_INIT_MSG( msg );

#define DEMUX_BY_EXTENSION_OR_FORCED( ext, module ) \
    demux_t *p_demux = (demux_t *)p_this; \
Laurent Aimar's avatar
Laurent Aimar committed
190
    if( !demux2_IsPathExtension( p_demux, ext ) && !demux2_IsForced( p_demux, module ) ) \
191
        return VLC_EGENERIC; \
192
    DEMUX_INIT_COMMON();
193 194 195

#define DEMUX_BY_EXTENSION_OR_FORCED_MSG( ext, module, msg ) \
    demux_t *p_demux = (demux_t *)p_this; \
Laurent Aimar's avatar
Laurent Aimar committed
196
    if( !demux2_IsPathExtension( p_demux, ext ) && !demux2_IsForced( p_demux, module ) ) \
197 198 199 200 201 202 203 204 205 206 207
        return VLC_EGENERIC; \
    STANDARD_DEMUX_INIT_MSG( msg );

#define CHECK_PEEK( zepeek, size ) \
    if( stream_Peek( p_demux->s , &zepeek, size ) < size ){ \
        msg_Dbg( p_demux, "not enough data" ); return VLC_EGENERIC; }

#define CHECK_PEEK_GOTO( zepeek, size ) \
    if( stream_Peek( p_demux->s , &zepeek, size ) < size ) { \
        msg_Dbg( p_demux, "not enough data" ); goto error; }

208
#define POKE( peek, stuff, size ) (strncasecmp( (const char *)peek, stuff, size )==0)
Clément Stenac's avatar
Clément Stenac committed
209 210

#define COMMON_INIT_PACKETIZER( location ) \
211
    location = vlc_object_create( p_demux, VLC_OBJECT_PACKETIZER ); \
Clément Stenac's avatar
Clément Stenac committed
212 213 214 215 216 217 218 219 220 221 222 223 224
    location->pf_decode_audio = 0; \
    location->pf_decode_video = 0; \
    location->pf_decode_sub = 0; \
    location->pf_packetize = 0; \

#define INIT_APACKETIZER( location, a,b,c,d ) \
    COMMON_INIT_PACKETIZER(location ); \
    es_format_Init( &location->fmt_in, AUDIO_ES, \
                    VLC_FOURCC( a, b, c, d ) );

#define INIT_VPACKETIZER( location, a,b,c,d ) \
    COMMON_INIT_PACKETIZER(location ); \
    es_format_Init( &location->fmt_in, VIDEO_ES, \
225 226 227
                    VLC_FOURCC( a, b, c, d ) );

/* BEWARE ! This can lead to memory leaks ! */
Clément Stenac's avatar
Clément Stenac committed
228 229 230 231
#define LOAD_PACKETIZER_OR_FAIL( location, msg ) \
    location->p_module = \
        module_Need( location, "packetizer", NULL, 0 ); \
    if( location->p_module == NULL ) \
232
    { \
Clément Stenac's avatar
Clément Stenac committed
233
        vlc_object_destroy( location ); \
234 235 236 237 238
        msg_Err( p_demux, "cannot find packetizer for " # msg ); \
        free( p_sys ); \
        return VLC_EGENERIC; \
    }

239 240 241 242
#define DESTROY_PACKETIZER( location ) \
    if( location->p_module ) module_Unneed( location, location->p_module ); \
    vlc_object_destroy( location );

243 244 245 246 247
/**
 * @}
 */

#endif