libavcodec/libschroedingerdec.c
f7cd9eed
 /*
  * Dirac decoder support via Schroedinger libraries
  * Copyright (c) 2008 BBC, Anuradha Suraparaju <asuraparaju at gmail dot com >
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
ba87f080
 * @file
f7cd9eed
 * Dirac decoder support via libschroedinger-1.0 libraries. More details about
 * the Schroedinger project can be found at http://www.diracvideo.org/.
 * The library implements Dirac Specification Version 2.2.
 * (http://dirac.sourceforge.net/specification.html).
 */
 
7ebe3962
 #include <string.h>
 
7ffe76e5
 #include "libavutil/imgutils.h"
7ebe3962
 #include "libavutil/internal.h"
38f06a14
 #include "libavutil/intreadwrite.h"
7ebe3962
 #include "libavutil/mem.h"
f7cd9eed
 #include "avcodec.h"
594d4d5d
 #include "internal.h"
f7cd9eed
 #include "libschroedinger.h"
 
 #include <schroedinger/schro.h>
 #include <schroedinger/schrodebug.h>
 #include <schroedinger/schrovideoformat.h>
 
38f06a14
 /** SchroFrame and Pts relation */
 typedef struct LibSchroFrameContext {
      SchroFrame *frame;
      int64_t pts;
 } LibSchroFrameContext;
 
f7cd9eed
 /** libschroedinger decoder private data */
45235d69
 typedef struct SchroDecoderParams {
f7cd9eed
     /** Schroedinger video format */
     SchroVideoFormat *format;
 
     /** Schroedinger frame format */
     SchroFrameFormat frame_format;
 
     /** decoder handle */
     SchroDecoder* decoder;
 
     /** queue storing decoded frames */
9cef0669
     FFSchroQueue dec_frame_queue;
f7cd9eed
 
     /** end of sequence signalled */
     int eos_signalled;
 
     /** end of sequence pulled */
     int eos_pulled;
 
     /** decoded picture */
38f06a14
     AVFrame dec_frame;
45235d69
 } SchroDecoderParams;
f7cd9eed
 
45235d69
 typedef struct SchroParseUnitContext {
733cec1d
     const uint8_t *buf;
     int           buf_size;
45235d69
 } SchroParseUnitContext;
733cec1d
 
 
0ebe3b8e
 static void libschroedinger_decode_buffer_free(SchroBuffer *schro_buf,
1f4f7521
                                                void *priv)
 {
     av_freep(&priv);
 }
733cec1d
 
fdc91863
 static void parse_context_init(SchroParseUnitContext *parse_ctx,
                                const uint8_t *buf, int buf_size)
733cec1d
 {
     parse_ctx->buf           = buf;
     parse_ctx->buf_size      = buf_size;
 }
 
fdc91863
 static SchroBuffer *find_next_parse_unit(SchroParseUnitContext *parse_ctx)
733cec1d
 {
     SchroBuffer *enc_buf = NULL;
     int next_pu_offset = 0;
     unsigned char *in_buf;
 
     if (parse_ctx->buf_size < 13 ||
         parse_ctx->buf[0] != 'B' ||
         parse_ctx->buf[1] != 'B' ||
         parse_ctx->buf[2] != 'C' ||
         parse_ctx->buf[3] != 'D')
         return NULL;
 
     next_pu_offset = (parse_ctx->buf[5] << 24) +
                      (parse_ctx->buf[6] << 16) +
                      (parse_ctx->buf[7] <<  8) +
                       parse_ctx->buf[8];
 
     if (next_pu_offset == 0 &&
         SCHRO_PARSE_CODE_IS_END_OF_SEQUENCE(parse_ctx->buf[4]))
         next_pu_offset = 13;
 
     if (next_pu_offset <= 0 || parse_ctx->buf_size < next_pu_offset)
         return NULL;
 
     in_buf = av_malloc(next_pu_offset);
a7fa5ce6
     if (!in_buf) {
         av_log(parse_ctx, AV_LOG_ERROR, "Unable to allocate input buffer\n");
         return NULL;
     }
 
0ebe3b8e
     memcpy(in_buf, parse_ctx->buf, next_pu_offset);
     enc_buf       = schro_buffer_new_with_data(in_buf, next_pu_offset);
733cec1d
     enc_buf->free = libschroedinger_decode_buffer_free;
     enc_buf->priv = in_buf;
 
0ebe3b8e
     parse_ctx->buf      += next_pu_offset;
733cec1d
     parse_ctx->buf_size -= next_pu_offset;
 
     return enc_buf;
 }
 
