vlc_codec.h 12.7 KB
Newer Older
1
/*****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
2
 * vlc_codec.h: Definition of the decoder and encoder structures
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2003 VLC authors and VideoLAN
5
 * $Id$
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
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_CODEC_H
#define VLC_CODEC_H 1
26

27 28
#include <assert.h>

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

34
/**
35 36 37 38 39
 * \defgroup codec Codec
 * Decoders and encoders
 * @{
 * \file
 * Decoder and encoder modules interface
40
 *
41 42
 * \defgroup decoder Decoder
 * Audio, video and text decoders
43 44 45
 * @{
 */

46 47
typedef struct decoder_owner_sys_t decoder_owner_sys_t;

48 49 50 51 52
/*
 * 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.
 */
53 54 55 56 57 58 59
struct decoder_t
{
    VLC_COMMON_MEMBERS

    /* Module properties */
    module_t *          p_module;
    decoder_sys_t *     p_sys;
60 61 62 63 64 65 66

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

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

70
#   define VLCDEC_SUCCESS   VLC_SUCCESS
71
#   define VLCDEC_ECRITICAL VLC_EGENERIC
72
    /* This function is called to decode one packetized block.
73
     *
74 75 76 77 78 79 80 81
     * The module implementation will own the input block (p_block) and should
     * process and release it. Depending of the decoder type, the module should
     * send output frames/blocks via decoder_QueueVideo(), decoder_QueueAudio()
     * or decoder_QueueSub().
     *
     * If p_block is NULL, the decoder asks the module to drain itself. The
     * module should return all available output frames/block via the queue
     * functions.
82 83 84 85 86
     *
     * Return values can be:
     *  VLCDEC_SUCCESS: pf_decode will be called again
     *  VLCDEC_ECRITICAL: in case of critical error, pf_decode won't be called
     *  again.
87 88 89 90 91 92
     */
    int                 ( * pf_decode )   ( decoder_t *, block_t *p_block );

    /* This function is called in a loop with the same pp_block argument until
     * it returns NULL. This allows a module implementation to return more than
     * one output blocks for one input block.
93 94 95 96 97 98 99
     *
     * pp_block or *pp_block can be NULL.
     *
     * If pp_block and *pp_block are not NULL, the module implementation will
     * own the input block (*pp_block) and should process and release it. The
     * module can also process a part of the block. In that case, it should
     * modify (*pp_block)->p_buffer/i_buffer accordingly and return a valid
100
     * output block. The module can also set *pp_block to NULL when the input
101 102 103 104
     * block is consumed.
     *
     * If pp_block is not NULL but *pp_block is NULL, a previous call of the pf
     * function has set the *pp_block to NULL. Here, the module can return new
105 106 107
     * output block for the same, already processed, input block (the
     * pf_packetize function will be called as long as the module return an
     * output block).
108 109
     *
     * When the pf function returns NULL, the next call to this function will
110
     * have a new a valid pp_block (if the packetizer is not drained).
111
     *
112 113 114 115
     * If pp_block is NULL, the packetizer asks the module to drain itself. In
     * that case, the module has to return all output frames available (the
     * pf_packetize function will be called as long as the module return an
     * output block).
116
     */
117
    block_t *           ( * pf_packetize )( decoder_t *, block_t **pp_block );
118
    /* */
119
    void                ( * pf_flush ) ( decoder_t * );
120

121
    /* Closed Caption (CEA 608/708) extraction.
122
     * If set, it *may* be called after pf_decode/pf_packetize
123
     * returned data. It should return CC for the pictures returned by the
124
     * last pf_packetize/pf_decode call only,
125 126
     * pb_present will be used to known which cc channel are present (but
     * globaly, not necessary for the current packet */
127
    block_t *           ( * pf_get_cc )      ( decoder_t *, bool pb_present[4] );
128

129 130 131 132 133 134
    /* 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;

135 136
    /*
     * Owner fields
137
     * XXX You MUST not use them directly.
138 139
     */

140
    /* Video output callbacks
141
     * XXX use decoder_NewPicture */
142
    int             (*pf_vout_format_update)( decoder_t * );
143 144
    picture_t      *(*pf_vout_buffer_new)( decoder_t * );

145 146 147 148 149 150
    /**
     * Number of extra (ie in addition to the DPB) picture buffers
     * needed for decoding.
     */
    int             i_extra_picture_buffers;

151 152
    /* Audio output callbacks */
    int             (*pf_aout_format_update)( decoder_t * );
153

154
    /* SPU output callbacks
155
     * XXX use decoder_NewSubpicture */
156
    subpicture_t   *(*pf_spu_buffer_new)( decoder_t *, const subpicture_updater_t * );
157

158 159 160 161 162 163 164 165 166 167 168 169
    /* 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 * );

170 171
    /* XXX use decoder_QueueVideo */
    int             (*pf_queue_video)( decoder_t *, picture_t * );
172 173
    /* XXX use decoder_QueueAudio */
    int             (*pf_queue_audio)( decoder_t *, block_t * );
174 175
    /* XXX use decoder_QueueSub */
    int             (*pf_queue_sub)( decoder_t *, subpicture_t *);
176
    void             *p_queue_ctx;
177

178 179
    /* Private structure for the owner of the decoder */
    decoder_owner_sys_t *p_owner;
180 181 182 183 184 185 186
};

