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 /*****************************************************************************
44 *****************************************************************************/
45 static int OpenDecoder ( vlc_object_t * );
46 static void CloseDecoder ( vlc_object_t * );
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" )
57 /*****************************************************************************
59 *****************************************************************************/
60 static picture_t *DecodeBlock ( decoder_t *p_dec, block_t **pp_block );
68 /*****************************************************************************
69 * decoder_sys_t : Schroedinger decoder descriptor
70 *****************************************************************************/
77 mtime_t i_frame_pts_delta;
78 SchroDecoder *p_schro;
79 SchroVideoFormat *p_format;
82 /*****************************************************************************
83 * OpenDecoder: probe the decoder and return score
84 *****************************************************************************/
85 static int OpenDecoder( vlc_object_t *p_this )
87 decoder_t *p_dec = (decoder_t*)p_this;
89 SchroDecoder *p_schro;
91 if( p_dec->fmt_in.i_codec != VLC_CODEC_DIRAC )
96 /* Allocate the memory needed to store the decoder's structure */
97 p_sys = malloc(sizeof(decoder_sys_t));
101 /* Initialise the schroedinger (and hence liboil libraries */
102 /* This does no allocation and is safe to call */
105 /* Initialise the schroedinger decoder */
106 if( !(p_schro = schro_decoder_new()) )
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;
118 /* Set output properties */
119 p_dec->fmt_out.i_cat = VIDEO_ES;
120 p_dec->fmt_out.i_codec = VLC_CODEC_I420;
123 p_dec->pf_decode_video = DecodeBlock;
128 /*****************************************************************************
129 * SetPictureFormat: Set the decoded picture params to the ones from the stream
130 *****************************************************************************/
131 static void SetVideoFormat( decoder_t *p_dec )
133 decoder_sys_t *p_sys = p_dec->p_sys;
136 p_sys->p_format = schro_decoder_get_video_format(p_sys->p_schro);
137 if( p_sys->p_format == NULL ) return;
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;
143 switch( p_sys->p_format->chroma_format )
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;
149 p_dec->fmt_out.i_codec = 0;
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;
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;
161 /* aspect_ratio_[numerator|denominator] describes the pixel aspect ratio */
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);
166 p_dec->fmt_out.video.i_aspect = VOUT_ASPECT_FACTOR * f_aspect;
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;
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)
181 struct picture_free_t *p_free = priv;
186 decoder_DeletePicture( p_free->p_dec, p_free->p_pic );
191 /*****************************************************************************
192 * CreateSchroFrameFromPic: wrap a picture_t in a SchroFrame
193 *****************************************************************************/
194 static SchroFrame *CreateSchroFrameFromPic( decoder_t *p_dec )
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;
204 p_pic = decoder_NewPicture( p_dec );
209 p_schroframe->format = SCHRO_FRAME_FORMAT_U8_420;
210 if( p_sys->p_format->chroma_format == SCHRO_CHROMA_422 )
212 p_schroframe->format = SCHRO_FRAME_FORMAT_U8_422;
214 else if( p_sys->p_format->chroma_format == SCHRO_CHROMA_444 )
216 p_schroframe->format = SCHRO_FRAME_FORMAT_U8_444;
219 p_schroframe->width = p_sys->p_format->width;
220 p_schroframe->height = p_sys->p_format->height;
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 );
227 for( int i=0; i<3; i++ )
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;
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 );
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;
252 /*****************************************************************************
253 * SchroBufferFree: schro_buffer callback to release the associated block_t
254 *****************************************************************************/
255 static void SchroBufferFree( SchroBuffer *buf, void *priv )
257 block_t *p_block = priv;
262 block_Release( p_block );
266 /*****************************************************************************
267 * CloseDecoder: decoder destruction
268 *****************************************************************************/
269 static void CloseDecoder( vlc_object_t *p_this )
271 decoder_t *p_dec = (decoder_t *)p_this;
272 decoder_sys_t *p_sys = p_dec->p_sys;
274 schro_decoder_free( p_sys->p_schro );
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
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 )
291 decoder_sys_t *p_sys = p_dec->p_sys;
293 if( !pp_block ) return NULL;
296 block_t *p_block = *pp_block;
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 );
303 p_sys->i_lastpts = -1;
304 block_Release( p_block );
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) );
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 );
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 */
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 */
331 SchroFrame *p_schroframe;
333 int state = schro_decoder_autoparse_wait( p_sys->p_schro );
337 case SCHRO_DECODER_FIRST_ACCESS_UNIT:
338 SetVideoFormat( p_dec );
341 case SCHRO_DECODER_NEED_BITS:
344 case SCHRO_DECODER_NEED_FRAME:
345 p_schroframe = CreateSchroFrameFromPic( p_dec );
349 msg_Err( p_dec, "Could not allocate picture for decoder");
353 schro_decoder_add_output_picture( p_sys->p_schro, p_schroframe);
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 )
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 );
367 p_pic = ((struct picture_free_t*) p_schroframe->priv)->p_pic;
368 p_schroframe->priv = NULL;
372 /* free is handled by schro_frame_unref */
373 p_pic->date = *(mtime_t*) p_tag->value;
374 schro_tag_free( p_tag );
376 else if( p_sys->i_lastpts >= 0 )
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
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;
385 p_sys->i_lastpts = p_pic->date;
387 schro_frame_unref( p_schroframe );
390 case SCHRO_DECODER_EOS:
391 /* NB, the new api will not emit _EOS, it handles the reset internally */
394 case SCHRO_DECODER_ERROR:
395 msg_Err( p_dec, "SCHRO_DECODER_ERROR");