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 */
71 typedef struct SchroParseUnitContext {
74 } SchroParseUnitContext;
77 static void libschroedinger_decode_buffer_free(SchroBuffer *schro_buf,
83 static void parse_context_init(SchroParseUnitContext *parse_ctx,
84 const uint8_t *buf, int buf_size)
87 parse_ctx->buf_size = buf_size;
90 static SchroBuffer *find_next_parse_unit(SchroParseUnitContext *parse_ctx)
92 SchroBuffer *enc_buf = NULL;
93 int next_pu_offset = 0;
94 unsigned char *in_buf;
96 if (parse_ctx->buf_size < 13 ||
97 parse_ctx->buf[0] != 'B' ||
98 parse_ctx->buf[1] != 'B' ||
99 parse_ctx->buf[2] != 'C' ||
100 parse_ctx->buf[3] != 'D')
103 next_pu_offset = (parse_ctx->buf[5] << 24) +
104 (parse_ctx->buf[6] << 16) +
105 (parse_ctx->buf[7] << 8) +
108 if (next_pu_offset == 0 &&
109 SCHRO_PARSE_CODE_IS_END_OF_SEQUENCE(parse_ctx->buf[4]))
112 if (next_pu_offset <= 0 || parse_ctx->buf_size < next_pu_offset)
115 in_buf = av_malloc(next_pu_offset);
117 av_log(parse_ctx, AV_LOG_ERROR, "Unable to allocate input buffer\n");
121 memcpy(in_buf, parse_ctx->buf, next_pu_offset);
122 enc_buf = schro_buffer_new_with_data(in_buf, next_pu_offset);
123 enc_buf->free = libschroedinger_decode_buffer_free;
124 enc_buf->priv = in_buf;
126 parse_ctx->buf += next_pu_offset;
127 parse_ctx->buf_size -= next_pu_offset;
133 * Returns FFmpeg chroma format.
135 static enum AVPixelFormat get_chroma_format(SchroChromaFormat schro_pix_fmt)
137 int num_formats = sizeof(schro_pixel_format_map) /
138 sizeof(schro_pixel_format_map[0]);
141 for (idx = 0; idx < num_formats; ++idx)
142 if (schro_pixel_format_map[idx].schro_pix_fmt == schro_pix_fmt)
143 return schro_pixel_format_map[idx].ff_pix_fmt;
144 return AV_PIX_FMT_NONE;
147 static av_cold int libschroedinger_decode_init(AVCodecContext *avctx)
150 SchroDecoderParams *p_schro_params = avctx->priv_data;
151 /* First of all, initialize our supporting libraries. */
154 schro_debug_set_level(avctx->debug);
155 p_schro_params->decoder = schro_decoder_new();
156 schro_decoder_set_skip_ratio(p_schro_params->decoder, 1);
158 if (!p_schro_params->decoder)
161 /* Initialize the decoded frame queue. */
162 ff_schro_queue_init(&p_schro_params->dec_frame_queue);
166 static void libschroedinger_decode_frame_free(void *frame)
168 schro_frame_unref(frame);
171 static void libschroedinger_handle_first_access_unit(AVCodecContext *avctx)
173 SchroDecoderParams *p_schro_params = avctx->priv_data;
174 SchroDecoder *decoder = p_schro_params->decoder;
176 p_schro_params->format = schro_decoder_get_video_format(decoder);
178 /* Tell FFmpeg about sequence details. */
179 if (av_image_check_size(p_schro_params->format->width,
180 p_schro_params->format->height, 0, avctx) < 0) {
181 av_log(avctx, AV_LOG_ERROR, "invalid dimensions (%dx%d)\n",
182 p_schro_params->format->width, p_schro_params->format->height);
183 avctx->height = avctx->width = 0;
186 avctx->height = p_schro_params->format->height;
187 avctx->width = p_schro_params->format->width;
188 avctx->pix_fmt = get_chroma_format(p_schro_params->format->chroma_format);
190 if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
191 &p_schro_params->frame_format) == -1) {
192 av_log(avctx, AV_LOG_ERROR,
193 "This codec currently only supports planar YUV 4:2:0, 4:2:2 "
194 "and 4:4:4 formats.\n");
198 avctx->framerate.num = p_schro_params->format->frame_rate_numerator;
199 avctx->framerate.den = p_schro_params->format->frame_rate_denominator;
202 static int libschroedinger_decode_frame(AVCodecContext *avctx,
203 void *data, int *got_frame,
206 const uint8_t *buf = avpkt->data;
207 int buf_size = avpkt->size;
208 int64_t pts = avpkt->pts;
211 SchroDecoderParams *p_schro_params = avctx->priv_data;
212 SchroDecoder *decoder = p_schro_params->decoder;
213 SchroBuffer *enc_buf;
215 AVFrame *avframe = data;
219 SchroParseUnitContext parse_ctx;
220 LibSchroFrameContext *framewithpts = NULL;
224 parse_context_init(&parse_ctx, buf, buf_size);
226 if (!p_schro_params->eos_signalled) {
227 state = schro_decoder_push_end_of_stream(decoder);
228 p_schro_params->eos_signalled = 1;
232 /* Loop through all the individual parse units in the input buffer */
234 if ((enc_buf = find_next_parse_unit(&parse_ctx))) {
235 /* Set Schrotag with the pts to be recovered after decoding*/
236 enc_buf->tag = schro_tag_new(av_malloc(sizeof(int64_t)), av_free);
237 if (!enc_buf->tag->value) {
238 av_log(avctx, AV_LOG_ERROR, "Unable to allocate SchroTag\n");
239 return AVERROR(ENOMEM);
241 AV_WN(64, enc_buf->tag->value, pts);
242 /* Push buffer into decoder. */
243 if (SCHRO_PARSE_CODE_IS_PICTURE(enc_buf->data[4]) &&
244 SCHRO_PARSE_CODE_NUM_REFS(enc_buf->data[4]) > 0)
245 avctx->has_b_frames = 1;
246 state = schro_decoder_push(decoder, enc_buf);
247 if (state == SCHRO_DECODER_FIRST_ACCESS_UNIT)
248 libschroedinger_handle_first_access_unit(avctx);
254 /* Parse data and process result. */
255 state = schro_decoder_wait(decoder);
257 case SCHRO_DECODER_FIRST_ACCESS_UNIT:
258 libschroedinger_handle_first_access_unit(avctx);
261 case SCHRO_DECODER_NEED_BITS:
262 /* Need more input data - stop iterating over what we have. */
266 case SCHRO_DECODER_NEED_FRAME:
267 /* Decoder needs a frame - create one and push it in. */
268 frame = ff_create_schro_frame(avctx,
269 p_schro_params->frame_format);
271 return AVERROR(ENOMEM);
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(avctx, 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) {
313 if ((ret = ff_get_buffer(avctx, avframe, 0)) < 0)
316 memcpy(avframe->data[0],
317 framewithpts->frame->components[0].data,
318 framewithpts->frame->components[0].length);
320 memcpy(avframe->data[1],
321 framewithpts->frame->components[1].data,
322 framewithpts->frame->components[1].length);
324 memcpy(avframe->data[2],
325 framewithpts->frame->components[2].data,
326 framewithpts->frame->components[2].length);
328 /* Fill frame with current buffer data from Schroedinger. */
329 avframe->pkt_pts = framewithpts->pts;
330 avframe->linesize[0] = framewithpts->frame->components[0].stride;
331 avframe->linesize[1] = framewithpts->frame->components[1].stride;
332 avframe->linesize[2] = framewithpts->frame->components[2].stride;
336 /* Now free the frame resources. */
337 libschroedinger_decode_frame_free(framewithpts->frame);
338 av_free(framewithpts);
347 static av_cold int libschroedinger_decode_close(AVCodecContext *avctx)
349 SchroDecoderParams *p_schro_params = avctx->priv_data;
350 /* Free the decoder. */
351 schro_decoder_free(p_schro_params->decoder);
352 av_freep(&p_schro_params->format);
354 /* Free data in the output frame queue. */
355 ff_schro_queue_free(&p_schro_params->dec_frame_queue,
356 libschroedinger_decode_frame_free);
361 static void libschroedinger_flush(AVCodecContext *avctx)
363 /* Got a seek request. Free the decoded frames queue and then reset
365 SchroDecoderParams *p_schro_params = avctx->priv_data;
367 /* Free data in the output frame queue. */
368 ff_schro_queue_free(&p_schro_params->dec_frame_queue,
369 libschroedinger_decode_frame_free);
371 ff_schro_queue_init(&p_schro_params->dec_frame_queue);
372 schro_decoder_reset(p_schro_params->decoder);
373 p_schro_params->eos_pulled = 0;
374 p_schro_params->eos_signalled = 0;
377 AVCodec ff_libschroedinger_decoder = {
378 .name = "libschroedinger",
379 .long_name = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),
380 .type = AVMEDIA_TYPE_VIDEO,
381 .id = AV_CODEC_ID_DIRAC,
382 .priv_data_size = sizeof(SchroDecoderParams),
383 .init = libschroedinger_decode_init,
384 .close = libschroedinger_decode_close,
385 .decode = libschroedinger_decode_frame,
386 .capabilities = CODEC_CAP_DELAY,
387 .flush = libschroedinger_flush,