theora.c 27.4 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-2001 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 32
#include <assert.h>

33
#include <vlc_common.h>
34
#include <vlc_plugin.h>
Clément Stenac's avatar
Clément Stenac committed
35 36
#include <vlc_codec.h>
#include <vlc_sout.h>
Clément Stenac's avatar
Clément Stenac committed
37
#include <vlc_input.h>
38
#include <vlc_memory.h>
Gildas Bazin's avatar
 
Gildas Bazin committed
39 40 41 42 43
#include <ogg/ogg.h>

#include <theora/theora.h>

/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
44
 * decoder_sys_t : theora decoder descriptor
Gildas Bazin's avatar
 
Gildas Bazin committed
45
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
46
struct decoder_sys_t
Gildas Bazin's avatar
 
Gildas Bazin committed
47
{
Gildas Bazin's avatar
 
Gildas Bazin committed
48
    /* Module mode */
49
    bool b_packetizer;
Gildas Bazin's avatar
 
Gildas Bazin committed
50

Gildas Bazin's avatar
 
Gildas Bazin committed
51
    /*
Gildas Bazin's avatar
 
Gildas Bazin committed
52
     * Input properties
Gildas Bazin's avatar
 
Gildas Bazin committed
53
     */
Gildas Bazin's avatar
 
Gildas Bazin committed
54
    int i_headers;
Gildas Bazin's avatar
 
Gildas Bazin committed
55 56 57 58 59

    /*
     * Theora properties
     */
    theora_info      ti;                        /* theora bitstream settings */
Gildas Bazin's avatar
 
Gildas Bazin committed
60
    theora_comment   tc;                            /* theora comment header */
Gildas Bazin's avatar
 
Gildas Bazin committed
61 62
    theora_state     td;                   /* theora bitstream user comments */

63 64 65
    /*
     * Decoding properties
     */
66
    bool b_decoded_first_keyframe;
67

Gildas Bazin's avatar
 
Gildas Bazin committed
68 69 70 71 72
    /*
     * Common properties
     */
    mtime_t i_pts;
};
Gildas Bazin's avatar
 
Gildas Bazin committed
73 74 75 76

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
77 78 79
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
80

Gildas Bazin's avatar
 
Gildas Bazin committed
81
static void *DecodeBlock  ( decoder_t *, block_t ** );
82
static int  ProcessHeaders( decoder_t * );
Gildas Bazin's avatar
 
Gildas Bazin committed
83
static void *ProcessPacket ( decoder_t *, ogg_packet *, block_t ** );
Gildas Bazin's avatar
 
Gildas Bazin committed
84

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

Gildas Bazin's avatar
 
Gildas Bazin committed
87
static void ParseTheoraComments( decoder_t * );
88
static void theora_CopyPicture( picture_t *, yuv_buffer * );
89

Gildas Bazin's avatar
 
Gildas Bazin committed
90 91 92 93
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
94 95 96
/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
97 98
#define ENC_QUALITY_TEXT N_("Encoding quality")
#define ENC_QUALITY_LONGTEXT N_( \
99
  "Enforce a quality between 1 (low) and 10 (high), instead " \
100 101
  "of specifying a particular bitrate. This will produce a VBR stream." )

102 103 104 105 106 107 108 109 110 111 112 113 114
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 )
115
    add_shortcut( "theora" )
116 117 118 119 120

    add_submodule ()
    set_description( N_("Theora video encoder") )
    set_capability( "encoder", 150 )
    set_callbacks( OpenEncoder, CloseEncoder )
121
    add_shortcut( "theora" )
122 123 124

#   define ENC_CFG_PREFIX "sout-theora-"
    add_integer( ENC_CFG_PREFIX "quality", 2, NULL, ENC_QUALITY_TEXT,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
125
                 ENC_QUALITY_LONGTEXT, false )
126
vlc_module_end ()
Gildas Bazin's avatar
 
Gildas Bazin committed
127

