vlc_demux.h 7.61 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
#ifndef VLC_DEMUX_H
#define VLC_DEMUX_H 1
26

27 28 29 30 31
/**
 * \file
 * This files defines functions and structures used by demux objects in vlc
 */

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

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
/**
 * \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 */
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 74 75

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

76 77 78 79 80 81 82 83 84 85

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

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

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

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

105 106 107 108
    /* 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) */
Laurent Aimar's avatar
Laurent Aimar committed
109
    DEMUX_SET_GROUP,            /* arg1= int, arg2=const vlc_list_t *   can fail */
110

111
    /* 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
112
     * but not more (and not less, at the precision available of course).
113 114 115 116 117
     * 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 */
118
    DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */
Laurent Aimar's avatar
Laurent Aimar committed
119

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

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

127 128 129 130 131 132
    /* RECORD you should accept it only if the stream can be recorded without
     * any modification or header addition. */
    DEMUX_CAN_RECORD,           /* arg1=bool*   res=can fail(assume false) */
    DEMUX_SET_RECORD_STATE,     /* arg1=bool    res=can fail */


133
    /* II. Specific access_demux queries */
134
    DEMUX_CAN_PAUSE = 0x1000,   /* arg1= bool*    can fail (assume false)*/
135
    DEMUX_SET_PAUSE_STATE,      /* arg1= bool     can fail */
136

137
    DEMUX_GET_PTS_DELAY,        /* arg1= int64_t*       cannot fail */
138 139 140

    /* DEMUX_CAN_CONTROL_PACE returns true (*pb_pace) if we can read the
     * data at our pace */
141
    DEMUX_CAN_CONTROL_PACE,     /* arg1= bool*pb_pace    can fail (assume false) */
142 143 144 145

    /* 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 */
146
    DEMUX_CAN_CONTROL_RATE,     /* arg1= bool*pb_rate arg2= bool*pb_ts_rescale  can fail(assume false) */
147 148 149
    /* 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 */
150

151
    DEMUX_CAN_SEEK,            /* arg1= bool*    can fail (assume false)*/
152 153
};

154
VLC_EXPORT( 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 ) );
155

156 157 158 159
/*************************************************************************
 * Miscellaneous helpers for demuxers
 *************************************************************************/

160
LIBVLC_USED
161
static inline bool demux_IsPathExtension( demux_t *p_demux, const char *psz_extension )
162
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
163
    const char *psz_ext = strrchr ( p_demux->psz_path, '.' );
164
    if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
165 166
        return false;
    return true;
167
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
168

169
LIBVLC_USED
170
static inline bool demux_IsForced( demux_t *p_demux, const char *psz_name )
171
{
Laurent Aimar's avatar
Laurent Aimar committed
172
   if( !p_demux->psz_demux || strcmp( p_demux->psz_demux, psz_name ) )
173 174
        return false;
    return true;
175 176
}

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
/**
 * 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.
 */
VLC_EXPORT( decoder_t *,demux_PacketizerNew, ( demux_t *p_demux, es_format_t *p_fmt, const char *psz_msg ) );

/**
 * This function will destroy a packetizer create by demux_PacketizerNew.
 */
VLC_EXPORT( void, demux_PacketizerDestroy, ( decoder_t *p_packetizer ) );

/* */
192 193 194
#define DEMUX_INIT_COMMON() do {            \
    p_demux->pf_control = Control;          \
    p_demux->pf_demux = Demux;              \
195 196
    p_demux->p_sys = malloc( sizeof( demux_sys_t ) ); \
    if( !p_demux->p_sys ) return VLC_ENOMEM;\
197
    memset( p_demux->p_sys, 0, sizeof( demux_sys_t ) ); } while(0)
198

199 200 201 202 203
/**
 * @}
 */

#endif