1 /*****************************************************************************
2 * theora.c: theora decoder module making use of libtheora.
3 *****************************************************************************
4 * Copyright (C) 1999-2001 VideoLAN
5 * $Id: theora.c,v 1.15 2003/11/22 23:39:14 fenrir Exp $
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
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>
32 #include <theora/theora.h>
34 /*****************************************************************************
35 * decoder_sys_t : theora decoder descriptor
36 *****************************************************************************/
40 vlc_bool_t b_packetizer;
50 theora_info ti; /* theora bitstream settings */
51 theora_comment tc; /* theora comment header */
52 theora_state td; /* theora bitstream user comments */
60 /*****************************************************************************
62 *****************************************************************************/
63 static int OpenDecoder ( vlc_object_t * );
64 static int OpenPacketizer( vlc_object_t * );
65 static void CloseDecoder ( vlc_object_t * );
67 static void *DecodeBlock ( decoder_t *, block_t ** );
68 static void *ProcessPacket ( decoder_t *, ogg_packet *, block_t ** );
70 static picture_t *DecodePacket( decoder_t *, ogg_packet * );
72 static void ParseTheoraComments( decoder_t * );
73 static void theora_CopyPicture( decoder_t *, picture_t *, yuv_buffer * );
75 static int OpenEncoder( vlc_object_t *p_this );
76 static void CloseEncoder( vlc_object_t *p_this );
77 static block_t *Headers( encoder_t *p_enc );
78 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict );
80 /*****************************************************************************
82 *****************************************************************************/
84 set_description( _("Theora video decoder") );
85 set_capability( "decoder", 100 );
86 set_callbacks( OpenDecoder, CloseDecoder );
87 add_shortcut( "theora" );
90 set_description( _("Theora video packetizer") );
91 set_capability( "packetizer", 100 );
92 set_callbacks( OpenPacketizer, CloseDecoder );
93 add_shortcut( "theora" );
96 set_description( _("Theora video encoder") );
97 set_capability( "encoder", 100 );
98 set_callbacks( OpenEncoder, CloseEncoder );
99 add_shortcut( "theora" );
102 /*****************************************************************************
103 * OpenDecoder: probe the decoder and return score
104 *****************************************************************************/
105 static int OpenDecoder( vlc_object_t *p_this )
107 decoder_t *p_dec = (decoder_t*)p_this;
108 decoder_sys_t *p_sys;
110 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','h','e','o') )
115 /* Allocate the memory needed to store the decoder's structure */
116 if( ( p_dec->p_sys = p_sys =
117 (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
119 msg_Err( p_dec, "out of memory" );
122 p_dec->p_sys->b_packetizer = VLC_FALSE;
126 /* Set output properties */
127 p_dec->fmt_out.i_cat = VIDEO_ES;
128 p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','0');
131 p_dec->pf_decode_video = (picture_t *(*)(decoder_t *, block_t **))
133 p_dec->pf_packetize = (block_t *(*)(decoder_t *, block_t **))
136 /* Init supporting Theora structures needed in header parsing */
137 theora_comment_init( &p_sys->tc );
138 theora_info_init( &p_sys->ti );
140 p_sys->i_headers = 0;
145 static int OpenPacketizer( vlc_object_t *p_this )
147 decoder_t *p_dec = (decoder_t*)p_this;
149 int i_ret = OpenDecoder( p_this );
151 if( i_ret == VLC_SUCCESS )
153 p_dec->p_sys->b_packetizer = VLC_TRUE;
154 p_dec->fmt_out.i_codec = VLC_FOURCC( 't', 'h', 'e', 'o' );
160 /****************************************************************************
161 * DecodeBlock: the whole thing
162 ****************************************************************************
163 * This function must be fed with ogg packets.
164 ****************************************************************************/
165 static void *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
167 decoder_sys_t *p_sys = p_dec->p_sys;
169 ogg_packet oggpacket;
171 if( !pp_block || !*pp_block ) return NULL;
175 /* Block to Ogg packet */
176 oggpacket.packet = p_block->p_buffer;
177 oggpacket.bytes = p_block->i_buffer;
178 oggpacket.granulepos = p_block->i_dts;
181 oggpacket.packetno = 0;
183 if( p_sys->i_headers == 0 )
185 /* Take care of the initial Theora header */
187 oggpacket.b_o_s = 1; /* yes this actually is a b_o_s packet :) */
188 if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
190 msg_Err( p_dec, "This bitstream does not contain Theora "
192 block_Release( p_block );
197 /* Set output properties */
198 p_dec->fmt_out.video.i_width = p_sys->ti.width;
199 p_dec->fmt_out.video.i_height = p_sys->ti.height;
201 if( p_sys->ti.aspect_denominator )
202 p_dec->fmt_out.video.i_aspect = VOUT_ASPECT_FACTOR *
203 p_sys->ti.aspect_numerator / p_sys->ti.aspect_denominator;
205 p_dec->fmt_out.video.i_aspect = VOUT_ASPECT_FACTOR *
206 p_sys->ti.frame_width / p_sys->ti.frame_height;
208 msg_Dbg( p_dec, "%dx%d %.02f fps video, frame content "
209 "is %dx%d with offset (%d,%d)",
210 p_sys->ti.width, p_sys->ti.height,
211 (double)p_sys->ti.fps_numerator/p_sys->ti.fps_denominator,
212 p_sys->ti.frame_width, p_sys->ti.frame_height,
213 p_sys->ti.offset_x, p_sys->ti.offset_y );
215 return ProcessPacket( p_dec, &oggpacket, pp_block );
218 if( p_sys->i_headers == 1 )
220 /* The next packet in order is the comments header */
221 if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
223 msg_Err( p_dec, "2nd Theora header is corrupted" );
228 ParseTheoraComments( p_dec );
230 return ProcessPacket( p_dec, &oggpacket, pp_block );
233 if( p_sys->i_headers == 2 )
235 /* The next packet in order is the codebooks header
236 We need to watch out that this packet is not missing as a
237 missing or corrupted header is fatal. */
238 if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
240 msg_Err( p_dec, "3rd Theora header is corrupted" );
245 if( !p_sys->b_packetizer )
247 /* We have all the headers, initialize decoder */
248 theora_decode_init( &p_sys->td, &p_sys->ti );
251 return ProcessPacket( p_dec, &oggpacket, pp_block );
254 return ProcessPacket( p_dec, &oggpacket, pp_block );
257 /*****************************************************************************
258 * ProcessPacket: processes a theora packet.
259 *****************************************************************************/
260 static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
263 decoder_sys_t *p_sys = p_dec->p_sys;
264 block_t *p_block = *pp_block;
267 /* Date management */
268 if( p_block->i_pts > 0 && p_block->i_pts != p_sys->i_pts )
270 p_sys->i_pts = p_block->i_pts;
273 if( p_sys->b_packetizer )
275 /* Date management */
276 p_block->i_dts = p_block->i_pts = p_sys->i_pts;
278 if( p_sys->i_headers >= 3 )
279 p_block->i_length = p_sys->i_pts - p_block->i_pts;
281 p_block->i_length = 0;
287 if( p_sys->i_headers >= 3 )
288 p_buf = DecodePacket( p_dec, p_oggpacket );
294 block_Release( p_block );
299 /* Date management */
300 p_sys->i_pts += ( I64C(1000000) * p_sys->ti.fps_denominator /
301 p_sys->ti.fps_numerator ); /* 1 frame per packet */
306 /*****************************************************************************
307 * DecodePacket: decodes a Theora packet.
308 *****************************************************************************/
309 static picture_t *DecodePacket( decoder_t *p_dec, ogg_packet *p_oggpacket )
311 decoder_sys_t *p_sys = p_dec->p_sys;
315 theora_decode_packetin( &p_sys->td, p_oggpacket );
318 theora_decode_YUVout( &p_sys->td, &yuv );
320 /* Get a new picture */
321 p_pic = p_dec->pf_vout_buffer_new( p_dec );
322 if( !p_pic ) return NULL;
324 theora_CopyPicture( p_dec, p_pic, &yuv );
326 p_pic->date = p_sys->i_pts;
331 /*****************************************************************************
332 * ParseTheoraComments: FIXME should be done in demuxer
333 *****************************************************************************/
334 static void ParseTheoraComments( decoder_t *p_dec )
336 input_thread_t *p_input = (input_thread_t *)p_dec->p_parent;
337 input_info_category_t *p_cat =
338 input_InfoCategory( p_input, _("Theora Comment") );
340 char *psz_name, *psz_value, *psz_comment;
341 while ( i < p_dec->p_sys->tc.comments )
343 psz_comment = strdup( p_dec->p_sys->tc.user_comments[i] );
346 msg_Warn( p_dec, "Out of memory" );
349 psz_name = psz_comment;
350 psz_value = strchr( psz_comment, '=' );
355 input_AddInfo( p_cat, psz_name, psz_value );
362 /*****************************************************************************
363 * CloseDecoder: theora decoder destruction
364 *****************************************************************************/
365 static void CloseDecoder( vlc_object_t *p_this )
367 decoder_t *p_dec = (decoder_t *)p_this;
368 decoder_sys_t *p_sys = p_dec->p_sys;
370 theora_info_clear( &p_sys->ti );
371 theora_comment_clear( &p_sys->tc );
376 /*****************************************************************************
377 * theora_CopyPicture: copy a picture from theora internal buffers to a
378 * picture_t structure.
379 *****************************************************************************/
380 static void theora_CopyPicture( decoder_t *p_dec, picture_t *p_pic,
383 int i_plane, i_line, i_width, i_dst_stride, i_src_stride;
384 int i_src_xoffset, i_src_yoffset;
385 uint8_t *p_dst, *p_src;
387 for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
389 p_dst = p_pic->p[i_plane].p_pixels;
390 p_src = i_plane ? (i_plane - 1 ? yuv->v : yuv->u ) : yuv->y;
391 i_width = p_pic->p[i_plane].i_visible_pitch;
392 i_dst_stride = p_pic->p[i_plane].i_pitch;
393 i_src_stride = i_plane ? yuv->uv_stride : yuv->y_stride;
394 i_src_xoffset = p_dec->p_sys->ti.offset_x;
395 i_src_yoffset = p_dec->p_sys->ti.offset_y;
402 p_src += (i_src_yoffset * i_src_stride + i_src_yoffset);
404 for( i_line = 0; i_line < p_pic->p[i_plane].i_lines; i_line++ )
406 p_dec->p_vlc->pf_memcpy( p_dst, p_src, i_width );
407 p_src += i_src_stride;
408 p_dst += i_dst_stride;
413 /*****************************************************************************
414 * encoder_sys_t : theora encoder descriptor
415 *****************************************************************************/
421 vlc_bool_t b_headers;
426 theora_info ti; /* theora bitstream settings */
427 theora_comment tc; /* theora comment header */
428 theora_state td; /* theora bitstream user comments */
436 /*****************************************************************************
437 * OpenEncoder: probe the encoder and return score
438 *****************************************************************************/
439 static int OpenEncoder( vlc_object_t *p_this )
441 encoder_t *p_enc = (encoder_t *)p_this;
442 encoder_sys_t *p_sys = p_enc->p_sys;
444 if( p_enc->fmt_out.i_codec != VLC_FOURCC('t','h','e','o') )
449 /* Allocate the memory needed to store the decoder's structure */
450 if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
452 msg_Err( p_enc, "out of memory" );
455 p_enc->p_sys = p_sys;
457 p_enc->pf_header = Headers;
458 p_enc->pf_encode_video = Encode;
459 p_enc->fmt_in.i_codec = VLC_FOURCC('I','4','2','0');
461 #define frame_x_offset 0
462 #define frame_y_offset 0
469 theora_info_init( &p_sys->ti );
471 p_sys->ti.width = p_enc->fmt_in.video.i_width;
472 p_sys->ti.height = p_enc->fmt_in.video.i_height;
473 p_sys->ti.frame_width = p_enc->fmt_in.video.i_width;
474 p_sys->ti.frame_height = p_enc->fmt_in.video.i_height;
475 p_sys->ti.offset_x = frame_x_offset;
476 p_sys->ti.offset_y = frame_y_offset;
477 p_sys->ti.fps_numerator = video_hzn;
478 p_sys->ti.fps_denominator = video_hzd;
479 p_sys->ti.aspect_numerator = video_an;
480 p_sys->ti.aspect_denominator = video_ad;
481 p_sys->ti.colorspace = not_specified;
482 p_sys->ti.target_bitrate = p_enc->fmt_out.i_bitrate;
483 p_sys->ti.quality = video_q;
485 p_sys->ti.dropframes_p = 0;
486 p_sys->ti.quick_p = 1;
487 p_sys->ti.keyframe_auto_p = 1;
488 p_sys->ti.keyframe_frequency = 64;
489 p_sys->ti.keyframe_frequency_force = 64;
490 p_sys->ti.keyframe_data_target_bitrate = p_enc->fmt_out.i_bitrate * 1.5;
491 p_sys->ti.keyframe_auto_threshold = 80;
492 p_sys->ti.keyframe_mindistance = 8;
493 p_sys->ti.noise_sensitivity = 1;
495 theora_encode_init( &p_sys->td, &p_sys->ti );
496 theora_info_clear( &p_sys->ti );
497 theora_comment_init( &p_sys->tc );
499 p_sys->b_headers = VLC_FALSE;
504 /****************************************************************************
505 * Encode: the whole thing
506 ****************************************************************************
507 * This function spits out ogg packets.
508 ****************************************************************************/
509 static block_t *Headers( encoder_t *p_enc )
511 encoder_sys_t *p_sys = p_enc->p_sys;
512 block_t *p_chain = NULL;
514 /* Create theora headers */
515 if( !p_sys->b_headers )
517 ogg_packet oggpackets[3];
520 theora_encode_header( &p_sys->td, &oggpackets[0] );
521 theora_encode_comment( &p_sys->tc, &oggpackets[1] );
522 theora_encode_tables( &p_sys->td, &oggpackets[2] );
524 /* Ogg packet to block */
525 for( i = 0; i < 3; i++ )
527 block_t *p_block = block_New( p_enc, oggpackets[i].bytes );
528 memcpy( p_block->p_buffer, oggpackets[i].packet,
529 oggpackets[i].bytes );
530 p_block->i_dts = p_block->i_pts = p_block->i_length = 0;
531 block_ChainAppend( &p_chain, p_block );
534 p_sys->b_headers = VLC_TRUE;
540 /****************************************************************************
541 * Encode: the whole thing
542 ****************************************************************************
543 * This function spits out ogg packets.
544 ****************************************************************************/
545 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict )
547 encoder_sys_t *p_sys = p_enc->p_sys;
548 ogg_packet oggpacket;
552 /* Theora is a one-frame-in, one-frame-out system. Submit a frame
553 * for compression and pull out the packet. */
555 yuv.y_width = p_pict->p[0].i_visible_pitch;
556 yuv.y_height = p_pict->p[0].i_lines;
557 yuv.y_stride = p_pict->p[0].i_pitch;
559 yuv.uv_width = p_pict->p[1].i_visible_pitch;
560 yuv.uv_height = p_pict->p[1].i_lines;
561 yuv.uv_stride = p_pict->p[1].i_pitch;
563 yuv.y = p_pict->p[0].p_pixels;
564 yuv.u = p_pict->p[1].p_pixels;
565 yuv.v = p_pict->p[2].p_pixels;
567 if( theora_encode_YUVin( &p_sys->td, &yuv ) < 0 )
569 msg_Warn( p_enc, "failed encoding a frame" );
573 theora_encode_packetout( &p_sys->td, 0, &oggpacket );
575 /* Ogg packet to block */
576 p_block = block_New( p_enc, oggpacket.bytes );
577 memcpy( p_block->p_buffer, oggpacket.packet, oggpacket.bytes );
578 p_block->i_dts = p_block->i_pts = p_pict->date;;
583 /*****************************************************************************
584 * CloseEncoder: theora encoder destruction
585 *****************************************************************************/
586 static void CloseEncoder( vlc_object_t *p_this )
588 encoder_t *p_enc = (encoder_t *)p_this;
589 encoder_sys_t *p_sys = p_enc->p_sys;
591 theora_info_clear( &p_sys->ti );
592 theora_comment_clear( &p_sys->tc );