theora.c 30 KB
Newer Older
Gildas Bazin's avatar
 
Gildas Bazin committed
1 2 3
/*****************************************************************************
 * theora.c: theora decoder module making use of libtheora.
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2012 VLC authors and VideoLAN
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
 *
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
 * (at your option) any later version.
Sam Hocevar's avatar
Sam Hocevar committed
13
 *
Gildas Bazin's avatar
 
Gildas Bazin committed
14 15
 * 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 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

94
#ifdef ENABLE_SOUT
Gildas Bazin's avatar
 
Gildas Bazin committed
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 );
98
#endif
Gildas Bazin's avatar
 
Gildas Bazin committed
99

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

108 109 110 111 112 113 114 115 116 117 118 119 120
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 )
121
    add_shortcut( "theora" )
122

123
#ifdef ENABLE_SOUT
124 125 126 127
    add_submodule ()
    set_description( N_("Theora video encoder") )
    set_capability( "encoder", 150 )
    set_callbacks( OpenEncoder, CloseEncoder )
128
    add_shortcut( "theora" )
129 130

#   define ENC_CFG_PREFIX "sout-theora-"
131
    add_integer( ENC_CFG_PREFIX "quality", 2, ENC_QUALITY_TEXT,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
132
                 ENC_QUALITY_LONGTEXT, false )
133
#endif
134
vlc_module_end ()
Gildas Bazin's avatar
 
Gildas Bazin committed
135

136
static const char *const ppsz_enc_options[] = {
137 138 139
    "quality", NULL
};

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

148
    if( p_dec->fmt_in.i_codec != VLC_CODEC_THEORA )
Gildas Bazin's avatar
 
Gildas Bazin committed
149 150 151 152
    {
        return VLC_EGENERIC;
    }

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

    /* Set output properties */
    p_dec->fmt_out.i_cat = VIDEO_ES;
164
    p_dec->fmt_out.i_codec = VLC_CODEC_I420;
Gildas Bazin's avatar
 
Gildas Bazin committed
165 166 167 168 169 170 171 172

    /* 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 */
173 174
    th_comment_init( &p_sys->tc );
    th_info_init( &p_sys->ti );
Gildas Bazin's avatar
 
Gildas Bazin committed
175

Gildas Bazin's avatar
 
Gildas Bazin committed
176 177
    return VLC_SUCCESS;
}
Gildas Bazin's avatar
 
Gildas Bazin committed
178 179 180 181 182 183 184

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
185 186
    if( i_ret == VLC_SUCCESS )
    {
187
        p_dec->p_sys->b_packetizer = true;
188
        p_dec->fmt_out.i_codec = VLC_CODEC_THEORA;
Gildas Bazin's avatar
 
Gildas Bazin committed
189
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
190 191 192 193 194

    return i_ret;
}

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

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

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

Gildas Bazin's avatar
 
Gildas Bazin committed
209 210 211 212 213 214 215
    /* 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
216

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

228 229
    return ProcessPacket( p_dec, &oggpacket, pp_block );
}
Sam Hocevar's avatar
Sam Hocevar committed
230

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

240 241 242 243 244 245 246 247
    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
248

249 250 251 252 253
    oggpacket.granulepos = -1;
    oggpacket.e_o_s = 0;
    oggpacket.packetno = 0;

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

263
    /* Set output properties */
264
    if( !p_sys->b_packetizer )
265 266

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

    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 )
286
    {
287 288 289 290
        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 )
291
        {
292 293
            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;
294
        }
295
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
296

297 298
    if( p_sys->ti.aspect_denominator && p_sys->ti.aspect_numerator )
    {
299 300
        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
301
    }
302 303
    else
    {
304 305
        p_dec->fmt_out.video.i_sar_num = 1;
        p_dec->fmt_out.video.i_sar_den = 1;
306 307
    }

308 309 310 311 312 313
    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;
    }

314 315 316
    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,
317 318 319 320 321 322 323 324 325 326 327
             (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
328

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

338 339 340 341
        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;
342 343
    }

344
    /* The next packet in order is the comments header */
345 346 347
    oggpacket.b_o_s  = 0;
    oggpacket.bytes  = pi_size[1];
    oggpacket.packet = pp_data[1];
348 349

    if( th_decode_headerin( &p_sys->ti, &p_sys->tc, &ts, &oggpacket ) < 0 )
350 351
    {
        msg_Err( p_dec, "2nd Theora header is corrupted" );
352
        goto error;
353 354 355
    }

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

