libavcodec/libschroedingerenc.c
f7cd9eed
 /*
  * Dirac encoder 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 encoder 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).
 */
 
 #include <schroedinger/schro.h>
 #include <schroedinger/schrodebug.h>
 #include <schroedinger/schrovideoformat.h>
 
6fee1b90
 #include "libavutil/attributes.h"
72a9e646
 #include "libavutil/avassert.h"
f7cd9eed
 #include "avcodec.h"
df53a473
 #include "internal.h"
f7cd9eed
 #include "libschroedinger.h"
37284120
 #include "bytestream.h"
f7cd9eed
 
 
 /** libschroedinger encoder private data */
45235d69
 typedef struct SchroEncoderParams {
f7cd9eed
     /** Schroedinger video format */
     SchroVideoFormat *format;
 
     /** Schroedinger frame format */
     SchroFrameFormat frame_format;
 
     /** frame size */
     int frame_size;
 
     /** Schroedinger encoder handle*/
     SchroEncoder* encoder;
 
007f67b0
     /** buffer to store encoder output before writing it to the frame queue*/
     unsigned char *enc_buf;
 
     /** Size of encoder buffer*/
     int enc_buf_size;
 
f7cd9eed
     /** queue storing encoded frames */
9cef0669
     FFSchroQueue enc_frame_queue;
f7cd9eed
 
     /** end of sequence signalled */
     int eos_signalled;
 
     /** end of sequence pulled */
     int eos_pulled;
df53a473
 
     /* counter for frames submitted to encoder, used as dts */
     int64_t dts;
45235d69
 } SchroEncoderParams;
f7cd9eed
 
 /**
 * Works out Schro-compatible chroma format.
 */
699d02b8
 static int set_chroma_format(AVCodecContext *avctx)
f7cd9eed
 {
45235d69
     int num_formats = sizeof(schro_pixel_format_map) /
                       sizeof(schro_pixel_format_map[0]);
f7cd9eed
     int idx;
 
699d02b8
     SchroEncoderParams *p_schro_params = avctx->priv_data;
f7cd9eed
 
     for (idx = 0; idx < num_formats; ++idx) {
699d02b8
         if (schro_pixel_format_map[idx].ff_pix_fmt == avctx->pix_fmt) {
f7cd9eed
             p_schro_params->format->chroma_format =
45235d69
                             schro_pixel_format_map[idx].schro_pix_fmt;
f7cd9eed
             return 0;
         }
     }
 
699d02b8
     av_log(avctx, AV_LOG_ERROR,
0ebe3b8e
            "This codec currently only supports planar YUV 4:2:0, 4:2:2"
            " and 4:4:4 formats.\n");
f7cd9eed
 
     return -1;
 }
 
6fee1b90
 static av_cold int libschroedinger_encode_init(AVCodecContext *avctx)
f7cd9eed
 {
699d02b8
     SchroEncoderParams *p_schro_params = avctx->priv_data;
f7cd9eed
     SchroVideoFormatEnum preset;
 
     /* Initialize the libraries that libschroedinger depends on. */
     schro_init();
 
     /* Create an encoder object. */
     p_schro_params->encoder = schro_encoder_new();
 
     if (!p_schro_params->encoder) {
699d02b8
         av_log(avctx, AV_LOG_ERROR,
f7cd9eed
                "Unrecoverable Error: schro_encoder_new failed. ");
         return -1;
     }
 
     /* Initialize the format. */
699d02b8
     preset = ff_get_schro_video_format_preset(avctx);
f7cd9eed
     p_schro_params->format =
                     schro_encoder_get_video_format(p_schro_params->encoder);
0ebe3b8e
     schro_video_format_set_std_video_format(p_schro_params->format, preset);
699d02b8
     p_schro_params->format->width  = avctx->width;
     p_schro_params->format->height = avctx->height;
f7cd9eed
 
699d02b8
     if (set_chroma_format(avctx) == -1)
f7cd9eed
         return -1;
 
699d02b8
     if (avctx->color_primaries == AVCOL_PRI_BT709) {
e9d96831
         p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_HDTV;
699d02b8
     } else if (avctx->color_primaries == AVCOL_PRI_BT470BG) {
e9d96831
         p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_625;
699d02b8
     } else if (avctx->color_primaries == AVCOL_PRI_SMPTE170M) {
e9d96831
         p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_525;
     }
 
699d02b8
     if (avctx->colorspace == AVCOL_SPC_BT709) {
e9d96831
         p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_HDTV;
699d02b8
     } else if (avctx->colorspace == AVCOL_SPC_BT470BG) {
e9d96831
         p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_SDTV;
     }
 
699d02b8
     if (avctx->color_trc == AVCOL_TRC_BT709) {
e9d96831
         p_schro_params->format->transfer_function = SCHRO_TRANSFER_CHAR_TV_GAMMA;
     }
 
f7cd9eed
     if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
                                   &p_schro_params->frame_format) == -1) {
699d02b8
         av_log(avctx, AV_LOG_ERROR,
0ebe3b8e
                "This codec currently supports only planar YUV 4:2:0, 4:2:2"
                " and 4:4:4 formats.\n");
f7cd9eed
         return -1;
     }
 
