libschroedingerenc.c
Go to the documentation of this file.
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/avassert.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 being encoded */
51 
52  /** frame size */
54 
55  /** Schroedinger encoder handle*/
56  SchroEncoder* encoder;
57 
58  /** buffer to store encoder output before writing it to the frame queue*/
59  unsigned char *enc_buf;
60 
61  /** Size of encoder buffer*/
63 
64  /** queue storing encoded frames */
66 
67  /** end of sequence signalled */
69 
70  /** end of sequence pulled */
72 
73  /* counter for frames submitted to encoder, used as dts */
74  int64_t dts;
76 
77 /**
78 * Works out Schro-compatible chroma format.
79 */
81 {
82  int num_formats = sizeof(schro_pixel_format_map) /
83  sizeof(schro_pixel_format_map[0]);
84  int idx;
85 
86  SchroEncoderParams *p_schro_params = avctx->priv_data;
87 
88  for (idx = 0; idx < num_formats; ++idx) {
89  if (schro_pixel_format_map[idx].ff_pix_fmt == avctx->pix_fmt) {
90  p_schro_params->format->chroma_format =
91  schro_pixel_format_map[idx].schro_pix_fmt;
92  return 0;
93  }
94  }
95 
96  av_log(avctx, AV_LOG_ERROR,
97  "This codec currently only supports planar YUV 4:2:0, 4:2:2"
98  " and 4:4:4 formats.\n");
99 
100  return -1;
101 }
102 
104 {
105  SchroEncoderParams *p_schro_params = avctx->priv_data;
106  SchroVideoFormatEnum preset;
107 
108  /* Initialize the libraries that libschroedinger depends on. */
109  schro_init();
110 
111  /* Create an encoder object. */
112  p_schro_params->encoder = schro_encoder_new();
113 
114  if (!p_schro_params->encoder) {
115  av_log(avctx, AV_LOG_ERROR,
116  "Unrecoverable Error: schro_encoder_new failed. ");
117  return -1;
118  }
119 
120  /* Initialize the format. */
121  preset = ff_get_schro_video_format_preset(avctx);
122  p_schro_params->format =
123  schro_encoder_get_video_format(p_schro_params->encoder);
124  schro_video_format_set_std_video_format(p_schro_params->format, preset);
125  p_schro_params->format->width = avctx->width;
126  p_schro_params->format->height = avctx->height;
127 
128  if (set_chroma_format(avctx) == -1)
129  return -1;
130 
131  if (avctx->color_primaries == AVCOL_PRI_BT709) {
132  p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_HDTV;
133  } else if (avctx->color_primaries == AVCOL_PRI_BT470BG) {
134  p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_625;
135  } else if (avctx->color_primaries == AVCOL_PRI_SMPTE170M) {
136  p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_525;
137  }
138 
139  if (avctx->colorspace == AVCOL_SPC_BT709) {
140  p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_HDTV;
141  } else if (avctx->colorspace == AVCOL_SPC_BT470BG) {
142  p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_SDTV;
143  }
144 
145  if (avctx->color_trc == AVCOL_TRC_BT709) {
146  p_schro_params->format->transfer_function = SCHRO_TRANSFER_CHAR_TV_GAMMA;
147  }
148 
149  if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
150  &p_schro_params->frame_format) == -1) {
151  av_log(avctx, AV_LOG_ERROR,
152  "This codec currently supports only planar YUV 4:2:0, 4:2:2"
153  " and 4:4:4 formats.\n");
154  return -1;
155  }
156 
157  p_schro_params->format->frame_rate_numerator = avctx->time_base.den;
158  p_schro_params->format->frame_rate_denominator = avctx->time_base.num;
159 
160  p_schro_params->frame_size = avpicture_get_size(avctx->pix_fmt,
161  avctx->width,
162  avctx->height);
163 
164  avctx->coded_frame = &p_schro_params->picture;
165 
166  if (!avctx->gop_size) {
167  schro_encoder_setting_set_double(p_schro_params->encoder,
168  "gop_structure",
169  SCHRO_ENCODER_GOP_INTRA_ONLY);
170 
171  if (avctx->coder_type == FF_CODER_TYPE_VLC)
172  schro_encoder_setting_set_double(p_schro_params->encoder,
173  "enable_noarith", 1);
174  } else {
175  schro_encoder_setting_set_double(p_schro_params->encoder,
176  "au_distance", avctx->gop_size);
177  avctx->has_b_frames = 1;
178  p_schro_params->dts = -1;
179  }
180 
181  /* FIXME - Need to handle SCHRO_ENCODER_RATE_CONTROL_LOW_DELAY. */
182  if (avctx->flags & CODEC_FLAG_QSCALE) {
183  if (!avctx->global_quality) {
184  /* lossless coding */
185  schro_encoder_setting_set_double(p_schro_params->encoder,
186  "rate_control",
187  SCHRO_ENCODER_RATE_CONTROL_LOSSLESS);
188  } else {
189  int quality;
190  schro_encoder_setting_set_double(p_schro_params->encoder,
191  "rate_control",
192  SCHRO_ENCODER_RATE_CONTROL_CONSTANT_QUALITY);
193 
194  quality = avctx->global_quality / FF_QP2LAMBDA;
195  if (quality > 10)
196  quality = 10;
197  schro_encoder_setting_set_double(p_schro_params->encoder,
198  "quality", quality);
199  }
200  } else {
201  schro_encoder_setting_set_double(p_schro_params->encoder,
202  "rate_control",
203  SCHRO_ENCODER_RATE_CONTROL_CONSTANT_BITRATE);
204 
205  schro_encoder_setting_set_double(p_schro_params->encoder,
206  "bitrate", avctx->bit_rate);
207  }
208 
209  if (avctx->flags & CODEC_FLAG_INTERLACED_ME)
210  /* All material can be coded as interlaced or progressive
211  irrespective of the type of source material. */
212  schro_encoder_setting_set_double(p_schro_params->encoder,
213  "interlaced_coding", 1);
214 
215  schro_encoder_setting_set_double(p_schro_params->encoder, "open_gop",
216  !(avctx->flags & CODEC_FLAG_CLOSED_GOP));
217 
218  /* FIXME: Signal range hardcoded to 8-bit data until both libschroedinger
219  * and libdirac support other bit-depth data. */
220  schro_video_format_set_std_signal_range(p_schro_params->format,
221  SCHRO_SIGNAL_RANGE_8BIT_VIDEO);
222 
223  /* Set the encoder format. */
224  schro_encoder_set_video_format(p_schro_params->encoder,
225  p_schro_params->format);
226 
227  /* Set the debug level. */
228  schro_debug_set_level(avctx->debug);
229 
230  schro_encoder_start(p_schro_params->encoder);
231 
232  /* Initialize the encoded frame queue. */
233  ff_schro_queue_init(&p_schro_params->enc_frame_queue);
234  return 0;
235 }
236 
238  const AVFrame *frame)
239 {
240  SchroEncoderParams *p_schro_params = avctx->priv_data;
241  SchroFrame *in_frame;
242  /* Input line size may differ from what the codec supports. Especially
243  * when transcoding from one format to another. So use avpicture_layout
244  * to copy the frame. */
245  in_frame = ff_create_schro_frame(avctx, p_schro_params->frame_format);
246 
247  if (in_frame)
248  avpicture_layout((const AVPicture *)frame, avctx->pix_fmt,
249  avctx->width, avctx->height,
250  in_frame->components[0].data,
251  p_schro_params->frame_size);
252 
253  return in_frame;
254 }
255 
257 {
258  FFSchroEncodedFrame *enc_frame = data;
259 
260  av_freep(&enc_frame->p_encbuf);
261  av_free(enc_frame);
262 }
263 
265  const AVFrame *frame, int *got_packet)
266 {
267  int enc_size = 0;
268  SchroEncoderParams *p_schro_params = avctx->priv_data;
269  SchroEncoder *encoder = p_schro_params->encoder;
270  struct FFSchroEncodedFrame *p_frame_output = NULL;
271  int go = 1;
272  SchroBuffer *enc_buf;
273  int presentation_frame;
274  int parse_code;
275  int last_frame_in_sequence = 0;
276  int pkt_size, ret;
277 
278  if (!frame) {
279  /* Push end of sequence if not already signalled. */
280  if (!p_schro_params->eos_signalled) {
281  schro_encoder_end_of_stream(encoder);
282  p_schro_params->eos_signalled = 1;
283  }
284  } else {
285  /* Allocate frame data to schro input buffer. */
286  SchroFrame *in_frame = libschroedinger_frame_from_data(avctx, frame);
287  /* Load next frame. */
288  schro_encoder_push_frame(encoder, in_frame);
289  }
290 
291  if (p_schro_params->eos_pulled)
292  go = 0;
293 
294  /* Now check to see if we have any output from the encoder. */
295  while (go) {
296  SchroStateEnum state;
297  state = schro_encoder_wait(encoder);
298  switch (state) {
299  case SCHRO_STATE_HAVE_BUFFER:
300  case SCHRO_STATE_END_OF_STREAM:
301  enc_buf = schro_encoder_pull(encoder, &presentation_frame);
302  av_assert0(enc_buf->length > 0);
303  parse_code = enc_buf->data[4];
304 
305  /* All non-frame data is prepended to actual frame data to
306  * be able to set the pts correctly. So we don't write data
307  * to the frame output queue until we actually have a frame
308  */
309  p_schro_params->enc_buf = av_realloc(p_schro_params->enc_buf,
310  p_schro_params->enc_buf_size + enc_buf->length);
311 
312  memcpy(p_schro_params->enc_buf + p_schro_params->enc_buf_size,
313  enc_buf->data, enc_buf->length);
314  p_schro_params->enc_buf_size += enc_buf->length;
315 
316 
317  if (state == SCHRO_STATE_END_OF_STREAM) {
318  p_schro_params->eos_pulled = 1;
319  go = 0;
320  }
321 
322  if (!SCHRO_PARSE_CODE_IS_PICTURE(parse_code)) {
323  schro_buffer_unref(enc_buf);
324  break;
325  }
326 
327  /* Create output frame. */
328  p_frame_output = av_mallocz(sizeof(FFSchroEncodedFrame));
329  /* Set output data. */
330  p_frame_output->size = p_schro_params->enc_buf_size;
331  p_frame_output->p_encbuf = p_schro_params->enc_buf;
332  if (SCHRO_PARSE_CODE_IS_INTRA(parse_code) &&
333  SCHRO_PARSE_CODE_IS_REFERENCE(parse_code))
334  p_frame_output->key_frame = 1;
335 
336  /* Parse the coded frame number from the bitstream. Bytes 14
337  * through 17 represesent the frame number. */
338  p_frame_output->frame_num = AV_RB32(enc_buf->data + 13);
339 
340  ff_schro_queue_push_back(&p_schro_params->enc_frame_queue,
341  p_frame_output);
342  p_schro_params->enc_buf_size = 0;
343  p_schro_params->enc_buf = NULL;
344 
345  schro_buffer_unref(enc_buf);
346 
347  break;
348 
349  case SCHRO_STATE_NEED_FRAME:
350  go = 0;
351  break;
352 
353  case SCHRO_STATE_AGAIN:
354  break;
355 
356  default:
357  av_log(avctx, AV_LOG_ERROR, "Unknown Schro Encoder state\n");
358  return -1;
359  }
360  }
361 
362  /* Copy 'next' frame in queue. */
363 
364  if (p_schro_params->enc_frame_queue.size == 1 &&
365  p_schro_params->eos_pulled)
366  last_frame_in_sequence = 1;
367 
368  p_frame_output = ff_schro_queue_pop(&p_schro_params->enc_frame_queue);
369 
370  if (!p_frame_output)
371  return 0;
372 
373  pkt_size = p_frame_output->size;
374  if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0)
375  pkt_size += p_schro_params->enc_buf_size;
376  if ((ret = ff_alloc_packet2(avctx, pkt, pkt_size)) < 0)
377  goto error;
378 
379  memcpy(pkt->data, p_frame_output->p_encbuf, p_frame_output->size);
380  avctx->coded_frame->key_frame = p_frame_output->key_frame;
381  /* Use the frame number of the encoded frame as the pts. It is OK to
382  * do so since Dirac is a constant frame rate codec. It expects input
383  * to be of constant frame rate. */
384  pkt->pts =
385  avctx->coded_frame->pts = p_frame_output->frame_num;
386  pkt->dts = p_schro_params->dts++;
387  enc_size = p_frame_output->size;
388 
389  /* Append the end of sequence information to the last frame in the
390  * sequence. */
391  if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0) {
392  memcpy(pkt->data + enc_size, p_schro_params->enc_buf,
393  p_schro_params->enc_buf_size);
394  enc_size += p_schro_params->enc_buf_size;
395  av_freep(&p_schro_params->enc_buf);
396  p_schro_params->enc_buf_size = 0;
397  }
398 
399  if (p_frame_output->key_frame)
400  pkt->flags |= AV_PKT_FLAG_KEY;
401  *got_packet = 1;
402 
403 error:
404  /* free frame */
405  libschroedinger_free_frame(p_frame_output);
406  return ret;
407 }
408 
409 
411 {
412  SchroEncoderParams *p_schro_params = avctx->priv_data;
413 
414  /* Close the encoder. */
415  schro_encoder_free(p_schro_params->encoder);
416 
417  /* Free data in the output frame queue. */
418  ff_schro_queue_free(&p_schro_params->enc_frame_queue,
420 
421 
422  /* Free the encoder buffer. */
423  if (p_schro_params->enc_buf_size)
424  av_freep(&p_schro_params->enc_buf);
425 
426  /* Free the video format structure. */
427  av_freep(&p_schro_params->format);
428 
429  return 0;
430 }
431 
432 
434  .name = "libschroedinger",
435  .type = AVMEDIA_TYPE_VIDEO,
436  .id = AV_CODEC_ID_DIRAC,
437  .priv_data_size = sizeof(SchroEncoderParams),
439  .encode2 = libschroedinger_encode_frame,
441  .capabilities = CODEC_CAP_DELAY,
442  .pix_fmts = (const enum AVPixelFormat[]){
444  },
445  .long_name = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),
446 };
void * av_mallocz(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:205
AVFrame picture
frame being encoded
This structure describes decoded (raw) audio or video data.
Definition: frame.h:76
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:73
AVFrame * coded_frame
the picture in the bitstream
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
uint16_t key_frame
key frame flag.
SchroFrame * ff_create_schro_frame(AVCodecContext *avctx, SchroFrameFormat schro_frame_fmt)
Create a Schro frame based on the dimensions and frame format passed.
int num
numerator
Definition: rational.h:44
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt, int width, int height, unsigned char *dest, int dest_size)
Copy pixel data from an AVPicture into a buffer, always assume a linesize alignment of 1...
Definition: avpicture.c:41
void * av_realloc(void *ptr, size_t size)
Allocate or reallocate a block of memory.
Definition: mem.c:141
libschroedinger encoder private data
int frame_size
frame size
four components are given, that&#39;s all.
data structures common to libschroedinger decoder and encoder
enum AVPixelFormat ff_pix_fmt
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
void av_freep(void *arg)
Free a memory block which has been allocated with av_malloc(z)() or av_realloc() and set the pointer ...
Definition: mem.c:198
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
static void libschroedinger_free_frame(void *data)
#define AV_RB32
static AVPacket pkt
Definition: demuxing.c:56
uint32_t frame_num
encoded frame number.
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:159
int coder_type
coder type
uint8_t * data
contains a single encoded frame returned from Dirac or Schroedinger
int size
Queue size.
uint8_t * p_encbuf
encoded frame data
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
frame
Definition: stft.m:14
static int set_chroma_format(AVCodecContext *avctx)
Works out Schro-compatible chroma format.
int has_b_frames
Size of the frame reordering buffer in the decoder.
void av_free(void *ptr)
Free a memory block which has been allocated with av_malloc(z)() or av_realloc(). ...
Definition: mem.c:183
SchroEncoder * encoder
Schroedinger encoder handle.
#define CODEC_FLAG_INTERLACED_ME
interlaced motion estimation
SchroFrameFormat frame_format
Schroedinger frame format.
#define CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
void * ff_schro_queue_pop(FFSchroQueue *queue)
Return the first element in the queue.
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Spectrum Plot time data
void ff_schro_queue_init(FFSchroQueue *queue)
Initialise the queue.
static int libschroedinger_encode_init(AVCodecContext *avctx)
int flags
CODEC_FLAG_*.
#define CODEC_FLAG_QSCALE
Use fixed qscale.
simple assert() macros that are a bit more flexible than ISO C assert().
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:246
const char * name
Name of the codec implementation.
FFSchroQueue enc_frame_queue
queue storing encoded frames
#define FF_CODER_TYPE_VLC
SchroVideoFormat * format
Schroedinger video format.
external API header
int flags
A combination of AV_PKT_FLAG values.
int ff_get_schro_frame_format(SchroChromaFormat schro_pix_fmt, SchroFrameFormat *schro_frame_fmt)
Sets the Schroedinger frame format corresponding to the Schro chroma format passed.
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:72
int enc_buf_size
Size of encoder buffer.
also ITU-R BT1361
int bit_rate
the average bitrate
int ff_schro_queue_push_back(FFSchroQueue *queue, void *p_data)
Add an element to the end of the queue.
void ff_schro_queue_free(FFSchroQueue *queue, void(*free_func)(void *))
Free the queue resources.
A simple queue implementation used in libschroedinger.
ret
Definition: avfilter.c:821
int width
picture width / height.
enum AVColorPrimaries color_primaries
Chromaticity coordinates of the source primaries.
trying all byte sequences megabyte in length and selecting the best looking sequence will yield cases to try But a word about quality
static int libschroedinger_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
int eos_signalled
end of sequence signalled
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int size)
Check AVPacket size and/or allocate data.
static const struct @67 schro_pixel_format_map[]
NULL
Definition: eval.c:55
also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
main external API structure.
static void close(AVCodecParserContext *s)
Definition: h264_parser.c:375
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:148
unsigned char * enc_buf
buffer to store encoder output before writing it to the frame queue
enum AVColorSpace colorspace
YUV colorspace type.
enum AVColorTransferCharacteristic color_trc
Color Transfer Characteristic.
SchroVideoFormatEnum ff_get_schro_video_format_preset(AVCodecContext *avctx)
Returns the video format preset matching the input video dimensions and time base.
int eos_pulled
end of sequence pulled
#define CODEC_FLAG_CLOSED_GOP
int global_quality
Global quality for codecs which cannot change it per frame.
static SchroFrame * libschroedinger_frame_from_data(AVCodecContext *avctx, const AVFrame *frame)
static uint32_t state
Definition: trasher.c:27
also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
int gop_size
the number of pictures in a group of pictures, or 0 for intra_only
preset
Definition: vf_curves.c:39
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:68
common internal api header.
AVCodec ff_libschroedinger_encoder
int den
denominator
Definition: rational.h:45
static int libschroedinger_encode_close(AVCodecContext *avctx)
uint32_t size
encoded frame size
int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height)
Calculate the size in bytes that a picture of the given width and height would occupy if stored in th...
Definition: avpicture.c:49
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:139
#define FF_QP2LAMBDA
factor to convert from H.263 QP to lambda
Definition: avutil.h:169
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed...
struct SchroEncoderParams SchroEncoderParams
libschroedinger encoder private data
also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601 ...
AVPixelFormat
Pixel format.
Definition: pixfmt.h:66
This structure stores compressed data.
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...