theora.c 29.7 KB
Newer Older
Gildas Bazin's avatar
 
Gildas Bazin committed
1 2 3
/*****************************************************************************
 * theora.c: theora decoder module making use of libtheora.
 *****************************************************************************
4
 * Copyright (C) 1999-2012 the VideoLAN team
5
 * $Id$
Gildas Bazin's avatar
 
Gildas Bazin committed
6
 *
7
 * Authors: Gildas Bazin <gbazin@videolan.org>
Gildas Bazin's avatar
 
Gildas Bazin committed
8 9 10 11 12
 *
 * 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.
Sam Hocevar's avatar
Sam Hocevar committed
13
 *
Gildas Bazin's avatar
 
Gildas Bazin committed
14 15 16 17 18 19 20
 * 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.
Gildas Bazin's avatar
 
Gildas Bazin committed
22 23 24 25 26
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
27 28 29 30
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

31
#include <vlc_common.h>
32
#include <vlc_plugin.h>
Clément Stenac's avatar
Clément Stenac committed
33 34
#include <vlc_codec.h>
#include <vlc_sout.h>
Clément Stenac's avatar
Clément Stenac committed
35
#include <vlc_input.h>
36 37
#include "../demux/xiph.h"

Gildas Bazin's avatar
 
Gildas Bazin committed
38 39
#include <ogg/ogg.h>

40 41 42 43 44 45
#include <theora/codec.h>
#include <theora/theoradec.h>
#include <theora/theoraenc.h>

#include <assert.h>
#include <limits.h>
Gildas Bazin's avatar
 
Gildas Bazin committed
46 47

/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
48
 * decoder_sys_t : theora decoder descriptor
Gildas Bazin's avatar
 
Gildas Bazin committed
49
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
50
struct decoder_sys_t
Gildas Bazin's avatar
 
Gildas Bazin committed
51
{
Gildas Bazin's avatar
 
Gildas Bazin committed
52
    /* Module mode */
53
    bool b_packetizer;
Gildas Bazin's avatar
 
Gildas Bazin committed
54

Gildas Bazin's avatar
 
Gildas Bazin committed
55
    /*
Gildas Bazin's avatar
 
Gildas Bazin committed
56
     * Input properties
Gildas Bazin's avatar
 
Gildas Bazin committed
57
     */
58
    bool b_has_headers;
Gildas Bazin's avatar
 
Gildas Bazin committed
59 60 61 62

    /*
     * Theora properties
     */
63 64 65
    th_info          ti;       /* theora bitstream settings */
    th_comment       tc;       /* theora comment information */
    th_dec_ctx       *tcx;     /* theora decoder context */
Gildas Bazin's avatar
 
Gildas Bazin committed
66

67 68 69
    /*
     * Decoding properties
     */
70
    bool b_decoded_first_keyframe;
71

Gildas Bazin's avatar
 
Gildas Bazin committed
72 73 74 75 76
    /*
     * Common properties
     */
    mtime_t i_pts;
};
Gildas Bazin's avatar
 
Gildas Bazin committed
77 78 79 80

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
81 82 83
static int  OpenDecoder   ( vlc_object_t * );
static int  OpenPacketizer( vlc_object_t * );
static void CloseDecoder  ( vlc_object_t * );
Gildas Bazin's avatar
 
Gildas Bazin committed
84

Gildas Bazin's avatar
 
Gildas Bazin committed
85
static void *DecodeBlock  ( decoder_t *, block_t ** );
86
static int  ProcessHeaders( decoder_t * );
Gildas Bazin's avatar
 
Gildas Bazin committed
87
static void *ProcessPacket ( decoder_t *, ogg_packet *, block_t ** );
Gildas Bazin's avatar
 
Gildas Bazin committed
88

Gildas Bazin's avatar
 
Gildas Bazin committed
89
static picture_t *DecodePacket( decoder_t *, ogg_packet * );
Gildas Bazin's avatar
 
Gildas Bazin committed
90

Gildas Bazin's avatar
 
Gildas Bazin committed
91
static void ParseTheoraComments( decoder_t * );
92
static void theora_CopyPicture( picture_t *, th_ycbcr_buffer );
93

Gildas Bazin's avatar
 
Gildas Bazin committed
94 95 96 97
static int  OpenEncoder( vlc_object_t *p_this );
static void CloseEncoder( vlc_object_t *p_this );
static block_t *Encode( encoder_t *p_enc, picture_t *p_pict );

Gildas Bazin's avatar
 
Gildas Bazin committed
98 99 100
/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
101 102
#define ENC_QUALITY_TEXT N_("Encoding quality")
#define ENC_QUALITY_LONGTEXT N_( \
103
  "Enforce a quality between 1 (low) and 10 (high), instead " \
104 105
  "of specifying a particular bitrate. This will produce a VBR stream." )

106 107 108 109 110 111 112 113 114 115 116 117 118
vlc_module_begin ()
    set_category( CAT_INPUT )
    set_subcategory( SUBCAT_INPUT_VCODEC )
    set_shortname( "Theora" )
    set_description( N_("Theora video decoder") )
    set_capability( "decoder", 100 )
    set_callbacks( OpenDecoder, CloseDecoder )
    add_shortcut( "theora" )

    add_submodule ()
    set_description( N_("Theora video packetizer") )
    set_capability( "packetizer", 100 )
    set_callbacks( OpenPacketizer, CloseDecoder )
119
    add_shortcut( "theora" )
120 121 122 123 124

    add_submodule ()
    set_description( N_("Theora video encoder") )
    set_capability( "encoder", 150 )
    set_callbacks( OpenEncoder, CloseEncoder )
125
    add_shortcut( "theora" )
126 127

