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
#include <vlc_common.h>
32
#include <vlc_plugin.h>
Clément Stenac's avatar
Clément Stenac committed
33 34 35
#include <vlc_codec.h>
#include <vlc_vout.h>
#include <vlc_sout.h>
Clément Stenac's avatar
Clément Stenac committed
36
#include <vlc_input.h>
Gildas Bazin's avatar
 
Gildas Bazin committed
37 38 39 40 41
#include <ogg/ogg.h>

#include <theora/theora.h>

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

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

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

61 62 63
    /*
     * Decoding properties
     */
64
    bool b_decoded_first_keyframe;
65

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

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

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

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

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

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

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

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

#   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
123
                 ENC_QUALITY_LONGTEXT, false )
124
vlc_module_end ()
Gildas Bazin's avatar
 
Gildas Bazin committed
125

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

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

Gildas Bazin's avatar
 
Gildas Bazin committed
138
    if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','h','e','o') )
Gildas Bazin's avatar
 
Gildas Bazin committed
139 140 141 142
    {
        return VLC_EGENERIC;
    }

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

Gildas Bazin's avatar
 
Gildas Bazin committed
148
    p_sys->i_pts = 0;
149
    p_sys->b_decoded_first_keyframe = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166

    /* Set output properties */
    p_dec->fmt_out.i_cat = VIDEO_ES;
    p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','0');

    /* 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
167 168
    return VLC_SUCCESS;
}
Gildas Bazin's avatar
 
Gildas Bazin committed
169 170 171 172 173 174 175

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
176 177
    if( i_ret == VLC_SUCCESS )
    {
178
        p_dec->p_sys->b_packetizer = true;
Gildas Bazin's avatar
 
Gildas Bazin committed
179 180
        p_dec->fmt_out.i_codec = VLC_FOURCC( 't', 'h', 'e', 'o' );
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
181 182 183 184 185

    return i_ret;
}

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

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

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

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

208 209
    /* Check for headers */
    if( p_sys->i_headers == 0 && p_dec->fmt_in.i_extra )
Gildas Bazin's avatar
 