f7cd9eed
 /**
2d2b5a14
 * Returns FFmpeg chroma format.
f7cd9eed
 */
716d413c
 static enum AVPixelFormat get_chroma_format(SchroChromaFormat schro_pix_fmt)
f7cd9eed
 {
45235d69
     int num_formats = sizeof(schro_pixel_format_map) /
                       sizeof(schro_pixel_format_map[0]);
f7cd9eed
     int idx;
 
735a3804
     for (idx = 0; idx < num_formats; ++idx)
45235d69
         if (schro_pixel_format_map[idx].schro_pix_fmt == schro_pix_fmt)
             return schro_pixel_format_map[idx].ff_pix_fmt;
716d413c
     return AV_PIX_FMT_NONE;
f7cd9eed
 }
 
5ef251e5
 static av_cold int libschroedinger_decode_init(AVCodecContext *avccontext)
f7cd9eed
 {
 
45235d69
     SchroDecoderParams *p_schro_params = avccontext->priv_data;
f7cd9eed
     /* First of all, initialize our supporting libraries. */
     schro_init();
 
     schro_debug_set_level(avccontext->debug);
0ebe3b8e
     p_schro_params->decoder = schro_decoder_new();
f7cd9eed
     schro_decoder_set_skip_ratio(p_schro_params->decoder, 1);
 
     if (!p_schro_params->decoder)
         return -1;
 
     /* Initialize the decoded frame queue. */
9cef0669
     ff_schro_queue_init(&p_schro_params->dec_frame_queue);
0ebe3b8e
     return 0;
f7cd9eed
 }
 
0ebe3b8e
 static void libschroedinger_decode_frame_free(void *frame)
f7cd9eed
 {
     schro_frame_unref(frame);
 }
 
 static void libschroedinger_handle_first_access_unit(AVCodecContext *avccontext)
 {
45235d69
     SchroDecoderParams *p_schro_params = avccontext->priv_data;
f7cd9eed
     SchroDecoder *decoder = p_schro_params->decoder;
 
0ebe3b8e
     p_schro_params->format = schro_decoder_get_video_format(decoder);
f7cd9eed
 
2d2b5a14
     /* Tell FFmpeg about sequence details. */
38f06a14
     if (av_image_check_size(p_schro_params->format->width,
                             p_schro_params->format->height, 0, avccontext) < 0) {
f7cd9eed
         av_log(avccontext, AV_LOG_ERROR, "invalid dimensions (%dx%d)\n",
                p_schro_params->format->width, p_schro_params->format->height);
         avccontext->height = avccontext->width = 0;
35027edd
         return;
f7cd9eed
     }
     avccontext->height  = p_schro_params->format->height;
     avccontext->width   = p_schro_params->format->width;
45235d69
     avccontext->pix_fmt = get_chroma_format(p_schro_params->format->chroma_format);
0ebe3b8e
 
     if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
                                   &p_schro_params->frame_format) == -1) {
         av_log(avccontext, AV_LOG_ERROR,
                "This codec currently only supports planar YUV 4:2:0, 4:2:2 "
                "and 4:4:4 formats.\n");
35027edd
         return;
f7cd9eed
     }
 
     avccontext->time_base.den = p_schro_params->format->frame_rate_numerator;
     avccontext->time_base.num = p_schro_params->format->frame_rate_denominator;
 }
 
 static int libschroedinger_decode_frame(AVCodecContext *avccontext,
df9b9567
                                         void *data, int *got_frame,
7a00bbad
                                         AVPacket *avpkt)