#   define ENC_CFG_PREFIX "sout-theora-"
128
    add_integer( ENC_CFG_PREFIX "quality", 2, ENC_QUALITY_TEXT,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
129
                 ENC_QUALITY_LONGTEXT, false )
130
vlc_module_end ()
Gildas Bazin's avatar
 
Gildas Bazin committed
131

132
static const char *const ppsz_enc_options[] = {
133 134 135
    "quality", NULL
};

Gildas Bazin's avatar
 
Gildas Bazin committed
136 137 138 139 140
/*****************************************************************************
 * OpenDecoder: probe the decoder and return score
 *****************************************************************************/
static int OpenDecoder( vlc_object_t *p_this )
{
Gildas Bazin's avatar
 
Gildas Bazin committed
141
    decoder_t *p_dec = (decoder_t*)p_this;
Gildas Bazin's avatar
 
Gildas Bazin committed
142
    decoder_sys_t *p_sys;
Gildas Bazin's avatar
 
Gildas Bazin committed
143

144
    if( p_dec->fmt_in.i_codec != VLC_CODEC_THEORA )
Gildas Bazin's avatar
 
Gildas Bazin committed
145 146 147 148
    {
        return VLC_EGENERIC;
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
149
    /* Allocate the memory needed to store the decoder's structure */
150
    if( ( p_dec->p_sys = p_sys = malloc(sizeof(*p_sys)) ) == NULL )
151
        return VLC_ENOMEM;
152
    p_dec->p_sys->b_packetizer = false;
153
    p_sys->b_has_headers = false;
154
    p_sys->i_pts = VLC_TS_INVALID;
155
    p_sys->b_decoded_first_keyframe = false;
156
    p_sys->tcx = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
157 158 159

    /* Set output properties */
    p_dec->fmt_out.i_cat = VIDEO_ES;
160
    p_dec->fmt_out.i_codec = VLC_CODEC_I420;
Gildas Bazin's avatar
 
Gildas Bazin committed
161 162 163 164 165 166 167 168

    /* Set callbacks */
    p_dec->pf_decode_video = (picture_t *(*)(decoder_t *, block_t **))
        DecodeBlock;
    p_dec->pf_packetize    = (block_t *(*)(decoder_t *, block_t **))
        DecodeBlock;

    /* Init supporting Theora structures needed in header parsing */
169 170
    th_comment_init( &p_sys->tc );
    th_info_init( &p_sys->ti );
Gildas Bazin's avatar
 
Gildas Bazin committed
171

Gildas Bazin's avatar
 
Gildas Bazin committed
172 173
    return VLC_SUCCESS;
}
Gildas Bazin's avatar
 
Gildas Bazin committed
174 175 176 177 178 179 180

static int OpenPacketizer( vlc_object_t *p_this )
{
    decoder_t *p_dec = (decoder_t*)p_this;

    int i_ret = OpenDecoder( p_this );

Gildas Bazin's avatar
 
Gildas Bazin committed
181 182
    if( i_ret == VLC_SUCCESS )
    {
183
        p_dec->p_sys->b_packetizer = true;
184
        p_dec->fmt_out.i_codec = VLC_CODEC_THEORA;
Gildas Bazin's avatar
 
Gildas Bazin committed
185
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
186 187 188 189 190

    return i_ret;
}

/****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
191
 * DecodeBlock: the whole thing
Gildas Bazin's avatar
 
Gildas Bazin committed
192 193 194
 ****************************************************************************
 * This function must be fed with ogg packets.
 ****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
195
static void *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
Gildas Bazin's avatar
 
Gildas Bazin committed
196 197
{
    decoder_sys_t *p_sys = p_dec->p_sys;
Gildas Bazin's avatar
 
Gildas Bazin committed
198
    block_t *p_block;
Gildas Bazin's avatar
 
Gildas Bazin committed
199
    ogg_packet oggpacket;
Gildas Bazin's avatar
 
Gildas Bazin committed
200 201 202 203

    if( !pp_block || !*pp_block ) return NULL;

    p_block = *pp_block;
Gildas Bazin's avatar
 
Gildas Bazin committed
204

Gildas Bazin's avatar
 
Gildas Bazin committed
205 206 207 208 209 210 211
    /* Block to Ogg packet */
    oggpacket.packet = p_block->p_buffer;
    oggpacket.bytes = p_block->i_buffer;
    oggpacket.granulepos = p_block->i_dts;
    oggpacket.b_o_s = 0;
    oggpacket.e_o_s = 0;
    oggpacket.packetno = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
212

213
    /* Check for headers */
214
    if( !p_sys->b_has_headers )
215
    {
216
        if( ProcessHeaders( p_dec ) )
Gildas Bazin's avatar
 
Gildas Bazin committed
217
        {
218
            block_Release( *pp_block );
Gildas Bazin's avatar
 
Gildas Bazin committed
219
            return NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
220
        }
221
        p_sys->b_has_headers = true;
222
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
223

224 225
    return ProcessPacket( p_dec, &oggpacket, pp_block );
}
Sam Hocevar's avatar
Sam Hocevar committed
226

227 228 229 230 231 232 233
/*****************************************************************************
 * ProcessHeaders: process Theora headers.
 *****************************************************************************/
static int ProcessHeaders( decoder_t *p_dec )
{
    decoder_sys_t *p_sys = p_dec->p_sys;
    ogg_packet oggpacket;
234
    th_setup_info *ts = NULL; /* theora setup information */
Gildas Bazin's avatar
 
Gildas Bazin committed
235

236 237 238 239 240 241 242 243
    unsigned pi_size[XIPH_MAX_HEADER_COUNT];
    void     *pp_data[XIPH_MAX_HEADER_COUNT];
    unsigned i_count;
    if( xiph_SplitHeaders( pi_size, pp_data, &i_count,
                           p_dec->fmt_in.i_extra, p_dec->fmt_in.p_extra) )
        return VLC_EGENERIC;
    if( i_count < 3 )
        goto error;
Gildas Bazin's avatar
 
Gildas Bazin committed
244

245 246 247 248 249
    oggpacket.granulepos = -1;
    oggpacket.e_o_s = 0;
    oggpacket.packetno = 0;

    /* Take care of the initial Vorbis header */
250 251 252
    oggpacket.b_o_s  = 1; /* yes this actually is a b_o_s packet :) */
    oggpacket.bytes  = pi_size[0];
    oggpacket.packet = pp_data[0];
253
    if( th_decode_headerin( &p_sys->ti, &p_sys->tc, &ts, &oggpacket ) < 0 )
Gildas Bazin's avatar
 
Gildas Bazin committed
254
    {
255
        msg_Err( p_dec, "this bitstream does not contain Theora video data" );
256
        goto error;
257
    }
Sam Hocevar's avatar
Sam Hocevar committed
258

259
    /* Set output properties */
260
    if( !p_sys->b_packetizer )
261 262

    switch( p_sys->ti.pixel_fmt )
263
    {
264
      case TH_PF_420:
265
        p_dec->fmt_out.i_codec = VLC_CODEC_I420;
266
        break;
267
      case TH_PF_422:
268
        p_dec->fmt_out.i_codec = VLC_CODEC_I422;
269
        break;
270
      case TH_PF_444:
271
        p_dec->fmt_out.i_codec = VLC_CODEC_I444;
272
        break;
273
      case TH_PF_RSVD:
274 275 276 277
      default:
        msg_Err( p_dec, "unknown chroma in theora sample" );
        break;
    }
278 279 280 281

    p_dec->fmt_out.video.i_width = p_sys->ti.frame_width;
    p_dec->fmt_out.video.i_height = p_sys->ti.frame_height;
    if( p_sys->ti.pic_width && p_sys->ti.pic_height )
282
    {
283 284 285 286
        p_dec->fmt_out.video.i_visible_width = p_sys->ti.pic_width;
        p_dec->fmt_out.video.i_visible_height = p_sys->ti.pic_height;

        if( p_sys->ti.pic_x || p_sys->ti.pic_y )
287
        {
288 289
            p_dec->fmt_out.video.i_x_offset = p_sys->ti.pic_x;
            p_dec->fmt_out.video.i_y_offset = p_sys->ti.pic_y;
290
        }
291
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
292

293 294
    if( p_sys->ti.aspect_denominator && p_sys->ti.aspect_numerator )
    {
295 296
        p_dec->fmt_out.video.i_sar_num = p_sys->ti.aspect_numerator;
        p_dec->fmt_out.video.i_sar_den = p_sys->ti.aspect_denominator;
Gildas Bazin's avatar
 
Gildas Bazin committed
297
    }
298 299
    else
    {
300 301
        p_dec->fmt_out.video.i_sar_num = 1;
        p_dec->fmt_out.video.i_sar_den = 1;
302 303
    }

304 305 306 307 308 309
    if( p_sys->ti.fps_numerator > 0 && p_sys->ti.fps_denominator > 0 )
    {
        p_dec->fmt_out.video.i_frame_rate = p_sys->ti.fps_numerator;
        p_dec->fmt_out.video.i_frame_rate_base = p_sys->ti.fps_denominator;
    }

310 311 312
    msg_Dbg( p_dec, "%dx%d %.02f fps video, frame content "
             "is %dx%d with offset (%d,%d)",
             p_sys->ti.frame_width, p_sys->ti.frame_height,
313 314 315 316 317 318 319 320 321 322 323
             (double)p_sys->ti.fps_numerator/p_sys->ti.fps_denominator,
             p_sys->ti.pic_width, p_sys->ti.pic_height,
             p_sys->ti.pic_x, p_sys->ti.pic_y );

    /* Some assertions based on the documentation.  These are mandatory restrictions. */
    assert( p_sys->ti.frame_height % 16 == 0 && p_sys->ti.frame_height < 1048576 );
    assert( p_sys->ti.frame_width % 16 == 0 && p_sys->ti.frame_width < 1048576 );
    assert( p_sys->ti.keyframe_granule_shift >= 0 && p_sys->ti.keyframe_granule_shift <= 31 );
    assert( p_sys->ti.pic_x <= __MIN( p_sys->ti.frame_width - p_sys->ti.pic_width, 255 ) );
    assert( p_sys->ti.pic_y <= p_sys->ti.frame_height - p_sys->ti.pic_height);
    assert( p_sys->ti.frame_height - p_sys->ti.pic_height - p_sys->ti.pic_y <= 255 );
Gildas Bazin's avatar
 
Gildas Bazin committed
324

325
    /* Sanity check that seems necessary for some corrupted files */
326 327
    if( p_sys->ti.frame_width < p_sys->ti.pic_width ||
        p_sys->ti.frame_height < p_sys->ti.pic_height )
328 329 330
    {
        msg_Warn( p_dec, "trying to correct invalid theora header "
                  "(frame size (%dx%d) is smaller than frame content (%d,%d))",
331 332
                  p_sys->ti.frame_width, p_sys->ti.frame_height,
                  p_sys->ti.pic_width, p_sys->ti.pic_height );
333

334 335 336 337
        if( p_sys->ti.frame_width < p_sys->ti.pic_width )
          p_sys->ti.frame_width = p_sys->ti.pic_width;
        if( p_sys->ti.frame_height < p_sys->ti.pic_height )
            p_sys->ti.frame_height = p_sys->ti.pic_height;
338 339
    }

340
    /* The next packet in order is the comments header */
341 342 343
    oggpacket.b_o_s  = 0;
    oggpacket.bytes  = pi_size[1];
    oggpacket.packet = pp_data[1];
344 345

    if( th_decode_headerin( &p_sys->ti, &p_sys->tc, &ts, &oggpacket ) < 0 )
346 347
    {
        msg_Err( p_dec, "2nd Theora header is corrupted" );
348
        goto error;
349 350 351
    }

    ParseTheoraComments( p_dec );
Gildas Bazin's avatar
 
Gildas Bazin committed
352

353 354 355
    /* The next packet in order is the codebooks header
     * We need to watch out that this packet is not missing as a
     * missing or corrupted header is fatal. */
356 357 358
    oggpacket.b_o_s  = 0;
    oggpacket.bytes  = pi_size[2];
    oggpacket.packet = pp_data[2];
359
    if( th_decode_headerin( &p_sys->ti, &p_sys->tc, &ts, &oggpacket ) < 0 )
360 361
    {
        msg_Err( p_dec, "3rd Theora header is corrupted" );
362
        goto error;
363 364 365 366 367
    }

    if( !p_sys->b_packetizer )
    {
        /* We have all the headers, initialize decoder */
368 369 370 371 372
        if ( ( p_sys->tcx = th_decode_alloc( &p_sys->ti, ts ) ) == NULL )
        {
            msg_Err( p_dec, "Could not allocate Theora decoder" );
            goto error;
        }
373 374 375 376
    }
    else
    {
        p_dec->fmt_out.i_extra = p_dec->fmt_in.i_extra;
377
        p_dec->fmt_out.p_extra = xrealloc( p_dec->fmt_out.p_extra,
378
                                                  p_dec->fmt_out.i_extra );
379 380 381 382
        memcpy( p_dec->fmt_out.p_extra,
                p_dec->fmt_in.p_extra, p_dec->fmt_out.i_extra );
    }

383 384
    for( unsigned i = 0; i < i_count; i++ )
        free( pp_data[i] );
385 386
    /* Clean up the decoder setup info... we're done with it */
    th_setup_free( ts );
387
    return VLC_SUCCESS;
388 389 390 391

error:
    for( unsigned i = 0; i < i_count; i++ )
        free( pp_data[i] );
392 393
    /* Clean up the decoder setup info... we're done with it */
    th_setup_free( ts );
394
    return VLC_EGENERIC;
Gildas Bazin's avatar
 
Gildas Bazin committed
395
}
Gildas Bazin's avatar
 
Gildas Bazin committed
396

Gildas Bazin's avatar
 
Gildas Bazin committed
397
/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
398
 * ProcessPacket: processes a theora packet.
Gildas Bazin's avatar
 
Gildas Bazin committed
399
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
400 401
static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
                            block_t **pp_block )
Gildas Bazin's avatar
 
Gildas Bazin committed
402 403
{
    decoder_sys_t *p_sys = p_dec->p_sys;
Gildas Bazin's avatar
 
Gildas Bazin committed
404 405
    block_t *p_block = *pp_block;
    void *p_buf;
Gildas Bazin's avatar
 
Gildas Bazin committed
406

Laurent Aimar's avatar
Laurent Aimar committed
407
    if( ( p_block->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) ) != 0 )
408 409 410 411 412 413 414
    {
        /* Don't send the the first packet after a discontinuity to
         * theora_decode, otherwise we get purple/green display artifacts
         * appearing in the video output */
        return NULL;
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
415
    /* Date management */
416
    if( p_block->i_pts > VLC_TS_INVALID && p_block->i_pts != p_sys->i_pts )
Gildas Bazin's avatar
 
Gildas Bazin committed
417
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
418
        p_sys->i_pts = p_block->i_pts;
Gildas Bazin's avatar
 
Gildas Bazin committed
419 420
    }

421 422
    *pp_block = NULL; /* To avoid being fed the same packet again */

Gildas Bazin's avatar
 
Gildas Bazin committed
423 424
    if( p_sys->b_packetizer )
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
425 426 427
        /* Date management */
        p_block->i_dts = p_block->i_pts = p_sys->i_pts;

428
        p_block->i_length = p_sys->i_pts - p_block->i_pts;
Gildas Bazin's avatar
 
Gildas Bazin committed
429 430

        p_buf = p_block;
Gildas Bazin's avatar
 
Gildas Bazin committed
431 432 433
    }
    else
    {
434 435 436
        p_buf = DecodePacket( p_dec, p_oggpacket );
        if( p_block )
            block_Release( p_block );
Gildas Bazin's avatar
 
Gildas Bazin committed
437
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
438 439

    /* Date management */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
440
    p_sys->i_pts += ( INT64_C(1000000) * p_sys->ti.fps_denominator /
Gildas Bazin's avatar
 
Gildas Bazin committed
441
                      p_sys->ti.fps_numerator ); /* 1 frame per packet */
Gildas Bazin's avatar
 
Gildas Bazin committed
442

Gildas Bazin's avatar
 
Gildas Bazin committed
443
    return p_buf;
Gildas Bazin's avatar
 
Gildas Bazin committed
444 445 446
}

/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
447
 * DecodePacket: decodes a Theora packet.
Gildas Bazin's avatar
 
Gildas Bazin committed
448
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
449
static picture_t *DecodePacket( decoder_t *p_dec, ogg_packet *p_oggpacket )
Gildas Bazin's avatar
 
Gildas Bazin committed
450
{
Gildas Bazin's avatar
 
Gildas Bazin committed
451
    decoder_sys_t *p_sys = p_dec->p_sys;
Gildas Bazin's avatar
 
Gildas Bazin committed
452
    picture_t *p_pic;
453
    th_ycbcr_buffer ycbcr;
Gildas Bazin's avatar
 
Gildas Bazin committed
454

455 456 457 458
    /* TODO: Implement _granpos (3rd parameter here) and add the
     * call to TH_DECCTL_SET_GRANDPOS after seek */
    if (th_decode_packetin( p_sys->tcx, p_oggpacket, NULL )) /* 0 on success */
        return NULL; /* bad packet */
Gildas Bazin's avatar
 
Gildas Bazin committed
459

460 461 462
    /* Check for keyframe */
    if( !(p_oggpacket->packet[0] & 0x80) /* data packet */ &&
        !(p_oggpacket->packet[0] & 0x40) /* intra frame */ )
463
        p_sys->b_decoded_first_keyframe = true;
464 465 466 467 468 469

    /* If we haven't seen a single keyframe yet, don't let Theora decode
     * anything, otherwise we'll get display artifacts.  (This is impossible
     * in the general case, but can happen if e.g. we play a network stream
     * using a timed URL, such that the server doesn't start the video with a
     * keyframe). */
470 471 472 473
    if( !p_sys->b_decoded_first_keyframe )
        return NULL; /* Wait until we've decoded the first keyframe */

    if( th_decode_ycbcr_out( p_sys->tcx, ycbcr ) ) /* returns 0 on success */
474
        return NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
475

Gildas Bazin's avatar
 
Gildas Bazin committed
476
    /* Get a new picture */
477
    p_pic = decoder_NewPicture( p_dec );
Gildas Bazin's avatar
 
Gildas Bazin committed
478
    if( !p_pic ) return NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
479

480
    theora_CopyPicture( p_pic, ycbcr );
Gildas Bazin's avatar
 
Gildas Bazin committed
481

Gildas Bazin's avatar
 
Gildas Bazin committed
482
    p_pic->date = p_sys->i_pts;
Gildas Bazin's avatar
 
Gildas Bazin committed
483

Gildas Bazin's avatar
 
Gildas Bazin committed
484
    return p_pic;
Gildas Bazin's avatar
 
Gildas Bazin committed
485 486 487
}

/*****************************************************************************
488
 * ParseTheoraComments:
Gildas Bazin's avatar
 
Gildas Bazin committed
489
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
490
static void ParseTheoraComments( decoder_t *p_dec )
Gildas Bazin's avatar
 
Gildas Bazin committed
491
{
Gildas Bazin's avatar
 
Gildas Bazin committed
492
    char *psz_name, *psz_value, *psz_comment;
493
    int i = 0;
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
    /* Regarding the th_comment structure: */

    /* The metadata is stored as a series of (tag, value) pairs, in
       length-encoded string vectors. The first occurrence of the '='
       character delimits the tag and value. A particular tag may
       occur more than once, and order is significant. The character
       set encoding for the strings is always UTF-8, but the tag names
       are limited to ASCII, and treated as case-insensitive. See the
       Theora specification, Section 6.3.3 for details. */

    /* In filling in this structure, th_decode_headerin() will
       null-terminate the user_comment strings for safety. However,
       the bitstream format itself treats them as 8-bit clean vectors,
       possibly containing null characters, and so the length array
       should be treated as their authoritative length. */
Gildas Bazin's avatar
 
Gildas Bazin committed
509
    while ( i < p_dec->p_sys->tc.comments )
Gildas Bazin's avatar
 
Gildas Bazin committed
510
    {
511 512 513
        int clen = p_dec->p_sys->tc.comment_lengths[i];
        if ( clen <= 0 || clen >= INT_MAX ) { i++; continue; }
        psz_comment = (char *)malloc( clen + 1 );
Gildas Bazin's avatar
 
Gildas Bazin committed
514 515
        if( !psz_comment )
            break;
516
        memcpy( (void*)psz_comment, (void*)p_dec->p_sys->tc.user_comments[i], clen + 1 );
Gildas Bazin's avatar
 
Gildas Bazin committed
517 518 519 520 521 522
        psz_name = psz_comment;
        psz_value = strchr( psz_comment, '=' );
        if( psz_value )
        {
            *psz_value = '\0';
            psz_value++;
523 524 525

            if( !p_dec->p_description )
                p_dec->p_description = vlc_meta_New();
526 527
            /* TODO:  Since psz_value can contain NULLs see if there is an
             * instance where we need to preserve the full length of this string */
528 529
            if( p_dec->p_description )
                vlc_meta_AddExtra( p_dec->p_description, psz_name, psz_value );
Gildas Bazin's avatar
 
Gildas Bazin committed
530 531 532 533 534 535 536
        }
        free( psz_comment );
        i++;
    }
}