357 358 359
    /* 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. */
360 361 362
    oggpacket.b_o_s  = 0;
    oggpacket.bytes  = pi_size[2];
    oggpacket.packet = pp_data[2];
363
    if( th_decode_headerin( &p_sys->ti, &p_sys->tc, &ts, &oggpacket ) < 0 )
364 365
    {
        msg_Err( p_dec, "3rd Theora header is corrupted" );
366
        goto error;
367 368 369 370 371
    }

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

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
411
    if( ( p_block->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) ) != 0 )
412 413 414 415 416 417 418
    {
        /* 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
419
    /* Date management */
420
    if( p_block->i_pts > VLC_TS_INVALID && p_block->i_pts != p_sys->i_pts )
Gildas Bazin's avatar
 
Gildas Bazin committed
421
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
422
        p_sys->i_pts = p_block->i_pts;
Gildas Bazin's avatar
 
Gildas Bazin committed
423 424
    }

425 426
    *pp_block = NULL; /* To avoid being fed the same packet again */

Gildas Bazin's avatar
 
Gildas Bazin committed
427 428
    if( p_sys->b_packetizer )
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
429 430 431
        /* Date management */
        p_block->i_dts = p_block->i_pts = p_sys->i_pts;

432
        p_block->i_length = p_sys->i_pts - p_block->i_pts;
Gildas Bazin's avatar
 
Gildas Bazin committed
433 434

        p_buf = p_block;
Gildas Bazin's avatar
 
Gildas Bazin committed
435 436 437
    }
    else
    {
438 439 440
        p_buf = DecodePacket( p_dec, p_oggpacket );
        if( p_block )
            block_Release( p_block );
Gildas Bazin's avatar
 
Gildas Bazin committed
441
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
442 443

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

Gildas Bazin's avatar
 
Gildas Bazin committed
447
    return p_buf;
Gildas Bazin's avatar
 
Gildas Bazin committed
448 449 450
}

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

459 460
    /* TODO: Implement _granpos (3rd parameter here) and add the
     * call to TH_DECCTL_SET_GRANDPOS after seek */
.'s avatar
. committed
461 462 463
    /* TODO: If the return is TH_DUPFRAME, we don't need to display a new
     * frame, but we do need to keep displaying the previous one. */
    if (th_decode_packetin( p_sys->tcx, p_oggpacket, NULL ) < 0)
464
        return NULL; /* bad packet */
Gildas Bazin's avatar
 
Gildas Bazin committed
465

466 467 468
    /* Check for keyframe */
    if( !(p_oggpacket->packet[0] & 0x80) /* data packet */ &&
        !(p_oggpacket->packet[0] & 0x40) /* intra frame */ )
469
        p_sys->b_decoded_first_keyframe = true;
470 471 472 473 474 475

    /* 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). */
476 477 478 479
    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 */
480
        return NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
481

Gildas Bazin's avatar
 
Gildas Bazin committed
482
    /* Get a new picture */
483
    p_pic = decoder_NewPicture( p_dec );
Gildas Bazin's avatar
 
Gildas Bazin committed
484
    if( !p_pic ) return NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
485

486
    theora_CopyPicture( p_pic, ycbcr );
Gildas Bazin's avatar
 
Gildas Bazin committed
487

Gildas Bazin's avatar
 
Gildas Bazin committed
488
    p_pic->date = p_sys->i_pts;
Gildas Bazin's avatar
 
Gildas Bazin committed
489

Gildas Bazin's avatar
 
Gildas Bazin committed
490
    return p_pic;
Gildas Bazin's avatar
 
Gildas Bazin committed
491 492 493
}

