yading@10: /*
yading@10:  * Dirac encoder support via Schroedinger libraries
yading@10:  * Copyright (c) 2008 BBC, Anuradha Suraparaju <asuraparaju at gmail dot com >
yading@10:  *
yading@10:  * This file is part of FFmpeg.
yading@10:  *
yading@10:  * FFmpeg is free software; you can redistribute it and/or
yading@10:  * modify it under the terms of the GNU Lesser General Public
yading@10:  * License as published by the Free Software Foundation; either
yading@10:  * version 2.1 of the License, or (at your option) any later version.
yading@10:  *
yading@10:  * FFmpeg is distributed in the hope that it will be useful,
yading@10:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@10:  * Lesser General Public License for more details.
yading@10:  *
yading@10:  * You should have received a copy of the GNU Lesser General Public
yading@10:  * License along with FFmpeg; if not, write to the Free Software
yading@10:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@10:  */
yading@10: 
yading@10: /**
yading@10: * @file
yading@10: * Dirac encoder support via libschroedinger-1.0 libraries. More details about
yading@10: * the Schroedinger project can be found at http://www.diracvideo.org/.
yading@10: * The library implements Dirac Specification Version 2.2
yading@10: * (http://dirac.sourceforge.net/specification.html).
yading@10: */
yading@10: 
yading@10: #include <schroedinger/schro.h>
yading@10: #include <schroedinger/schrodebug.h>
yading@10: #include <schroedinger/schrovideoformat.h>
yading@10: 
yading@10: #include "libavutil/avassert.h"
yading@10: #include "avcodec.h"
yading@10: #include "internal.h"
yading@10: #include "libschroedinger.h"
yading@10: #include "bytestream.h"
yading@10: 
yading@10: 
yading@10: /** libschroedinger encoder private data */
yading@10: typedef struct SchroEncoderParams {
yading@10:     /** Schroedinger video format */
yading@10:     SchroVideoFormat *format;
yading@10: 
yading@10:     /** Schroedinger frame format */
yading@10:     SchroFrameFormat frame_format;
yading@10: 
yading@10:     /** frame being encoded */
yading@10:     AVFrame picture;
yading@10: 
yading@10:     /** frame size */
yading@10:     int frame_size;
yading@10: 
yading@10:     /** Schroedinger encoder handle*/
yading@10:     SchroEncoder* encoder;
yading@10: 
yading@10:     /** buffer to store encoder output before writing it to the frame queue*/
yading@10:     unsigned char *enc_buf;
yading@10: 
yading@10:     /** Size of encoder buffer*/
yading@10:     int enc_buf_size;
yading@10: 
yading@10:     /** queue storing encoded frames */
yading@10:     FFSchroQueue enc_frame_queue;
yading@10: 
yading@10:     /** end of sequence signalled */
yading@10:     int eos_signalled;
yading@10: 
yading@10:     /** end of sequence pulled */
yading@10:     int eos_pulled;
yading@10: 
yading@10:     /* counter for frames submitted to encoder, used as dts */
yading@10:     int64_t dts;
yading@10: } SchroEncoderParams;
yading@10: 
yading@10: /**
yading@10: * Works out Schro-compatible chroma format.
yading@10: */
yading@10: static int set_chroma_format(AVCodecContext *avctx)
yading@10: {
yading@10:     int num_formats = sizeof(schro_pixel_format_map) /
yading@10:                       sizeof(schro_pixel_format_map[0]);
yading@10:     int idx;
yading@10: 
yading@10:     SchroEncoderParams *p_schro_params = avctx->priv_data;
yading@10: 
yading@10:     for (idx = 0; idx < num_formats; ++idx) {
yading@10:         if (schro_pixel_format_map[idx].ff_pix_fmt == avctx->pix_fmt) {
yading@10:             p_schro_params->format->chroma_format =
yading@10:                             schro_pixel_format_map[idx].schro_pix_fmt;
yading@10:             return 0;
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     av_log(avctx, AV_LOG_ERROR,
yading@10:            "This codec currently only supports planar YUV 4:2:0, 4:2:2"
yading@10:            " and 4:4:4 formats.\n");
yading@10: 
yading@10:     return -1;
yading@10: }
yading@10: 
yading@10: static int libschroedinger_encode_init(AVCodecContext *avctx)
yading@10: {
yading@10:     SchroEncoderParams *p_schro_params = avctx->priv_data;
yading@10:     SchroVideoFormatEnum preset;
yading@10: 
yading@10:     /* Initialize the libraries that libschroedinger depends on. */
yading@10:     schro_init();
yading@10: 
yading@10:     /* Create an encoder object. */
yading@10:     p_schro_params->encoder = schro_encoder_new();
yading@10: 
yading@10:     if (!p_schro_params->encoder) {
yading@10:         av_log(avctx, AV_LOG_ERROR,
yading@10:                "Unrecoverable Error: schro_encoder_new failed. ");
yading@10:         return -1;
yading@10:     }
yading@10: 
yading@10:     /* Initialize the format. */
yading@10:     preset = ff_get_schro_video_format_preset(avctx);
yading@10:     p_schro_params->format =
yading@10:                     schro_encoder_get_video_format(p_schro_params->encoder);
yading@10:     schro_video_format_set_std_video_format(p_schro_params->format, preset);
yading@10:     p_schro_params->format->width  = avctx->width;
yading@10:     p_schro_params->format->height = avctx->height;
yading@10: 
yading@10:     if (set_chroma_format(avctx) == -1)
yading@10:         return -1;
yading@10: 
yading@10:     if (avctx->color_primaries == AVCOL_PRI_BT709) {
yading@10:         p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_HDTV;
yading@10:     } else if (avctx->color_primaries == AVCOL_PRI_BT470BG) {
yading@10:         p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_625;
yading@10:     } else if (avctx->color_primaries == AVCOL_PRI_SMPTE170M) {
yading@10:         p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_525;
yading@10:     }
yading@10: 
yading@10:     if (avctx->colorspace == AVCOL_SPC_BT709) {
yading@10:         p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_HDTV;
yading@10:     } else if (avctx->colorspace == AVCOL_SPC_BT470BG) {
yading@10:         p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_SDTV;
yading@10:     }
yading@10: 
yading@10:     if (avctx->color_trc == AVCOL_TRC_BT709) {
yading@10:         p_schro_params->format->transfer_function = SCHRO_TRANSFER_CHAR_TV_GAMMA;
yading@10:     }
yading@10: 
yading@10:     if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
yading@10:                                   &p_schro_params->frame_format) == -1) {
yading@10:         av_log(avctx, AV_LOG_ERROR,
yading@10:                "This codec currently supports only planar YUV 4:2:0, 4:2:2"
yading@10:                " and 4:4:4 formats.\n");
yading@10:         return -1;
yading@10:     }
yading@10: 
yading@10:     p_schro_params->format->frame_rate_numerator   = avctx->time_base.den;
yading@10:     p_schro_params->format->frame_rate_denominator = avctx->time_base.num;
yading@10: 
yading@10:     p_schro_params->frame_size = avpicture_get_size(avctx->pix_fmt,
yading@10:                                                     avctx->width,
yading@10:                                                     avctx->height);
yading@10: 
yading@10:     avctx->coded_frame = &p_schro_params->picture;
yading@10: 
yading@10:     if (!avctx->gop_size) {
yading@10:         schro_encoder_setting_set_double(p_schro_params->encoder,
yading@10:                                          "gop_structure",
yading@10:                                          SCHRO_ENCODER_GOP_INTRA_ONLY);
yading@10: 
yading@10:         if (avctx->coder_type == FF_CODER_TYPE_VLC)
yading@10:             schro_encoder_setting_set_double(p_schro_params->encoder,
yading@10:                                              "enable_noarith", 1);
yading@10:     } else {
yading@10:         schro_encoder_setting_set_double(p_schro_params->encoder,
yading@10:                                          "au_distance", avctx->gop_size);
yading@10:         avctx->has_b_frames = 1;
yading@10:         p_schro_params->dts = -1;
yading@10:     }
yading@10: 
yading@10:     /* FIXME - Need to handle SCHRO_ENCODER_RATE_CONTROL_LOW_DELAY. */
yading@10:     if (avctx->flags & CODEC_FLAG_QSCALE) {
yading@10:         if (!avctx->global_quality) {
yading@10:             /* lossless coding */
yading@10:             schro_encoder_setting_set_double(p_schro_params->encoder,
yading@10:                                              "rate_control",
yading@10:                                              SCHRO_ENCODER_RATE_CONTROL_LOSSLESS);
yading@10:         } else {
yading@10:             int quality;
yading@10:             schro_encoder_setting_set_double(p_schro_params->encoder,
yading@10:                                              "rate_control",
yading@10:                                              SCHRO_ENCODER_RATE_CONTROL_CONSTANT_QUALITY);
yading@10: 
yading@10:             quality = avctx->global_quality / FF_QP2LAMBDA;
yading@10:             if (quality > 10)
yading@10:                 quality = 10;
yading@10:             schro_encoder_setting_set_double(p_schro_params->encoder,
yading@10:                                              "quality", quality);
yading@10:         }
yading@10:     } else {
yading@10:         schro_encoder_setting_set_double(p_schro_params->encoder,
yading@10:                                          "rate_control",
yading@10:                                          SCHRO_ENCODER_RATE_CONTROL_CONSTANT_BITRATE);
yading@10: 
yading@10:         schro_encoder_setting_set_double(p_schro_params->encoder,
yading@10:                                          "bitrate", avctx->bit_rate);
yading@10:     }
yading@10: 
yading@10:     if (avctx->flags & CODEC_FLAG_INTERLACED_ME)
yading@10:         /* All material can be coded as interlaced or progressive
yading@10:            irrespective of the type of source material. */
yading@10:         schro_encoder_setting_set_double(p_schro_params->encoder,
yading@10:                                          "interlaced_coding", 1);
yading@10: 
yading@10:     schro_encoder_setting_set_double(p_schro_params->encoder, "open_gop",
yading@10:                                      !(avctx->flags & CODEC_FLAG_CLOSED_GOP));
yading@10: 
yading@10:     /* FIXME: Signal range hardcoded to 8-bit data until both libschroedinger
yading@10:      * and libdirac support other bit-depth data. */
yading@10:     schro_video_format_set_std_signal_range(p_schro_params->format,
yading@10:                                             SCHRO_SIGNAL_RANGE_8BIT_VIDEO);
yading@10: 
yading@10:     /* Set the encoder format. */
yading@10:     schro_encoder_set_video_format(p_schro_params->encoder,
yading@10:                                    p_schro_params->format);
yading@10: 
yading@10:     /* Set the debug level. */
yading@10:     schro_debug_set_level(avctx->debug);
yading@10: 
yading@10:     schro_encoder_start(p_schro_params->encoder);
yading@10: 
yading@10:     /* Initialize the encoded frame queue. */
yading@10:     ff_schro_queue_init(&p_schro_params->enc_frame_queue);
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static SchroFrame *libschroedinger_frame_from_data(AVCodecContext *avctx,
yading@10:                                                    const AVFrame *frame)
yading@10: {
yading@10:     SchroEncoderParams *p_schro_params = avctx->priv_data;
yading@10:     SchroFrame *in_frame;
yading@10:     /* Input line size may differ from what the codec supports. Especially
yading@10:      * when transcoding from one format to another. So use avpicture_layout
yading@10:      * to copy the frame. */
yading@10:     in_frame = ff_create_schro_frame(avctx, p_schro_params->frame_format);
yading@10: 
yading@10:     if (in_frame)
yading@10:         avpicture_layout((const AVPicture *)frame, avctx->pix_fmt,
yading@10:                           avctx->width, avctx->height,
yading@10:                           in_frame->components[0].data,
yading@10:                           p_schro_params->frame_size);
yading@10: 
yading@10:     return in_frame;
yading@10: }
yading@10: 
yading@10: static void libschroedinger_free_frame(void *data)
yading@10: {
yading@10:     FFSchroEncodedFrame *enc_frame = data;
yading@10: 
yading@10:     av_freep(&enc_frame->p_encbuf);
yading@10:     av_free(enc_frame);
yading@10: }
yading@10: 
yading@10: static int libschroedinger_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
yading@10:                                         const AVFrame *frame, int *got_packet)
yading@10: {
yading@10:     int enc_size = 0;
yading@10:     SchroEncoderParams *p_schro_params = avctx->priv_data;
yading@10:     SchroEncoder *encoder = p_schro_params->encoder;
yading@10:     struct FFSchroEncodedFrame *p_frame_output = NULL;
yading@10:     int go = 1;
yading@10:     SchroBuffer *enc_buf;
yading@10:     int presentation_frame;
yading@10:     int parse_code;
yading@10:     int last_frame_in_sequence = 0;
yading@10:     int pkt_size, ret;
yading@10: 
yading@10:     if (!frame) {
yading@10:         /* Push end of sequence if not already signalled. */
yading@10:         if (!p_schro_params->eos_signalled) {
yading@10:             schro_encoder_end_of_stream(encoder);
yading@10:             p_schro_params->eos_signalled = 1;
yading@10:         }
yading@10:     } else {
yading@10:         /* Allocate frame data to schro input buffer. */
yading@10:         SchroFrame *in_frame = libschroedinger_frame_from_data(avctx, frame);
yading@10:         /* Load next frame. */
yading@10:         schro_encoder_push_frame(encoder, in_frame);
yading@10:     }
yading@10: 
yading@10:     if (p_schro_params->eos_pulled)
yading@10:         go = 0;
yading@10: 
yading@10:     /* Now check to see if we have any output from the encoder. */
yading@10:     while (go) {
yading@10:         SchroStateEnum state;
yading@10:         state = schro_encoder_wait(encoder);
yading@10:         switch (state) {
yading@10:         case SCHRO_STATE_HAVE_BUFFER:
yading@10:         case SCHRO_STATE_END_OF_STREAM:
yading@10:             enc_buf = schro_encoder_pull(encoder, &presentation_frame);
yading@10:             av_assert0(enc_buf->length > 0);
yading@10:             parse_code = enc_buf->data[4];
yading@10: 
yading@10:             /* All non-frame data is prepended to actual frame data to
yading@10:              * be able to set the pts correctly. So we don't write data
yading@10:              * to the frame output queue until we actually have a frame
yading@10:              */
yading@10:             p_schro_params->enc_buf = av_realloc(p_schro_params->enc_buf,
yading@10:                                                  p_schro_params->enc_buf_size + enc_buf->length);
yading@10: 
yading@10:             memcpy(p_schro_params->enc_buf + p_schro_params->enc_buf_size,
yading@10:                    enc_buf->data, enc_buf->length);
yading@10:             p_schro_params->enc_buf_size += enc_buf->length;
yading@10: 
yading@10: 
yading@10:             if (state == SCHRO_STATE_END_OF_STREAM) {
yading@10:                 p_schro_params->eos_pulled = 1;
yading@10:                 go = 0;
yading@10:             }
yading@10: 
yading@10:             if (!SCHRO_PARSE_CODE_IS_PICTURE(parse_code)) {
yading@10:                 schro_buffer_unref(enc_buf);
yading@10:                 break;
yading@10:             }
yading@10: 
yading@10:             /* Create output frame. */
yading@10:             p_frame_output = av_mallocz(sizeof(FFSchroEncodedFrame));
yading@10:             /* Set output data. */
yading@10:             p_frame_output->size     = p_schro_params->enc_buf_size;
yading@10:             p_frame_output->p_encbuf = p_schro_params->enc_buf;
yading@10:             if (SCHRO_PARSE_CODE_IS_INTRA(parse_code) &&
yading@10:                 SCHRO_PARSE_CODE_IS_REFERENCE(parse_code))
yading@10:                 p_frame_output->key_frame = 1;
yading@10: 
yading@10:             /* Parse the coded frame number from the bitstream. Bytes 14
yading@10:              * through 17 represesent the frame number. */
yading@10:             p_frame_output->frame_num = AV_RB32(enc_buf->data + 13);
yading@10: 
yading@10:             ff_schro_queue_push_back(&p_schro_params->enc_frame_queue,
yading@10:                                      p_frame_output);
yading@10:             p_schro_params->enc_buf_size = 0;
yading@10:             p_schro_params->enc_buf      = NULL;
yading@10: 
yading@10:             schro_buffer_unref(enc_buf);
yading@10: 
yading@10:             break;
yading@10: 
yading@10:         case SCHRO_STATE_NEED_FRAME:
yading@10:             go = 0;
yading@10:             break;
yading@10: 
yading@10:         case SCHRO_STATE_AGAIN:
yading@10:             break;
yading@10: 
yading@10:         default:
yading@10:             av_log(avctx, AV_LOG_ERROR, "Unknown Schro Encoder state\n");
yading@10:             return -1;
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     /* Copy 'next' frame in queue. */
yading@10: 
yading@10:     if (p_schro_params->enc_frame_queue.size == 1 &&
yading@10:         p_schro_params->eos_pulled)
yading@10:         last_frame_in_sequence = 1;
yading@10: 
yading@10:     p_frame_output = ff_schro_queue_pop(&p_schro_params->enc_frame_queue);
yading@10: 
yading@10:     if (!p_frame_output)
yading@10:         return 0;
yading@10: 
yading@10:     pkt_size = p_frame_output->size;
yading@10:     if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0)
yading@10:         pkt_size += p_schro_params->enc_buf_size;
yading@10:     if ((ret = ff_alloc_packet2(avctx, pkt, pkt_size)) < 0)
yading@10:         goto error;
yading@10: 
yading@10:     memcpy(pkt->data, p_frame_output->p_encbuf, p_frame_output->size);
yading@10:     avctx->coded_frame->key_frame = p_frame_output->key_frame;
yading@10:     /* Use the frame number of the encoded frame as the pts. It is OK to
yading@10:      * do so since Dirac is a constant frame rate codec. It expects input
yading@10:      * to be of constant frame rate. */
yading@10:     pkt->pts =
yading@10:     avctx->coded_frame->pts = p_frame_output->frame_num;
yading@10:     pkt->dts = p_schro_params->dts++;
yading@10:     enc_size = p_frame_output->size;
yading@10: 
yading@10:     /* Append the end of sequence information to the last frame in the
yading@10:      * sequence. */
yading@10:     if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0) {
yading@10:         memcpy(pkt->data + enc_size, p_schro_params->enc_buf,
yading@10:                p_schro_params->enc_buf_size);
yading@10:         enc_size += p_schro_params->enc_buf_size;
yading@10:         av_freep(&p_schro_params->enc_buf);
yading@10:         p_schro_params->enc_buf_size = 0;
yading@10:     }
yading@10: 
yading@10:     if (p_frame_output->key_frame)
yading@10:         pkt->flags |= AV_PKT_FLAG_KEY;
yading@10:     *got_packet = 1;
yading@10: 
yading@10: error:
yading@10:     /* free frame */
yading@10:     libschroedinger_free_frame(p_frame_output);
yading@10:     return ret;
yading@10: }
yading@10: 
yading@10: 
yading@10: static int libschroedinger_encode_close(AVCodecContext *avctx)
yading@10: {
yading@10:     SchroEncoderParams *p_schro_params = avctx->priv_data;
yading@10: 
yading@10:     /* Close the encoder. */
yading@10:     schro_encoder_free(p_schro_params->encoder);
yading@10: 
yading@10:     /* Free data in the output frame queue. */
yading@10:     ff_schro_queue_free(&p_schro_params->enc_frame_queue,
yading@10:                         libschroedinger_free_frame);
yading@10: 
yading@10: 
yading@10:     /* Free the encoder buffer. */
yading@10:     if (p_schro_params->enc_buf_size)
yading@10:         av_freep(&p_schro_params->enc_buf);
yading@10: 
yading@10:     /* Free the video format structure. */
yading@10:     av_freep(&p_schro_params->format);
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: 
yading@10: AVCodec ff_libschroedinger_encoder = {
yading@10:     .name           = "libschroedinger",
yading@10:     .type           = AVMEDIA_TYPE_VIDEO,
yading@10:     .id             = AV_CODEC_ID_DIRAC,
yading@10:     .priv_data_size = sizeof(SchroEncoderParams),
yading@10:     .init           = libschroedinger_encode_init,
yading@10:     .encode2        = libschroedinger_encode_frame,
yading@10:     .close          = libschroedinger_encode_close,
yading@10:     .capabilities   = CODEC_CAP_DELAY,
yading@10:     .pix_fmts       = (const enum AVPixelFormat[]){
yading@10:         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_NONE
yading@10:     },
yading@10:     .long_name      = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),
yading@10: };