128
static const char *const ppsz_enc_options[] = {
129 130 131
    "quality", NULL
};

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

140
    if( p_dec->fmt_in.i_codec != VLC_CODEC_THEORA )
Gildas Bazin's avatar
 
Gildas Bazin committed
141 142 143 144
    {
        return VLC_EGENERIC;
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
145
    /* Allocate the memory needed to store the decoder's structure */
146
    if( ( p_dec->p_sys = p_sys = malloc(sizeof(*p_sys)) ) == NULL )
147
        return VLC_ENOMEM;
148
    p_dec->p_sys->b_packetizer = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
149

Gildas Bazin's avatar
 
Gildas Bazin committed
150
    p_sys->i_pts = 0;
151
    p_sys->b_decoded_first_keyframe = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
152 153 154

    /* Set output properties */
    p_dec->fmt_out.i_cat = VIDEO_ES;
155
    p_dec->fmt_out.i_codec = VLC_CODEC_I420;
Gildas Bazin's avatar
 
Gildas Bazin committed
156 157 158 159 160 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 */
    theora_comment_init( &p_sys->tc );
    theora_info_init( &p_sys->ti );

    p_sys->i_headers = 0;

Gildas Bazin's avatar
 
Gildas Bazin committed
169 170
    return VLC_SUCCESS;
}
Gildas Bazin's avatar
 
Gildas Bazin committed
171 172 173 174 175 176 177

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
178 179
    if( i_ret == VLC_SUCCESS )
    {
180
        p_dec->p_sys->b_packetizer = true;
181
        p_dec->fmt_out.i_codec = VLC_CODEC_THEORA;
Gildas Bazin's avatar
 
Gildas Bazin committed
182
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
183 184 185 186 187

    return i_ret;
}

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

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

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

Gildas Bazin's avatar
 
Gildas Bazin committed
202 203 204 205 206 207 208
    /* 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
209

210 211
    /* Check for headers */
    if( p_sys->i_headers == 0 && p_dec->fmt_in.i_extra )
Gildas Bazin's avatar
 