/*****************************************************************************
494
 * ParseTheoraComments:
Gildas Bazin's avatar
 
Gildas Bazin committed
495
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
496
static void ParseTheoraComments( decoder_t *p_dec )
Gildas Bazin's avatar
 
Gildas Bazin committed
497
{
Gildas Bazin's avatar
 
Gildas Bazin committed
498
    char *psz_name, *psz_value, *psz_comment;
499
    int i = 0;
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
    /* 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
515
    while ( i < p_dec->p_sys->tc.comments )
Gildas Bazin's avatar
 
Gildas Bazin committed
516
    {
517 518 519
        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
520 521
        if( !psz_comment )
            break;
522
        memcpy( (void*)psz_comment, (void*)p_dec->p_sys->tc.user_comments[i], clen + 1 );
Gildas Bazin's avatar
 
Gildas Bazin committed
523 524 525 526 527 528
        psz_name = psz_comment;
        psz_value = strchr( psz_comment, '=' );
        if( psz_value )
        {
            *psz_value = '\0';
            psz_value++;
529 530 531

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

/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
543
 * CloseDecoder: theora decoder destruction
Gildas Bazin's avatar
 
Gildas Bazin committed
544
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
545
static void CloseDecoder( vlc_object_t *p_this )
Gildas Bazin's avatar
 
Gildas Bazin committed
546
{
Gildas Bazin's avatar
 
Gildas Bazin committed
547
    decoder_t *p_dec = (decoder_t *)p_this;
Gildas Bazin's avatar
 
Gildas Bazin committed
548
    decoder_sys_t *p_sys = p_dec->p_sys;
Gildas Bazin's avatar
 
Gildas Bazin committed
549

550 551 552 553
    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
554
    free( p_sys );
Gildas Bazin's avatar
 
Gildas Bazin committed
555 556 557 558 559 560
}

/*****************************************************************************
 * theora_CopyPicture: copy a picture from theora internal buffers to a
 *                     picture_t structure.
 *****************************************************************************/
561
static void theora_CopyPicture( picture_t *p_pic,
562
                                th_ycbcr_buffer ycbcr )
Gildas Bazin's avatar
 
