2c4a2c3ed545e36e985196787ecdf523245db707
[vlc.git] / modules / codec / schroedinger.c
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
7  * $Id$
8  *
9  * Authors: Jonathan Rosser <jonathan.rosser@gmail.com>
10  *          David Flynn <davidf at rd dot bbc.co.uk>
11  *
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.
16  *
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.
21  *
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  *****************************************************************************/
26
27 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30 #ifdef HAVE_CONFIG_H
31 # include "config.h"
32 #endif
33
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_codec.h>
37 #include <vlc_sout.h>
38 #include <vlc_vout.h>
39
40 #include <schroedinger/schro.h>
41
42 /*****************************************************************************
43  * Module descriptor
44  *****************************************************************************/
45 static int        OpenDecoder  ( vlc_object_t * );
46 static void       CloseDecoder ( vlc_object_t * );
47
48 vlc_module_begin();
49     set_category( CAT_INPUT );
50     set_subcategory( SUBCAT_INPUT_VCODEC );
51     set_description( N_("Schroedinger video decoder") );
52     set_capability( "decoder", 200 );
53     set_callbacks( OpenDecoder, CloseDecoder );
54     add_shortcut( "schroedinger" );
55 vlc_module_end();
56
57 /*****************************************************************************
58  * Local prototypes
59  *****************************************************************************/
60 static picture_t *DecodeBlock  ( decoder_t *p_dec, block_t **pp_block );
61
62 /*****************************************************************************
63  * picture_pts_t : store pts alongside picture number, not carried through
64  * decoder
65  *****************************************************************************/
66 struct picture_pts_t
67 {
68    int i_empty;      //not in use
69    uint32_t u_pnum;  //picture number from dirac header
70    mtime_t i_pts;    //pts for this picture
71 };
72
73 struct picture_free_t
74 {
75    picture_t *p_pic;
76    decoder_t *p_dec;
77 };
78
79 /*****************************************************************************
80  * decoder_sys_t : Schroedinger decoder descriptor
81  *****************************************************************************/
82 #define PTS_TLB_SIZE 16
83 struct decoder_sys_t
84 {
85     /*
86      * Dirac properties
87      */
88     mtime_t i_lastpts;
89     mtime_t i_frame_pts_delta;
90     SchroDecoder *p_schro;
91     SchroVideoFormat *p_format;
92     struct picture_pts_t pts_tlb[PTS_TLB_SIZE];
93     int i_ts_resync_hack;
94 };
95
96 //#define TRACE
97
98 /*****************************************************************************
99  * ResetPTStlb: Purge all entries in @p_dec@'s PTS-tlb
100  *****************************************************************************/
101 static void ResetPTStlb( decoder_t *p_dec )
102 {
103     decoder_sys_t *p_sys = p_dec->p_sys;
104     for( int i=0; i<PTS_TLB_SIZE; i++) {
105         p_sys->pts_tlb[i].i_empty = 1;
106     }
107 }
108
109 /*****************************************************************************
110  * OpenDecoder: probe the decoder and return score
111  *****************************************************************************/
112 static int OpenDecoder( vlc_object_t *p_this )
113 {
114     decoder_t *p_dec = (decoder_t*)p_this;
115     decoder_sys_t *p_sys;
116     SchroDecoder *p_schro;
117
118     if( p_dec->fmt_in.i_codec != VLC_FOURCC('d','r','a','c') )
119     {
120         return VLC_EGENERIC;
121     }
122
123     /* Allocate the memory needed to store the decoder's structure */
124     p_sys = malloc(sizeof(decoder_sys_t));
125     if( p_sys == NULL )
126         return VLC_ENOMEM;
127
128     /* Initialise the schroedinger (and hence liboil libraries */
129     /* This does no allocation and is safe to call */
130     schro_init();
131
132     /* Initialise the schroedinger decoder */
133     if( !(p_schro = schro_decoder_new()) )
134     {
135         free( p_sys );
136         return VLC_EGENERIC;
137     }
138
139     p_dec->p_sys = p_sys;
140     p_sys->p_schro = p_schro;
141     p_sys->p_format = NULL;
142     p_sys->i_lastpts = -1;
143     p_sys->i_frame_pts_delta = 0;
144     p_sys->i_ts_resync_hack = 0;
145
146     ResetPTStlb(p_dec);
147
148     /* Set output properties */
149     p_dec->fmt_out.i_cat = VIDEO_ES;
150     p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','0');
151
152     /* Set callbacks */
153     p_dec->pf_decode_video = DecodeBlock;
154
155     return VLC_SUCCESS;
156 }
157
158 /*****************************************************************************
159  * SetPictureFormat: Set the decoded picture params to the ones from the stream
160  *****************************************************************************/
161 static void SetVideoFormat( decoder_t *p_dec )
162 {
163     decoder_sys_t *p_sys = p_dec->p_sys;
164     double f_aspect;
165
166     p_sys->p_format = schro_decoder_get_video_format(p_sys->p_schro);
167     if( p_sys->p_format == NULL ) return;
168
169     p_sys->i_frame_pts_delta = INT64_C(1000000)
170                             * p_sys->p_format->frame_rate_denominator
171                             / p_sys->p_format->frame_rate_numerator;
172
173     switch( p_sys->p_format->chroma_format )
174     {
175     case SCHRO_CHROMA_420: p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','0'); break;
176     case SCHRO_CHROMA_422: p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','2'); break;
177     case SCHRO_CHROMA_444: p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','4','4'); break;
178     default:
179         p_dec->fmt_out.i_codec = 0;
180         break;
181     }
182
183     p_dec->fmt_out.video.i_visible_width =
184     p_dec->fmt_out.video.i_width = p_sys->p_format->width;
185
186     p_dec->fmt_out.video.i_visible_height =
187     p_dec->fmt_out.video.i_height = p_sys->p_format->height;
188
189     /* aspect_ratio_[numerator|denominator] describes the pixel aspect ratio */
190     f_aspect = (double)
191         ( p_sys->p_format->aspect_ratio_numerator * p_sys->p_format->width ) /
192         ( p_sys->p_format->aspect_ratio_denominator * p_sys->p_format->height);
193
194     p_dec->fmt_out.video.i_aspect = VOUT_ASPECT_FACTOR * f_aspect;
195
196     p_dec->fmt_out.video.i_frame_rate =
197         p_sys->p_format->frame_rate_numerator;
198     p_dec->fmt_out.video.i_frame_rate_base =
199         p_sys->p_format->frame_rate_denominator;
200 }
201
202 /*****************************************************************************
203  * StorePicturePTS: Store the PTS value for a particular picture number
204  *****************************************************************************/
205 static void StorePicturePTS( decoder_t *p_dec, block_t *p_block, int i_pupos )
206 {
207     decoder_sys_t *p_sys = p_dec->p_sys;
208     uint32_t u_pnum;
209     mtime_t i_pts;
210
211     u_pnum = GetDWBE( p_block->p_buffer + i_pupos + 13 );
212     i_pts = p_block->i_pts > 0 ? p_block->i_pts : p_block->i_dts;
213
214     for( int i=0; i<PTS_TLB_SIZE; i++ ) {
215         if( p_sys->pts_tlb[i].i_empty ) {
216
217             p_sys->pts_tlb[i].u_pnum = u_pnum;
218             p_sys->pts_tlb[i].i_pts = i_pts;
219             p_sys->pts_tlb[i].i_empty = 0;
220
221             return;
222         }
223     }
224
225     msg_Err( p_dec, "Could not store PTS %"PRId64" for picture %u",
226              i_pts, u_pnum );
227 }
228
229 /*****************************************************************************
230  * GetPicturePTS: Retrieve the PTS value for a particular picture number
231  *****************************************************************************/
232 static mtime_t GetPicturePTS( decoder_t *p_dec, uint32_t u_pnum )
233 {
234     decoder_sys_t *p_sys = p_dec->p_sys;
235
236     for( int i=0; i<PTS_TLB_SIZE; i++ ) {
237         if( (!p_sys->pts_tlb[i].i_empty) &&
238             (p_sys->pts_tlb[i].u_pnum == u_pnum)) {
239
240              p_sys->pts_tlb[i].i_empty = 1;
241              return p_sys->pts_tlb[i].i_pts;
242         }
243     }
244
245     msg_Err( p_dec, "Could not retrieve PTS for picture %u", u_pnum );
246     return 0;
247 }
248
249 /*****************************************************************************
250  * SchroFrameFree: schro_frame callback to release the associated picture_t
251  * When schro_decoder_reset() is called there will be pictures in the
252  * decoding pipeline that need to be released rather than displayed.
253  *****************************************************************************/
254 static void SchroFrameFree( SchroFrame *frame, void *priv)
255 {
256     struct picture_free_t *p_free = priv;
257
258     if( !p_free )
259         return;
260
261     p_free->p_dec->pf_vout_buffer_del( p_free->p_dec, p_free->p_pic );
262     free(p_free);
263     (void)frame;
264 }
265
266 /*****************************************************************************
267  * CreateSchroFrameFromPic: wrap a picture_t in a SchroFrame
268  *****************************************************************************/
269 static SchroFrame *CreateSchroFrameFromPic( decoder_t *p_dec )
270 {
271     decoder_sys_t *p_sys = p_dec->p_sys;
272     SchroFrame *p_schroframe = schro_frame_new();
273     picture_t *p_pic = NULL;
274     struct picture_free_t *p_free;
275
276     if( !p_schroframe )
277         return NULL;
278
279     p_pic = p_dec->pf_vout_buffer_new( p_dec );
280
281     if( !p_pic )
282         return NULL;
283
284     p_schroframe->format = SCHRO_FRAME_FORMAT_U8_420;
285     if( p_sys->p_format->chroma_format == SCHRO_CHROMA_422 )
286     {
287         p_schroframe->format = SCHRO_FRAME_FORMAT_U8_422;
288     }
289     else if( p_sys->p_format->chroma_format == SCHRO_CHROMA_444 )
290     {
291         p_schroframe->format = SCHRO_FRAME_FORMAT_U8_444;
292     }
293
294     p_schroframe->width = p_sys->p_format->width;
295     p_schroframe->height = p_sys->p_format->height;
296
297     p_free = malloc( sizeof( *p_free ) );
298     p_free->p_pic = p_pic;
299     p_free->p_dec = p_dec;
300     schro_frame_set_free_callback( p_schroframe, SchroFrameFree, p_free );
301
302     for( int i=0; i<3; i++ )
303     {
304         p_schroframe->components[i].width = p_pic->p[i].i_visible_pitch;
305         p_schroframe->components[i].stride = p_pic->p[i].i_pitch;
306         p_schroframe->components[i].height = p_pic->p[i].i_visible_lines;
307         p_schroframe->components[i].length =
308             p_pic->p[i].i_pitch * p_pic->p[i].i_lines;
309         p_schroframe->components[i].data = p_pic->p[i].p_pixels;
310
311         if(i!=0)
312         {
313             p_schroframe->components[i].v_shift =
314                 SCHRO_FRAME_FORMAT_V_SHIFT( p_schroframe->format );
315             p_schroframe->components[i].h_shift =
316                 SCHRO_FRAME_FORMAT_H_SHIFT( p_schroframe->format );
317         }
318     }
319
320     p_pic->b_progressive = !p_sys->p_format->interlaced;
321     p_pic->b_top_field_first = p_sys->p_format->top_field_first;
322     p_pic->i_nb_fields = 2;
323
324     return p_schroframe;
325 }
326
327 /*****************************************************************************
328  * SchroBufferFree: schro_buffer callback to release the associated block_t
329  *****************************************************************************/
330 static void SchroBufferFree( SchroBuffer *buf, void *priv )
331 {
332     block_t *p_block = priv;
333
334     if( !p_block )
335         return;
336
337     block_Release( p_block );
338     (void)buf;
339 }
340
341 /*****************************************************************************
342  * CloseDecoder: decoder destruction
343  *****************************************************************************/
344 static void CloseDecoder( vlc_object_t *p_this )
345 {
346     decoder_t *p_dec = (decoder_t *)p_this;
347     decoder_sys_t *p_sys = p_dec->p_sys;
348
349     schro_decoder_free( p_sys->p_schro );
350     free( p_sys );
351 }
352
353 /****************************************************************************
354  * DecodeBlock: the whole thing
355  ****************************************************************************
356  * Blocks must start with a Dirac parse unit.
357  * Blocks must contain at least one Dirac parse unit.
358  * Blocks must end with a picture parse unit.
359  * Blocks must not contain more than one picture parse unit.
360  * If a block has a PTS signaled, it applies to the first picture in p_block
361  *   - Schroedinger has no internal means to tag pictures with a PTS
362  *   - In this case, the picture number is extracted and stored in a TLB
363  * When a picture is extracted from schro, it is looked up in the pts_tlb
364  *   - If the picture was never tagged with a PTS, a new one is calculated
365  *     based upon the frame rate and last output PTS.
366  *
367  * If this function returns a picture (!NULL), it is called again and the
368  * same block is resubmitted.  To avoid this, set *pp_block to NULL;
369  * If this function returns NULL, the *pp_block is lost (and leaked).
370  * This function must free all blocks when finished with them.
371  ****************************************************************************/
372 static picture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
373 {
374     decoder_sys_t *p_sys = p_dec->p_sys;
375     int state;
376     SchroBuffer *p_schrobuffer;
377     SchroFrame *p_schroframe;
378     picture_t *p_pic;
379     block_t *p_block;
380     uint32_t u_pnum;
381
382     if( !pp_block ) return NULL;
383
384     p_block = *pp_block;
385
386     if ( p_block ) do {
387         /* prepare block for submission */
388
389         if (p_sys->i_ts_resync_hack && p_sys->i_ts_resync_hack--)
390             return NULL;
391
392         if( !p_block->i_buffer ) {
393             msg_Err( p_dec, "block is of zero size" );
394             break;
395         }
396
397         /* reset the decoder when seeking as the decode in progress is invalid */
398         /* discard the block as it is just a null magic block */
399         if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) ) {
400 #ifdef TRACE
401             msg_Dbg( p_dec, "SCHRO_DECODER_RESET" );
402 #endif
403             schro_decoder_reset( p_sys->p_schro );
404
405             ResetPTStlb( p_dec );
406
407             p_sys->i_lastpts = -1;
408
409             /* The ts layer manages to corrupt the next packet we are to receive
410              * Since schro has no sync support, we need to drop it */
411             p_sys->i_ts_resync_hack = 1;
412
413             block_Release( p_block );
414             *pp_block = NULL;
415             return NULL;
416         }
417
418         /* Unsatisfactory, and will later be fixed in schro:
419          *  - Schro can only handle a single Dirac parse unit at a time
420          *  - Multiple parse units may exist in p_block
421          *  - All mapping specs so far guarantee that p_block would
422          *    not contain anything after a picture
423          * So, we can not give the whole block to schro, but piecemeal
424          */
425         size_t i_bufused = 0;
426         while( schro_decoder_push_ready( p_sys->p_schro )) {
427             if( p_block->i_buffer - i_bufused < 13 ) {
428                 *pp_block = NULL;
429                 block_Release( p_block );
430                 msg_Err( p_dec, "not enough data left in block" );
431                 break;
432             }
433
434             int b_bail = 0;
435             size_t i_pulen = GetDWBE( p_block->p_buffer + i_bufused + 5 );
436             uint8_t *p_pu = p_block->p_buffer + i_bufused;
437
438             /* blocks that do not start with the parse info prefix are invalid */
439             if( p_pu[0] != 'B' || p_pu[1] != 'B' ||
440                 p_pu[2] != 'C' || p_pu[3] != 'D')
441             {
442                 *pp_block = NULL;
443                 block_Release( p_block );
444                 msg_Err( p_dec, "block does not start with dirac parse code" );
445                 break;
446             }
447
448             if( i_bufused + i_pulen > p_block->i_buffer ) {
449                 *pp_block = NULL;
450                 block_Release( p_block );
451                 break;
452             }
453
454             if( p_pu[4] & 0x08 )
455                 StorePicturePTS( p_dec, p_block, i_bufused );
456
457             p_schrobuffer = schro_buffer_new_with_data( p_pu, i_pulen );
458             if( i_pulen + i_bufused < p_block->i_buffer ) {
459                 /* don't let schro free this block, more data still in it */
460                 p_schrobuffer->free = 0;
461             }
462             else {
463                 p_schrobuffer->free = SchroBufferFree;
464                 p_schrobuffer->priv = p_block;
465                 b_bail = 1;
466             }
467
468 #ifdef TRACE
469             msg_Dbg( p_dec, "Inserting bytes into decoder len=%zu of %zu pts=%"PRId64,
470                      i_pulen, p_block->i_buffer, p_block->i_pts);
471 #endif
472             /* this stops the same block being fed back into this function if
473              * we were on the next iteration of this loop to output a picture */
474             *pp_block = NULL;
475             state = schro_decoder_push( p_sys->p_schro, p_schrobuffer );
476
477             /* DO NOT refer to p_block after this point, it may have been freed */
478
479             i_bufused += i_pulen;
480
481             if( state == SCHRO_DECODER_FIRST_ACCESS_UNIT ) {
482 #ifdef TRACE
483                 msg_Dbg( p_dec, "SCHRO_DECODER_FIRST_ACCESS_UNIT");
484 #endif
485                 SetVideoFormat( p_dec );
486                 ResetPTStlb( p_dec );
487             }
488
489             if( b_bail )
490                 break;
491         }
492     } while( 0 );
493
494     while( 1 )
495     {
496         state = schro_decoder_wait( p_sys->p_schro );
497
498         switch( state )
499         {
500         case SCHRO_DECODER_NEED_BITS:
501 #ifdef TRACE
502             msg_Dbg( p_dec, "SCHRO_DECODER_NEED_BITS" );
503 #endif
504             return NULL;
505
506         case SCHRO_DECODER_NEED_FRAME:
507 #ifdef TRACE
508             msg_Dbg( p_dec, "SCHRO_DECODER_NEED_FRAME" );
509 #endif
510             p_schroframe = CreateSchroFrameFromPic( p_dec );
511
512             if( !p_schroframe )
513             {
514                 msg_Err( p_dec, "Could not allocate picture for decoder");
515                 return NULL;
516             }
517
518             schro_decoder_add_output_picture( p_sys->p_schro, p_schroframe);
519             break;
520
521         case SCHRO_DECODER_OK:
522             u_pnum = schro_decoder_get_picture_number( p_sys->p_schro );
523             p_schroframe = schro_decoder_pull( p_sys->p_schro );
524             p_pic = ((struct picture_free_t*) p_schroframe->priv)->p_pic;
525             p_schroframe->priv = NULL;
526             schro_frame_unref( p_schroframe );
527
528             /* solve presentation time stamp for picture.  If this picture
529              * was not tagged with a pts when presented to decoder, interpolate
530              * one
531              * This means no need to set p_pic->b_force, as we have a pts on
532              * each picture */
533             p_pic->date = GetPicturePTS( p_dec, u_pnum );
534             if (p_sys->i_lastpts >= 0 && p_pic->date == 0)
535                 p_pic->date = p_sys->i_lastpts + p_sys->i_frame_pts_delta;
536             p_sys->i_lastpts = p_pic->date;
537
538 #ifdef TRACE
539             msg_Dbg( p_dec, "SCHRO_DECODER_OK num=%u date=%"PRId64,
540                      u_pnum, p_pic->date);
541 #endif
542             return p_pic;
543
544         case SCHRO_DECODER_EOS:
545 #ifdef TRACE
546             msg_Dbg( p_dec, "SCHRO_DECODER_EOS");
547 #endif
548             /* reset the decoder -- schro doesn't do this itself automatically */
549             /* there are no more pictures in the output buffer at this point */
550             schro_decoder_reset( p_sys->p_schro );
551             break;
552
553         case SCHRO_DECODER_ERROR:
554 #ifdef TRACE
555             msg_Dbg( p_dec, "SCHRO_DECODER_ERROR");
556 #endif
557             return NULL;
558         }
559     }
560 }
561