699d02b8
     p_schro_params->format->frame_rate_numerator   = avctx->time_base.den;
     p_schro_params->format->frame_rate_denominator = avctx->time_base.num;
f7cd9eed
 
699d02b8
     p_schro_params->frame_size = avpicture_get_size(avctx->pix_fmt,
                                                     avctx->width,
                                                     avctx->height);
f7cd9eed
 
37226285
     avctx->coded_frame = av_frame_alloc();
     if (!avctx->coded_frame)
         return AVERROR(ENOMEM);
f7cd9eed
 
699d02b8
     if (!avctx->gop_size) {
0ebe3b8e
         schro_encoder_setting_set_double(p_schro_params->encoder,
                                          "gop_structure",
                                          SCHRO_ENCODER_GOP_INTRA_ONLY);
d7c96d66
 
699d02b8
         if (avctx->coder_type == FF_CODER_TYPE_VLC)
0ebe3b8e
             schro_encoder_setting_set_double(p_schro_params->encoder,
                                              "enable_noarith", 1);
     } else {
3d6fa004
         schro_encoder_setting_set_double(p_schro_params->encoder,
699d02b8
                                          "au_distance", avctx->gop_size);
         avctx->has_b_frames = 1;
df53a473
         p_schro_params->dts = -1;
f7cd9eed
     }
 
     /* FIXME - Need to handle SCHRO_ENCODER_RATE_CONTROL_LOW_DELAY. */
699d02b8
     if (avctx->flags & CODEC_FLAG_QSCALE) {
         if (!avctx->global_quality) {
f7cd9eed
             /* lossless coding */
0ebe3b8e
             schro_encoder_setting_set_double(p_schro_params->encoder,
                                              "rate_control",
                                              SCHRO_ENCODER_RATE_CONTROL_LOSSLESS);
f7cd9eed
         } else {
e0a24555
             int quality;
0ebe3b8e
             schro_encoder_setting_set_double(p_schro_params->encoder,
                                              "rate_control",
e0a24555
                                              SCHRO_ENCODER_RATE_CONTROL_CONSTANT_QUALITY);
f7cd9eed
 
699d02b8
             quality = avctx->global_quality / FF_QP2LAMBDA;
e0a24555
             if (quality > 10)
                 quality = 10;
0ebe3b8e
             schro_encoder_setting_set_double(p_schro_params->encoder,
e0a24555
                                              "quality", quality);
f7cd9eed
         }
0ebe3b8e
     } else {
         schro_encoder_setting_set_double(p_schro_params->encoder,
                                          "rate_control",
                                          SCHRO_ENCODER_RATE_CONTROL_CONSTANT_BITRATE);
f7cd9eed
 
0ebe3b8e
         schro_encoder_setting_set_double(p_schro_params->encoder,
699d02b8
                                          "bitrate", avctx->bit_rate);
f7cd9eed
     }
 
699d02b8
     if (avctx->flags & CODEC_FLAG_INTERLACED_ME)
f7cd9eed
         /* All material can be coded as interlaced or progressive
            irrespective of the type of source material. */
0ebe3b8e
         schro_encoder_setting_set_double(p_schro_params->encoder,
                                          "interlaced_coding", 1);
f7cd9eed
 
31cf8c65
     schro_encoder_setting_set_double(p_schro_params->encoder, "open_gop",
699d02b8
                                      !(avctx->flags & CODEC_FLAG_CLOSED_GOP));
31cf8c65
 
f7cd9eed
     /* FIXME: Signal range hardcoded to 8-bit data until both libschroedinger
      * and libdirac support other bit-depth data. */
     schro_video_format_set_std_signal_range(p_schro_params->format,
                                             SCHRO_SIGNAL_RANGE_8BIT_VIDEO);
 
     /* Set the encoder format. */
     schro_encoder_set_video_format(p_schro_params->encoder,
                                    p_schro_params->format);
 
     /* Set the debug level. */
699d02b8
     schro_debug_set_level(avctx->debug);
f7cd9eed
 
0ebe3b8e
     schro_encoder_start(p_schro_params->encoder);
f7cd9eed
 
     /* Initialize the encoded frame queue. */
9cef0669
     ff_schro_queue_init(&p_schro_params->enc_frame_queue);
0ebe3b8e
     return 0;
f7cd9eed
 }
 
