3 * Copyright (c) 2012 Jan Ekström
5 * This file is part of FFmpeg.
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.
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.
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
27 #include "libavutil/imgutils.h"
28 #include "libavutil/intreadwrite.h"
29 #include "libavutil/opt.h"
34 #include "bytestream.h"
40 /* Compare huffentry symbols */
41 static int huff_cmp_sym(const void *a, const void *b)
43 const HuffEntry *aa = a, *bb = b;
44 return aa->sym - bb->sym;
47 static av_cold int utvideo_encode_close(AVCodecContext *avctx)
49 UtvideoContext *c = avctx->priv_data;
52 av_freep(&c->slice_bits);
53 for (i = 0; i < 4; i++)
54 av_freep(&c->slice_buffer[i]);
59 static av_cold int utvideo_encode_init(AVCodecContext *avctx)
61 UtvideoContext *c = avctx->priv_data;
62 int i, subsampled_height;
63 uint32_t original_format;
66 c->frame_info_size = 4;
67 c->slice_stride = FFALIGN(avctx->width, 32);
69 switch (avctx->pix_fmt) {
72 avctx->codec_tag = MKTAG('U', 'L', 'R', 'G');
73 original_format = UTVIDEO_RGB;
75 case AV_PIX_FMT_GBRAP:
77 avctx->codec_tag = MKTAG('U', 'L', 'R', 'A');
78 original_format = UTVIDEO_RGBA;
79 avctx->bits_per_coded_sample = 32;
81 case AV_PIX_FMT_YUV420P:
82 if (avctx->width & 1 || avctx->height & 1) {
83 av_log(avctx, AV_LOG_ERROR,
84 "4:2:0 video requires even width and height.\n");
85 return AVERROR_INVALIDDATA;
88 if (avctx->colorspace == AVCOL_SPC_BT709)
89 avctx->codec_tag = MKTAG('U', 'L', 'H', '0');
91 avctx->codec_tag = MKTAG('U', 'L', 'Y', '0');
92 original_format = UTVIDEO_420;
94 case AV_PIX_FMT_YUV422P:
95 if (avctx->width & 1) {
96 av_log(avctx, AV_LOG_ERROR,
97 "4:2:2 video requires even width.\n");
98 return AVERROR_INVALIDDATA;
101 if (avctx->colorspace == AVCOL_SPC_BT709)
102 avctx->codec_tag = MKTAG('U', 'L', 'H', '2');
104 avctx->codec_tag = MKTAG('U', 'L', 'Y', '2');
105 original_format = UTVIDEO_422;
107 case AV_PIX_FMT_YUV444P:
109 if (avctx->colorspace == AVCOL_SPC_BT709)
110 avctx->codec_tag = MKTAG('U', 'L', 'H', '4');
112 avctx->codec_tag = MKTAG('U', 'L', 'Y', '4');
113 original_format = UTVIDEO_444;
116 av_log(avctx, AV_LOG_ERROR, "Unknown pixel format: %d\n",
118 return AVERROR_INVALIDDATA;
121 ff_bswapdsp_init(&c->bdsp);
122 ff_llvidencdsp_init(&c->llvidencdsp);
124 #if FF_API_PRIVATE_OPT
125 FF_DISABLE_DEPRECATION_WARNINGS
126 /* Check the prediction method, and error out if unsupported */
127 if (avctx->prediction_method < 0 || avctx->prediction_method > 4) {
128 av_log(avctx, AV_LOG_WARNING,
129 "Prediction method %d is not supported in Ut Video.\n",
130 avctx->prediction_method);
131 return AVERROR_OPTION_NOT_FOUND;
134 if (avctx->prediction_method == FF_PRED_PLANE) {
135 av_log(avctx, AV_LOG_ERROR,
136 "Plane prediction is not supported in Ut Video.\n");
137 return AVERROR_OPTION_NOT_FOUND;
140 /* Convert from libavcodec prediction type to Ut Video's */
141 if (avctx->prediction_method)
142 c->frame_pred = ff_ut_pred_order[avctx->prediction_method];
143 FF_ENABLE_DEPRECATION_WARNINGS
146 if (c->frame_pred == PRED_GRADIENT) {
147 av_log(avctx, AV_LOG_ERROR, "Gradient prediction is not supported.\n");
148 return AVERROR_OPTION_NOT_FOUND;
152 * Check the asked slice count for obviously invalid
153 * values (> 256 or negative).
155 if (avctx->slices > 256 || avctx->slices < 0) {
156 av_log(avctx, AV_LOG_ERROR,
157 "Slice count %d is not supported in Ut Video (theoretical range is 0-256).\n",
159 return AVERROR(EINVAL);
162 /* Check that the slice count is not larger than the subsampled height */
163 subsampled_height = avctx->height >> av_pix_fmt_desc_get(avctx->pix_fmt)->log2_chroma_h;
164 if (avctx->slices > subsampled_height) {
165 av_log(avctx, AV_LOG_ERROR,
166 "Slice count %d is larger than the subsampling-applied height %d.\n",
167 avctx->slices, subsampled_height);
168 return AVERROR(EINVAL);
171 /* extradata size is 4 * 32 bits */
172 avctx->extradata_size = 16;
174 avctx->extradata = av_mallocz(avctx->extradata_size +
175 AV_INPUT_BUFFER_PADDING_SIZE);
177 if (!avctx->extradata) {
178 av_log(avctx, AV_LOG_ERROR, "Could not allocate extradata.\n");
179 utvideo_encode_close(avctx);
180 return AVERROR(ENOMEM);
183 for (i = 0; i < c->planes; i++) {
184 c->slice_buffer[i] = av_malloc(c->slice_stride * (avctx->height + 2) +
185 AV_INPUT_BUFFER_PADDING_SIZE);
186 if (!c->slice_buffer[i]) {
187 av_log(avctx, AV_LOG_ERROR, "Cannot allocate temporary buffer 1.\n");
188 utvideo_encode_close(avctx);
189 return AVERROR(ENOMEM);
194 * Set the version of the encoder.
195 * Last byte is "implementation ID", which is
196 * obtained from the creator of the format.
197 * Libavcodec has been assigned with the ID 0xF0.
199 AV_WB32(avctx->extradata, MKTAG(1, 0, 0, 0xF0));
202 * Set the "original format"
203 * Not used for anything during decoding.
205 AV_WL32(avctx->extradata + 4, original_format);
207 /* Write 4 as the 'frame info size' */
208 AV_WL32(avctx->extradata + 8, c->frame_info_size);
211 * Set how many slices are going to be used.
212 * By default uses multiple slices depending on the subsampled height.
213 * This enables multithreading in the official decoder.
215 if (!avctx->slices) {
216 c->slices = subsampled_height / 120;
220 else if (c->slices > 256)
223 c->slices = avctx->slices;
226 /* Set compression mode */
227 c->compression = COMP_HUFF;
230 * Set the encoding flags:
231 * - Slice count minus 1
232 * - Interlaced encoding mode flag, set to zero for now.
233 * - Compression mode (none/huff)
234 * And write the flags.
236 c->flags = (c->slices - 1) << 24;
237 c->flags |= 0 << 11; // bit field to signal interlaced encoding mode
238 c->flags |= c->compression;
240 AV_WL32(avctx->extradata + 12, c->flags);
245 static void mangle_rgb_planes(uint8_t *dst[4], ptrdiff_t dst_stride,
246 uint8_t *const src[4], int planes, const int stride[4],
247 int width, int height)
250 int k = 2 * dst_stride;
251 const uint8_t *sg = src[0];
252 const uint8_t *sb = src[1];
253 const uint8_t *sr = src[2];
254 const uint8_t *sa = src[3];
257 for (j = 0; j < height; j++) {
259 for (i = 0; i < width; i++) {
263 dst[1][k] = sb[i] - g;
264 dst[2][k] = sr[i] - g;
268 for (i = 0; i < width; i++) {
272 dst[1][k] = sb[i] - g;
273 dst[2][k] = sr[i] - g;
279 k += dst_stride - width;
289 /* Write data to a plane with median prediction */
290 static void median_predict(UtvideoContext *c, uint8_t *src, uint8_t *dst,
291 ptrdiff_t stride, int width, int height)
297 /* First line uses left neighbour prediction */
298 prev = 0x80; /* Set the initial value */
299 for (i = 0; i < width; i++) {
300 *dst++ = src[i] - prev;
310 * Second line uses top prediction for the first sample,
311 * and median for the rest.
315 /* Rest of the coded part uses median prediction */
316 for (j = 1; j < height; j++) {
317 c->llvidencdsp.sub_median_pred(dst, src - stride, src, width, &A, &B);
323 /* Count the usage of values in a plane */
324 static void count_usage(uint8_t *src, int width,
325 int height, uint64_t *counts)
329 for (j = 0; j < height; j++) {
330 for (i = 0; i < width; i++) {
337 /* Calculate the actual huffman codes from the code lengths */
338 static void calculate_codes(HuffEntry *he)
343 qsort(he, 256, sizeof(*he), ff_ut_huff_cmp_len);
346 while (he[last].len == 255 && last)
350 for (i = last; i >= 0; i--) {
351 he[i].code = code >> (32 - he[i].len);
352 code += 0x80000000u >> (he[i].len - 1);
355 qsort(he, 256, sizeof(*he), huff_cmp_sym);
358 /* Write huffman bit codes to a memory block */
359 static int write_huff_codes(uint8_t *src, uint8_t *dst, int dst_size,
360 int width, int height, HuffEntry *he)
366 init_put_bits(&pb, dst, dst_size);
368 /* Write the codes */
369 for (j = 0; j < height; j++) {
370 for (i = 0; i < width; i++)
371 put_bits(&pb, he[src[i]].len, he[src[i]].code);
376 /* Pad output to a 32-bit boundary */
377 count = put_bits_count(&pb) & 0x1F;
380 put_bits(&pb, 32 - count, 0);
382 /* Get the amount of bits written */
383 count = put_bits_count(&pb);
385 /* Flush the rest with zeroes */
391 static int encode_plane(AVCodecContext *avctx, uint8_t *src,
392 uint8_t *dst, ptrdiff_t stride, int plane_no,
393 int width, int height, PutByteContext *pb)
395 UtvideoContext *c = avctx->priv_data;
396 uint8_t lengths[256];
397 uint64_t counts[256] = { 0 };
401 uint32_t offset = 0, slice_len = 0;
402 const int cmask = ~(!plane_no && avctx->pix_fmt == AV_PIX_FMT_YUV420P);
403 int i, sstart, send = 0;
407 /* Do prediction / make planes */
408 switch (c->frame_pred) {
410 for (i = 0; i < c->slices; i++) {
412 send = height * (i + 1) / c->slices & cmask;
413 av_image_copy_plane(dst + sstart * width, width,
414 src + sstart * stride, stride,
415 width, send - sstart);
419 for (i = 0; i < c->slices; i++) {
421 send = height * (i + 1) / c->slices & cmask;
422 c->llvidencdsp.sub_left_predict(dst + sstart * width, src + sstart * stride, stride, width, send - sstart);
426 for (i = 0; i < c->slices; i++) {
428 send = height * (i + 1) / c->slices & cmask;
429 median_predict(c, src + sstart * stride, dst + sstart * width,
430 stride, width, send - sstart);
434 av_log(avctx, AV_LOG_ERROR, "Unknown prediction mode: %d\n",
436 return AVERROR_OPTION_NOT_FOUND;
439 /* Count the usage of values */
440 count_usage(dst, width, height, counts);
442 /* Check for a special case where only one symbol was used */
443 for (symbol = 0; symbol < 256; symbol++) {
444 /* If non-zero count is found, see if it matches width * height */
445 if (counts[symbol]) {
446 /* Special case if only one symbol was used */
447 if (counts[symbol] == width * (int64_t)height) {
449 * Write a zero for the single symbol
450 * used in the plane, else 0xFF.
452 for (i = 0; i < 256; i++) {
454 bytestream2_put_byte(pb, 0);
456 bytestream2_put_byte(pb, 0xFF);
459 /* Write zeroes for lengths */
460 for (i = 0; i < c->slices; i++)
461 bytestream2_put_le32(pb, 0);
463 /* And that's all for that plane folks */
470 /* Calculate huffman lengths */
471 if ((ret = ff_huff_gen_len_table(lengths, counts, 256, 1)) < 0)
475 * Write the plane's header into the output packet:
476 * - huffman code lengths (256 bytes)
477 * - slice end offsets (gotten from the slice lengths)
479 for (i = 0; i < 256; i++) {
480 bytestream2_put_byte(pb, lengths[i]);
482 he[i].len = lengths[i];
486 /* Calculate the huffman codes themselves */
490 for (i = 0; i < c->slices; i++) {
492 send = height * (i + 1) / c->slices & cmask;
495 * Write the huffman codes to a buffer,
496 * get the offset in bits and convert to bytes.
498 offset += write_huff_codes(dst + sstart * width, c->slice_bits,
499 width * height + 4, width,
500 send - sstart, he) >> 3;
502 slice_len = offset - slice_len;
504 /* Byteswap the written huffman codes */
505 c->bdsp.bswap_buf((uint32_t *) c->slice_bits,
506 (uint32_t *) c->slice_bits,
509 /* Write the offset to the stream */
510 bytestream2_put_le32(pb, offset);
512 /* Seek to the data part of the packet */
513 bytestream2_seek_p(pb, 4 * (c->slices - i - 1) +
514 offset - slice_len, SEEK_CUR);
516 /* Write the slices' data into the output packet */
517 bytestream2_put_buffer(pb, c->slice_bits, slice_len);
519 /* Seek back to the slice offsets */
520 bytestream2_seek_p(pb, -4 * (c->slices - i - 1) - offset,
526 /* And at the end seek to the end of written slice(s) */
527 bytestream2_seek_p(pb, offset, SEEK_CUR);
532 static int utvideo_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
533 const AVFrame *pic, int *got_packet)
535 UtvideoContext *c = avctx->priv_data;
542 int width = avctx->width, height = avctx->height;
545 /* Allocate a new packet if needed, and set it to the pointer dst */
546 ret = ff_alloc_packet2(avctx, pkt, (256 + 4 * c->slices + width * height) *
554 bytestream2_init_writer(&pb, dst, pkt->size);
556 av_fast_padded_malloc(&c->slice_bits, &c->slice_bits_size, width * height + 4);
558 if (!c->slice_bits) {
559 av_log(avctx, AV_LOG_ERROR, "Cannot allocate temporary buffer 2.\n");
560 return AVERROR(ENOMEM);
563 /* In case of RGB, mangle the planes to Ut Video's format */
564 if (avctx->pix_fmt == AV_PIX_FMT_GBRAP || avctx->pix_fmt == AV_PIX_FMT_GBRP)
565 mangle_rgb_planes(c->slice_buffer, c->slice_stride, pic->data,
566 c->planes, pic->linesize, width, height);
568 /* Deal with the planes */
569 switch (avctx->pix_fmt) {
570 case AV_PIX_FMT_GBRP:
571 case AV_PIX_FMT_GBRAP:
572 for (i = 0; i < c->planes; i++) {
573 ret = encode_plane(avctx, c->slice_buffer[i] + 2 * c->slice_stride,
574 c->slice_buffer[i], c->slice_stride, i,
578 av_log(avctx, AV_LOG_ERROR, "Error encoding plane %d.\n", i);
583 case AV_PIX_FMT_YUV444P:
584 for (i = 0; i < c->planes; i++) {
585 ret = encode_plane(avctx, pic->data[i], c->slice_buffer[0],
586 pic->linesize[i], i, width, height, &pb);
589 av_log(avctx, AV_LOG_ERROR, "Error encoding plane %d.\n", i);
594 case AV_PIX_FMT_YUV422P:
595 for (i = 0; i < c->planes; i++) {
596 ret = encode_plane(avctx, pic->data[i], c->slice_buffer[0],
597 pic->linesize[i], i, width >> !!i, height, &pb);
600 av_log(avctx, AV_LOG_ERROR, "Error encoding plane %d.\n", i);
605 case AV_PIX_FMT_YUV420P:
606 for (i = 0; i < c->planes; i++) {
607 ret = encode_plane(avctx, pic->data[i], c->slice_buffer[0],
608 pic->linesize[i], i, width >> !!i, height >> !!i,
612 av_log(avctx, AV_LOG_ERROR, "Error encoding plane %d.\n", i);
618 av_log(avctx, AV_LOG_ERROR, "Unknown pixel format: %d\n",
620 return AVERROR_INVALIDDATA;
624 * Write frame information (LE 32-bit unsigned)
625 * into the output packet.
626 * Contains the prediction method.
628 frame_info = c->frame_pred << 8;
629 bytestream2_put_le32(&pb, frame_info);
632 * At least currently Ut Video is IDR only.
633 * Set flags accordingly.
635 #if FF_API_CODED_FRAME
636 FF_DISABLE_DEPRECATION_WARNINGS
637 avctx->coded_frame->key_frame = 1;
638 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
639 FF_ENABLE_DEPRECATION_WARNINGS
642 pkt->size = bytestream2_tell_p(&pb);
643 pkt->flags |= AV_PKT_FLAG_KEY;
645 /* Packet should be done */
651 #define OFFSET(x) offsetof(UtvideoContext, x)
652 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
653 static const AVOption options[] = {
654 { "pred", "Prediction method", OFFSET(frame_pred), AV_OPT_TYPE_INT, { .i64 = PRED_LEFT }, PRED_NONE, PRED_MEDIAN, VE, "pred" },
655 { "none", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = PRED_NONE }, INT_MIN, INT_MAX, VE, "pred" },
656 { "left", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = PRED_LEFT }, INT_MIN, INT_MAX, VE, "pred" },
657 { "gradient", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = PRED_GRADIENT }, INT_MIN, INT_MAX, VE, "pred" },
658 { "median", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = PRED_MEDIAN }, INT_MIN, INT_MAX, VE, "pred" },
663 static const AVClass utvideo_class = {
664 .class_name = "utvideo",
665 .item_name = av_default_item_name,
667 .version = LIBAVUTIL_VERSION_INT,
670 AVCodec ff_utvideo_encoder = {
672 .long_name = NULL_IF_CONFIG_SMALL("Ut Video"),
673 .type = AVMEDIA_TYPE_VIDEO,
674 .id = AV_CODEC_ID_UTVIDEO,
675 .priv_data_size = sizeof(UtvideoContext),
676 .priv_class = &utvideo_class,
677 .init = utvideo_encode_init,
678 .encode2 = utvideo_encode_frame,
679 .close = utvideo_encode_close,
680 .capabilities = AV_CODEC_CAP_FRAME_THREADS | AV_CODEC_CAP_INTRA_ONLY,
681 .pix_fmts = (const enum AVPixelFormat[]) {
682 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP, AV_PIX_FMT_YUV422P,
683 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_NONE