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