/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
537
 * CloseDecoder: theora decoder destruction
Gildas Bazin's avatar
 
Gildas Bazin committed
538
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
539
static void CloseDecoder( vlc_object_t *p_this )
Gildas Bazin's avatar
 
Gildas Bazin committed
540
{
Gildas Bazin's avatar
 
Gildas Bazin committed
541
    decoder_t *p_dec = (decoder_t *)p_this;
Gildas Bazin's avatar
 
Gildas Bazin committed
542
    decoder_sys_t *p_sys = p_dec->p_sys;
Gildas Bazin's avatar
 
Gildas Bazin committed
543

544 545 546 547
    th_info_clear(&p_sys->ti);
    th_comment_clear(&p_sys->tc);
    th_decode_free(p_sys->tcx);
    p_sys->tcx = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
548
    free( p_sys );
Gildas Bazin's avatar
 
Gildas Bazin committed
549 550 551 552 553 554
}

/*****************************************************************************
 * theora_CopyPicture: copy a picture from theora internal buffers to a
 *                     picture_t structure.
 *****************************************************************************/
555
static void theora_CopyPicture( picture_t *p_pic,
556
                                th_ycbcr_buffer ycbcr )
Gildas Bazin's avatar
 
Gildas Bazin committed
557
{
558
    int i_plane, i_planes, i_line, i_dst_stride, i_src_stride;
Sam Hocevar's avatar
Sam Hocevar committed
559
    uint8_t *p_dst, *p_src;
560 561 562 563 564 565 566 567 568
    /* th_img_plane
       int  width   The width of this plane.
       int  height  The height of this plane.
       int  stride  The offset in bytes between successive rows.
       unsigned char *data  A pointer to the beginning of the first row.

       Detailed Description

       A buffer for a single color plane in an uncompressed image.
Gildas Bazin's avatar
 
Gildas Bazin committed
569

570 571 572 573 574 575 576 577 578 579 580 581 582
       This contains the image data in a left-to-right, top-down
       format. Each row of pixels is stored contiguously in memory,
       but successive rows need not be. Use stride to compute the
       offset of the next row. The encoder accepts both positive
       stride values (top-down in memory) and negative (bottom-up in
       memory). The decoder currently always generates images with
       positive strides.

       typedef th_img_plane th_ycbcr_buffer[3]
    */

    i_planes = p_pic->i_planes < 3 ? p_pic->i_planes : 3;
    for( i_plane = 0; i_plane < i_planes; i_plane++ )
Gildas Bazin's avatar
 
Gildas Bazin committed
583 584
    {
        p_dst = p_pic->p[i_plane].p_pixels;
585
        p_src = ycbcr[i_plane].data;
Gildas Bazin's avatar
 
Gildas Bazin committed
586
        i_dst_stride  = p_pic->p[i_plane].i_pitch;
587 588 589 590
        i_src_stride  = ycbcr[i_plane].stride;
        for( i_line = 0;
             i_line < __MIN(p_pic->p[i_plane].i_lines, ycbcr[i_plane].height);
             i_line++ )
Gildas Bazin's avatar
 
Gildas Bazin committed
591
        {
Rafaël Carré's avatar
Rafaël Carré committed
592
            memcpy( p_dst, p_src, ycbcr[i_plane].width );
Gildas Bazin's avatar
 
Gildas Bazin committed
593 594 595 596 597
            p_src += i_src_stride;
            p_dst += i_dst_stride;
        }
    }
}
Gildas Bazin's avatar
 
