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 void *ProcessPacket ( decoder_t *, ogg_packet *, block_t ** );
72 static picture_t *DecodePacket( decoder_t *, ogg_packet * );
74 static void ParseTheoraComments( decoder_t * );
75 static void theora_CopyPicture( decoder_t *, picture_t *, yuv_buffer * );
77 static int OpenEncoder( vlc_object_t *p_this );
78 static void CloseEncoder( vlc_object_t *p_this );
79 static block_t *Headers( encoder_t *p_enc );
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 if( p_sys->i_headers == 0 )
200 /* Take care of the initial Theora header */
202 oggpacket.b_o_s = 1; /* yes this actually is a b_o_s packet :) */
203 if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
205 msg_Err( p_dec, "This bitstream does not contain Theora "
207 block_Release( p_block );
212 /* Set output properties */
213 p_dec->fmt_out.video.i_width = p_sys->ti.width;
214 p_dec->fmt_out.video.i_height = p_sys->ti.height;
216 if( p_sys->ti.aspect_denominator && p_sys->ti.aspect_numerator )
217 p_dec->fmt_out.video.i_aspect = ((int64_t)VOUT_ASPECT_FACTOR) *
218 p_sys->ti.aspect_numerator / p_sys->ti.aspect_denominator;
220 p_dec->fmt_out.video.i_aspect = VOUT_ASPECT_FACTOR *
221 p_sys->ti.frame_width / p_sys->ti.frame_height;
223 msg_Dbg( p_dec, "%dx%d %.02f fps video, frame content "
224 "is %dx%d with offset (%d,%d).",
225 p_sys->ti.width, p_sys->ti.height,
226 (double)p_sys->ti.fps_numerator/p_sys->ti.fps_denominator,
227 p_sys->ti.frame_width, p_sys->ti.frame_height,
228 p_sys->ti.offset_x, p_sys->ti.offset_y );
230 return ProcessPacket( p_dec, &oggpacket, pp_block );
233 if( p_sys->i_headers == 1 )
235 /* The next packet in order is the comments header */
236 if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
238 msg_Err( p_dec, "2nd Theora header is corrupted." );
243 ParseTheoraComments( p_dec );
245 return ProcessPacket( p_dec, &oggpacket, pp_block );
248 if( p_sys->i_headers == 2 )
250 /* The next packet in order is the codebooks header
251 We need to watch out that this packet is not missing as a
252 missing or corrupted header is fatal. */
253 if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
255 msg_Err( p_dec, "3rd Theora header is corrupted." );
260 if( !p_sys->b_packetizer )
262 /* We have all the headers, initialize decoder */
263 theora_decode_init( &p_sys->td, &p_sys->ti );
266 return ProcessPacket( p_dec, &oggpacket, pp_block );
269 return ProcessPacket( p_dec, &oggpacket, pp_block );
272 /*****************************************************************************
273 * ProcessPacket: processes a theora packet.
274 *****************************************************************************/
275 static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
278 decoder_sys_t *p_sys = p_dec->p_sys;
279 block_t *p_block = *pp_block;
282 /* Date management */
283 if( p_block->i_pts > 0 && p_block->i_pts != p_sys->i_pts )
285 p_sys->i_pts = p_block->i_pts;
288 if( p_sys->b_packetizer )
290 /* Date management */
291 p_block->i_dts = p_block->i_pts = p_sys->i_pts;
293 if( p_sys->i_headers >= 3 )
294 p_block->i_length = p_sys->i_pts - p_block->i_pts;
296 p_block->i_length = 0;
302 if( p_sys->i_headers >= 3 )
303 p_buf = DecodePacket( p_dec, p_oggpacket );
309 block_Release( p_block );
314 /* Date management */
315 p_sys->i_pts += ( I64C(1000000) * p_sys->ti.fps_denominator /
316 p_sys->ti.fps_numerator ); /* 1 frame per packet */
321 /*****************************************************************************
322 * DecodePacket: decodes a Theora packet.
323 *****************************************************************************/
324 static picture_t *DecodePacket( decoder_t *p_dec, ogg_packet *p_oggpacket )
326 decoder_sys_t *p_sys = p_dec->p_sys;
330 theora_decode_packetin( &p_sys->td, p_oggpacket );
333 theora_decode_YUVout( &p_sys->td, &yuv );
335 /* Get a new picture */
336 p_pic = p_dec->pf_vout_buffer_new( p_dec );
337 if( !p_pic ) return NULL;
339 theora_CopyPicture( p_dec, p_pic, &yuv );
341 p_pic->date = p_sys->i_pts;
346 /*****************************************************************************
347 * ParseTheoraComments: FIXME should be done in demuxer
348 *****************************************************************************/
349 static void ParseTheoraComments( decoder_t *p_dec )
351 input_thread_t *p_input = (input_thread_t *)p_dec->p_parent;
354 char *psz_name, *psz_value, *psz_comment;
355 while ( i < p_dec->p_sys->tc.comments )
357 psz_comment = strdup( p_dec->p_sys->tc.user_comments[i] );
360 msg_Warn( p_dec, "out of memory" );
363 psz_name = psz_comment;
364 psz_value = strchr( psz_comment, '=' );
369 input_Control( p_input, INPUT_ADD_INFO, _("Theora comment"),
370 psz_name, psz_value );
377 /*****************************************************************************
378 * CloseDecoder: theora decoder destruction
379 *****************************************************************************/
380 static void CloseDecoder( vlc_object_t *p_this )
382 decoder_t *p_dec = (decoder_t *)p_this;
383 decoder_sys_t *p_sys = p_dec->p_sys;
385 theora_info_clear( &p_sys->ti );
386 theora_comment_clear( &p_sys->tc );
391 /*****************************************************************************
392 * theora_CopyPicture: copy a picture from theora internal buffers to a
393 * picture_t structure.
394 *****************************************************************************/
395 static void theora_CopyPicture( decoder_t *p_dec, picture_t *p_pic,
398 int i_plane, i_line, i_width, i_dst_stride, i_src_stride;
399 int i_src_xoffset, i_src_yoffset;
400 uint8_t *p_dst, *p_src;
402 for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
404 p_dst = p_pic->p[i_plane].p_pixels;
405 p_src = i_plane ? (i_plane - 1 ? yuv->v : yuv->u ) : yuv->y;
406 i_width = p_pic->p[i_plane].i_visible_pitch;
407 i_dst_stride = p_pic->p[i_plane].i_pitch;
408 i_src_stride = i_plane ? yuv->uv_stride : yuv->y_stride;
409 i_src_xoffset = p_dec->p_sys->ti.offset_x;
410 i_src_yoffset = p_dec->p_sys->ti.offset_y;
417 p_src += (i_src_yoffset * i_src_stride + i_src_yoffset);
419 for( i_line = 0; i_line < p_pic->p[i_plane].i_lines; i_line++ )
421 p_dec->p_vlc->pf_memcpy( p_dst, p_src, i_width );
422 p_src += i_src_stride;
423 p_dst += i_dst_stride;
428 /*****************************************************************************
429 * encoder_sys_t : theora encoder descriptor
430 *****************************************************************************/
436 vlc_bool_t b_headers;
441 theora_info ti; /* theora bitstream settings */
442 theora_comment tc; /* theora comment header */
443 theora_state td; /* theora bitstream user comments */
451 /*****************************************************************************
452 * OpenEncoder: probe the encoder and return score
453 *****************************************************************************/
454 static int OpenEncoder( vlc_object_t *p_this )
456 encoder_t *p_enc = (encoder_t *)p_this;
457 encoder_sys_t *p_sys = p_enc->p_sys;
461 if( p_enc->fmt_out.i_codec != VLC_FOURCC('t','h','e','o') &&
467 if( p_enc->fmt_in.video.i_width % 16 ||
468 p_enc->fmt_in.video.i_height % 16 )
470 msg_Err( p_enc, "Theora video encoding requires dimensions which are "
471 "multiples of 16. Which is not the case here (%dx%d).",
472 p_enc->fmt_in.video.i_width, p_enc->fmt_in.video.i_height );
476 /* Allocate the memory needed to store the decoder's structure */
477 if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
479 msg_Err( p_enc, "out of memory" );
482 p_enc->p_sys = p_sys;
484 p_enc->pf_header = Headers;
485 p_enc->pf_encode_video = Encode;
486 p_enc->fmt_in.i_codec = VLC_FOURCC('I','4','2','0');
487 p_enc->fmt_out.i_codec = VLC_FOURCC('t','h','e','o');
489 sout_ParseCfg( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
491 var_Get( p_enc, ENC_CFG_PREFIX "quality", &val );
492 i_quality = val.i_int;
493 if( i_quality > 10 ) i_quality = 10;
494 if( i_quality < 0 ) i_quality = 0;
496 theora_info_init( &p_sys->ti );
498 p_sys->ti.width = p_enc->fmt_in.video.i_width;
499 p_sys->ti.height = p_enc->fmt_in.video.i_height;
500 p_sys->ti.frame_width = p_enc->fmt_in.video.i_width;
501 p_sys->ti.frame_height = p_enc->fmt_in.video.i_height;
502 p_sys->ti.offset_x = 0 /*frame_x_offset*/;
503 p_sys->ti.offset_y = 0/*frame_y_offset*/;
505 if( !p_enc->fmt_in.video.i_frame_rate ||
506 !p_enc->fmt_in.video.i_frame_rate_base )
508 p_sys->ti.fps_numerator = 25;
509 p_sys->ti.fps_denominator = 1;
513 p_sys->ti.fps_numerator = p_enc->fmt_in.video.i_frame_rate;
514 p_sys->ti.fps_denominator = p_enc->fmt_in.video.i_frame_rate_base;
517 if( p_enc->fmt_in.video.i_aspect )
519 p_sys->ti.aspect_numerator = p_enc->fmt_in.video.i_aspect;
520 p_sys->ti.aspect_denominator = VOUT_ASPECT_FACTOR;
524 p_sys->ti.aspect_numerator = 4;
525 p_sys->ti.aspect_denominator = 3;
528 p_sys->ti.target_bitrate = p_enc->fmt_out.i_bitrate;
529 p_sys->ti.quality = ((float)i_quality) * 6.3;
531 p_sys->ti.dropframes_p = 0;
532 p_sys->ti.quick_p = 1;
533 p_sys->ti.keyframe_auto_p = 1;
534 p_sys->ti.keyframe_frequency = 64;
535 p_sys->ti.keyframe_frequency_force = 64;
536 p_sys->ti.keyframe_data_target_bitrate = p_enc->fmt_out.i_bitrate * 1.5;
537 p_sys->ti.keyframe_auto_threshold = 80;
538 p_sys->ti.keyframe_mindistance = 8;
539 p_sys->ti.noise_sensitivity = 1;
541 theora_encode_init( &p_sys->td, &p_sys->ti );
542 theora_info_clear( &p_sys->ti );
543 theora_comment_init( &p_sys->tc );
545 p_sys->b_headers = VLC_FALSE;
550 /****************************************************************************
551 * Encode: the whole thing
552 ****************************************************************************
553 * This function spits out ogg packets.
554 ****************************************************************************/
555 static block_t *Headers( encoder_t *p_enc )
557 encoder_sys_t *p_sys = p_enc->p_sys;
558 block_t *p_chain = NULL;
560 /* Create theora headers */
561 if( !p_sys->b_headers )
563 ogg_packet oggpackets;
567 /* Ogg packet to block */
568 for( i = 0; i < 3; i++ )
573 theora_encode_header( &p_sys->td, &oggpackets );
576 theora_encode_comment( &p_sys->tc, &oggpackets );
579 theora_encode_tables( &p_sys->td, &oggpackets );
583 p_block = block_New( p_enc, oggpackets.bytes );
584 memcpy( p_block->p_buffer, oggpackets.packet, oggpackets.bytes );
585 p_block->i_dts = p_block->i_pts = p_block->i_length = 0;
586 block_ChainAppend( &p_chain, p_block );
589 p_sys->b_headers = VLC_TRUE;
595 /****************************************************************************
596 * Encode: the whole thing
597 ****************************************************************************
598 * This function spits out ogg packets.
599 ****************************************************************************/
600 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict )
602 encoder_sys_t *p_sys = p_enc->p_sys;
603 ogg_packet oggpacket;
607 /* Theora is a one-frame-in, one-frame-out system. Submit a frame
608 * for compression and pull out the packet. */
610 yuv.y_width = p_pict->p[0].i_visible_pitch;
611 yuv.y_height = p_pict->p[0].i_lines;
612 yuv.y_stride = p_pict->p[0].i_pitch;
614 yuv.uv_width = p_pict->p[1].i_visible_pitch;
615 yuv.uv_height = p_pict->p[1].i_lines;
616 yuv.uv_stride = p_pict->p[1].i_pitch;
618 yuv.y = p_pict->p[0].p_pixels;
619 yuv.u = p_pict->p[1].p_pixels;
620 yuv.v = p_pict->p[2].p_pixels;
622 if( theora_encode_YUVin( &p_sys->td, &yuv ) < 0 )
624 msg_Warn( p_enc, "failed encoding a frame" );
628 theora_encode_packetout( &p_sys->td, 0, &oggpacket );
630 /* Ogg packet to block */
631 p_block = block_New( p_enc, oggpacket.bytes );
632 memcpy( p_block->p_buffer, oggpacket.packet, oggpacket.bytes );
633 p_block->i_dts = p_block->i_pts = p_pict->date;
638 /*****************************************************************************
639 * CloseEncoder: theora encoder destruction
640 *****************************************************************************/
641 static void CloseEncoder( vlc_object_t *p_this )
643 encoder_t *p_enc = (encoder_t *)p_this;
644 encoder_sys_t *p_sys = p_enc->p_sys;
646 theora_info_clear( &p_sys->ti );
647 theora_comment_clear( &p_sys->tc );