vlc_codec.h 9.12 KB
Newer Older
Gildas Bazin's avatar
 
Gildas Bazin committed
1
/*****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
2
 * vlc_codec.h: Definition of the decoder and encoder structures
Gildas Bazin's avatar
 
Gildas Bazin committed
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2003 VLC authors and VideoLAN
5
 * $Id$
Gildas Bazin's avatar
 
Gildas Bazin committed
6 7 8
 *
 * Authors: Gildas Bazin <gbazin@netcourrier.com>
 *
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
Gildas Bazin's avatar
 
Gildas Bazin committed
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.
Gildas Bazin's avatar
 
Gildas Bazin committed
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.
Gildas Bazin's avatar
 
Gildas Bazin committed
22
 *****************************************************************************/
23

24 25
#ifndef VLC_CODEC_H
#define VLC_CODEC_H 1
Gildas Bazin's avatar
 
Gildas Bazin committed
26

Clément Stenac's avatar
Clément Stenac committed
27 28
#include <vlc_block.h>
#include <vlc_es.h>
29 30
#include <vlc_picture.h>
#include <vlc_subpicture.h>
Clément Stenac's avatar
Clément Stenac committed
31

Gildas Bazin's avatar
 
Gildas Bazin committed
32
/**
33 34 35 36 37
 * \defgroup codec Codec
 * Decoders and encoders
 * @{
 * \file
 * Decoder and encoder modules interface
Gildas Bazin's avatar
 
Gildas Bazin committed
38
 *
39 40
 * \defgroup decoder Decoder
 * Audio, video and text decoders
Gildas Bazin's avatar
 
Gildas Bazin committed
41 42 43
 * @{
 */

44 45
typedef struct decoder_owner_sys_t decoder_owner_sys_t;

46 47 48 49 50
/*
 * BIG FAT WARNING : the code relies in the first 4 members of filter_t
 * and decoder_t to be the same, so if you have anything to add, do it
 * at the end of the structure.
 */
Gildas Bazin's avatar
 
Gildas Bazin committed
51 52 53 54 55 56 57
struct decoder_t
{
    VLC_COMMON_MEMBERS

    /* Module properties */
    module_t *          p_module;
    decoder_sys_t *     p_sys;
Gildas Bazin's avatar
 
Gildas Bazin committed
58 59 60 61 62 63 64

    /* Input format ie from demuxer (XXX: a lot of field could be invalid) */
    es_format_t         fmt_in;

    /* Output format of decoder/packetizer */
    es_format_t         fmt_out;

65
    /* Tell the decoder if it is allowed to drop frames */
66
    bool                b_frame_drop_allowed;
67

68
    /* */
69
    picture_t *         ( * pf_decode_video )( decoder_t *, block_t ** );
70
    block_t *           ( * pf_decode_audio )( decoder_t *, block_t ** );
71 72
    subpicture_t *      ( * pf_decode_sub)   ( decoder_t *, block_t ** );
    block_t *           ( * pf_packetize )   ( decoder_t *, block_t ** );
73
    void                ( * pf_flush ) ( decoder_t * );
74

75 76 77 78 79 80
    /* Closed Caption (CEA 608/708) extraction.
     * If set, it *may* be called after pf_decode_video/pf_packetize
     * returned data. It should return CC for the pictures returned by the
     * last pf_packetize/pf_decode_video call only,
     * pb_present will be used to known which cc channel are present (but
     * globaly, not necessary for the current packet */
81
    block_t *           ( * pf_get_cc )      ( decoder_t *, bool pb_present[4] );
82

83 84 85 86 87 88
    /* Meta data at codec level
     *  The decoder owner set it back to NULL once it has retreived what it needs.
     *  The decoder owner is responsible of its release except when you overwrite it.
     */
    vlc_meta_t          *p_description;

89 90
    /*
     * Owner fields
91
     * XXX You MUST not use them directly.
92 93
     */

94
    /* Video output callbacks
95
     * XXX use decoder_NewPicture */
96
    int             (*pf_vout_format_update)( decoder_t * );
97 98
    picture_t      *(*pf_vout_buffer_new)( decoder_t * );

99 100 101 102 103 104
    /**
     * Number of extra (ie in addition to the DPB) picture buffers
     * needed for decoding.
     */
    int             i_extra_picture_buffers;

105 106
    /* Audio output callbacks */
    int             (*pf_aout_format_update)( decoder_t * );
107

108
    /* SPU output callbacks
109
     * XXX use decoder_NewSubpicture */
110
    subpicture_t   *(*pf_spu_buffer_new)( decoder_t *, const subpicture_updater_t * );
111

112 113 114 115 116 117 118 119 120 121 122 123
    /* Input attachments
     * XXX use decoder_GetInputAttachments */
    int             (*pf_get_attachments)( decoder_t *p_dec, input_attachment_t ***ppp_attachment, int *pi_attachment );

    /* Display date
     * XXX use decoder_GetDisplayDate */
    mtime_t         (*pf_get_display_date)( decoder_t *, mtime_t );

    /* Display rate
     * XXX use decoder_GetDisplayRate */
    int             (*pf_get_display_rate)( decoder_t * );

Gildas Bazin's avatar
 
Gildas Bazin committed
124 125
    /* Private structure for the owner of the decoder */
    decoder_owner_sys_t *p_owner;
Erwan Tulou's avatar
Erwan Tulou committed
126

127
    bool                b_error;
Gildas Bazin's avatar
 
Gildas Bazin committed
128 129 130 131 132 133 134
};

/**
 * @}
 */

/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
135
 * \defgroup encoder Encoder
136
 * Audio, video and text encoders
Gildas Bazin's avatar
 
