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  * 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 struct picture_free_t
  63 {
  64    picture_t *p_pic;
  65    decoder_t *p_dec;
  66 };
  67
  68 /*****************************************************************************
  69  * decoder_sys_t : Schroedinger decoder descriptor
  70  *****************************************************************************/
  71 struct decoder_sys_t
  72 {
  73     /*
  74      * Dirac properties
  75      */
  76     mtime_t i_lastpts;
  77     mtime_t i_frame_pts_delta;
  78     SchroDecoder *p_schro;
  79     SchroVideoFormat *p_format;
  80 };
  81
  82 /*****************************************************************************
  83  * OpenDecoder: probe the decoder and return score
  84  *****************************************************************************/
  85 static int OpenDecoder( vlc_object_t *p_this )
  86 {
  87     decoder_t *p_dec = (decoder_t*)p_this;
  88     decoder_sys_t *p_sys;
  89     SchroDecoder *p_schro;
  90
  91     if( p_dec->fmt_in.i_codec != VLC_CODEC_DIRAC )
  92     {
  93         return VLC_EGENERIC;
  94     }
  95
  96     /* Allocate the memory needed to store the decoder's structure */
  97     p_sys = malloc(sizeof(decoder_sys_t));
  98     if( p_sys == NULL )
  99         return VLC_ENOMEM;
 100
 101     /* Initialise the schroedinger (and hence liboil libraries */
 102     /* This does no allocation and is safe to call */
 103     schro_init();
 104
 105     /* Initialise the schroedinger decoder */
 106     if( !(p_schro = schro_decoder_new()) )
 107     {
 108         free( p_sys );
 109         return VLC_EGENERIC;
 110     }
 111
 112     p_dec->p_sys = p_sys;
 113     p_sys->p_schro = p_schro;
 114     p_sys->p_format = NULL;
 115     p_sys->i_lastpts = -1;
 116     p_sys->i_frame_pts_delta = 0;
 117
 118     /* Set output properties */
 119     p_dec->fmt_out.i_cat = VIDEO_ES;
 120     p_dec->fmt_out.i_codec = VLC_CODEC_I420;
 121
 122     /* Set callbacks */
 123     p_dec->pf_decode_video = DecodeBlock;
 124
 125     return VLC_SUCCESS;
 126 }
 127
 128 /*****************************************************************************
 129  * SetPictureFormat: Set the decoded picture params to the ones from the stream
 130  *****************************************************************************/
 131 static void SetVideoFormat( decoder_t *p_dec )
 132 {
 133     decoder_sys_t *p_sys = p_dec->p_sys;
 134     double f_aspect;
 135
 136     p_sys->p_format = schro_decoder_get_video_format(p_sys->p_schro);
 137     if( p_sys->p_format == NULL ) return;
 138
 139     p_sys->i_frame_pts_delta = INT64_C(1000000)
 140                             * p_sys->p_format->frame_rate_denominator
 141                             / p_sys->p_format->frame_rate_numerator;
 142
 143     switch( p_sys->p_format->chroma_format )
 144     {
 145     case SCHRO_CHROMA_420: p_dec->fmt_out.i_codec = VLC_CODEC_I420; break;
 146     case SCHRO_CHROMA_422: p_dec->fmt_out.i_codec = VLC_CODEC_I422; break;
 147     case SCHRO_CHROMA_444: p_dec->fmt_out.i_codec = VLC_CODEC_I444; break;
 148     default:
 149         p_dec->fmt_out.i_codec = 0;
 150         break;
 151     }
 152
 153     p_dec->fmt_out.video.i_visible_width = p_sys->p_format->clean_width;
 154     p_dec->fmt_out.video.i_x_offset = p_sys->p_format->left_offset;
 155     p_dec->fmt_out.video.i_width = p_sys->p_format->width;
 156
 157     p_dec->fmt_out.video.i_visible_height = p_sys->p_format->clean_height;
 158     p_dec->fmt_out.video.i_y_offset = p_sys->p_format->top_offset;
 159     p_dec->fmt_out.video.i_height = p_sys->p_format->height;
 160
 161     /* aspect_ratio_[numerator|denominator] describes the pixel aspect ratio */
 162     f_aspect = (double)
 163         ( p_sys->p_format->aspect_ratio_numerator * p_sys->p_format->width ) /
 164         ( p_sys->p_format->aspect_ratio_denominator * p_sys->p_format->height);
 165
 166     p_dec->fmt_out.video.i_aspect = VOUT_ASPECT_FACTOR * f_aspect;
 167
 168     p_dec->fmt_out.video.i_frame_rate =
 169         p_sys->p_format->frame_rate_numerator;
 170     p_dec->fmt_out.video.i_frame_rate_base =
 171         p_sys->p_format->frame_rate_denominator;
 172 }
 173
 174 /*****************************************************************************
 175  * SchroFrameFree: schro_frame callback to release the associated picture_t
 176  * When schro_decoder_reset() is called there will be pictures in the
 177  * decoding pipeline that need to be released rather than displayed.
 178  *****************************************************************************/
 179 static void SchroFrameFree( SchroFrame *frame, void *priv)
 180 {
 181     struct picture_free_t *p_free = priv;
 182
 183     if( !p_free )
 184         return;
 185
 186     decoder_DeletePicture( p_free->p_dec, p_free->p_pic );
 187     free(p_free);
 188     (void)frame;
 189 }
 190
 191 /*****************************************************************************
 192  * CreateSchroFrameFromPic: wrap a picture_t in a SchroFrame
 193  *****************************************************************************/
 194 static SchroFrame *CreateSchroFrameFromPic( decoder_t *p_dec )
 195 {
 196     decoder_sys_t *p_sys = p_dec->p_sys;
 197     SchroFrame *p_schroframe = schro_frame_new();
 198     picture_t *p_pic = NULL;
 199     struct picture_free_t *p_free;
 200
 201     if( !p_schroframe )
 202         return NULL;
 203
 204     p_pic = decoder_NewPicture( p_dec );
 205
 206     if( !p_pic )
 207         return NULL;
 208
 209     p_schroframe->format = SCHRO_FRAME_FORMAT_U8_420;
 210     if( p_sys->p_format->chroma_format == SCHRO_CHROMA_422 )
 211     {
 212         p_schroframe->format = SCHRO_FRAME_FORMAT_U8_422;
 213     }
 214     else if( p_sys->p_format->chroma_format == SCHRO_CHROMA_444 )
 215     {
 216         p_schroframe->format = SCHRO_FRAME_FORMAT_U8_444;
 217     }
 218
 219     p_schroframe->width = p_sys->p_format->width;
 220     p_schroframe->height = p_sys->p_format->height;
 221
 222     p_free = malloc( sizeof( *p_free ) );
 223     p_free->p_pic = p_pic;
 224     p_free->p_dec = p_dec;
 225     schro_frame_set_free_callback( p_schroframe, SchroFrameFree, p_free );
 226
 227     for( int i=0; i<3; i++ )
 228     {
 229         p_schroframe->components[i].width = p_pic->p[i].i_visible_pitch;
 230         p_schroframe->components[i].stride = p_pic->p[i].i_pitch;
 231         p_schroframe->components[i].height = p_pic->p[i].i_visible_lines;
 232         p_schroframe->components[i].length =
 233             p_pic->p[i].i_pitch * p_pic->p[i].i_lines;
 234         p_schroframe->components[i].data = p_pic->p[i].p_pixels;
 235
 236         if(i!=0)
 237         {
 238             p_schroframe->components[i].v_shift =
 239                 SCHRO_FRAME_FORMAT_V_SHIFT( p_schroframe->format );
 240             p_schroframe->components[i].h_shift =
 241                 SCHRO_FRAME_FORMAT_H_SHIFT( p_schroframe->format );
 242         }
 243     }
 244
 245     p_pic->b_progressive = !p_sys->p_format->interlaced;
 246     p_pic->b_top_field_first = p_sys->p_format->top_field_first;
 247     p_pic->i_nb_fields = 2;
 248
 249     return p_schroframe;
 250 }
 251
 252 /*****************************************************************************
 253  * SchroBufferFree: schro_buffer callback to release the associated block_t
 254  *****************************************************************************/
 255 static void SchroBufferFree( SchroBuffer *buf, void *priv )
 256 {
 257     block_t *p_block = priv;
 258
 259     if( !p_block )
 260         return;
 261
 262     block_Release( p_block );
 263     (void)buf;
 264 }
 265
 266 /*****************************************************************************
 267  * CloseDecoder: decoder destruction
 268  *****************************************************************************/
 269 static void CloseDecoder( vlc_object_t *p_this )
 270 {
 271     decoder_t *p_dec = (decoder_t *)p_this;
 272     decoder_sys_t *p_sys = p_dec->p_sys;
 273
 274     schro_decoder_free( p_sys->p_schro );
 275     free( p_sys );
 276 }
 277
 278 /****************************************************************************
 279  * DecodeBlock: the whole thing
 280  ****************************************************************************
 281  * Blocks need not be Dirac dataunit aligned.
 282  * If a block has a PTS signaled, it applies to the first picture at or after p_block
 283  *
 284  * If this function returns a picture (!NULL), it is called again and the
 285  * same block is resubmitted.  To avoid this, set *pp_block to NULL;
 286  * If this function returns NULL, the *pp_block is lost (and leaked).
 287  * This function must free all blocks when finished with them.
 288  ****************************************************************************/
 289 static picture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 290 {
 291     decoder_sys_t *p_sys = p_dec->p_sys;
 292
 293     if( !pp_block ) return NULL;
 294
 295     if ( *pp_block ) {
 296         block_t *p_block = *pp_block;
 297
 298         /* reset the decoder when seeking as the decode in progress is invalid */
 299         /* discard the block as it is just a null magic block */
 300         if( p_block->i_flags & BLOCK_FLAG_DISCONTINUITY ) {
 301             schro_decoder_reset( p_sys->p_schro );
 302
 303             p_sys->i_lastpts = -1;
 304             block_Release( p_block );
 305             *pp_block = NULL;
 306             return NULL;
 307         }
 308
 309         SchroBuffer *p_schrobuffer;
 310         p_schrobuffer = schro_buffer_new_with_data( p_block->p_buffer, p_block->i_buffer );
 311         p_schrobuffer->free = SchroBufferFree;
 312         p_schrobuffer->priv = p_block;
 313         if( p_block->i_pts != VLC_TS_INVALID ) {
 314             mtime_t *p_pts = malloc( sizeof(*p_pts) );
 315             if( p_pts ) {
 316                 *p_pts = p_block->i_pts;
 317                 /* if this call fails, p_pts is freed automatically */
 318                 p_schrobuffer->tag = schro_tag_new( p_pts, free );
 319             }
 320         }
 321
 322         /* this stops the same block being fed back into this function if
 323          * we were on the next iteration of this loop to output a picture */
 324         *pp_block = NULL;
 325         schro_decoder_autoparse_push( p_sys->p_schro, p_schrobuffer );
 326         /* DO NOT refer to p_block after this point, it may have been freed */
 327     }
 328
 329     while( 1 )
 330     {
 331         SchroFrame *p_schroframe;
 332         picture_t *p_pic;
 333         int state = schro_decoder_autoparse_wait( p_sys->p_schro );
 334
 335         switch( state )
 336         {
 337         case SCHRO_DECODER_FIRST_ACCESS_UNIT:
 338             SetVideoFormat( p_dec );
 339             break;
 340
 341         case SCHRO_DECODER_NEED_BITS:
 342             return NULL;
 343
 344         case SCHRO_DECODER_NEED_FRAME:
 345             p_schroframe = CreateSchroFrameFromPic( p_dec );
 346
 347             if( !p_schroframe )
 348             {
 349                 msg_Err( p_dec, "Could not allocate picture for decoder");
 350                 return NULL;
 351             }
 352
 353             schro_decoder_add_output_picture( p_sys->p_schro, p_schroframe);
 354             break;
 355
 356         case SCHRO_DECODER_OK: {
 357             SchroTag *p_tag = schro_decoder_get_picture_tag( p_sys->p_schro );
 358             p_schroframe = schro_decoder_pull( p_sys->p_schro );
 359             if( !p_schroframe || !p_schroframe->priv )
 360             {
 361                 /* frame can't be one that was allocated by us
 362                  *   -- no private data: discard */
 363                 if( p_tag ) schro_tag_free( p_tag );
 364                 if( p_schroframe ) schro_frame_unref( p_schroframe );
 365                 break;
 366             }
 367             p_pic = ((struct picture_free_t*) p_schroframe->priv)->p_pic;
 368             p_schroframe->priv = NULL;
 369
 370             if( p_tag )
 371             {
 372                 /* free is handled by schro_frame_unref */
 373                 p_pic->date = *(mtime_t*) p_tag->value;
 374                 schro_tag_free( p_tag );
 375             }
 376             else if( p_sys->i_lastpts >= 0 )
 377             {
 378                 /* NB, this shouldn't happen since the packetizer does a
 379                  * very thorough job of inventing timestamps.  The
 380                  * following is just a very rough fall back incase packetizer
 381                  * is missing. */
 382                 /* maybe it would be better to set p_pic->b_force ? */
 383                 p_pic->date = p_sys->i_lastpts + p_sys->i_frame_pts_delta;
 384             }
 385             p_sys->i_lastpts = p_pic->date;
 386
 387             schro_frame_unref( p_schroframe );
 388             return p_pic;
 389         }
 390         case SCHRO_DECODER_EOS:
 391             /* NB, the new api will not emit _EOS, it handles the reset internally */
 392             break;
 393
 394         case SCHRO_DECODER_ERROR:
 395             msg_Err( p_dec, "SCHRO_DECODER_ERROR");
 396             return NULL;
 397         }
 398     }
 399 }
 400