699d02b8
 static SchroFrame *libschroedinger_frame_from_data(AVCodecContext *avctx,
df53a473
                                                    const AVFrame *frame)
f7cd9eed
 {
699d02b8
     SchroEncoderParams *p_schro_params = avctx->priv_data;
f7cd9eed
     SchroFrame *in_frame;
     /* Input line size may differ from what the codec supports. Especially
      * when transcoding from one format to another. So use avpicture_layout
      * to copy the frame. */
699d02b8
     in_frame = ff_create_schro_frame(avctx, p_schro_params->frame_format);
d15f2e00
 
     if (in_frame)
699d02b8
         avpicture_layout((const AVPicture *)frame, avctx->pix_fmt,
                           avctx->width, avctx->height,
d15f2e00
                           in_frame->components[0].data,
                           p_schro_params->frame_size);
f7cd9eed
 
     return in_frame;
 }
 
fdc91863
 static void libschroedinger_free_frame(void *data)
f7cd9eed
 {
9cef0669
     FFSchroEncodedFrame *enc_frame = data;
f7cd9eed
 
3dc99a18
     av_freep(&enc_frame->p_encbuf);
f7cd9eed
     av_free(enc_frame);
 }
 
699d02b8
 static int libschroedinger_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
df53a473
                                         const AVFrame *frame, int *got_packet)
f7cd9eed
 {
     int enc_size = 0;
699d02b8
     SchroEncoderParams *p_schro_params = avctx->priv_data;
f7cd9eed
     SchroEncoder *encoder = p_schro_params->encoder;
9cef0669
     struct FFSchroEncodedFrame *p_frame_output = NULL;
f7cd9eed
     int go = 1;
     SchroBuffer *enc_buf;
     int presentation_frame;
     int parse_code;
007f67b0
     int last_frame_in_sequence = 0;
df53a473
     int pkt_size, ret;
f7cd9eed
 
df53a473
     if (!frame) {
f7cd9eed
         /* Push end of sequence if not already signalled. */
         if (!p_schro_params->eos_signalled) {
             schro_encoder_end_of_stream(encoder);
             p_schro_params->eos_signalled = 1;
         }
     } else {
         /* Allocate frame data to schro input buffer. */
699d02b8
         SchroFrame *in_frame = libschroedinger_frame_from_data(avctx, frame);
f7cd9eed
         /* Load next frame. */
         schro_encoder_push_frame(encoder, in_frame);
     }
 
     if (p_schro_params->eos_pulled)
         go = 0;
 
     /* Now check to see if we have any output from the encoder. */
     while (go) {
9b8d11a7
         int err;
0ebe3b8e
         SchroStateEnum state;
f7cd9eed
         state = schro_encoder_wait(encoder);
0ebe3b8e
         switch (state) {
f7cd9eed
         case SCHRO_STATE_HAVE_BUFFER:
         case SCHRO_STATE_END_OF_STREAM:
0ebe3b8e
             enc_buf = schro_encoder_pull(encoder, &presentation_frame);
6f270da6
             if (enc_buf->length <= 0)
                 return AVERROR_BUG;
007f67b0
             parse_code = enc_buf->data[4];
 
             /* All non-frame data is prepended to actual frame data to
              * be able to set the pts correctly. So we don't write data
              * to the frame output queue until we actually have a frame
              */
9b8d11a7
             if ((err = av_reallocp(&p_schro_params->enc_buf,
                                    p_schro_params->enc_buf_size +
                                    enc_buf->length)) < 0) {
                 p_schro_params->enc_buf_size = 0;
                 return err;
             }
007f67b0
 
0ebe3b8e
             memcpy(p_schro_params->enc_buf + p_schro_params->enc_buf_size,
007f67b0
                    enc_buf->data, enc_buf->length);
             p_schro_params->enc_buf_size += enc_buf->length;
 
 
             if (state == SCHRO_STATE_END_OF_STREAM) {
                 p_schro_params->eos_pulled = 1;
                 go = 0;
             }
 
             if (!SCHRO_PARSE_CODE_IS_PICTURE(parse_code)) {
0ebe3b8e
                 schro_buffer_unref(enc_buf);
007f67b0
                 break;
             }
f7cd9eed
 
             /* Create output frame. */
9cef0669
             p_frame_output = av_mallocz(sizeof(FFSchroEncodedFrame));
f7cd9eed
             /* Set output data. */
007f67b0
             p_frame_output->size     = p_schro_params->enc_buf_size;
             p_frame_output->p_encbuf = p_schro_params->enc_buf;
f7cd9eed
             if (SCHRO_PARSE_CODE_IS_INTRA(parse_code) &&
735a3804
                 SCHRO_PARSE_CODE_IS_REFERENCE(parse_code))
f7cd9eed
                 p_frame_output->key_frame = 1;
 
             /* Parse the coded frame number from the bitstream. Bytes 14
              * through 17 represesent the frame number. */
37284120
             p_frame_output->frame_num = AV_RB32(enc_buf->data + 13);
f7cd9eed
 
9cef0669
             ff_schro_queue_push_back(&p_schro_params->enc_frame_queue,
                                      p_frame_output);
007f67b0
             p_schro_params->enc_buf_size = 0;
             p_schro_params->enc_buf      = NULL;
 
0ebe3b8e
             schro_buffer_unref(enc_buf);
f7cd9eed
 
             break;
 
         case SCHRO_STATE_NEED_FRAME:
             go = 0;
             break;
 
         case SCHRO_STATE_AGAIN:
             break;
 
         default:
699d02b8
             av_log(avctx, AV_LOG_ERROR, "Unknown Schro Encoder state\n");
f7cd9eed
             return -1;
         }
     }
 
     /* Copy 'next' frame in queue. */
007f67b0
 
     if (p_schro_params->enc_frame_queue.size == 1 &&
         p_schro_params->eos_pulled)
         last_frame_in_sequence = 1;
 
9cef0669
     p_frame_output = ff_schro_queue_pop(&p_schro_params->enc_frame_queue);
f7cd9eed
 
7c809dc3
     if (!p_frame_output)
f7cd9eed
         return 0;
 
df53a473
     pkt_size = p_frame_output->size;
     if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0)
         pkt_size += p_schro_params->enc_buf_size;
