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