Gildas Bazin committed
212
    {
213 214 215 216 217 218 219 220
        /* Headers already available as extra data */
        p_sys->i_headers = 3;
    }
    else if( oggpacket.bytes && p_sys->i_headers < 3 )
    {
        /* Backup headers as extra data */
        uint8_t *p_extra;

221 222 223
        p_dec->fmt_in.p_extra = realloc_or_free( p_dec->fmt_in.p_extra,
                                p_dec->fmt_in.i_extra + oggpacket.bytes + 2 );
        assert( p_dec->fmt_in.p_extra );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
224
        p_extra = ((uint8_t *)p_dec->fmt_in.p_extra) + p_dec->fmt_in.i_extra;
225 226 227 228 229 230 231 232 233 234
        *(p_extra++) = oggpacket.bytes >> 8;
        *(p_extra++) = oggpacket.bytes & 0xFF;

        memcpy( p_extra, oggpacket.packet, oggpacket.bytes );
        p_dec->fmt_in.i_extra += oggpacket.bytes + 2;

        block_Release( *pp_block );
        p_sys->i_headers++;
        return NULL;
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
235

236 237 238
    if( p_sys->i_headers == 3 )
    {
        if( ProcessHeaders( p_dec ) != VLC_SUCCESS )
Gildas Bazin's avatar
 
Gildas Bazin committed
239
        {
240 241 242
            p_sys->i_headers = 0;
            p_dec->fmt_in.i_extra = 0;
            block_Release( *pp_block );
Gildas Bazin's avatar
 
Gildas Bazin committed
243
            return NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
244
        }
245 246
        else p_sys->i_headers++;
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
247

248 249
    return ProcessPacket( p_dec, &oggpacket, pp_block );
}
Sam Hocevar's avatar
Sam Hocevar committed
250

251 252 253 254 255 256 257 258 259
/*****************************************************************************
 * ProcessHeaders: process Theora headers.
 *****************************************************************************/
static int ProcessHeaders( decoder_t *p_dec )
{
    decoder_sys_t *p_sys = p_dec->p_sys;
    ogg_packet oggpacket;
    uint8_t *p_extra;
    int i_extra;
Gildas Bazin's avatar
 
Gildas Bazin committed
260

261
    if( !p_dec->fmt_in.i_extra ) return VLC_EGENERIC;
Gildas Bazin's avatar
 
Gildas Bazin committed
262

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
    oggpacket.granulepos = -1;
    oggpacket.b_o_s = 1; /* yes this actually is a b_o_s packet :) */
    oggpacket.e_o_s = 0;
    oggpacket.packetno = 0;
    p_extra = p_dec->fmt_in.p_extra;
    i_extra = p_dec->fmt_in.i_extra;

    /* Take care of the initial Vorbis header */
    oggpacket.bytes = *(p_extra++) << 8;
    oggpacket.bytes |= (*(p_extra++) & 0xFF);
    oggpacket.packet = p_extra;
    p_extra += oggpacket.bytes;
    i_extra -= (oggpacket.bytes + 2);
    if( i_extra < 0 )
    {
        msg_Err( p_dec, "header data corrupted");
        return VLC_EGENERIC;
Gildas Bazin's avatar
 
Gildas Bazin committed
280 281
    }

282
    if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
Gildas Bazin's avatar
 
Gildas Bazin committed
283
    {
284
        msg_Err( p_dec, "this bitstream does not contain Theora video data" );
285 286
        return VLC_EGENERIC;
    }
Sam Hocevar's avatar
Sam Hocevar committed
287

288
    /* Set output properties */
289 290 291
    switch( p_sys->ti.pixelformat )
    {
      case OC_PF_420:
292
        p_dec->fmt_out.i_codec = VLC_CODEC_I420;
293 294
        break;
      case OC_PF_422:
295
        p_dec->fmt_out.i_codec = VLC_CODEC_I422;
296 297
        break;
      case OC_PF_444:
298
        p_dec->fmt_out.i_codec = VLC_CODEC_I444;
299 300 301 302 303 304
        break;
      case OC_PF_RSVD:
      default:
        msg_Err( p_dec, "unknown chroma in theora sample" );
        break;
    }
305 306
    p_dec->fmt_out.video.i_width = p_sys->ti.width;
    p_dec->fmt_out.video.i_height = p_sys->ti.height;
307 308
    if( p_sys->ti.frame_width && p_sys->ti.frame_height )
    {
309 310
        p_dec->fmt_out.video.i_visible_width = p_sys->ti.frame_width;
        p_dec->fmt_out.video.i_visible_height = p_sys->ti.frame_height;
311 312 313 314 315
        if( p_sys->ti.offset_x || p_sys->ti.offset_y )
        {
            p_dec->fmt_out.video.i_x_offset = p_sys->ti.offset_x;
            p_dec->fmt_out.video.i_y_offset = p_sys->ti.offset_y;
        }
316
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
317

318 319 320
    if( p_sys->ti.aspect_denominator && p_sys->ti.aspect_numerator )
    {
        p_dec->fmt_out.video.i_aspect = ((int64_t)VOUT_ASPECT_FACTOR) *
321 322
            ( p_sys->ti.aspect_numerator * p_dec->fmt_out.video.i_width ) /
            ( p_sys->ti.aspect_denominator * p_dec->fmt_out.video.i_height );
Gildas Bazin's avatar
 
Gildas Bazin committed
323
    }
324 325 326 327 328 329
    else
    {
        p_dec->fmt_out.video.i_aspect = VOUT_ASPECT_FACTOR *
            p_sys->ti.frame_width / p_sys->ti.frame_height;
    }

330 331 332 333 334 335
    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;
    }

336 337 338 339 340 341
    msg_Dbg( p_dec, "%dx%d %.02f fps video, frame content "
             "is %dx%d with offset (%d,%d)",
             p_sys->ti.width, p_sys->ti.height,
             (double)p_sys->ti.fps_numerator/p_sys->ti.fps_denominator,
             p_sys->ti.frame_width, p_sys->ti.frame_height,
             p_sys->ti.offset_x, p_sys->ti.offset_y );
Gildas Bazin's avatar
 
Gildas Bazin committed
342

343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
    /* Sanity check that seems necessary for some corrupted files */
    if( p_sys->ti.width < p_sys->ti.frame_width ||
        p_sys->ti.height < p_sys->ti.frame_height )
    {
        msg_Warn( p_dec, "trying to correct invalid theora header "
                  "(frame size (%dx%d) is smaller than frame content (%d,%d))",
                  p_sys->ti.width, p_sys->ti.height,
                  p_sys->ti.frame_width, p_sys->ti.frame_height );

        if( p_sys->ti.width < p_sys->ti.frame_width )
            p_sys->ti.width = p_sys->ti.frame_width;
        if( p_sys->ti.height < p_sys->ti.frame_height )
            p_sys->ti.height = p_sys->ti.frame_height;
    }

358 359 360 361 362 363 364 365
    /* The next packet in order is the comments header */
    oggpacket.b_o_s = 0;
    oggpacket.bytes = *(p_extra++) << 8;
    oggpacket.bytes |= (*(p_extra++) & 0xFF);
    oggpacket.packet = p_extra;
    p_extra += oggpacket.bytes;
    i_extra -= (oggpacket.bytes + 2);
    if( i_extra < 0 )
Gildas Bazin's avatar
 
Gildas Bazin committed
366
    {
367 368 369
        msg_Err( p_dec, "header data corrupted");
        return VLC_EGENERIC;
    }
Sam Hocevar's avatar
Sam Hocevar committed
370

371 372 373 374 375 376 377 378
    /* The next packet in order is the comments header */
    if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
    {
        msg_Err( p_dec, "2nd Theora header is corrupted" );
        return VLC_EGENERIC;
    }

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

380 381 382 383 384 385 386 387 388 389 390
    /* 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. */
    oggpacket.bytes = *(p_extra++) << 8;
    oggpacket.bytes |= (*(p_extra++) & 0xFF);
    oggpacket.packet = p_extra;
    i_extra -= (oggpacket.bytes + 2);
    if( i_extra < 0 )
    {
        msg_Err( p_dec, "header data corrupted");
        return VLC_EGENERIC;
Gildas Bazin's avatar
 
Gildas Bazin committed
391 392
    }

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
    /* 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 */
    if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
    {
        msg_Err( p_dec, "3rd Theora header is corrupted" );
        return VLC_EGENERIC;
    }

    if( !p_sys->b_packetizer )
    {
        /* We have all the headers, initialize decoder */
        theora_decode_init( &p_sys->td, &p_sys->ti );
    }
    else
    {
        p_dec->fmt_out.i_extra = p_dec->fmt_in.i_extra;
410 411 412
        p_dec->fmt_out.p_extra = realloc_or_free( p_dec->fmt_out.p_extra,
                                                  p_dec->fmt_out.i_extra );
        assert( p_dec->fmt_out.p_extra );
413 414 415 416 417
        memcpy( p_dec->fmt_out.p_extra,
                p_dec->fmt_in.p_extra, p_dec->fmt_out.i_extra );
    }

    return VLC_SUCCESS;
Gildas Bazin's avatar
 
Gildas Bazin committed
418
}
Gildas Bazin's avatar
 
Gildas Bazin committed
419

Gildas Bazin's avatar
 
Gildas Bazin committed
420
/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
421
 * ProcessPacket: processes a theora packet.
Gildas Bazin's avatar
 
Gildas Bazin committed
422
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
423 424
static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
                            block_t **pp_block )