/**
 * @}
 */

/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
187
 * \defgroup encoder Encoder
188
 * Audio, video and text encoders
189 190 191 192 193 194 195 196 197 198 199 200
 * @{
 */

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 */
201
    es_format_t         fmt_in;
202 203

    /* Properties of the output of the encoder */
204
    es_format_t         fmt_out;
205

206
    block_t *           ( * pf_encode_video )( encoder_t *, picture_t * );
207
    block_t *           ( * pf_encode_audio )( encoder_t *, block_t * );
208 209
    block_t *           ( * pf_encode_sub )( encoder_t *, subpicture_t * );

210 211 212 213 214
    /* 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 */
215 216

    /* Encoder config */
217
    config_chain_t *p_cfg;
218 219 220 221
};

/**
 * @}
222 223 224
 *
 * \ingroup decoder
 * @{
225 226
 */

227
/**
228 229
 * Updates the video output format.
 *
230
 * This function notifies the video output pipeline of a new video output
231 232
 * 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
233
 * up. decoder_NewPicture() can then be used to allocate picture buffers.
234 235 236 237 238 239
 *
 * If the format is unchanged, this function has no effects and returns zero.
 *
 * \note
 * This function is not reentrant.
 *
240
 * @return 0 if the video output was set up successfully, -1 otherwise.
241
 */
242 243 244 245 246 247 248 249
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;
}

250
/**
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
 * 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
266
 */
267 268 269
VLC_USED
static inline picture_t *decoder_NewPicture( decoder_t *dec )
{
270
    return dec->pf_vout_buffer_new( dec );
271
}
272

273
/**
274
 * Abort any calls of decoder_NewPicture
275
 *
276 277 278
 * If b_abort is true, all pending and futures calls of decoder_NewPicture
 * will be aborted. This function can be used by asynchronous video decoders
 * to unblock a thread that is waiting for a picture.
279 280 281
 */
VLC_API void decoder_AbortPictures( decoder_t *dec, bool b_abort );

282 283 284 285 286 287 288 289 290 291 292 293
/**
 * This function queues a picture to the video output.
 *
 * \note
 * The caller doesn't own the picture anymore after this call (even in case of
 * error).
 * FIXME: input_DecoderFrameNext won't work if a module use this function.
 *
 * \return 0 if the picture is queued, -1 on error
 */
static inline int decoder_QueueVideo( decoder_t *dec, picture_t *p_pic )
{
294
    assert( dec->pf_queue_video != NULL );
295 296 297
    return dec->pf_queue_video( dec, p_pic );
}

298 299 300 301 302 303 304 305 306 307 308
/**
 * This function queues an audio block to the audio output.
 *
 * \note
 * The caller doesn't own the audio block anymore after this call (even in case
 * of error).
 *
 * \return 0 if the block is queued, -1 on error
 */
static inline int decoder_QueueAudio( decoder_t *dec, block_t *p_aout_buf )
{
309
    assert( dec->pf_queue_audio != NULL );
310 311 312
    return dec->pf_queue_audio( dec, p_aout_buf );
}

313 314 315 316 317 318 319 320 321 322 323
/**
 * This function queues a subtitle to the video output.
 *
 * \note
 * The caller doesn't own the subtitle anymore after this call (even in case of
 * error).
 *
 * \return 0 if the subtitle is queued, -1 on error
 */
static inline int decoder_QueueSub( decoder_t *dec, subpicture_t *p_spu )
{
324
    assert( dec->pf_queue_sub != NULL );
325 326 327
    return dec->pf_queue_sub( dec, p_spu );
}

328 329 330 331 332 333 334 335 336 337 338 339 340
/**
 * 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;
}

341 342
/**
 * 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
343
 * output buffer. It must be released with block_Release() or returned it to
344
 * the caller as a decoder_QueueAudio parameter.
345
 */
346
VLC_API block_t * decoder_NewAudioBuffer( decoder_t *, int i_size ) VLC_USED;
347

348 349
/**
 * This function will return a new subpicture usable by a decoder as an output
350
 * buffer. You have to release it using subpicture_Delete() or by returning
351
 * it to the caller as a decoder_QueueSub parameter.
352
 */
353
VLC_API subpicture_t * decoder_NewSubpicture( decoder_t *, const subpicture_updater_t * ) VLC_USED;
354

355 356 357 358 359 360 361
/*
 * Request that the decoder should be reloaded. The current module will be
 * unloaded. Reloading a module may cause a loss of frames. There is no
 * warranty that pf_decode_* callbacks won't be called again after this call.
 */
VLC_API void decoder_RequestReload( decoder_t * );

362 363 364 365 366
/**
 * This function gives all input attachments at once.
 *
 * You MUST release the returned values
 */
367
VLC_API int decoder_GetInputAttachments( decoder_t *, input_attachment_t ***ppp_attachment, int *pi_attachment );
368 369 370 371 372 373

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

376 377 378 379
/**
 * This function returns the current input rate.
 * You MUST use it *only* for gathering statistics about speed.
 */
380
VLC_API int decoder_GetDisplayRate( decoder_t * ) VLC_USED;
381

382 383
/** @} */
/** @} */
384
#endif /* _VLC_CODEC_H */