git.sesse.net Git - ffmpeg/blob - libavcodec/libschroedingerenc.c

   1 /*
   2  * Dirac encoder support via Schroedinger libraries
   3  * Copyright (c) 2008 BBC, Anuradha Suraparaju <asuraparaju at gmail dot com >
   4  *
   5  * This file is part of Libav.
   6  *
   7  * Libav 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.
  11  *
  12  * Libav 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.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with Libav; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 /**
  23 * @file
  24 * Dirac encoder 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).
  28 */
  29
  30 #include <schroedinger/schro.h>
  31 #include <schroedinger/schrodebug.h>
  32 #include <schroedinger/schrovideoformat.h>
  33
  34 #include "libavutil/attributes.h"
  35 #include "avcodec.h"
  36 #include "internal.h"
  37 #include "libschroedinger.h"
  38 #include "bytestream.h"
  39
  40
  41 /** libschroedinger encoder private data */
  42 typedef struct SchroEncoderParams {
  43     /** Schroedinger video format */
  44     SchroVideoFormat *format;
  45
  46     /** Schroedinger frame format */
  47     SchroFrameFormat frame_format;
  48
  49     /** frame size */
  50     int frame_size;
  51
  52     /** Schroedinger encoder handle*/
  53     SchroEncoder* encoder;
  54
  55     /** buffer to store encoder output before writing it to the frame queue*/
  56     unsigned char *enc_buf;
  57
  58     /** Size of encoder buffer*/
  59     int enc_buf_size;
  60
  61     /** queue storing encoded frames */
  62     FFSchroQueue enc_frame_queue;
  63
  64     /** end of sequence signalled */
  65     int eos_signalled;
  66
  67     /** end of sequence pulled */
  68     int eos_pulled;
  69
  70     /* counter for frames submitted to encoder, used as dts */
  71     int64_t dts;
  72 } SchroEncoderParams;
  73
  74 /**
  75 * Works out Schro-compatible chroma format.
  76 */
  77 static int set_chroma_format(AVCodecContext *avctx)
  78 {
  79     int num_formats = sizeof(schro_pixel_format_map) /
  80                       sizeof(schro_pixel_format_map[0]);
  81     int idx;
  82
  83     SchroEncoderParams *p_schro_params = avctx->priv_data;
  84
  85     for (idx = 0; idx < num_formats; ++idx) {
  86         if (schro_pixel_format_map[idx].ff_pix_fmt == avctx->pix_fmt) {
  87             p_schro_params->format->chroma_format =
  88                             schro_pixel_format_map[idx].schro_pix_fmt;
  89             return 0;
  90         }
  91     }
  92
  93     av_log(avctx, AV_LOG_ERROR,
  94            "This codec currently only supports planar YUV 4:2:0, 4:2:2"
  95            " and 4:4:4 formats.\n");
  96
  97     return -1;
  98 }
  99
 100 static av_cold int libschroedinger_encode_init(AVCodecContext *avctx)
 101 {
 102     SchroEncoderParams *p_schro_params = avctx->priv_data;
 103     SchroVideoFormatEnum preset;
 104
 105     /* Initialize the libraries that libschroedinger depends on. */
 106     schro_init();
 107
 108     /* Create an encoder object. */
 109     p_schro_params->encoder = schro_encoder_new();
 110
 111     if (!p_schro_params->encoder) {
 112         av_log(avctx, AV_LOG_ERROR,
 113                "Unrecoverable Error: schro_encoder_new failed. ");
 114         return -1;
 115     }
 116
 117     /* Initialize the format. */
 118     preset = ff_get_schro_video_format_preset(avctx);
 119     p_schro_params->format =
 120                     schro_encoder_get_video_format(p_schro_params->encoder);
 121     schro_video_format_set_std_video_format(p_schro_params->format, preset);
 122     p_schro_params->format->width  = avctx->width;
 123     p_schro_params->format->height = avctx->height;
 124
 125     if (set_chroma_format(avctx) == -1)
 126         return -1;
 127
 128     if (avctx->color_primaries == AVCOL_PRI_BT709) {
 129         p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_HDTV;
 130     } else if (avctx->color_primaries == AVCOL_PRI_BT470BG) {
 131         p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_625;
 132     } else if (avctx->color_primaries == AVCOL_PRI_SMPTE170M) {
 133         p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_525;
 134     }
 135
 136     if (avctx->colorspace == AVCOL_SPC_BT709) {
 137         p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_HDTV;
 138     } else if (avctx->colorspace == AVCOL_SPC_BT470BG) {
 139         p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_SDTV;
 140     }
 141
 142     if (avctx->color_trc == AVCOL_TRC_BT709) {
 143         p_schro_params->format->transfer_function = SCHRO_TRANSFER_CHAR_TV_GAMMA;
 144     }
 145
 146     if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
 147                                   &p_schro_params->frame_format) == -1) {
 148         av_log(avctx, AV_LOG_ERROR,
 149                "This codec currently supports only planar YUV 4:2:0, 4:2:2"
 150                " and 4:4:4 formats.\n");
 151         return -1;
 152     }
 153
 154     p_schro_params->format->frame_rate_numerator   = avctx->time_base.den;
 155     p_schro_params->format->frame_rate_denominator = avctx->time_base.num;
 156
 157     p_schro_params->frame_size = avpicture_get_size(avctx->pix_fmt,
 158                                                     avctx->width,
 159                                                     avctx->height);
 160
 161     avctx->coded_frame = av_frame_alloc();
 162     if (!avctx->coded_frame)
 163         return AVERROR(ENOMEM);
 164
 165     if (!avctx->gop_size) {
 166         schro_encoder_setting_set_double(p_schro_params->encoder,
 167                                          "gop_structure",
 168                                          SCHRO_ENCODER_GOP_INTRA_ONLY);
 169
 170         if (avctx->coder_type == FF_CODER_TYPE_VLC)
 171             schro_encoder_setting_set_double(p_schro_params->encoder,
 172                                              "enable_noarith", 1);
 173     } else {
 174         schro_encoder_setting_set_double(p_schro_params->encoder,
 175                                          "au_distance", avctx->gop_size);
 176         avctx->has_b_frames = 1;
 177         p_schro_params->dts = -1;
 178     }
 179
 180     /* FIXME - Need to handle SCHRO_ENCODER_RATE_CONTROL_LOW_DELAY. */
 181     if (avctx->flags & CODEC_FLAG_QSCALE) {
 182         if (!avctx->global_quality) {
 183             /* lossless coding */
 184             schro_encoder_setting_set_double(p_schro_params->encoder,
 185                                              "rate_control",
 186                                              SCHRO_ENCODER_RATE_CONTROL_LOSSLESS);
 187         } else {
 188             int quality;
 189             schro_encoder_setting_set_double(p_schro_params->encoder,
 190                                              "rate_control",
 191                                              SCHRO_ENCODER_RATE_CONTROL_CONSTANT_QUALITY);
 192
 193             quality = avctx->global_quality / FF_QP2LAMBDA;
 194             if (quality > 10)
 195                 quality = 10;
 196             schro_encoder_setting_set_double(p_schro_params->encoder,
 197                                              "quality", quality);
 198         }
 199     } else {
 200         schro_encoder_setting_set_double(p_schro_params->encoder,
 201                                          "rate_control",
 202                                          SCHRO_ENCODER_RATE_CONTROL_CONSTANT_BITRATE);
 203
 204         schro_encoder_setting_set_double(p_schro_params->encoder,
 205                                          "bitrate", avctx->bit_rate);
 206     }
 207
 208     if (avctx->flags & CODEC_FLAG_INTERLACED_ME)
 209         /* All material can be coded as interlaced or progressive
 210            irrespective of the type of source material. */
 211         schro_encoder_setting_set_double(p_schro_params->encoder,
 212                                          "interlaced_coding", 1);
 213
 214     schro_encoder_setting_set_double(p_schro_params->encoder, "open_gop",
 215                                      !(avctx->flags & CODEC_FLAG_CLOSED_GOP));
 216
 217     /* FIXME: Signal range hardcoded to 8-bit data until both libschroedinger
 218      * and libdirac support other bit-depth data. */
 219     schro_video_format_set_std_signal_range(p_schro_params->format,
 220                                             SCHRO_SIGNAL_RANGE_8BIT_VIDEO);
 221
 222     /* Set the encoder format. */
 223     schro_encoder_set_video_format(p_schro_params->encoder,
 224                                    p_schro_params->format);
 225
 226     /* Set the debug level. */
 227     schro_debug_set_level(avctx->debug);
 228
 229     schro_encoder_start(p_schro_params->encoder);
 230
 231     /* Initialize the encoded frame queue. */
 232     ff_schro_queue_init(&p_schro_params->enc_frame_queue);
 233     return 0;
 234 }
 235
 236 static SchroFrame *libschroedinger_frame_from_data(AVCodecContext *avctx,
 237                                                    const AVFrame *frame)
 238 {
 239     SchroEncoderParams *p_schro_params = avctx->priv_data;
 240     SchroFrame *in_frame;
 241     /* Input line size may differ from what the codec supports. Especially
 242      * when transcoding from one format to another. So use avpicture_layout
 243      * to copy the frame. */
 244     in_frame = ff_create_schro_frame(avctx, p_schro_params->frame_format);
 245
 246     if (in_frame)
 247         avpicture_layout((const AVPicture *)frame, avctx->pix_fmt,
 248                           avctx->width, avctx->height,
 249                           in_frame->components[0].data,
 250                           p_schro_params->frame_size);
 251
 252     return in_frame;
 253 }
 254
 255 static void libschroedinger_free_frame(void *data)
 256 {
 257     FFSchroEncodedFrame *enc_frame = data;
 258
 259     av_freep(&enc_frame->p_encbuf);
 260     av_free(enc_frame);
 261 }
 262
 263 static int libschroedinger_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
 264                                         const AVFrame *frame, int *got_packet)
 265 {
 266     int enc_size = 0;
 267     SchroEncoderParams *p_schro_params = avctx->priv_data;
 268     SchroEncoder *encoder = p_schro_params->encoder;
 269     struct FFSchroEncodedFrame *p_frame_output = NULL;
 270     int go = 1;
 271     SchroBuffer *enc_buf;
 272     int presentation_frame;
 273     int parse_code;
 274     int last_frame_in_sequence = 0;
 275     int pkt_size, ret;
 276
 277     if (!frame) {
 278         /* Push end of sequence if not already signalled. */
 279         if (!p_schro_params->eos_signalled) {
 280             schro_encoder_end_of_stream(encoder);
 281             p_schro_params->eos_signalled = 1;
 282         }
 283     } else {
 284         /* Allocate frame data to schro input buffer. */
 285         SchroFrame *in_frame = libschroedinger_frame_from_data(avctx, frame);
 286         if (!in_frame)
 287             return AVERROR(ENOMEM);
 288         /* Load next frame. */
 289         schro_encoder_push_frame(encoder, in_frame);
 290     }
 291
 292     if (p_schro_params->eos_pulled)
 293         go = 0;
 294
 295     /* Now check to see if we have any output from the encoder. */
 296     while (go) {
 297         int err;
 298         SchroStateEnum state;
 299         state = schro_encoder_wait(encoder);
 300         switch (state) {
 301         case SCHRO_STATE_HAVE_BUFFER:
 302         case SCHRO_STATE_END_OF_STREAM:
 303             enc_buf = schro_encoder_pull(encoder, &presentation_frame);
 304             if (enc_buf->length <= 0)
 305                 return AVERROR_BUG;
 306             parse_code = enc_buf->data[4];
 307
 308             /* All non-frame data is prepended to actual frame data to
 309              * be able to set the pts correctly. So we don't write data
 310              * to the frame output queue until we actually have a frame
 311              */
 312             if ((err = av_reallocp(&p_schro_params->enc_buf,
 313                                    p_schro_params->enc_buf_size +
 314                                    enc_buf->length)) < 0) {
 315                 p_schro_params->enc_buf_size = 0;
 316                 return err;
 317             }
 318
 319             memcpy(p_schro_params->enc_buf + p_schro_params->enc_buf_size,
 320                    enc_buf->data, enc_buf->length);
 321             p_schro_params->enc_buf_size += enc_buf->length;
 322
 323
 324             if (state == SCHRO_STATE_END_OF_STREAM) {
 325                 p_schro_params->eos_pulled = 1;
 326                 go = 0;
 327             }
 328
 329             if (!SCHRO_PARSE_CODE_IS_PICTURE(parse_code)) {
 330                 schro_buffer_unref(enc_buf);
 331                 break;
 332             }
 333
 334             /* Create output frame. */
 335             p_frame_output = av_mallocz(sizeof(FFSchroEncodedFrame));
 336             if (!p_frame_output)
 337                 return AVERROR(ENOMEM);
 338             /* Set output data. */
 339             p_frame_output->size     = p_schro_params->enc_buf_size;
 340             p_frame_output->p_encbuf = p_schro_params->enc_buf;
 341             if (SCHRO_PARSE_CODE_IS_INTRA(parse_code) &&
 342                 SCHRO_PARSE_CODE_IS_REFERENCE(parse_code))
 343                 p_frame_output->key_frame = 1;
 344
 345             /* Parse the coded frame number from the bitstream. Bytes 14
 346              * through 17 represesent the frame number. */
 347             p_frame_output->frame_num = AV_RB32(enc_buf->data + 13);
 348
 349             ff_schro_queue_push_back(&p_schro_params->enc_frame_queue,
 350                                      p_frame_output);
 351             p_schro_params->enc_buf_size = 0;
 352             p_schro_params->enc_buf      = NULL;
 353
 354             schro_buffer_unref(enc_buf);
 355
 356             break;
 357
 358         case SCHRO_STATE_NEED_FRAME:
 359             go = 0;
 360             break;
 361
 362         case SCHRO_STATE_AGAIN:
 363             break;
 364
 365         default:
 366             av_log(avctx, AV_LOG_ERROR, "Unknown Schro Encoder state\n");
 367             return -1;
 368         }
 369     }
 370
 371     /* Copy 'next' frame in queue. */
 372
 373     if (p_schro_params->enc_frame_queue.size == 1 &&
 374         p_schro_params->eos_pulled)
 375         last_frame_in_sequence = 1;
 376
 377     p_frame_output = ff_schro_queue_pop(&p_schro_params->enc_frame_queue);
 378
 379     if (!p_frame_output)
 380         return 0;
 381
 382     pkt_size = p_frame_output->size;
 383     if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0)
 384         pkt_size += p_schro_params->enc_buf_size;
 385     if ((ret = ff_alloc_packet(pkt, pkt_size)) < 0) {
 386         av_log(avctx, AV_LOG_ERROR, "Error getting output packet of size %d.\n", pkt_size);
 387         goto error;
 388     }
 389
 390     memcpy(pkt->data, p_frame_output->p_encbuf, p_frame_output->size);
 391     avctx->coded_frame->key_frame = p_frame_output->key_frame;
 392     /* Use the frame number of the encoded frame as the pts. It is OK to
 393      * do so since Dirac is a constant frame rate codec. It expects input
 394      * to be of constant frame rate. */
 395     pkt->pts =
 396     avctx->coded_frame->pts = p_frame_output->frame_num;
 397     pkt->dts = p_schro_params->dts++;
 398     enc_size = p_frame_output->size;
 399
 400     /* Append the end of sequence information to the last frame in the
 401      * sequence. */
 402     if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0) {
 403         memcpy(pkt->data + enc_size, p_schro_params->enc_buf,
 404                p_schro_params->enc_buf_size);
 405         enc_size += p_schro_params->enc_buf_size;
 406         av_freep(&p_schro_params->enc_buf);
 407         p_schro_params->enc_buf_size = 0;
 408     }
 409
 410     if (p_frame_output->key_frame)
 411         pkt->flags |= AV_PKT_FLAG_KEY;
 412     *got_packet = 1;
 413
 414 error:
 415     /* free frame */
 416     libschroedinger_free_frame(p_frame_output);
 417     return ret;
 418 }
 419
 420
 421 static int libschroedinger_encode_close(AVCodecContext *avctx)
 422 {
 423     SchroEncoderParams *p_schro_params = avctx->priv_data;
 424
 425     /* Close the encoder. */
 426     schro_encoder_free(p_schro_params->encoder);
 427
 428     /* Free data in the output frame queue. */
 429     ff_schro_queue_free(&p_schro_params->enc_frame_queue,
 430                         libschroedinger_free_frame);
 431
 432
 433     /* Free the encoder buffer. */
 434     if (p_schro_params->enc_buf_size)
 435         av_freep(&p_schro_params->enc_buf);
 436
 437     /* Free the video format structure. */
 438     av_freep(&p_schro_params->format);
 439
 440     av_frame_free(&avctx->coded_frame);
 441
 442     return 0;
 443 }
 444
 445
 446 AVCodec ff_libschroedinger_encoder = {
 447     .name           = "libschroedinger",
 448     .long_name      = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),
 449     .type           = AVMEDIA_TYPE_VIDEO,
 450     .id             = AV_CODEC_ID_DIRAC,
 451     .priv_data_size = sizeof(SchroEncoderParams),
 452     .init           = libschroedinger_encode_init,
 453     .encode2        = libschroedinger_encode_frame,
 454     .close          = libschroedinger_encode_close,
 455     .capabilities   = CODEC_CAP_DELAY,
 456     .pix_fmts       = (const enum AVPixelFormat[]){
 457         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_NONE
 458     },
 459 };