Gildas Bazin's avatar
 
Gildas Bazin committed
425 426
{
    decoder_sys_t *p_sys = p_dec->p_sys;
Gildas Bazin's avatar
 
Gildas Bazin committed
427 428
    block_t *p_block = *pp_block;
    void *p_buf;
Gildas Bazin's avatar
 
Gildas Bazin committed
429

Laurent Aimar's avatar
Laurent Aimar committed
430
    if( ( p_block->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) ) != 0 )
431 432 433 434 435 436 437
    {
        /* 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
438
    /* Date management */
Gildas Bazin's avatar
 
Gildas Bazin committed
439
    if( p_block->i_pts > 0 && p_block->i_pts != p_sys->i_pts )
Gildas Bazin's avatar
 
Gildas Bazin committed
440
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
441
        p_sys->i_pts = p_block->i_pts;
Gildas Bazin's avatar
 
Gildas Bazin committed
442 443
    }

444 445
    *pp_block = NULL; /* To avoid being fed the same packet again */

Gildas Bazin's avatar
 
Gildas Bazin committed
446 447
    if( p_sys->b_packetizer )
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
448 449 450 451 452 453 454 455 456
        /* Date management */
        p_block->i_dts = p_block->i_pts = p_sys->i_pts;

        if( p_sys->i_headers >= 3 )
            p_block->i_length = p_sys->i_pts - p_block->i_pts;
        else
            p_block->i_length = 0;

        p_buf = p_block;