6fbddc80
     if ((ret = ff_alloc_packet2(avctx, pkt, pkt_size)) < 0)
df53a473
         goto error;
 
     memcpy(pkt->data, p_frame_output->p_encbuf, p_frame_output->size);
699d02b8
     avctx->coded_frame->key_frame = p_frame_output->key_frame;
f7cd9eed
     /* Use the frame number of the encoded frame as the pts. It is OK to
      * do so since Dirac is a constant frame rate codec. It expects input
      * to be of constant frame rate. */
df53a473
     pkt->pts =
699d02b8
     avctx->coded_frame->pts = p_frame_output->frame_num;
df53a473
     pkt->dts = p_schro_params->dts++;
f7cd9eed
     enc_size = p_frame_output->size;
 
007f67b0
     /* Append the end of sequence information to the last frame in the
      * sequence. */
0ebe3b8e
     if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0) {
df53a473
         memcpy(pkt->data + enc_size, p_schro_params->enc_buf,
0ebe3b8e
                p_schro_params->enc_buf_size);
007f67b0
         enc_size += p_schro_params->enc_buf_size;
0ebe3b8e
         av_freep(&p_schro_params->enc_buf);
007f67b0
         p_schro_params->enc_buf_size = 0;
     }
 
df53a473
     if (p_frame_output->key_frame)
         pkt->flags |= AV_PKT_FLAG_KEY;
     *got_packet = 1;
 
 error:
f7cd9eed
     /* free frame */
fdc91863
     libschroedinger_free_frame(p_frame_output);
df53a473
     return ret;
f7cd9eed
 }
 
 
699d02b8
 static int libschroedinger_encode_close(AVCodecContext *avctx)
f7cd9eed
 {
699d02b8
     SchroEncoderParams *p_schro_params = avctx->priv_data;
f7cd9eed
 
0ebe3b8e
     /* Close the encoder. */
f7cd9eed
     schro_encoder_free(p_schro_params->encoder);
 
     /* Free data in the output frame queue. */
9cef0669
     ff_schro_queue_free(&p_schro_params->enc_frame_queue,
fdc91863
                         libschroedinger_free_frame);
f7cd9eed
 
007f67b0
 
     /* Free the encoder buffer. */
     if (p_schro_params->enc_buf_size)
         av_freep(&p_schro_params->enc_buf);
 
f7cd9eed
     /* Free the video format structure. */
     av_freep(&p_schro_params->format);
 
37226285
     av_frame_free(&avctx->coded_frame);
 
0ebe3b8e
     return 0;
f7cd9eed
 }
 
 
e7e2df27
 AVCodec ff_libschroedinger_encoder = {
ec6402b7
     .name           = "libschroedinger",
b2bed932
     .long_name      = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),
ec6402b7
     .type           = AVMEDIA_TYPE_VIDEO,
36ef5369
     .id             = AV_CODEC_ID_DIRAC,
45235d69
     .priv_data_size = sizeof(SchroEncoderParams),
ec6402b7
     .init           = libschroedinger_encode_init,
df53a473
     .encode2        = libschroedinger_encode_frame,
ec6402b7
     .close          = libschroedinger_encode_close,
00c3b67b
     .capabilities   = CODEC_CAP_DELAY,
716d413c
     .pix_fmts       = (const enum AVPixelFormat[]){
         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_NONE
00c3b67b
     },
f7cd9eed
 };