Gildas Bazin committed
563
{
564
    int i_plane, i_planes, i_line, i_dst_stride, i_src_stride;
Sam Hocevar's avatar
Sam Hocevar committed
565
    uint8_t *p_dst, *p_src;
566 567 568 569 570 571 572 573 574
    /* 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
575

576 577 578 579 580 581 582 583 584 585 586 587 588
       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
589 590
    {
        p_dst = p_pic->p[i_plane].p_pixels;
591
        p_src = ycbcr[i_plane].data;
Gildas Bazin's avatar
 
Gildas Bazin committed
592
        i_dst_stride  = p_pic->p[i_plane].i_pitch;
593 594 595 596
        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
597
        {
Rafaël Carré's avatar
Rafaël Carré committed
598
            memcpy( p_dst, p_src, ycbcr[i_plane].width );
Gildas Bazin's avatar
 
Gildas Bazin committed
599 600 601 602 603
            p_src += i_src_stride;
            p_dst += i_dst_stride;
        }
    }
}
Gildas Bazin's avatar
 
Gildas Bazin committed
604

605
#ifdef ENABLE_SOUT
Gildas Bazin's avatar
 
Gildas Bazin committed
606 607 608 609 610 611 612 613
/*****************************************************************************
 * encoder_sys_t : theora encoder descriptor
 *****************************************************************************/
struct encoder_sys_t
{
    /*
     * Input properties
     */
614
    bool b_headers;
Gildas Bazin's avatar
 
Gildas Bazin committed
615 616 617 618

    /*
     * Theora properties
     */
619 620 621
    th_info      ti;                     /* theora bitstream settings */
    th_comment   tc;                     /* theora comment header */
    th_enc_ctx   *tcx;                   /* theora context */
622
    int i_width, i_height;
Gildas Bazin's avatar
 
Gildas Bazin committed
623 624 625 626 627 628 629 630
};

/*****************************************************************************
 * OpenEncoder: probe the encoder and return score
 *****************************************************************************/
static int OpenEncoder( vlc_object_t *p_this )
{
    encoder_t *p_enc = (encoder_t *)p_this;
631
    encoder_sys_t *p_sys;
Laurent Aimar's avatar
Laurent Aimar committed
632
    int i_quality;
633 634 635 636 637
    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
638

639
    if( p_enc->fmt_out.i_codec != VLC_CODEC_THEORA &&
640
        !p_enc->b_force )
Gildas Bazin's avatar
 
Gildas Bazin committed
641 642 643 644 645
    {
        return VLC_EGENERIC;
    }

    /* Allocate the memory needed to store the decoder's structure */
646
    if( ( p_sys = malloc(sizeof(encoder_sys_t)) ) == NULL )
647
        return VLC_ENOMEM;
Gildas Bazin's avatar
 
Gildas Bazin committed
648 649 650
    p_enc->p_sys = p_sys;

    p_enc->pf_encode_video = Encode;
651 652
    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
653

654
    config_ChainParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
655

656
    i_quality = var_GetInteger( p_enc, ENC_CFG_PREFIX "quality" );
657 658 659
    if( i_quality > 10 ) i_quality = 10;
    if( i_quality < 0 ) i_quality = 0;

660
    th_info_init( &p_sys->ti );
Gildas Bazin's avatar
 
Gildas Bazin committed
661

662 663
    p_sys->ti.frame_width = p_enc->fmt_in.video.i_visible_width;
    p_sys->ti.frame_height = p_enc->fmt_in.video.i_visible_height;
664

665
    if( p_sys->ti.frame_width % 16 || p_sys->ti.frame_height % 16 )
666 667 668
    {
        /* Pictures from the transcoder should always have a pitch
         * which is a multiple of 16 */
669 670
        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;
671 672

        msg_Dbg( p_enc, "padding video from %dx%d to %dx%d",
673
                 p_enc->fmt_in.video.i_visible_width, p_enc->fmt_in.video.i_visible_height,
674
                 p_sys->ti.frame_width, p_sys->ti.frame_height );
675 676
    }

677 678
    p_sys->ti.pic_width = p_enc->fmt_in.video.i_visible_width;
    p_sys->ti.pic_height = p_enc->fmt_in.video.i_visible_height;
679 680
    p_sys->ti.pic_x = 0 /*frame_x_offset*/;
    p_sys->ti.pic_y = 0 /*frame_y_offset*/;
681

682 683
    p_sys->i_width = p_sys->ti.frame_width;
    p_sys->i_height = p_sys->ti.frame_height;
684

685 686 687 688 689 690 691 692 693 694 695
    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
696

697
    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
698
    {
699
        unsigned i_dst_num, i_dst_den;
700 701 702
        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 );
703 704
        p_sys->ti.aspect_numerator = i_dst_num;
        p_sys->ti.aspect_denominator = i_dst_den;
Gildas Bazin's avatar
 
Gildas Bazin committed
705 706 707 708 709 710 711
    }
    else
    {
        p_sys->ti.aspect_numerator = 4;
        p_sys->ti.aspect_denominator = 3;
    }

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

715 716 717 718 719 720

    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
721 722 723 724 725
    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
726
    p_sys->ti.keyframe_data_target_bitrate = p_enc->fmt_out.i_bitrate * 1.5;
Gildas Bazin's avatar
 
Gildas Bazin committed
727 728 729
    p_sys->ti.keyframe_auto_threshold = 80;
    p_sys->ti.keyframe_mindistance = 8;
    p_sys->ti.noise_sensitivity = 1;
730
    */
Gildas Bazin's avatar
 
Gildas Bazin committed
731

732 733 734
    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
735

736 737 738 739
    /* 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) );
740

741 742 743
    /* 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) );
744

745 746 747 748
    /* 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
749 750 751 752 753 754
        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
755
    }
756
    return VLC_SUCCESS;
Gildas Bazin's avatar
 
Gildas Bazin committed
757 758 759 760 761 762 763 764 765 766 767 768
}

/****************************************************************************
 * 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;
769
    th_ycbcr_buffer ycbcr;
770 771
    int i;

772
    if( !p_pict ) return NULL;
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 818 819 820 821 822 823 824
    /* 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
825 826 827 828

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

829 830 831 832
    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
833

834 835 836 837
    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
838

839 840 841 842
    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
843

844
    if( th_encode_ycbcr_in( p_sys->tcx, ycbcr ) < 0 )
Gildas Bazin's avatar
 
Gildas Bazin committed
845 846 847 848
    {
        msg_Warn( p_enc, "failed encoding a frame" );
        return NULL;
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
849

850
    th_encode_packetout( p_sys->tcx, 0, &oggpacket );
Gildas Bazin's avatar
 
Gildas Bazin committed
851 852

    /* Ogg packet to block */
853
    p_block = block_Alloc( oggpacket.bytes );
Gildas Bazin's avatar
 
Gildas Bazin committed
854
    memcpy( p_block->p_buffer, oggpacket.packet, oggpacket.bytes );
855
    p_block->i_dts = p_block->i_pts = p_pict->date;
Gildas Bazin's avatar
 
Gildas Bazin committed
856

857
    if( th_packet_iskeyframe( &oggpacket ) )
ogg.k.ogg.k's avatar
ogg.k.ogg.k committed
858 859 860 861
    {
        p_block->i_flags |= BLOCK_FLAG_TYPE_I;
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
862 863 864 865 866 867 868 869 870 871 872
    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;

873 874 875 876
    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
877 878
    free( p_sys );
}
879
#endif