1 /*****************************************************************************
2 * schroedinger.c: Dirac decoder module making use of libschroedinger.
3 * (http://www.bbc.co.uk/rd/projects/dirac/index.shtml)
4 * (http://diracvideo.org)
5 *****************************************************************************
6 * Copyright (C) 2008 the VideoLAN team
9 * Authors: Jonathan Rosser <jonathan.rosser@gmail.com>
10 * David Flynn <davidf at rd dot bbc.co.uk>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_codec.h>
40 #include <schroedinger/schro.h>
42 /*****************************************************************************
43 * picture_pts_t : store pts alongside picture number, not carried through
45 *****************************************************************************/
48 int i_empty; //not in use
49 uint32_t u_pnum; //picture number from dirac header
50 mtime_t i_pts; //pts for this picture
53 /*****************************************************************************
54 * decoder_sys_t : Schroedinger decoder descriptor
55 *****************************************************************************/
56 #define PTS_TLB_SIZE 16
63 mtime_t i_frame_pts_delta;
64 SchroDecoder *p_schro;
65 SchroVideoFormat *p_format;
66 struct picture_pts_t pts_tlb[PTS_TLB_SIZE];
70 /*****************************************************************************
72 *****************************************************************************/
73 static int OpenDecoder ( vlc_object_t * );
74 static void CloseDecoder ( vlc_object_t * );
75 static picture_t *DecodeBlock ( decoder_t *p_dec, block_t **pp_block );
77 /*****************************************************************************
79 *****************************************************************************/
82 set_category( CAT_INPUT );
83 set_subcategory( SUBCAT_INPUT_VCODEC );
84 set_description( N_("Schroedinger video decoder") );
85 set_capability( "decoder", 200 );
86 set_callbacks( OpenDecoder, CloseDecoder );
87 add_shortcut( "schroedinger" );
90 /*****************************************************************************
91 * ResetPTStlb: Purge all entries in @p_dec@'s PTS-tlb
92 *****************************************************************************/
93 static void ResetPTStlb( decoder_t *p_dec )
95 decoder_sys_t *p_sys = p_dec->p_sys;
96 for( int i=0; i<PTS_TLB_SIZE; i++) {
97 p_sys->pts_tlb[i].i_empty = 1;
101 /*****************************************************************************
102 * OpenDecoder: probe the decoder and return score
103 *****************************************************************************/
104 static int OpenDecoder( vlc_object_t *p_this )
106 decoder_t *p_dec = (decoder_t*)p_this;
107 decoder_sys_t *p_sys;
108 SchroDecoder *p_schro;
110 if( p_dec->fmt_in.i_codec != VLC_FOURCC('d','r','a','c') )
115 /* Allocate the memory needed to store the decoder's structure */
116 p_sys = malloc(sizeof(decoder_sys_t));
120 /* Initialise the schroedinger (and hence liboil libraries */
121 /* This does no allocation and is safe to call */
124 /* Initialise the schroedinger decoder */
125 if( !(p_schro = schro_decoder_new()) )
131 p_dec->p_sys = p_sys;
132 p_sys->p_schro = p_schro;
133 p_sys->p_format = NULL;
134 p_sys->i_lastpts = -1;
135 p_sys->i_frame_pts_delta = 0;
136 p_sys->i_ts_resync_hack = 0;
140 /* Set output properties */
141 p_dec->fmt_out.i_cat = VIDEO_ES;
142 p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','0');
145 p_dec->pf_decode_video = DecodeBlock;
150 /*****************************************************************************
151 * SetPictureFormat: Set the decoded picture params to the ones from the stream
152 *****************************************************************************/
153 static void SetVideoFormat( decoder_t *p_dec )
155 decoder_sys_t *p_sys = p_dec->p_sys;
158 p_sys->p_format = schro_decoder_get_video_format(p_sys->p_schro);
159 if( p_sys->p_format == NULL ) return;
161 p_sys->i_frame_pts_delta = INT64_C(1000000)
162 * p_sys->p_format->frame_rate_denominator
163 / p_sys->p_format->frame_rate_numerator;
165 switch( p_sys->p_format->chroma_format )
167 case SCHRO_CHROMA_420: p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','0'); break;
168 case SCHRO_CHROMA_422: p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','2'); break;
169 case SCHRO_CHROMA_444: p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','4','4'); break;
171 p_dec->fmt_out.i_codec = 0;
175 p_dec->fmt_out.video.i_visible_width =
176 p_dec->fmt_out.video.i_width = p_sys->p_format->width;
178 p_dec->fmt_out.video.i_visible_height =
179 p_dec->fmt_out.video.i_height = p_sys->p_format->height;
181 /* aspect_ratio_[numerator|denominator] describes the pixel aspect ratio */
183 ( p_sys->p_format->aspect_ratio_numerator * p_sys->p_format->width ) /
184 ( p_sys->p_format->aspect_ratio_denominator * p_sys->p_format->height);
186 p_dec->fmt_out.video.i_aspect = VOUT_ASPECT_FACTOR * f_aspect;
188 p_dec->fmt_out.video.i_frame_rate =
189 p_sys->p_format->frame_rate_numerator;
190 p_dec->fmt_out.video.i_frame_rate_base =
191 p_sys->p_format->frame_rate_denominator;
194 /*****************************************************************************
195 * StorePicturePTS: Store the PTS value for a particular picture number
196 *****************************************************************************/
197 static void StorePicturePTS( decoder_t *p_dec, block_t *p_block, int i_pupos )
199 decoder_sys_t *p_sys = p_dec->p_sys;
203 u_pnum = GetDWBE( p_block->p_buffer + i_pupos + 13 );
204 i_pts = p_block->i_pts > 0 ? p_block->i_pts : p_block->i_dts;
206 for( int i=0; i<PTS_TLB_SIZE; i++ ) {
207 if( p_sys->pts_tlb[i].i_empty ) {
209 p_sys->pts_tlb[i].u_pnum = u_pnum;
210 p_sys->pts_tlb[i].i_pts = i_pts;
211 p_sys->pts_tlb[i].i_empty = 0;
217 msg_Err( p_dec, "Could not store PTS %"PRId64" for picture %u",
221 /*****************************************************************************
222 * GetPicturePTS: Retrieve the PTS value for a particular picture number
223 *****************************************************************************/
224 static mtime_t GetPicturePTS( decoder_t *p_dec, uint32_t u_pnum )
226 decoder_sys_t *p_sys = p_dec->p_sys;
228 for( int i=0; i<PTS_TLB_SIZE; i++ ) {
229 if( (!p_sys->pts_tlb[i].i_empty) &&
230 (p_sys->pts_tlb[i].u_pnum == u_pnum)) {
232 p_sys->pts_tlb[i].i_empty = 1;
233 return p_sys->pts_tlb[i].i_pts;
237 msg_Err( p_dec, "Could not retrieve PTS for picture %u", u_pnum );
241 /*****************************************************************************
242 * SchroFrameFree: schro_frame callback to release the associated picture_t
243 * When schro_decoder_reset() is called there will be pictures in the
244 * decoding pipeline that need to be released rather than displayed.
245 *****************************************************************************/
246 static void SchroFrameFree( SchroFrame *frame, void *priv)
248 picture_t *p_pic = priv;
253 if( p_pic->pf_release ) p_pic->pf_release( p_pic );
257 /*****************************************************************************
258 * CreateSchroFrameFromPic: wrap a picture_t in a SchroFrame
259 *****************************************************************************/
260 static SchroFrame *CreateSchroFrameFromPic( decoder_t *p_dec )
262 decoder_sys_t *p_sys = p_dec->p_sys;
263 SchroFrame *p_schroframe = schro_frame_new();
264 picture_t *p_pic = NULL;
269 p_pic = p_dec->pf_vout_buffer_new( p_dec );
274 p_schroframe->format = SCHRO_FRAME_FORMAT_U8_420;
275 if( p_sys->p_format->chroma_format == SCHRO_CHROMA_422 )
277 p_schroframe->format = SCHRO_FRAME_FORMAT_U8_422;
279 else if( p_sys->p_format->chroma_format == SCHRO_CHROMA_444 )
281 p_schroframe->format = SCHRO_FRAME_FORMAT_U8_444;
284 p_schroframe->width = p_sys->p_format->width;
285 p_schroframe->height = p_sys->p_format->height;
286 schro_frame_set_free_callback( p_schroframe, SchroFrameFree, p_pic );
288 for( int i=0; i<3; i++ )
290 p_schroframe->components[i].width = p_pic->p[i].i_visible_pitch;
291 p_schroframe->components[i].stride = p_pic->p[i].i_pitch;
292 p_schroframe->components[i].height = p_pic->p[i].i_visible_lines;
293 p_schroframe->components[i].length =
294 p_pic->p[i].i_pitch * p_pic->p[i].i_lines;
295 p_schroframe->components[i].data = p_pic->p[i].p_pixels;
299 p_schroframe->components[i].v_shift =
300 SCHRO_FRAME_FORMAT_V_SHIFT( p_schroframe->format );
301 p_schroframe->components[i].h_shift =
302 SCHRO_FRAME_FORMAT_H_SHIFT( p_schroframe->format );
306 p_pic->b_progressive = !p_sys->p_format->interlaced;
307 p_pic->b_top_field_first = p_sys->p_format->top_field_first;
308 p_pic->i_nb_fields = 2;
313 /*****************************************************************************
314 * SchroBufferFree: schro_buffer callback to release the associated block_t
315 *****************************************************************************/
316 static void SchroBufferFree( SchroBuffer *buf, void *priv )
318 block_t *p_block = priv;
323 block_Release( p_block );
327 /*****************************************************************************
328 * CloseDecoder: decoder destruction
329 *****************************************************************************/
330 static void CloseDecoder( vlc_object_t *p_this )
332 decoder_t *p_dec = (decoder_t *)p_this;
333 decoder_sys_t *p_sys = p_dec->p_sys;
335 schro_decoder_free( p_sys->p_schro );
339 /****************************************************************************
340 * DecodeBlock: the whole thing
341 ****************************************************************************
342 * Blocks must start with a Dirac parse unit.
343 * Blocks must contain at least one Dirac parse unit.
344 * Blocks must end with a picture parse unit.
345 * Blocks must not contain more than one picture parse unit.
346 * If a block has a PTS signaled, it applies to the first picture in p_block
347 * - Schroedinger has no internal means to tag pictures with a PTS
348 * - In this case, the picture number is extracted and stored in a TLB
349 * When a picture is extracted from schro, it is looked up in the pts_tlb
350 * - If the picture was never tagged with a PTS, a new one is calculated
351 * based upon the frame rate and last output PTS.
353 * If this function returns a picture (!NULL), it is called again and the
354 * same block is resubmitted. To avoid this, set *pp_block to NULL;
355 * If this function returns NULL, the *pp_block is lost (and leaked).
356 * This function must free all blocks when finished with them.
357 ****************************************************************************/
358 static picture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
360 decoder_sys_t *p_sys = p_dec->p_sys;
362 SchroBuffer *p_schrobuffer;
363 SchroFrame *p_schroframe;
368 if( !pp_block ) return NULL;
373 /* prepare block for submission */
375 if (p_sys->i_ts_resync_hack && p_sys->i_ts_resync_hack--)
378 if( !p_block->i_buffer ) {
379 msg_Err( p_dec, "block is of zero size" );
383 /* reset the decoder when seeking as the decode in progress is invalid */
384 /* discard the block as it is just a null magic block */
385 if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) ) {
386 msg_Dbg( p_dec, "SCHRO_DECODER_RESET" );
387 schro_decoder_reset( p_sys->p_schro );
389 ResetPTStlb( p_dec );
391 p_sys->i_lastpts = -1;
393 /* The ts layer manages to corrupt the next packet we are to receive
394 * Since schro has no sync support, we need to drop it */
395 p_sys->i_ts_resync_hack = 1;
397 block_Release( p_block );
402 /* Unsatisfactory, and will later be fixed in schro:
403 * - Schro can only handle a single Dirac parse unit at a time
404 * - Multiple parse units may exist in p_block
405 * - All mapping specs so far guarantee that p_block would
406 * not contain anything after a picture
407 * So, we can not give the whole block to schro, but piecemeal
409 size_t i_bufused = 0;
410 while( schro_decoder_push_ready( p_sys->p_schro )) {
411 if( p_block->i_buffer - i_bufused < 13 ) {
413 block_Release( p_block );
414 msg_Err( p_dec, "not enough data left in block" );
419 size_t i_pulen = GetDWBE( p_block->p_buffer + i_bufused + 5 );
420 uint8_t *p_pu = p_block->p_buffer + i_bufused;
422 /* blocks that do not start with the parse info prefix are invalid */
423 if( p_pu[0] != 'B' || p_pu[1] != 'B' ||
424 p_pu[2] != 'C' || p_pu[3] != 'D')
427 block_Release( p_block );
428 msg_Err( p_dec, "block does not start with dirac parse code" );
432 if( i_bufused + i_pulen > p_block->i_buffer ) {
434 block_Release( p_block );
439 StorePicturePTS( p_dec, p_block, i_bufused );
441 p_schrobuffer = schro_buffer_new_with_data( p_pu, i_pulen );
442 if( i_pulen + i_bufused < p_block->i_buffer ) {
443 /* don't let schro free this block, more data still in it */
444 p_schrobuffer->free = 0;
447 p_schrobuffer->free = SchroBufferFree;
448 p_schrobuffer->priv = p_block;
452 msg_Dbg( p_dec, "Inserting bytes into decoder len=%d of %d pts=%"PRId64,
453 i_pulen, p_block->i_buffer, p_block->i_pts);
454 /* this stops the same block being fed back into this function if
455 * we were on the next iteration of this loop to output a picture */
457 state = schro_decoder_push( p_sys->p_schro, p_schrobuffer );
459 /* DO NOT refer to p_block after this point, it may have been freed */
461 i_bufused += i_pulen;
463 if( state == SCHRO_DECODER_FIRST_ACCESS_UNIT ) {
464 msg_Dbg( p_dec, "SCHRO_DECODER_FIRST_ACCESS_UNIT");
465 SetVideoFormat( p_dec );
466 ResetPTStlb( p_dec );
473 if( (i_bufused > 0) && (i_bufused < p_block->i_buffer) )
474 msg_Err( p_dec, "not submitted everything in p_buffer");
481 state = schro_decoder_wait( p_sys->p_schro );
485 case SCHRO_DECODER_NEED_BITS:
486 msg_Dbg( p_dec, "SCHRO_DECODER_NEED_BITS" );
489 case SCHRO_DECODER_NEED_FRAME:
490 msg_Dbg( p_dec, "SCHRO_DECODER_NEED_FRAME" );
491 p_schroframe = CreateSchroFrameFromPic( p_dec );
495 msg_Err( p_dec, "Could not allocate picture for decoder");
499 schro_decoder_add_output_picture( p_sys->p_schro, p_schroframe);
502 case SCHRO_DECODER_OK:
503 u_pnum = schro_decoder_get_picture_number( p_sys->p_schro );
504 p_schroframe = schro_decoder_pull( p_sys->p_schro );
505 p_pic = p_schroframe->priv;
506 p_schroframe->priv = NULL;
507 schro_frame_unref( p_schroframe );
509 /* solve presentation time stamp for picture. If this picture
510 * was not tagged with a pts when presented to decoder, interpolate
512 * This means no need to set p_pic->b_force, as we have a pts on
514 p_pic->date = GetPicturePTS( p_dec, u_pnum );
515 if (p_sys->i_lastpts >= 0 && p_pic->date == 0)
516 p_pic->date = p_sys->i_lastpts + p_sys->i_frame_pts_delta;
517 p_sys->i_lastpts = p_pic->date;
519 msg_Dbg( p_dec, "SCHRO_DECODER_OK num=%u date=%"PRId64,
520 u_pnum, p_pic->date);
524 case SCHRO_DECODER_EOS:
525 msg_Dbg( p_dec, "SCHRO_DECODER_EOS");
526 /* reset the decoder -- schro doesn't do this itself automatically */
527 /* there are no more pictures in the output buffer at this point */
528 schro_decoder_reset( p_sys->p_schro );
531 case SCHRO_DECODER_ERROR:
532 msg_Dbg( p_dec, "SCHRO_DECODER_ERROR");