Gildas Bazin committed
210
    {
211 212 213 214 215 216 217 218 219 220 221
        /* 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;

        p_dec->fmt_in.p_extra =
            realloc( p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra +
                     oggpacket.bytes + 2 );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
222
        p_extra = ((uint8_t *)p_dec->fmt_in.p_extra) + p_dec->fmt_in.i_extra;
223 224 225 226 227 228 229 230 231 232
        *(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
233

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

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

249 250 251 252 253 254 255 256 257
/*****************************************************************************
 * 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
258

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

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
    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
278 279
    }

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

286
    /* Set output properties */
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
    switch( p_sys->ti.pixelformat )
    {
      case OC_PF_420:
        p_dec->fmt_out.i_codec = VLC_FOURCC( 'I','4','2','0' );
        break;
      case OC_PF_422:
        p_dec->fmt_out.i_codec = VLC_FOURCC( 'I','4','2','2' );
        break;
      case OC_PF_444:
        p_dec->fmt_out.i_codec = VLC_FOURCC( 'I','4','4','4' );
        break;
      case OC_PF_RSVD:
      default:
        msg_Err( p_dec, "unknown chroma in theora sample" );
        break;
    }
303 304
    p_dec->fmt_out.video.i_width = p_sys->ti.width;
    p_dec->fmt_out.video.i_height = p_sys->ti.height;
305 306
    if( p_sys->ti.frame_width && p_sys->ti.frame_height )
    {
307 308
        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;
309 310 311 312 313
        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;
        }
314
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
315

316 317 318
    if( p_sys->ti.aspect_denominator && p_sys->ti.aspect_numerator )
    {
        p_dec->fmt_out.video.i_aspect = ((int64_t)VOUT_ASPECT_FACTOR) *
319 320
            ( 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
321
    }
322 323 324 325 326 327
    else
    {
        p_dec->fmt_out.video.i_aspect = VOUT_ASPECT_FACTOR *
            p_sys->ti.frame_width / p_sys->ti.frame_height;
    }

328 329 330 331 332 333
    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;
    }

334 335 336 337 338 339
    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
340

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
    /* 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;
    }

356 357 358 359 360 361 362 363
    /* 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
364
    {
365 366 367
        msg_Err( p_dec, "header data corrupted");
        return VLC_EGENERIC;
    }
Sam Hocevar's avatar
Sam Hocevar committed
368

369 370 371 372 373 374 375 376
    /* 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
377

378 379 380 381 382 383 384 385 386 387 388
    /* 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
389 390
    }

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
    /* 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;
        p_dec->fmt_out.p_extra =
            realloc( p_dec->fmt_out.p_extra, p_dec->fmt_out.i_extra );
        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
415
}
Gildas Bazin's avatar
 
Gildas Bazin committed
416

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

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

441 442
    *pp_block = NULL; /* To avoid being fed the same packet again */

Gildas Bazin's avatar
 
Gildas Bazin committed
443 444
    if( p_sys->b_packetizer )
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
445 446 447 448 449 450 451 452 453
        /* 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
454 455 456
    }
    else
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
457 458 459 460
        if( p_sys->i_headers >= 3 )
            p_buf = DecodePacket( p_dec, p_oggpacket );
        else
            p_buf = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
461

462
        if( p_block ) block_Release( p_block );
Gildas Bazin's avatar
 
Gildas Bazin committed
463
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
464 465

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

Gildas Bazin's avatar
 
Gildas Bazin committed
469
    return p_buf;
Gildas Bazin's avatar
 
Gildas Bazin committed
470 471 472
}

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

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

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

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

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

Gildas Bazin's avatar
 
Gildas Bazin committed
502
    theora_CopyPicture( p_dec, p_pic, &yuv );
Gildas Bazin's avatar
 
Gildas Bazin committed
503

Gildas Bazin's avatar
 
Gildas Bazin committed
504
    p_pic->date = p_sys->i_pts;
Gildas Bazin's avatar
 
Gildas Bazin committed
505

Gildas Bazin's avatar
 
Gildas Bazin committed
506
    return p_pic;
Gildas Bazin's avatar
 
Gildas Bazin committed
507 508 509
}

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

Gildas Bazin's avatar
 
Gildas Bazin committed
517
    while ( i < p_dec->p_sys->tc.comments )
Gildas Bazin's avatar
 
Gildas Bazin committed
518
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
519 520 521 522 523 524 525 526 527
        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++;
528 529 530 531 532

            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
533 534 535 536 537 538 539
        }
        free( psz_comment );
        i++;
    }
}

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

Gildas Bazin's avatar
 
Gildas Bazin committed
547 548
    theora_info_clear( &p_sys->ti );
    theora_comment_clear( &p_sys->tc );
Gildas Bazin's avatar
 
Gildas Bazin committed
549

Gildas Bazin's avatar
 
Gildas Bazin committed
550
    free( p_sys );
Gildas Bazin's avatar
 
Gildas Bazin committed
551 552 553 554 555 556
}

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

    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
567 568
        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
569

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

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

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

597
    int i_width, i_height;
Gildas Bazin's avatar
 
Gildas Bazin committed
598 599 600 601 602 603 604 605 606
};

/*****************************************************************************
 * OpenEncoder: probe the encoder and return score
 *****************************************************************************/
static int OpenEncoder( vlc_object_t *p_this )
{
    encoder_t *p_enc = (encoder_t *)p_this;
    encoder_sys_t *p_sys = p_enc->p_sys;
607
    ogg_packet header;
608
    uint8_t *p_extra;
609
    vlc_value_t val;
610
    int i_quality, i;
Gildas Bazin's avatar
 
Gildas Bazin committed
611

612 613
    if( p_enc->fmt_out.i_codec != VLC_FOURCC('t','h','e','o') &&
        !p_enc->b_force )
Gildas Bazin's avatar
 
Gildas Bazin committed
614 615 616 617 618 619
    {
        return VLC_EGENERIC;
    }

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

    p_enc->pf_encode_video = Encode;
Gildas Bazin's avatar
 
Gildas Bazin committed
624
    p_enc->fmt_in.i_codec = VLC_FOURCC('I','4','2','0');
625
    p_enc->fmt_out.i_codec = VLC_FOURCC('t','h','e','o');
Gildas Bazin's avatar
 
Gildas Bazin committed
626

627
    config_ChainParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
628 629 630 631 632 633

    var_Get( p_enc, ENC_CFG_PREFIX "quality", &val );
    i_quality = val.i_int;
    if( i_quality > 10 ) i_quality = 10;
    if( i_quality < 0 ) i_quality = 0;

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

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

    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
651 652
    p_sys->ti.frame_width = p_enc->fmt_in.video.i_width;
    p_sys->ti.frame_height = p_enc->fmt_in.video.i_height;
653
    p_sys->ti.offset_x = 0 /*frame_x_offset*/;
654
    p_sys->ti.offset_y = 0 /*frame_y_offset*/;
655

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

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

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

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

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

    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
696
    p_sys->ti.keyframe_data_target_bitrate = p_enc->fmt_out.i_bitrate * 1.5;
Gildas Bazin's avatar
 
Gildas Bazin committed
697 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 );
    theora_info_clear( &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 713 714 715 716 717 718 719 720 721 722 723
        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 );

        p_enc->fmt_out.p_extra =
            realloc( p_enc->fmt_out.p_extra,
                     p_enc->fmt_out.i_extra + header.bytes );
        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 823 824 825 826 827 828 829 830 831 832 833 834

    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 );
835
    theora_comment_clear( &p_sys->tc );
Gildas Bazin's avatar
 
Gildas Bazin committed
836 837 838

    free( p_sys );
}