Gildas Bazin's avatar
 
Gildas Bazin committed
457 458 459
    }
    else
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
460 461 462 463
        if( p_sys->i_headers >= 3 )
            p_buf = DecodePacket( p_dec, p_oggpacket );
        else
            p_buf = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
464

465
        if( p_block ) block_Release( p_block );
Gildas Bazin's avatar
 
Gildas Bazin committed
466
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
467 468

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

Gildas Bazin's avatar
 
Gildas Bazin committed
472
    return p_buf;
Gildas Bazin's avatar
 
Gildas Bazin committed
473 474 475
}

/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
476
 * DecodePacket: decodes a Theora packet.
Gildas Bazin's avatar
 
Gildas Bazin committed
477
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
478
static picture_t *DecodePacket( decoder_t *p_dec, ogg_packet *p_oggpacket )
Gildas Bazin's avatar
 
Gildas Bazin committed
479
{
Gildas Bazin's avatar
 
Gildas Bazin committed
480
    decoder_sys_t *p_sys = p_dec->p_sys;
Gildas Bazin's avatar
 
Gildas Bazin committed
481 482
    picture_t *p_pic;
    yuv_buffer yuv;
Gildas Bazin's avatar
 
Gildas Bazin committed
483

Gildas Bazin's avatar
 
Gildas Bazin committed
484
    theora_decode_packetin( &p_sys->td, p_oggpacket );
Gildas Bazin's avatar
 
Gildas Bazin committed
485

486 487 488
    /* Check for keyframe */
    if( !(p_oggpacket->packet[0] & 0x80) /* data packet */ &&
        !(p_oggpacket->packet[0] & 0x40) /* intra frame */ )
489
        p_sys->b_decoded_first_keyframe = true;
490 491 492 493 494 495 496 497 498 499

    /* 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). */
    if( p_sys->b_decoded_first_keyframe )
        theora_decode_YUVout( &p_sys->td, &yuv );
    else
        return NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
500

Gildas Bazin's avatar
 
Gildas Bazin committed
501
    /* Get a new picture */
502
    p_pic = decoder_NewPicture( p_dec );
Gildas Bazin's avatar
 
Gildas Bazin committed
503
    if( !p_pic ) return NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
504

505
    theora_CopyPicture( p_pic, &yuv );
Gildas Bazin's avatar
 
Gildas Bazin committed
506

Gildas Bazin's avatar
 
Gildas Bazin committed
507
    p_pic->date = p_sys->i_pts;
Gildas Bazin's avatar
 
Gildas Bazin committed
508

Gildas Bazin's avatar
 
Gildas Bazin committed
509
    return p_pic;
Gildas Bazin's avatar
 
Gildas Bazin committed
510 511 512
}