Gildas Bazin committed
137 138 139 140 141 142 143 144 145 146 147 148
 * @{
 */

struct encoder_t
{
    VLC_COMMON_MEMBERS

    /* Module properties */
    module_t *          p_module;
    encoder_sys_t *     p_sys;

    /* Properties of the input data fed to the encoder */
Gildas Bazin's avatar
 
Gildas Bazin committed
149
    es_format_t         fmt_in;
Gildas Bazin's avatar
 
Gildas Bazin committed
150 151

    /* Properties of the output of the encoder */
Gildas Bazin's avatar
 
Gildas Bazin committed
152
    es_format_t         fmt_out;
Gildas Bazin's avatar
 
Gildas Bazin committed
153

154
    block_t *           ( * pf_encode_video )( encoder_t *, picture_t * );
155
    block_t *           ( * pf_encode_audio )( encoder_t *, block_t * );
156 157
    block_t *           ( * pf_encode_sub )( encoder_t *, subpicture_t * );

158 159 160 161 162
    /* Common encoder options */
    int i_threads;               /* Number of threads to use during encoding */
    int i_iframes;               /* One I frame per i_iframes */
    int i_bframes;               /* One B frame per i_bframes */
    int i_tolerance;             /* Bitrate tolerance */
163 164

    /* Encoder config */
165
    config_chain_t *p_cfg;
Gildas Bazin's avatar
 
Gildas Bazin committed
166 167 168 169
};

/**
 * @}
170 171 172
 *
 * \ingroup decoder
 * @{
Gildas Bazin's avatar
 
Gildas Bazin committed
173 174
 */

175
/**
176 177
 * Updates the video output format.
 *
178
 * This function notifies the video output pipeline of a new video output
179 180 181 182 183 184 185 186 187 188 189
 * format (fmt_out.video). If there was no video output from the decoder so far
 * or if the video output format has changed, a new video output will be set
 * up. decoder_GetPicture() can then be used to allocate picture buffers.
 *
 * If the format is unchanged, this function has no effects and returns zero.
 *
 * \note
 * This function is not reentrant.
 *
 * @return 0 if the video output was set up succesfully, -1 otherwise.
 */
190 191 192 193 194 195 196 197
static inline int decoder_UpdateVideoFormat( decoder_t *dec )
{
    if( dec->pf_vout_format_update != NULL )
        return dec->pf_vout_format_update( dec );
    else
        return -1;
}

198
/**
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
 * Allocates an output picture buffer.
 *
 * This function pulls an output picture buffer for the decoder from the
 * buffer pool of the video output. The picture must be released with
 * picture_Release() when it is no longer referenced by the decoder.
 *
 * \note
 * This function is reentrant. However, decoder_UpdateVideoFormat() cannot be
 * used concurrently; the caller is responsible for serialization.
 *
 * \warning
 * The behaviour is undefined if decoder_UpdateVideoFormat() was not called or
 * if the last call returned an error.
 *
 * \return a picture buffer on success, NULL on error
214
 */
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
VLC_USED
static inline picture_t *decoder_GetPicture( decoder_t *dec )
{
    return dec->pf_vout_buffer_new( dec );
}

/**
 * Checks the format and allocates a picture buffer.
 *
 * This common helper function sets the output video output format and
 * allocates a picture buffer in that format. The picture must be released with
 * picture_Release() when it is no longer referenced by the decoder.
 *
 * \note
 * Lile decoder_UpdateVideoFormat(), this function is not reentrant.
 *
 * \return a picture buffer on success, NULL on error
 */
VLC_USED
static inline picture_t *decoder_NewPicture( decoder_t *dec )
{
    if( decoder_UpdateVideoFormat(dec) )
        return NULL;
    return decoder_GetPicture( dec );
}
240

241 242 243 244 245 246 247 248 249 250 251 252 253
/**
 * This function notifies the audio output pipeline of a new audio output
 * format (fmt_out.audio). If there is currently no audio output or if the
 * audio output format has changed, a new audio output will be set up.
 * @return 0 if the audio output is working, -1 if not. */
static inline int decoder_UpdateAudioFormat( decoder_t *dec )
{
    if( dec->pf_aout_format_update != NULL )
        return dec->pf_aout_format_update( dec );
    else
        return -1;
}

254 255
/**
 * This function will return a new audio buffer usable by a decoder as an
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
256 257
 * output buffer. It must be released with block_Release() or returned it to
 * the caller as a pf_decode_audio return value.
258
 */
259
VLC_API block_t * decoder_NewAudioBuffer( decoder_t *, int i_size ) VLC_USED;
260

261 262
/**
 * This function will return a new subpicture usable by a decoder as an output
263
 * buffer. You have to release it using subpicture_Delete() or by returning
264 265
 * it to the caller as a pf_decode_sub return value.
 */
266
VLC_API subpicture_t * decoder_NewSubpicture( decoder_t *, const subpicture_updater_t * ) VLC_USED;
267

268 269 270 271 272
/**
 * This function gives all input attachments at once.
 *
 * You MUST release the returned values
 */
273
VLC_API int decoder_GetInputAttachments( decoder_t *, input_attachment_t ***ppp_attachment, int *pi_attachment );
274 275 276 277 278 279

/**
 * This function converts a decoder timestamp into a display date comparable
 * to mdate().
 * You MUST use it *only* for gathering statistics about speed.
 */
280
VLC_API mtime_t decoder_GetDisplayDate( decoder_t *, mtime_t ) VLC_USED;
281

282 283 284 285
/**
 * This function returns the current input rate.
 * You MUST use it *only* for gathering statistics about speed.
 */
286
VLC_API int decoder_GetDisplayRate( decoder_t * ) VLC_USED;
287

288 289
/** @} */
/** @} */
Gildas Bazin's avatar
 
Gildas Bazin committed
290
#endif /* _VLC_CODEC_H */