f7cd9eed
 {
7a00bbad
     const uint8_t *buf = avpkt->data;
     int buf_size = avpkt->size;
38f06a14
     int64_t pts  = avpkt->pts;
     SchroTag *tag;
f7cd9eed
 
45235d69
     SchroDecoderParams *p_schro_params = avccontext->priv_data;
f7cd9eed
     SchroDecoder *decoder = p_schro_params->decoder;
     SchroBuffer *enc_buf;
     SchroFrame* frame;
     int state;
     int go = 1;
733cec1d
     int outer = 1;
45235d69
     SchroParseUnitContext parse_ctx;
38f06a14
     LibSchroFrameContext *framewithpts = NULL;
f7cd9eed
 
df9b9567
     *got_frame = 0;
f7cd9eed
 
fdc91863
     parse_context_init(&parse_ctx, buf, buf_size);
7c809dc3
     if (!buf_size) {
f7cd9eed
         if (!p_schro_params->eos_signalled) {
             state = schro_decoder_push_end_of_stream(decoder);
             p_schro_params->eos_signalled = 1;
         }
     }
 
733cec1d
     /* Loop through all the individual parse units in the input buffer */
     do {
fdc91863
         if ((enc_buf = find_next_parse_unit(&parse_ctx))) {
38f06a14
             /* Set Schrotag with the pts to be recovered after decoding*/
             enc_buf->tag = schro_tag_new(av_malloc(sizeof(int64_t)), av_free);
             if (!enc_buf->tag->value) {
                 av_log(avccontext, AV_LOG_ERROR, "Unable to allocate SchroTag\n");
                 return AVERROR(ENOMEM);
             }
             AV_WN(64, enc_buf->tag->value, pts);
733cec1d
             /* Push buffer into decoder. */
64bfc584
             if (SCHRO_PARSE_CODE_IS_PICTURE(enc_buf->data[4]) &&
                 SCHRO_PARSE_CODE_NUM_REFS(enc_buf->data[4]) > 0)
                 avccontext->has_b_frames = 1;
0ebe3b8e
             state = schro_decoder_push(decoder, enc_buf);
733cec1d
             if (state == SCHRO_DECODER_FIRST_ACCESS_UNIT)
0ebe3b8e
                 libschroedinger_handle_first_access_unit(avccontext);
733cec1d
             go = 1;
0ebe3b8e
         } else
733cec1d
             outer = 0;
0ebe3b8e
 
         while (go) {
             /* Parse data and process result. */
             state = schro_decoder_wait(decoder);
             switch (state) {
             case SCHRO_DECODER_FIRST_ACCESS_UNIT:
                 libschroedinger_handle_first_access_unit(avccontext);
                 break;
 
             case SCHRO_DECODER_NEED_BITS:
                 /* Need more input data - stop iterating over what we have. */
                 go = 0;
                 break;
 
             case SCHRO_DECODER_NEED_FRAME:
                 /* Decoder needs a frame - create one and push it in. */
d15f2e00
                 frame = ff_create_schro_frame(avccontext,
                                               p_schro_params->frame_format);
0ebe3b8e
                 schro_decoder_add_output_picture(decoder, frame);
                 break;
 
             case SCHRO_DECODER_OK:
                 /* Pull a frame out of the decoder. */
38f06a14
                 tag   = schro_decoder_get_picture_tag(decoder);
0ebe3b8e
                 frame = schro_decoder_pull(decoder);
 
38f06a14
                 if (frame) {
                     /* Add relation between schroframe and pts. */
                     framewithpts = av_malloc(sizeof(LibSchroFrameContext));
                     if (!framewithpts) {
                         av_log(avccontext, AV_LOG_ERROR, "Unable to allocate FrameWithPts\n");
                         return AVERROR(ENOMEM);
                     }
                     framewithpts->frame = frame;
                     framewithpts->pts   = AV_RN64(tag->value);
9cef0669
                     ff_schro_queue_push_back(&p_schro_params->dec_frame_queue,
38f06a14
                                              framewithpts);
                 }
0ebe3b8e
                 break;
             case SCHRO_DECODER_EOS:
                 go = 0;
                 p_schro_params->eos_pulled = 1;
                 schro_decoder_reset(decoder);
                 outer = 0;
                 break;
 
             case SCHRO_DECODER_ERROR:
                 return -1;
                 break;
             }
f7cd9eed
         }
0ebe3b8e
     } while (outer);
f7cd9eed
 
     /* Grab next frame to be returned from the top of the queue. */
38f06a14
     framewithpts = ff_schro_queue_pop(&p_schro_params->dec_frame_queue);
 
     if (framewithpts && framewithpts->frame) {
         if (p_schro_params->dec_frame.data[0])
             avccontext->release_buffer(avccontext, &p_schro_params->dec_frame);
594d4d5d
         if (ff_get_buffer(avccontext, &p_schro_params->dec_frame) < 0) {
38f06a14
             av_log(avccontext, AV_LOG_ERROR, "Unable to allocate buffer\n");
             return AVERROR(ENOMEM);
         }
f7cd9eed
 
38f06a14
         memcpy(p_schro_params->dec_frame.data[0],
                framewithpts->frame->components[0].data,
                framewithpts->frame->components[0].length);
f7cd9eed
 
38f06a14
         memcpy(p_schro_params->dec_frame.data[1],
                framewithpts->frame->components[1].data,
                framewithpts->frame->components[1].length);
f7cd9eed
 
38f06a14
         memcpy(p_schro_params->dec_frame.data[2],
                framewithpts->frame->components[2].data,
                framewithpts->frame->components[2].length);
f7cd9eed
 
38f06a14
         /* Fill frame with current buffer data from Schroedinger. */
         p_schro_params->dec_frame.format  = -1; /* Unknown -1 */
         p_schro_params->dec_frame.width   = framewithpts->frame->width;
         p_schro_params->dec_frame.height  = framewithpts->frame->height;
         p_schro_params->dec_frame.pkt_pts = framewithpts->pts;
         p_schro_params->dec_frame.linesize[0] = framewithpts->frame->components[0].stride;
         p_schro_params->dec_frame.linesize[1] = framewithpts->frame->components[1].stride;
         p_schro_params->dec_frame.linesize[2] = framewithpts->frame->components[2].stride;
f7cd9eed
 
38f06a14
         *(AVFrame*)data = p_schro_params->dec_frame;
df9b9567
         *got_frame      = 1;
f7cd9eed
 
         /* Now free the frame resources. */
38f06a14
         libschroedinger_decode_frame_free(framewithpts->frame);
         av_free(framewithpts);
     } else {
         data       = NULL;
df9b9567
         *got_frame = 0;
f7cd9eed
     }
     return buf_size;
 }
 
 
