1 /*****************************************************************************
2 * theora.c: theora decoder module making use of libtheora.
3 *****************************************************************************
4 * Copyright (C) 1999-2001 VideoLAN
7 * Authors: Gildas Bazin <gbazin@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
28 #include <vlc/decoder.h>
29 #include <vlc/input.h>
34 #include <theora/theora.h>
36 /*****************************************************************************
37 * decoder_sys_t : theora decoder descriptor
38 *****************************************************************************/
42 vlc_bool_t b_packetizer;
52 theora_info ti; /* theora bitstream settings */
53 theora_comment tc; /* theora comment header */
54 theora_state td; /* theora bitstream user comments */
62 /*****************************************************************************
64 *****************************************************************************/
65 static int OpenDecoder ( vlc_object_t * );
66 static int OpenPacketizer( vlc_object_t * );
67 static void CloseDecoder ( vlc_object_t * );
69 static void *DecodeBlock ( decoder_t *, block_t ** );
70 static int ProcessHeaders( decoder_t * );
71 static void *ProcessPacket ( decoder_t *, ogg_packet *, block_t ** );
73 static picture_t *DecodePacket( decoder_t *, ogg_packet * );
75 static void ParseTheoraComments( decoder_t * );
76 static void theora_CopyPicture( decoder_t *, picture_t *, yuv_buffer * );
78 static int OpenEncoder( vlc_object_t *p_this );
79 static void CloseEncoder( vlc_object_t *p_this );
80 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict );
82 /*****************************************************************************
84 *****************************************************************************/
85 #define ENC_QUALITY_TEXT N_("Encoding quality")
86 #define ENC_QUALITY_LONGTEXT N_( \
87 "Allows you to specify a quality between 1 (low) and 10 (high), instead " \
88 "of specifying a particular bitrate. This will produce a VBR stream." )
91 set_description( _("Theora video decoder") );
92 set_capability( "decoder", 100 );
93 set_callbacks( OpenDecoder, CloseDecoder );
94 add_shortcut( "theora" );
97 set_description( _("Theora video packetizer") );
98 set_capability( "packetizer", 100 );
99 set_callbacks( OpenPacketizer, CloseDecoder );
100 add_shortcut( "theora" );
103 set_description( _("Theora video encoder") );
104 set_capability( "encoder", 100 );
105 set_callbacks( OpenEncoder, CloseEncoder );
106 add_shortcut( "theora" );
108 # define ENC_CFG_PREFIX "sout-theora-"
109 add_integer( ENC_CFG_PREFIX "quality", 2, NULL, ENC_QUALITY_TEXT,
110 ENC_QUALITY_LONGTEXT, VLC_FALSE );
113 static const char *ppsz_enc_options[] = {
117 /*****************************************************************************
118 * OpenDecoder: probe the decoder and return score
119 *****************************************************************************/
120 static int OpenDecoder( vlc_object_t *p_this )
122 decoder_t *p_dec = (decoder_t*)p_this;
123 decoder_sys_t *p_sys;
125 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','h','e','o') )
130 /* Allocate the memory needed to store the decoder's structure */
131 if( ( p_dec->p_sys = p_sys =
132 (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
134 msg_Err( p_dec, "out of memory" );
137 p_dec->p_sys->b_packetizer = VLC_FALSE;
141 /* Set output properties */
142 p_dec->fmt_out.i_cat = VIDEO_ES;
143 p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','0');
146 p_dec->pf_decode_video = (picture_t *(*)(decoder_t *, block_t **))
148 p_dec->pf_packetize = (block_t *(*)(decoder_t *, block_t **))
151 /* Init supporting Theora structures needed in header parsing */
152 theora_comment_init( &p_sys->tc );
153 theora_info_init( &p_sys->ti );
155 p_sys->i_headers = 0;
160 static int OpenPacketizer( vlc_object_t *p_this )
162 decoder_t *p_dec = (decoder_t*)p_this;
164 int i_ret = OpenDecoder( p_this );
166 if( i_ret == VLC_SUCCESS )
168 p_dec->p_sys->b_packetizer = VLC_TRUE;
169 p_dec->fmt_out.i_codec = VLC_FOURCC( 't', 'h', 'e', 'o' );
175 /****************************************************************************
176 * DecodeBlock: the whole thing
177 ****************************************************************************
178 * This function must be fed with ogg packets.
179 ****************************************************************************/
180 static void *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
182 decoder_sys_t *p_sys = p_dec->p_sys;
184 ogg_packet oggpacket;
186 if( !pp_block || !*pp_block ) return NULL;
190 /* Block to Ogg packet */
191 oggpacket.packet = p_block->p_buffer;
192 oggpacket.bytes = p_block->i_buffer;
193 oggpacket.granulepos = p_block->i_dts;
196 oggpacket.packetno = 0;
198 /* Check for headers */
199 if( p_sys->i_headers == 0 && p_dec->fmt_in.i_extra )
201 /* Headers already available as extra data */
202 p_sys->i_headers = 3;
204 else if( oggpacket.bytes && p_sys->i_headers < 3 )
206 /* Backup headers as extra data */
209 p_dec->fmt_in.p_extra =
210 realloc( p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra +
211 oggpacket.bytes + 2 );
212 p_extra = p_dec->fmt_in.p_extra + p_dec->fmt_in.i_extra;
213 *(p_extra++) = oggpacket.bytes >> 8;
214 *(p_extra++) = oggpacket.bytes & 0xFF;
216 memcpy( p_extra, oggpacket.packet, oggpacket.bytes );
217 p_dec->fmt_in.i_extra += oggpacket.bytes + 2;
219 block_Release( *pp_block );
224 if( p_sys->i_headers == 3 )
226 if( ProcessHeaders( p_dec ) != VLC_SUCCESS )
228 p_sys->i_headers = 0;
229 p_dec->fmt_in.i_extra = 0;
230 block_Release( *pp_block );
233 else p_sys->i_headers++;
236 return ProcessPacket( p_dec, &oggpacket, pp_block );
239 /*****************************************************************************
240 * ProcessHeaders: process Theora headers.
241 *****************************************************************************/
242 static int ProcessHeaders( decoder_t *p_dec )
244 decoder_sys_t *p_sys = p_dec->p_sys;
245 ogg_packet oggpacket;
249 if( !p_dec->fmt_in.i_extra ) return VLC_EGENERIC;
251 oggpacket.granulepos = -1;
252 oggpacket.b_o_s = 1; /* yes this actually is a b_o_s packet :) */
254 oggpacket.packetno = 0;
255 p_extra = p_dec->fmt_in.p_extra;
256 i_extra = p_dec->fmt_in.i_extra;
258 /* Take care of the initial Vorbis header */
259 oggpacket.bytes = *(p_extra++) << 8;
260 oggpacket.bytes |= (*(p_extra++) & 0xFF);
261 oggpacket.packet = p_extra;
262 p_extra += oggpacket.bytes;
263 i_extra -= (oggpacket.bytes + 2);
266 msg_Err( p_dec, "header data corrupted");
270 if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
272 msg_Err( p_dec, "This bitstream does not contain Theora video data" );
276 /* Set output properties */
277 p_dec->fmt_out.video.i_width = p_sys->ti.width;
278 p_dec->fmt_out.video.i_height = p_sys->ti.height;
280 if( p_sys->ti.aspect_denominator && p_sys->ti.aspect_numerator )
282 p_dec->fmt_out.video.i_aspect = ((int64_t)VOUT_ASPECT_FACTOR) *
283 ( p_sys->ti.aspect_numerator * p_sys->ti.width ) /
284 ( p_sys->ti.aspect_denominator * p_sys->ti.height );
288 p_dec->fmt_out.video.i_aspect = VOUT_ASPECT_FACTOR *
289 p_sys->ti.frame_width / p_sys->ti.frame_height;
292 msg_Dbg( p_dec, "%dx%d %.02f fps video, frame content "
293 "is %dx%d with offset (%d,%d)",
294 p_sys->ti.width, p_sys->ti.height,
295 (double)p_sys->ti.fps_numerator/p_sys->ti.fps_denominator,
296 p_sys->ti.frame_width, p_sys->ti.frame_height,
297 p_sys->ti.offset_x, p_sys->ti.offset_y );
299 /* The next packet in order is the comments header */
301 oggpacket.bytes = *(p_extra++) << 8;
302 oggpacket.bytes |= (*(p_extra++) & 0xFF);
303 oggpacket.packet = p_extra;
304 p_extra += oggpacket.bytes;
305 i_extra -= (oggpacket.bytes + 2);
308 msg_Err( p_dec, "header data corrupted");
312 /* The next packet in order is the comments header */
313 if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
315 msg_Err( p_dec, "2nd Theora header is corrupted" );
319 ParseTheoraComments( p_dec );
321 /* The next packet in order is the codebooks header
322 * We need to watch out that this packet is not missing as a
323 * missing or corrupted header is fatal. */
324 oggpacket.bytes = *(p_extra++) << 8;
325 oggpacket.bytes |= (*(p_extra++) & 0xFF);
326 oggpacket.packet = p_extra;
327 i_extra -= (oggpacket.bytes + 2);
330 msg_Err( p_dec, "header data corrupted");
334 /* The next packet in order is the codebooks header
335 * We need to watch out that this packet is not missing as a
336 * missing or corrupted header is fatal */
337 if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
339 msg_Err( p_dec, "3rd Theora header is corrupted" );
343 if( !p_sys->b_packetizer )
345 /* We have all the headers, initialize decoder */
346 theora_decode_init( &p_sys->td, &p_sys->ti );
350 p_dec->fmt_out.i_extra = p_dec->fmt_in.i_extra;
351 p_dec->fmt_out.p_extra =
352 realloc( p_dec->fmt_out.p_extra, p_dec->fmt_out.i_extra );
353 memcpy( p_dec->fmt_out.p_extra,
354 p_dec->fmt_in.p_extra, p_dec->fmt_out.i_extra );
360 /*****************************************************************************
361 * ProcessPacket: processes a theora packet.
362 *****************************************************************************/
363 static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
366 decoder_sys_t *p_sys = p_dec->p_sys;
367 block_t *p_block = *pp_block;
370 /* Date management */
371 if( p_block->i_pts > 0 && p_block->i_pts != p_sys->i_pts )
373 p_sys->i_pts = p_block->i_pts;
376 *pp_block = NULL; /* To avoid being fed the same packet again */
378 if( p_sys->b_packetizer )
380 /* Date management */
381 p_block->i_dts = p_block->i_pts = p_sys->i_pts;
383 if( p_sys->i_headers >= 3 )
384 p_block->i_length = p_sys->i_pts - p_block->i_pts;
386 p_block->i_length = 0;
392 if( p_sys->i_headers >= 3 )
393 p_buf = DecodePacket( p_dec, p_oggpacket );
397 if( p_block ) block_Release( p_block );
400 /* Date management */
401 p_sys->i_pts += ( I64C(1000000) * p_sys->ti.fps_denominator /
402 p_sys->ti.fps_numerator ); /* 1 frame per packet */
407 /*****************************************************************************
408 * DecodePacket: decodes a Theora packet.
409 *****************************************************************************/
410 static picture_t *DecodePacket( decoder_t *p_dec, ogg_packet *p_oggpacket )
412 decoder_sys_t *p_sys = p_dec->p_sys;
416 theora_decode_packetin( &p_sys->td, p_oggpacket );
419 theora_decode_YUVout( &p_sys->td, &yuv );
421 /* Get a new picture */
422 p_pic = p_dec->pf_vout_buffer_new( p_dec );
423 if( !p_pic ) return NULL;
425 theora_CopyPicture( p_dec, p_pic, &yuv );
427 p_pic->date = p_sys->i_pts;
432 /*****************************************************************************
433 * ParseTheoraComments: FIXME should be done in demuxer
434 *****************************************************************************/
435 static void ParseTheoraComments( decoder_t *p_dec )
437 input_thread_t *p_input = (input_thread_t *)p_dec->p_parent;
438 char *psz_name, *psz_value, *psz_comment;
441 if( p_input->i_object_type != VLC_OBJECT_INPUT ) return;
443 while ( i < p_dec->p_sys->tc.comments )
445 psz_comment = strdup( p_dec->p_sys->tc.user_comments[i] );
448 msg_Warn( p_dec, "out of memory" );
451 psz_name = psz_comment;
452 psz_value = strchr( psz_comment, '=' );
457 input_Control( p_input, INPUT_ADD_INFO, _("Theora comment"),
458 psz_name, psz_value );
465 /*****************************************************************************
466 * CloseDecoder: theora decoder destruction
467 *****************************************************************************/
468 static void CloseDecoder( vlc_object_t *p_this )
470 decoder_t *p_dec = (decoder_t *)p_this;
471 decoder_sys_t *p_sys = p_dec->p_sys;
473 theora_info_clear( &p_sys->ti );
474 theora_comment_clear( &p_sys->tc );
479 /*****************************************************************************
480 * theora_CopyPicture: copy a picture from theora internal buffers to a
481 * picture_t structure.
482 *****************************************************************************/
483 static void theora_CopyPicture( decoder_t *p_dec, picture_t *p_pic,
486 int i_plane, i_line, i_width, i_dst_stride, i_src_stride;
487 int i_src_xoffset, i_src_yoffset;
488 uint8_t *p_dst, *p_src;
490 for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
492 p_dst = p_pic->p[i_plane].p_pixels;
493 p_src = i_plane ? (i_plane - 1 ? yuv->v : yuv->u ) : yuv->y;
494 i_width = p_pic->p[i_plane].i_visible_pitch;
495 i_dst_stride = p_pic->p[i_plane].i_pitch;
496 i_src_stride = i_plane ? yuv->uv_stride : yuv->y_stride;
497 i_src_xoffset = p_dec->p_sys->ti.offset_x;
498 i_src_yoffset = p_dec->p_sys->ti.offset_y;
505 p_src += (i_src_yoffset * i_src_stride + i_src_yoffset);
507 for( i_line = 0; i_line < p_pic->p[i_plane].i_lines; i_line++ )
509 p_dec->p_vlc->pf_memcpy( p_dst, p_src, i_width );
510 p_src += i_src_stride;
511 p_dst += i_dst_stride;
516 /*****************************************************************************
517 * encoder_sys_t : theora encoder descriptor
518 *****************************************************************************/
524 vlc_bool_t b_headers;
529 theora_info ti; /* theora bitstream settings */
530 theora_comment tc; /* theora comment header */
531 theora_state td; /* theora bitstream user comments */
539 /*****************************************************************************
540 * OpenEncoder: probe the encoder and return score
541 *****************************************************************************/
542 static int OpenEncoder( vlc_object_t *p_this )
544 encoder_t *p_enc = (encoder_t *)p_this;
545 encoder_sys_t *p_sys = p_enc->p_sys;
551 if( p_enc->fmt_out.i_codec != VLC_FOURCC('t','h','e','o') &&
557 if( p_enc->fmt_in.video.i_width % 16 ||
558 p_enc->fmt_in.video.i_height % 16 )
560 msg_Err( p_enc, "Theora video encoding requires dimensions which are "
561 "multiples of 16. Which is not the case here (%dx%d).",
562 p_enc->fmt_in.video.i_width, p_enc->fmt_in.video.i_height );
566 /* Allocate the memory needed to store the decoder's structure */
567 if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
569 msg_Err( p_enc, "out of memory" );
572 p_enc->p_sys = p_sys;
574 p_enc->pf_encode_video = Encode;
575 p_enc->fmt_in.i_codec = VLC_FOURCC('I','4','2','0');
576 p_enc->fmt_out.i_codec = VLC_FOURCC('t','h','e','o');
578 sout_CfgParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
580 var_Get( p_enc, ENC_CFG_PREFIX "quality", &val );
581 i_quality = val.i_int;
582 if( i_quality > 10 ) i_quality = 10;
583 if( i_quality < 0 ) i_quality = 0;
585 theora_info_init( &p_sys->ti );
587 p_sys->ti.width = p_enc->fmt_in.video.i_width;
588 p_sys->ti.height = p_enc->fmt_in.video.i_height;
589 p_sys->ti.frame_width = p_enc->fmt_in.video.i_width;
590 p_sys->ti.frame_height = p_enc->fmt_in.video.i_height;
591 p_sys->ti.offset_x = 0 /*frame_x_offset*/;
592 p_sys->ti.offset_y = 0/*frame_y_offset*/;
594 if( !p_enc->fmt_in.video.i_frame_rate ||
595 !p_enc->fmt_in.video.i_frame_rate_base )
597 p_sys->ti.fps_numerator = 25;
598 p_sys->ti.fps_denominator = 1;
602 p_sys->ti.fps_numerator = p_enc->fmt_in.video.i_frame_rate;
603 p_sys->ti.fps_denominator = p_enc->fmt_in.video.i_frame_rate_base;
606 if( p_enc->fmt_in.video.i_aspect )
608 p_sys->ti.aspect_numerator =
609 p_enc->fmt_in.video.i_aspect * p_sys->ti.height / p_sys->ti.width;
610 p_sys->ti.aspect_denominator = VOUT_ASPECT_FACTOR;
614 p_sys->ti.aspect_numerator = 4;
615 p_sys->ti.aspect_denominator = 3;
618 p_sys->ti.target_bitrate = p_enc->fmt_out.i_bitrate;
619 p_sys->ti.quality = ((float)i_quality) * 6.3;
621 p_sys->ti.dropframes_p = 0;
622 p_sys->ti.quick_p = 1;
623 p_sys->ti.keyframe_auto_p = 1;
624 p_sys->ti.keyframe_frequency = 64;
625 p_sys->ti.keyframe_frequency_force = 64;
626 p_sys->ti.keyframe_data_target_bitrate = p_enc->fmt_out.i_bitrate * 1.5;
627 p_sys->ti.keyframe_auto_threshold = 80;
628 p_sys->ti.keyframe_mindistance = 8;
629 p_sys->ti.noise_sensitivity = 1;
631 theora_encode_init( &p_sys->td, &p_sys->ti );
632 theora_info_clear( &p_sys->ti );
633 theora_comment_init( &p_sys->tc );
635 /* Create and store headers */
636 p_enc->fmt_out.i_extra = 3 * 2;
637 for( i = 0; i < 3; i++ )
639 if( i == 0 ) theora_encode_header( &p_sys->td, &header );
640 else if( i == 1 ) theora_encode_comment( &p_sys->tc, &header );
641 else if( i == 2 ) theora_encode_tables( &p_sys->td, &header );
643 p_enc->fmt_out.p_extra =
644 realloc( p_enc->fmt_out.p_extra,
645 p_enc->fmt_out.i_extra + header.bytes );
646 p_extra = p_enc->fmt_out.p_extra;
647 p_extra += p_enc->fmt_out.i_extra + (i-3)*2;
648 p_enc->fmt_out.i_extra += header.bytes;
650 *(p_extra++) = header.bytes >> 8;
651 *(p_extra++) = header.bytes & 0xFF;
653 memcpy( p_extra, header.packet, header.bytes );
659 /****************************************************************************
660 * Encode: the whole thing
661 ****************************************************************************
662 * This function spits out ogg packets.
663 ****************************************************************************/
664 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict )
666 encoder_sys_t *p_sys = p_enc->p_sys;
667 ogg_packet oggpacket;
671 /* Theora is a one-frame-in, one-frame-out system. Submit a frame
672 * for compression and pull out the packet. */
674 yuv.y_width = p_pict->p[0].i_visible_pitch;
675 yuv.y_height = p_pict->p[0].i_lines;
676 yuv.y_stride = p_pict->p[0].i_pitch;
678 yuv.uv_width = p_pict->p[1].i_visible_pitch;
679 yuv.uv_height = p_pict->p[1].i_lines;
680 yuv.uv_stride = p_pict->p[1].i_pitch;
682 yuv.y = p_pict->p[0].p_pixels;
683 yuv.u = p_pict->p[1].p_pixels;
684 yuv.v = p_pict->p[2].p_pixels;
686 if( theora_encode_YUVin( &p_sys->td, &yuv ) < 0 )
688 msg_Warn( p_enc, "failed encoding a frame" );
692 theora_encode_packetout( &p_sys->td, 0, &oggpacket );
694 /* Ogg packet to block */
695 p_block = block_New( p_enc, oggpacket.bytes );
696 memcpy( p_block->p_buffer, oggpacket.packet, oggpacket.bytes );
697 p_block->i_dts = p_block->i_pts = p_pict->date;
702 /*****************************************************************************
703 * CloseEncoder: theora encoder destruction
704 *****************************************************************************/
705 static void CloseEncoder( vlc_object_t *p_this )
707 encoder_t *p_enc = (encoder_t *)p_this;
708 encoder_sys_t *p_sys = p_enc->p_sys;
710 theora_info_clear( &p_sys->ti );
711 theora_comment_clear( &p_sys->tc );