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