5ef251e5
 static av_cold int libschroedinger_decode_close(AVCodecContext *avccontext)
f7cd9eed
 {
45235d69
     SchroDecoderParams *p_schro_params = avccontext->priv_data;
f7cd9eed
     /* Free the decoder. */
0ebe3b8e
     schro_decoder_free(p_schro_params->decoder);
f7cd9eed
     av_freep(&p_schro_params->format);
 
38f06a14
     if (p_schro_params->dec_frame.data[0])
         avccontext->release_buffer(avccontext, &p_schro_params->dec_frame);
f7cd9eed
 
     /* Free data in the output frame queue. */
9cef0669
     ff_schro_queue_free(&p_schro_params->dec_frame_queue,
                         libschroedinger_decode_frame_free);
f7cd9eed
 
0ebe3b8e
     return 0;
f7cd9eed
 }
 
0ebe3b8e
 static void libschroedinger_flush(AVCodecContext *avccontext)
f7cd9eed
 {
     /* Got a seek request. Free the decoded frames queue and then reset
      * the decoder */
45235d69
     SchroDecoderParams *p_schro_params = avccontext->priv_data;
f7cd9eed
 
     /* Free data in the output frame queue. */
9cef0669
     ff_schro_queue_free(&p_schro_params->dec_frame_queue,
                         libschroedinger_decode_frame_free);
f7cd9eed
 
9cef0669
     ff_schro_queue_init(&p_schro_params->dec_frame_queue);
f7cd9eed
     schro_decoder_reset(p_schro_params->decoder);
     p_schro_params->eos_pulled = 0;
     p_schro_params->eos_signalled = 0;
 }
 
e7e2df27
 AVCodec ff_libschroedinger_decoder = {
ec6402b7
     .name           = "libschroedinger",
     .type           = AVMEDIA_TYPE_VIDEO,
36ef5369
     .id             = AV_CODEC_ID_DIRAC,
45235d69
     .priv_data_size = sizeof(SchroDecoderParams),
ec6402b7
     .init           = libschroedinger_decode_init,
     .close          = libschroedinger_decode_close,
     .decode         = libschroedinger_decode_frame,
     .capabilities   = CODEC_CAP_DELAY,
00c3b67b
     .flush          = libschroedinger_flush,
     .long_name      = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),
f7cd9eed
 };