2 * Dirac decoder support via Schroedinger libraries
3 * Copyright (c) 2008 BBC, Anuradha Suraparaju <asuraparaju at gmail dot com >
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Dirac decoder support via libschroedinger-1.0 libraries. More details about
25 * the Schroedinger project can be found at http://www.diracvideo.org/.
26 * The library implements Dirac Specification Version 2.2.
27 * (http://dirac.sourceforge.net/specification.html).
32 #include "libavutil/imgutils.h"
33 #include "libavutil/internal.h"
34 #include "libavutil/intreadwrite.h"
35 #include "libavutil/mem.h"
38 #include "libschroedinger.h"
40 #include <schroedinger/schro.h>
41 #include <schroedinger/schrodebug.h>
42 #include <schroedinger/schrovideoformat.h>
44 /** SchroFrame and Pts relation */
45 typedef struct LibSchroFrameContext {
48 } LibSchroFrameContext;
50 /** libschroedinger decoder private data */
51 typedef struct SchroDecoderParams {
52 /** Schroedinger video format */
53 SchroVideoFormat *format;
55 /** Schroedinger frame format */
56 SchroFrameFormat frame_format;
59 SchroDecoder* decoder;
61 /** queue storing decoded frames */
62 FFSchroQueue dec_frame_queue;
64 /** end of sequence signalled */
67 /** end of sequence pulled */
70 /** decoded picture */
74 typedef struct SchroParseUnitContext {
77 } SchroParseUnitContext;
80 static void libschroedinger_decode_buffer_free(SchroBuffer *schro_buf,
86 static void parse_context_init(SchroParseUnitContext *parse_ctx,
87 const uint8_t *buf, int buf_size)
90 parse_ctx->buf_size = buf_size;
93 static SchroBuffer *find_next_parse_unit(SchroParseUnitContext *parse_ctx)
95 SchroBuffer *enc_buf = NULL;
96 int next_pu_offset = 0;
97 unsigned char *in_buf;
99 if (parse_ctx->buf_size < 13 ||
100 parse_ctx->buf[0] != 'B' ||
101 parse_ctx->buf[1] != 'B' ||
102 parse_ctx->buf[2] != 'C' ||
103 parse_ctx->buf[3] != 'D')
106 next_pu_offset = (parse_ctx->buf[5] << 24) +
107 (parse_ctx->buf[6] << 16) +
108 (parse_ctx->buf[7] << 8) +
111 if (next_pu_offset == 0 &&
112 SCHRO_PARSE_CODE_IS_END_OF_SEQUENCE(parse_ctx->buf[4]))
115 if (next_pu_offset <= 0 || parse_ctx->buf_size < next_pu_offset)
118 in_buf = av_malloc(next_pu_offset);
120 av_log(parse_ctx, AV_LOG_ERROR, "Unable to allocate input buffer\n");
124 memcpy(in_buf, parse_ctx->buf, next_pu_offset);
125 enc_buf = schro_buffer_new_with_data(in_buf, next_pu_offset);
126 enc_buf->free = libschroedinger_decode_buffer_free;
127 enc_buf->priv = in_buf;
129 parse_ctx->buf += next_pu_offset;
130 parse_ctx->buf_size -= next_pu_offset;
136 * Returns FFmpeg chroma format.
138 static enum AVPixelFormat get_chroma_format(SchroChromaFormat schro_pix_fmt)
140 int num_formats = sizeof(schro_pixel_format_map) /
141 sizeof(schro_pixel_format_map[0]);
144 for (idx = 0; idx < num_formats; ++idx)
145 if (schro_pixel_format_map[idx].schro_pix_fmt == schro_pix_fmt)
146 return schro_pixel_format_map[idx].ff_pix_fmt;
147 return AV_PIX_FMT_NONE;
150 static av_cold int libschroedinger_decode_init(AVCodecContext *avccontext)
153 SchroDecoderParams *p_schro_params = avccontext->priv_data;
154 /* First of all, initialize our supporting libraries. */
157 schro_debug_set_level(avccontext->debug);
158 p_schro_params->decoder = schro_decoder_new();
159 schro_decoder_set_skip_ratio(p_schro_params->decoder, 1);
161 if (!p_schro_params->decoder)
164 /* Initialize the decoded frame queue. */
165 ff_schro_queue_init(&p_schro_params->dec_frame_queue);
169 static void libschroedinger_decode_frame_free(void *frame)
171 schro_frame_unref(frame);
174 static void libschroedinger_handle_first_access_unit(AVCodecContext *avccontext)
176 SchroDecoderParams *p_schro_params = avccontext->priv_data;
177 SchroDecoder *decoder = p_schro_params->decoder;
179 p_schro_params->format = schro_decoder_get_video_format(decoder);
181 /* Tell FFmpeg about sequence details. */
182 if (av_image_check_size(p_schro_params->format->width,
183 p_schro_params->format->height, 0, avccontext) < 0) {
184 av_log(avccontext, AV_LOG_ERROR, "invalid dimensions (%dx%d)\n",
185 p_schro_params->format->width, p_schro_params->format->height);
186 avccontext->height = avccontext->width = 0;
189 avccontext->height = p_schro_params->format->height;
190 avccontext->width = p_schro_params->format->width;
191 avccontext->pix_fmt = get_chroma_format(p_schro_params->format->chroma_format);
193 if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
194 &p_schro_params->frame_format) == -1) {
195 av_log(avccontext, AV_LOG_ERROR,
196 "This codec currently only supports planar YUV 4:2:0, 4:2:2 "
197 "and 4:4:4 formats.\n");
201 avccontext->time_base.den = p_schro_params->format->frame_rate_numerator;
202 avccontext->time_base.num = p_schro_params->format->frame_rate_denominator;
205 static int libschroedinger_decode_frame(AVCodecContext *avccontext,
206 void *data, int *got_frame,
209 const uint8_t *buf = avpkt->data;
210 int buf_size = avpkt->size;
211 int64_t pts = avpkt->pts;
214 SchroDecoderParams *p_schro_params = avccontext->priv_data;
215 SchroDecoder *decoder = p_schro_params->decoder;
216 SchroBuffer *enc_buf;
221 SchroParseUnitContext parse_ctx;
222 LibSchroFrameContext *framewithpts = NULL;
226 parse_context_init(&parse_ctx, buf, buf_size);
228 if (!p_schro_params->eos_signalled) {
229 state = schro_decoder_push_end_of_stream(decoder);
230 p_schro_params->eos_signalled = 1;
234 /* Loop through all the individual parse units in the input buffer */
236 if ((enc_buf = find_next_parse_unit(&parse_ctx))) {
237 /* Set Schrotag with the pts to be recovered after decoding*/
238 enc_buf->tag = schro_tag_new(av_malloc(sizeof(int64_t)), av_free);
239 if (!enc_buf->tag->value) {
240 av_log(avccontext, AV_LOG_ERROR, "Unable to allocate SchroTag\n");
241 return AVERROR(ENOMEM);
243 AV_WN(64, enc_buf->tag->value, pts);
244 /* Push buffer into decoder. */
245 if (SCHRO_PARSE_CODE_IS_PICTURE(enc_buf->data[4]) &&
246 SCHRO_PARSE_CODE_NUM_REFS(enc_buf->data[4]) > 0)
247 avccontext->has_b_frames = 1;
248 state = schro_decoder_push(decoder, enc_buf);
249 if (state == SCHRO_DECODER_FIRST_ACCESS_UNIT)
250 libschroedinger_handle_first_access_unit(avccontext);
256 /* Parse data and process result. */
257 state = schro_decoder_wait(decoder);
259 case SCHRO_DECODER_FIRST_ACCESS_UNIT:
260 libschroedinger_handle_first_access_unit(avccontext);
263 case SCHRO_DECODER_NEED_BITS:
264 /* Need more input data - stop iterating over what we have. */
268 case SCHRO_DECODER_NEED_FRAME:
269 /* Decoder needs a frame - create one and push it in. */
270 frame = ff_create_schro_frame(avccontext,
271 p_schro_params->frame_format);
272 schro_decoder_add_output_picture(decoder, frame);
275 case SCHRO_DECODER_OK:
276 /* Pull a frame out of the decoder. */
277 tag = schro_decoder_get_picture_tag(decoder);
278 frame = schro_decoder_pull(decoder);
281 /* Add relation between schroframe and pts. */
282 framewithpts = av_malloc(sizeof(LibSchroFrameContext));
284 av_log(avccontext, AV_LOG_ERROR, "Unable to allocate FrameWithPts\n");
285 return AVERROR(ENOMEM);
287 framewithpts->frame = frame;
288 framewithpts->pts = AV_RN64(tag->value);
289 ff_schro_queue_push_back(&p_schro_params->dec_frame_queue,
293 case SCHRO_DECODER_EOS:
295 p_schro_params->eos_pulled = 1;
296 schro_decoder_reset(decoder);
300 case SCHRO_DECODER_ERROR:
307 /* Grab next frame to be returned from the top of the queue. */
308 framewithpts = ff_schro_queue_pop(&p_schro_params->dec_frame_queue);
310 if (framewithpts && framewithpts->frame) {
311 if (p_schro_params->dec_frame.data[0])
312 avccontext->release_buffer(avccontext, &p_schro_params->dec_frame);
313 if (ff_get_buffer(avccontext, &p_schro_params->dec_frame) < 0) {
314 av_log(avccontext, AV_LOG_ERROR, "Unable to allocate buffer\n");
315 return AVERROR(ENOMEM);
318 memcpy(p_schro_params->dec_frame.data[0],
319 framewithpts->frame->components[0].data,
320 framewithpts->frame->components[0].length);
322 memcpy(p_schro_params->dec_frame.data[1],
323 framewithpts->frame->components[1].data,
324 framewithpts->frame->components[1].length);
326 memcpy(p_schro_params->dec_frame.data[2],
327 framewithpts->frame->components[2].data,
328 framewithpts->frame->components[2].length);
330 /* Fill frame with current buffer data from Schroedinger. */
331 p_schro_params->dec_frame.format = -1; /* Unknown -1 */
332 p_schro_params->dec_frame.width = framewithpts->frame->width;
333 p_schro_params->dec_frame.height = framewithpts->frame->height;
334 p_schro_params->dec_frame.pkt_pts = framewithpts->pts;
335 p_schro_params->dec_frame.linesize[0] = framewithpts->frame->components[0].stride;
336 p_schro_params->dec_frame.linesize[1] = framewithpts->frame->components[1].stride;
337 p_schro_params->dec_frame.linesize[2] = framewithpts->frame->components[2].stride;
339 *(AVFrame*)data = p_schro_params->dec_frame;
342 /* Now free the frame resources. */
343 libschroedinger_decode_frame_free(framewithpts->frame);
344 av_free(framewithpts);
353 static av_cold int libschroedinger_decode_close(AVCodecContext *avccontext)
355 SchroDecoderParams *p_schro_params = avccontext->priv_data;
356 /* Free the decoder. */
357 schro_decoder_free(p_schro_params->decoder);
358 av_freep(&p_schro_params->format);
360 if (p_schro_params->dec_frame.data[0])
361 avccontext->release_buffer(avccontext, &p_schro_params->dec_frame);
363 /* Free data in the output frame queue. */
364 ff_schro_queue_free(&p_schro_params->dec_frame_queue,
365 libschroedinger_decode_frame_free);
370 static void libschroedinger_flush(AVCodecContext *avccontext)
372 /* Got a seek request. Free the decoded frames queue and then reset
374 SchroDecoderParams *p_schro_params = avccontext->priv_data;
376 /* Free data in the output frame queue. */
377 ff_schro_queue_free(&p_schro_params->dec_frame_queue,
378 libschroedinger_decode_frame_free);
380 ff_schro_queue_init(&p_schro_params->dec_frame_queue);
381 schro_decoder_reset(p_schro_params->decoder);
382 p_schro_params->eos_pulled = 0;
383 p_schro_params->eos_signalled = 0;
386 AVCodec ff_libschroedinger_decoder = {
387 .name = "libschroedinger",
388 .type = AVMEDIA_TYPE_VIDEO,
389 .id = AV_CODEC_ID_DIRAC,
390 .priv_data_size = sizeof(SchroDecoderParams),
391 .init = libschroedinger_decode_init,
392 .close = libschroedinger_decode_close,
393 .decode = libschroedinger_decode_frame,
394 .capabilities = CODEC_CAP_DELAY,
395 .flush = libschroedinger_flush,
396 .long_name = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),