/*****************************************************************************
513
 * ParseTheoraComments:
Gildas Bazin's avatar
 
Gildas Bazin committed
514
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
515
static void ParseTheoraComments( decoder_t *p_dec )
Gildas Bazin's avatar
 
Gildas Bazin committed
516
{
Gildas Bazin's avatar
 
Gildas Bazin committed
517
    char *psz_name, *psz_value, *psz_comment;
518 519
    int i = 0;

Gildas Bazin's avatar
 
Gildas Bazin committed
520
    while ( i < p_dec->p_sys->tc.comments )
Gildas Bazin's avatar
 
Gildas Bazin committed
521
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
522 523 524 525 526 527 528 529 530
        psz_comment = strdup( p_dec->p_sys->tc.user_comments[i] );
        if( !psz_comment )
            break;
        psz_name = psz_comment;
        psz_value = strchr( psz_comment, '=' );
        if( psz_value )
        {
            *psz_value = '\0';
            psz_value++;
531 532 533 534 535

            if( !p_dec->p_description )
                p_dec->p_description = vlc_meta_New();
            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

Gildas Bazin's avatar
 
Gildas Bazin committed
550 551
    theora_info_clear( &p_sys->ti );
    theora_comment_clear( &p_sys->tc );
Gildas Bazin's avatar
 
Gildas Bazin committed
552

Gildas Bazin's avatar
 
Gildas Bazin committed
553
    free( p_sys );
Gildas Bazin's avatar
 
Gildas Bazin committed
554 555 556 557 558 559
}

/*****************************************************************************
 * theora_CopyPicture: copy a picture from theora internal buffers to a
 *                     picture_t structure.
 *****************************************************************************/
560
static void theora_CopyPicture( picture_t *p_pic,
Gildas Bazin's avatar
 
Gildas Bazin committed
561 562
                                yuv_buffer *yuv )
{
563
    int i_plane, i_line, i_dst_stride, i_src_stride;
Sam Hocevar's avatar
Sam Hocevar committed
564
    uint8_t *p_dst, *p_src;
Gildas Bazin's avatar
 
Gildas Bazin committed
565 566 567 568 569

    for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
    {
        p_dst = p_pic->p[i_plane].p_pixels;
        p_src = i_plane ? (i_plane - 1 ? yuv->v : yuv->u ) : yuv->y;
Gildas Bazin's avatar
 
Gildas Bazin committed
570 571
        i_dst_stride  = p_pic->p[i_plane].i_pitch;
        i_src_stride  = i_plane ? yuv->uv_stride : yuv->y_stride;
Gildas Bazin's avatar
 
Gildas Bazin committed
572

573
        for( i_line = 0; i_line < p_pic->p[i_plane].i_lines; i_line++ )
Gildas Bazin's avatar
 
Gildas Bazin committed
574
        {
575
            vlc_memcpy( p_dst, p_src,
576
                        i_plane ? yuv->uv_width : yuv->y_width );
Gildas Bazin's avatar
 
Gildas Bazin committed
577 578 579 580 581
            p_src += i_src_stride;
            p_dst += i_dst_stride;
        }
    }
}
Gildas Bazin's avatar
 
Gildas Bazin committed
582 583 584 585 586 587 588 589 590

/*****************************************************************************
 * encoder_sys_t : theora encoder descriptor
 *****************************************************************************/
struct encoder_sys_t
{
    /*
     * Input properties
     */
591
    bool b_headers;
Gildas Bazin's avatar
 
Gildas Bazin committed
592 593 594 595 596 597 598 599

    /*
     * Theora properties
     */
    theora_info      ti;                        /* theora bitstream settings */
    theora_comment   tc;                            /* theora comment header */
    theora_state     td;                   /* theora bitstream user comments */

600
    int i_width, i_height;
Gildas Bazin's avatar
 
Gildas Bazin committed
601 602 603 604 605 606 607 608
};