Gildas Bazin committed
598 599 600 601 602 603 604 605 606

/*****************************************************************************
 * encoder_sys_t : theora encoder descriptor
 *****************************************************************************/
struct encoder_sys_t
{
    /*
     * Input properties
     */
607
    bool b_headers;
Gildas Bazin's avatar
 
Gildas Bazin committed
608 609 610 611

    /*
     * Theora properties
     */
612 613 614
    th_info      ti;                     /* theora bitstream settings */
    th_comment   tc;                     /* theora comment header */
    th_enc_ctx   *tcx;                   /* theora context */
615
    int i_width, i_height;
Gildas Bazin's avatar
 
Gildas Bazin committed
616 617 618 619 620 621 622 623
};

/*****************************************************************************
 * OpenEncoder: probe the encoder and return score
 *****************************************************************************/
static int OpenEncoder( vlc_object_t *p_this )
{
    encoder_t *p_enc = (encoder_t *)p_this;
624
    encoder_sys_t *p_sys;
Laurent Aimar's avatar
Laurent Aimar committed
625
    int i_quality;
626 627 628 629 630
    int t_flags;
    int max_enc_level = 0;
    int keyframe_freq_force = 64;
    ogg_packet header;
    int status;
Gildas Bazin's avatar
 
Gildas Bazin committed
631

632
    if( p_enc->fmt_out.i_codec != VLC_CODEC_THEORA &&
633
        !p_enc->b_force )
Gildas Bazin's avatar
 
Gildas Bazin committed
634 635 636 637 638
    {
        return VLC_EGENERIC;
    }

    /* Allocate the memory needed to store the decoder's structure */
639
    if( ( p_sys = malloc(sizeof(encoder_sys_t)) ) == NULL )
640
        return VLC_ENOMEM;
Gildas Bazin's avatar
 
Gildas Bazin committed
641 642 643
    p_enc->p_sys = p_sys;

    p_enc->pf_encode_video = Encode;
644 645
    p_enc->fmt_in.i_codec = VLC_CODEC_I420;
    p_enc->fmt_out.i_codec = VLC_CODEC_THEORA;
Gildas Bazin's avatar
 
Gildas Bazin committed
646

647
    config_ChainParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
648

649
    i_quality = var_GetInteger( p_enc, ENC_CFG_PREFIX "quality" );
650 651 652
    if( i_quality > 10 ) i_quality = 10;
    if( i_quality < 0 ) i_quality = 0;

653
    th_info_init( &p_sys->ti );
Gildas Bazin's avatar
 
Gildas Bazin committed
654

655 656
    p_sys->ti.frame_width = p_enc->fmt_in.video.i_width;
    p_sys->ti.frame_height = p_enc->fmt_in.video.i_height;
657

658
    if( p_sys->ti.frame_width % 16 || p_sys->ti.frame_height % 16 )
659 660 661
    {
        /* Pictures from the transcoder should always have a pitch
         * which is a multiple of 16 */
662 663
        p_sys->ti.frame_width = (p_sys->ti.frame_width + 15) >> 4 << 4;
        p_sys->ti.frame_height = (p_sys->ti.frame_height + 15) >> 4 << 4;
664 665 666

        msg_Dbg( p_enc, "padding video from %dx%d to %dx%d",
                 p_enc->fmt_in.video.i_width, p_enc->fmt_in.video.i_height,
667
                 p_sys->ti.frame_width, p_sys->ti.frame_height );
668 669
    }

670 671 672 673
    p_sys->ti.pic_width = p_enc->fmt_in.video.i_width;
    p_sys->ti.pic_height = p_enc->fmt_in.video.i_height;
    p_sys->ti.pic_x = 0 /*frame_x_offset*/;
    p_sys->ti.pic_y = 0 /*frame_y_offset*/;
674

675 676
    p_sys->i_width = p_sys->ti.frame_width;
    p_sys->i_height = p_sys->ti.frame_height;
677

678 679 680 681 682 683 684 685 686 687 688
    if( !p_enc->fmt_in.video.i_frame_rate ||
        !p_enc->fmt_in.video.i_frame_rate_base )
    {
        p_sys->ti.fps_numerator = 25;
        p_sys->ti.fps_denominator = 1;
    }
    else
    {
        p_sys->ti.fps_numerator = p_enc->fmt_in.video.i_frame_rate;
        p_sys->ti.fps_denominator = p_enc->fmt_in.video.i_frame_rate_base;
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
689

690
    if( p_enc->fmt_in.video.i_sar_num > 0 && p_enc->fmt_in.video.i_sar_den > 0 )
Gildas Bazin's avatar
 
Gildas Bazin committed
691
    {
692
        unsigned i_dst_num, i_dst_den;
693 694 695
        vlc_ureduce( &i_dst_num, &i_dst_den,
                     p_enc->fmt_in.video.i_sar_num,
                     p_enc->fmt_in.video.i_sar_den, 0 );
696 697
        p_sys->ti.aspect_numerator = i_dst_num;
        p_sys->ti.aspect_denominator = i_dst_den;
Gildas Bazin's avatar
 
Gildas Bazin committed
698 699 700 701 702 703 704
    }
    else
    {
        p_sys->ti.aspect_numerator = 4;
        p_sys->ti.aspect_denominator = 3;
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
705
    p_sys->ti.target_bitrate = p_enc->fmt_out.i_bitrate;
706
    p_sys->ti.quality = ((float)i_quality) * 6.3;
Gildas Bazin's avatar
 
Gildas Bazin committed
707

708 709 710 711 712 713

    p_sys->tcx = th_encode_alloc( &p_sys->ti );
    th_comment_init( &p_sys->tc );

    /* These are no longer supported here: */
    /*
Gildas Bazin's avatar
 
Gildas Bazin committed
714 715 716 717 718
    p_sys->ti.dropframes_p = 0;
    p_sys->ti.quick_p = 1;
    p_sys->ti.keyframe_auto_p = 1;
    p_sys->ti.keyframe_frequency = 64;
    p_sys->ti.keyframe_frequency_force = 64;
Gildas Bazin's avatar
 
Gildas Bazin committed
719
    p_sys->ti.keyframe_data_target_bitrate = p_enc->fmt_out.i_bitrate * 1.5;
Gildas Bazin's avatar
 
Gildas Bazin committed
720 721 722
    p_sys->ti.keyframe_auto_threshold = 80;
    p_sys->ti.keyframe_mindistance = 8;
    p_sys->ti.noise_sensitivity = 1;
723
    */
Gildas Bazin's avatar
 
Gildas Bazin committed
724

725 726 727
    t_flags = TH_RATECTL_CAP_OVERFLOW; /* default is TH_RATECTL_CAP_OVERFLOW | TL_RATECTL_DROP_FRAMES */
    /* Turn off dropframes */
    th_encode_ctl( p_sys->tcx, TH_ENCCTL_SET_RATE_FLAGS, &t_flags, sizeof(t_flags) );
Gildas Bazin's avatar
 
Gildas Bazin committed
728

729 730 731 732
    /* turn on fast encoding */
    if ( !th_encode_ctl( p_sys->tcx, TH_ENCCTL_GET_SPLEVEL_MAX, &max_enc_level,
                sizeof(max_enc_level) ) ) /* returns 0 on success */
        th_encode_ctl( p_sys->tcx, TH_ENCCTL_SET_SPLEVEL, &max_enc_level, sizeof(max_enc_level) );
733

734 735 736
    /* Set forced distance between key frames */
    th_encode_ctl( p_sys->tcx, TH_ENCCTL_SET_KEYFRAME_FREQUENCY_FORCE,
                   &keyframe_freq_force, sizeof(keyframe_freq_force) );
737

738 739 740 741
    /* Create and store headers */
    while ( ( status = th_encode_flushheader( p_sys->tcx, &p_sys->tc, &header ) ) )
    {
        if ( status < 0 ) return VLC_EGENERIC;
Laurent Aimar's avatar
Laurent Aimar committed
742 743 744 745 746 747
        if( xiph_AppendHeaders( &p_enc->fmt_out.i_extra, &p_enc->fmt_out.p_extra,
                                header.bytes, header.packet ) )
        {
            p_enc->fmt_out.i_extra = 0;
            p_enc->fmt_out.p_extra = NULL;
        }
Gildas Bazin's avatar
 
Gildas Bazin committed
748
    }
749
    return VLC_SUCCESS;
Gildas Bazin's avatar
 
Gildas Bazin committed
750 751 752 753 754 755 756 757 758 759 760 761
}

/****************************************************************************
 * Encode: the whole thing
 ****************************************************************************
 * This function spits out ogg packets.
 ****************************************************************************/
static block_t *Encode( encoder_t *p_enc, picture_t *p_pict )
{
    encoder_sys_t *p_sys = p_enc->p_sys;
    ogg_packet oggpacket;
    block_t *p_block;
762
    th_ycbcr_buffer ycbcr;
763 764
    int i;

765
    if( !p_pict ) return NULL;
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
    /* Sanity check */
    if( p_pict->p[0].i_pitch < (int)p_sys->i_width ||
        p_pict->p[0].i_lines < (int)p_sys->i_height )
    {
        msg_Warn( p_enc, "frame is smaller than encoding size"
                  "(%ix%i->%ix%i) -> dropping frame",
                  p_pict->p[0].i_pitch, p_pict->p[0].i_lines,
                  p_sys->i_width, p_sys->i_height );
        return NULL;
    }

    /* Fill padding */
    if( p_pict->p[0].i_visible_pitch < (int)p_sys->i_width )
    {
        for( i = 0; i < p_sys->i_height; i++ )
        {
            memset( p_pict->p[0].p_pixels + i * p_pict->p[0].i_pitch +
                    p_pict->p[0].i_visible_pitch,
                    *( p_pict->p[0].p_pixels + i * p_pict->p[0].i_pitch +
                       p_pict->p[0].i_visible_pitch - 1 ),
                    p_sys->i_width - p_pict->p[0].i_visible_pitch );
        }
        for( i = 0; i < p_sys->i_height / 2; i++ )
        {
            memset( p_pict->p[1].p_pixels + i * p_pict->p[1].i_pitch +
                    p_pict->p[1].i_visible_pitch,
                    *( p_pict->p[1].p_pixels + i * p_pict->p[1].i_pitch +
                       p_pict->p[1].i_visible_pitch - 1 ),
                    p_sys->i_width / 2 - p_pict->p[1].i_visible_pitch );
            memset( p_pict->p[2].p_pixels + i * p_pict->p[2].i_pitch +
                    p_pict->p[2].i_visible_pitch,
                    *( p_pict->p[2].p_pixels + i * p_pict->p[2].i_pitch +
                       p_pict->p[2].i_visible_pitch - 1 ),
                    p_sys->i_width / 2 - p_pict->p[2].i_visible_pitch );
        }
    }

    if( p_pict->p[0].i_visible_lines < (int)p_sys->i_height )
    {
        for( i = p_pict->p[0].i_visible_lines; i < p_sys->i_height; i++ )
        {
            memset( p_pict->p[0].p_pixels + i * p_pict->p[0].i_pitch, 0,
                    p_sys->i_width );
        }
        for( i = p_pict->p[1].i_visible_lines; i < p_sys->i_height / 2; i++ )
        {
            memset( p_pict->p[1].p_pixels + i * p_pict->p[1].i_pitch, 0x80,
                    p_sys->i_width / 2 );
            memset( p_pict->p[2].p_pixels + i * p_pict->p[2].i_pitch, 0x80,
                    p_sys->i_width / 2 );
        }
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
818 819 820 821

    /* Theora is a one-frame-in, one-frame-out system. Submit a frame
     * for compression and pull out the packet. */

822 823 824 825
    ycbcr[0].width = p_sys->i_width;
    ycbcr[0].height = p_sys->i_height;
    ycbcr[0].stride = p_pict->p[0].i_pitch;
    ycbcr[0].data = p_pict->p[0].p_pixels;
Gildas Bazin's avatar
 
Gildas Bazin committed
826

827 828 829 830
    ycbcr[1].width = p_sys->i_width / 2;
    ycbcr[1].height = p_sys->i_height / 2;
    ycbcr[1].stride = p_pict->p[1].i_pitch;
    ycbcr[1].data = p_pict->p[1].p_pixels;
Gildas Bazin's avatar
 
Gildas Bazin committed
831

832 833 834 835
    ycbcr[2].width = p_sys->i_width / 2;
    ycbcr[2].height = p_sys->i_height / 2;
    ycbcr[2].stride = p_pict->p[1].i_pitch;
    ycbcr[2].data = p_pict->p[2].p_pixels;
Gildas Bazin's avatar
 
Gildas Bazin committed
836

837
    if( th_encode_ycbcr_in( p_sys->tcx, ycbcr ) < 0 )
Gildas Bazin's avatar
 
Gildas Bazin committed
838 839 840 841
    {
        msg_Warn( p_enc, "failed encoding a frame" );
        return NULL;
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
842

843
    th_encode_packetout( p_sys->tcx, 0, &oggpacket );
Gildas Bazin's avatar
 
Gildas Bazin committed
844 845 846

    /* Ogg packet to block */
    p_block = block_New( p_enc, oggpacket.bytes );
Gildas Bazin's avatar
 
Gildas Bazin committed
847
    memcpy( p_block->p_buffer, oggpacket.packet, oggpacket.bytes );
848
    p_block->i_dts = p_block->i_pts = p_pict->date;
Gildas Bazin's avatar
 
Gildas Bazin committed
849

850
    if( th_packet_iskeyframe( &oggpacket ) )
ogg.k.ogg.k's avatar
ogg.k.ogg.k committed
851 852 853 854
    {
        p_block->i_flags |= BLOCK_FLAG_TYPE_I;
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
855 856 857 858 859 860 861 862 863 864 865
    return p_block;
}

/*****************************************************************************
 * CloseEncoder: theora encoder destruction
 *****************************************************************************/
static void CloseEncoder( vlc_object_t *p_this )
{
    encoder_t *p_enc = (encoder_t *)p_this;
    encoder_sys_t *p_sys = p_enc->p_sys;

866 867 868 869
    th_info_clear(&p_sys->ti);
    th_comment_clear(&p_sys->tc);
    th_encode_free(p_sys->tcx);
    p_sys->tcx = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
870 871
    free( p_sys );
}