/*****************************************************************************
 * OpenEncoder: probe the encoder and return score
 *****************************************************************************/
static int OpenEncoder( vlc_object_t *p_this )
{
    encoder_t *p_enc = (encoder_t *)p_this;
Rémi Duraffort's avatar
Rémi Duraffort committed
609
    encoder_sys_t *p_sys;
610
    ogg_packet header;
611 612
    uint8_t *p_extra;
    int i_quality, i;
Gildas Bazin's avatar
 
Gildas Bazin committed
613

614
    if( p_enc->fmt_out.i_codec != VLC_CODEC_THEORA &&
615
        !p_enc->b_force )
Gildas Bazin's avatar
 
Gildas Bazin committed
616 617 618 619 620
    {
        return VLC_EGENERIC;
    }

    /* Allocate the memory needed to store the decoder's structure */
Rémi Duraffort's avatar
Rémi Duraffort committed
621
    if( ( p_sys = malloc(sizeof(encoder_sys_t)) ) == NULL )
622
        return VLC_ENOMEM;
Gildas Bazin's avatar
 
Gildas Bazin committed
623 624 625
    p_enc->p_sys = p_sys;

    p_enc->pf_encode_video = Encode;
626 627
    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
628

629
    config_ChainParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
630

631
    i_quality = var_GetInteger( p_enc, ENC_CFG_PREFIX "quality" );
632 633 634
    if( i_quality > 10 ) i_quality = 10;
    if( i_quality < 0 ) i_quality = 0;

Gildas Bazin's avatar
 
Gildas Bazin committed
635 636
    theora_info_init( &p_sys->ti );

Gildas Bazin's avatar
 
Gildas Bazin committed
637 638
    p_sys->ti.width = p_enc->fmt_in.video.i_width;
    p_sys->ti.height = p_enc->fmt_in.video.i_height;
639 640 641 642 643 644 645 646 647 648 649 650 651

    if( p_sys->ti.width % 16 || p_sys->ti.height % 16 )
    {
        /* Pictures from the transcoder should always have a pitch
         * which is a multiple of 16 */
        p_sys->ti.width = (p_sys->ti.width + 15) >> 4 << 4;
        p_sys->ti.height = (p_sys->ti.height + 15) >> 4 << 4;

        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,
                 p_sys->ti.width, p_sys->ti.height );
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
652 653
    p_sys->ti.frame_width = p_enc->fmt_in.video.i_width;
    p_sys->ti.frame_height = p_enc->fmt_in.video.i_height;
654
    p_sys->ti.offset_x = 0 /*frame_x_offset*/;
655
    p_sys->ti.offset_y = 0 /*frame_y_offset*/;
656

657 658 659
    p_sys->i_width = p_sys->ti.width;
    p_sys->i_height = p_sys->ti.height;

660 661 662 663 664 665 666 667 668 669 670
    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
671 672 673

    if( p_enc->fmt_in.video.i_aspect )
    {
674 675
        uint64_t i_num, i_den;
        unsigned i_dst_num, i_dst_den;
676 677 678

        i_num = p_enc->fmt_in.video.i_aspect * (int64_t)p_sys->ti.height;
        i_den = VOUT_ASPECT_FACTOR * p_sys->ti.width;
679
        vlc_ureduce( &i_dst_num, &i_dst_den, i_num, i_den, 0 );
680 681
        p_sys->ti.aspect_numerator = i_dst_num;
        p_sys->ti.aspect_denominator = i_dst_den;
Gildas Bazin's avatar
 
Gildas Bazin committed
682 683 684 685 686 687 688
    }
    else
    {
        p_sys->ti.aspect_numerator = 4;
        p_sys->ti.aspect_denominator = 3;
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
689
    p_sys->ti.target_bitrate = p_enc->fmt_out.i_bitrate;
690
    p_sys->ti.quality = ((float)i_quality) * 6.3;
Gildas Bazin's avatar
 
Gildas Bazin committed
691 692 693 694 695 696

    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
697
    p_sys->ti.keyframe_data_target_bitrate = p_enc->fmt_out.i_bitrate * 1.5;
Gildas Bazin's avatar
 
Gildas Bazin committed
698 699 700 701 702
    p_sys->ti.keyframe_auto_threshold = 80;
    p_sys->ti.keyframe_mindistance = 8;
    p_sys->ti.noise_sensitivity = 1;

    theora_encode_init( &p_sys->td, &p_sys->ti );
Gildas Bazin's avatar
 
Gildas Bazin committed
703
    theora_comment_init( &p_sys->tc );
Gildas Bazin's avatar
 
Gildas Bazin committed
704

705
    /* Create and store headers */
706
    p_enc->fmt_out.i_extra = 3 * 2;
707
    for( i = 0; i < 3; i++ )
Gildas Bazin's avatar
 
Gildas Bazin committed
708
    {
709 710 711 712
        if( i == 0 ) theora_encode_header( &p_sys->td, &header );
        else if( i == 1 ) theora_encode_comment( &p_sys->tc, &header );
        else if( i == 2 ) theora_encode_tables( &p_sys->td, &header );

713 714 715
        p_enc->fmt_out.p_extra = realloc_or_free( p_enc->fmt_out.p_extra,
                                      p_enc->fmt_out.i_extra + header.bytes );
        assert( p_enc->fmt_out.p_extra );
716 717 718 719 720 721 722 723
        p_extra = p_enc->fmt_out.p_extra;
        p_extra += p_enc->fmt_out.i_extra + (i-3)*2;
        p_enc->fmt_out.i_extra += header.bytes;

        *(p_extra++) = header.bytes >> 8;
        *(p_extra++) = header.bytes & 0xFF;

        memcpy( p_extra, header.packet, header.bytes );
Gildas Bazin's avatar
 
Gildas Bazin committed
724 725
    }

726
    return VLC_SUCCESS;
Gildas Bazin's avatar
 
Gildas Bazin committed
727 728 729 730 731 732 733 734 735 736 737 738 739
}

/****************************************************************************
 * 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;
    yuv_buffer yuv;
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 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
    int i;

    /* 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
794 795 796 797

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

798 799
    yuv.y_width  = p_sys->i_width;
    yuv.y_height = p_sys->i_height;
Gildas Bazin's avatar
 
Gildas Bazin committed
800 801
    yuv.y_stride = p_pict->p[0].i_pitch;

802 803
    yuv.uv_width  = p_sys->i_width / 2;
    yuv.uv_height = p_sys->i_height / 2;
Gildas Bazin's avatar
 
Gildas Bazin committed
804 805 806 807 808 809
    yuv.uv_stride = p_pict->p[1].i_pitch;

    yuv.y = p_pict->p[0].p_pixels;
    yuv.u = p_pict->p[1].p_pixels;
    yuv.v = p_pict->p[2].p_pixels;

Gildas Bazin's avatar
 
Gildas Bazin committed
810 811 812 813 814
    if( theora_encode_YUVin( &p_sys->td, &yuv ) < 0 )
    {
        msg_Warn( p_enc, "failed encoding a frame" );
        return NULL;
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
815 816 817 818 819

    theora_encode_packetout( &p_sys->td, 0, &oggpacket );

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

ogg.k.ogg.k's avatar
ogg.k.ogg.k committed
823 824 825 826 827
    if( theora_packet_iskeyframe( &oggpacket ) )
    {
        p_block->i_flags |= BLOCK_FLAG_TYPE_I;
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
828 829 830 831 832 833 834 835 836 837 838 839
    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;

    theora_info_clear( &p_sys->ti );
840
    theora_comment_clear( &p_sys->tc );
Gildas Bazin's avatar
 
Gildas Bazin committed
841 842 843

    free( p_sys );
}