00185cfd9ad52f5b723b8c8a669d8a0eb134c811
[ffmpeg.git] / libavcodec / utvideoenc.c
1 /*
2  * Ut Video encoder
3  * Copyright (c) 2012 Jan Ekström
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  * Ut Video encoder
25  */
26
27 #include "libavutil/imgutils.h"
28 #include "libavutil/intreadwrite.h"
29 #include "libavutil/opt.h"
30
31 #include "avcodec.h"
32 #include "internal.h"
33 #include "bswapdsp.h"
34 #include "bytestream.h"
35 #include "put_bits.h"
36 #include "huffyuvencdsp.h"
37 #include "mathops.h"
38 #include "utvideo.h"
39 #include "huffman.h"
40
41 /* Compare huffentry symbols */
42 static int huff_cmp_sym(const void *a, const void *b)
43 {
44     const HuffEntry *aa = a, *bb = b;
45     return aa->sym - bb->sym;
46 }
47
48 static av_cold int utvideo_encode_close(AVCodecContext *avctx)
49 {
50     UtvideoContext *c = avctx->priv_data;
51     int i;
52
53     av_freep(&c->slice_bits);
54     for (i = 0; i < 4; i++)
55         av_freep(&c->slice_buffer[i]);
56
57     return 0;
58 }
59
60 static av_cold int utvideo_encode_init(AVCodecContext *avctx)
61 {
62     UtvideoContext *c = avctx->priv_data;
63     int i, subsampled_height;
64     uint32_t original_format;
65
66     c->avctx           = avctx;
67     c->frame_info_size = 4;
68     c->slice_stride    = FFALIGN(avctx->width, 32);
69
70     switch (avctx->pix_fmt) {
71     case AV_PIX_FMT_RGB24:
72         c->planes        = 3;
73         avctx->codec_tag = MKTAG('U', 'L', 'R', 'G');
74         original_format  = UTVIDEO_RGB;
75         break;
76     case AV_PIX_FMT_RGBA:
77         c->planes        = 4;
78         avctx->codec_tag = MKTAG('U', 'L', 'R', 'A');
79         original_format  = UTVIDEO_RGBA;
80         break;
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;
86         }
87         c->planes        = 3;
88         if (avctx->colorspace == AVCOL_SPC_BT709)
89             avctx->codec_tag = MKTAG('U', 'L', 'H', '0');
90         else
91             avctx->codec_tag = MKTAG('U', 'L', 'Y', '0');
92         original_format  = UTVIDEO_420;
93         break;
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;
99         }
100         c->planes        = 3;
101         if (avctx->colorspace == AVCOL_SPC_BT709)
102             avctx->codec_tag = MKTAG('U', 'L', 'H', '2');
103         else
104             avctx->codec_tag = MKTAG('U', 'L', 'Y', '2');
105         original_format  = UTVIDEO_422;
106         break;
107     default:
108         av_log(avctx, AV_LOG_ERROR, "Unknown pixel format: %d\n",
109                avctx->pix_fmt);
110         return AVERROR_INVALIDDATA;
111     }
112
113     ff_bswapdsp_init(&c->bdsp);
114     ff_huffyuvencdsp_init(&c->hdsp);
115
116 #if FF_API_PRIVATE_OPT
117 FF_DISABLE_DEPRECATION_WARNINGS
118     /* Check the prediction method, and error out if unsupported */
119     if (avctx->prediction_method < 0 || avctx->prediction_method > 4) {
120         av_log(avctx, AV_LOG_WARNING,
121                "Prediction method %d is not supported in Ut Video.\n",
122                avctx->prediction_method);
123         return AVERROR_OPTION_NOT_FOUND;
124     }
125
126     if (avctx->prediction_method == FF_PRED_PLANE) {
127         av_log(avctx, AV_LOG_ERROR,
128                "Plane prediction is not supported in Ut Video.\n");
129         return AVERROR_OPTION_NOT_FOUND;
130     }
131
132     /* Convert from libavcodec prediction type to Ut Video's */
133     if (avctx->prediction_method)
134         c->frame_pred = ff_ut_pred_order[avctx->prediction_method];
135 FF_ENABLE_DEPRECATION_WARNINGS
136 #endif
137
138     if (c->frame_pred == PRED_GRADIENT) {
139         av_log(avctx, AV_LOG_ERROR, "Gradient prediction is not supported.\n");
140         return AVERROR_OPTION_NOT_FOUND;
141     }
142
143     /*
144      * Check the asked slice count for obviously invalid
145      * values (> 256 or negative).
146      */
147     if (avctx->slices > 256 || avctx->slices < 0) {
148         av_log(avctx, AV_LOG_ERROR,
149                "Slice count %d is not supported in Ut Video (theoretical range is 0-256).\n",
150                avctx->slices);
151         return AVERROR(EINVAL);
152     }
153
154     /* Check that the slice count is not larger than the subsampled height */
155     subsampled_height = avctx->height >> av_pix_fmt_desc_get(avctx->pix_fmt)->log2_chroma_h;
156     if (avctx->slices > subsampled_height) {
157         av_log(avctx, AV_LOG_ERROR,
158                "Slice count %d is larger than the subsampling-applied height %d.\n",
159                avctx->slices, subsampled_height);
160         return AVERROR(EINVAL);
161     }
162
163     /* extradata size is 4 * 32bit */
164     avctx->extradata_size = 16;
165
166     avctx->extradata = av_mallocz(avctx->extradata_size +
167                                   AV_INPUT_BUFFER_PADDING_SIZE);
168
169     if (!avctx->extradata) {
170         av_log(avctx, AV_LOG_ERROR, "Could not allocate extradata.\n");
171         utvideo_encode_close(avctx);
172         return AVERROR(ENOMEM);
173     }
174
175     for (i = 0; i < c->planes; i++) {
176         c->slice_buffer[i] = av_malloc(c->slice_stride * (avctx->height + 2) +
177                                        AV_INPUT_BUFFER_PADDING_SIZE);
178         if (!c->slice_buffer[i]) {
179             av_log(avctx, AV_LOG_ERROR, "Cannot allocate temporary buffer 1.\n");
180             utvideo_encode_close(avctx);
181             return AVERROR(ENOMEM);
182         }
183     }
184
185     /*
186      * Set the version of the encoder.
187      * Last byte is "implementation ID", which is
188      * obtained from the creator of the format.
189      * Libavcodec has been assigned with the ID 0xF0.
190      */
191     AV_WB32(avctx->extradata, MKTAG(1, 0, 0, 0xF0));
192
193     /*
194      * Set the "original format"
195      * Not used for anything during decoding.
196      */
197     AV_WL32(avctx->extradata + 4, original_format);
198
199     /* Write 4 as the 'frame info size' */
200     AV_WL32(avctx->extradata + 8, c->frame_info_size);
201
202     /*
203      * Set how many slices are going to be used.
204      * By default uses multiple slices depending on the subsampled height.
205      * This enables multithreading in the official decoder.
206      */
207     if (!avctx->slices) {
208         c->slices = subsampled_height / 120;
209
210         if (!c->slices)
211             c->slices = 1;
212         else if (c->slices > 256)
213             c->slices = 256;
214     } else {
215         c->slices = avctx->slices;
216     }
217
218     /* Set compression mode */
219     c->compression = COMP_HUFF;
220
221     /*
222      * Set the encoding flags:
223      * - Slice count minus 1
224      * - Interlaced encoding mode flag, set to zero for now.
225      * - Compression mode (none/huff)
226      * And write the flags.
227      */
228     c->flags  = (c->slices - 1) << 24;
229     c->flags |= 0 << 11; // bit field to signal interlaced encoding mode
230     c->flags |= c->compression;
231
232     AV_WL32(avctx->extradata + 12, c->flags);
233
234     return 0;
235 }
236
237 static void mangle_rgb_planes(uint8_t *dst[4], int dst_stride, uint8_t *src,
238                               int step, int stride, int width, int height)
239 {
240     int i, j;
241     int k = 2 * dst_stride;
242     unsigned int g;
243
244     for (j = 0; j < height; j++) {
245         if (step == 3) {
246             for (i = 0; i < width * step; i += step) {
247                 g         = src[i + 1];
248                 dst[0][k] = g;
249                 g        += 0x80;
250                 dst[1][k] = src[i + 2] - g;
251                 dst[2][k] = src[i + 0] - g;
252                 k++;
253             }
254         } else {
255             for (i = 0; i < width * step; i += step) {
256                 g         = src[i + 1];
257                 dst[0][k] = g;
258                 g        += 0x80;
259                 dst[1][k] = src[i + 2] - g;
260                 dst[2][k] = src[i + 0] - g;
261                 dst[3][k] = src[i + 3];
262                 k++;
263             }
264         }
265         k += dst_stride - width;
266         src += stride;
267     }
268 }
269
270 /* Write data to a plane with left prediction */
271 static void left_predict(uint8_t *src, uint8_t *dst, int stride,
272                          int width, int height)
273 {
274     int i, j;
275     uint8_t prev;
276
277     prev = 0x80; /* Set the initial value */
278     for (j = 0; j < height; j++) {
279         for (i = 0; i < width; i++) {
280             *dst++ = src[i] - prev;
281             prev   = src[i];
282         }
283         src += stride;
284     }
285 }
286
287 /* Write data to a plane with median prediction */
288 static void median_predict(UtvideoContext *c, uint8_t *src, uint8_t *dst, int stride,
289                            int width, int height)
290 {
291     int i, j;
292     int A, B;
293     uint8_t prev;
294
295     /* First line uses left neighbour prediction */
296     prev = 0x80; /* Set the initial value */
297     for (i = 0; i < width; i++) {
298         *dst++ = src[i] - prev;
299         prev   = src[i];
300     }
301
302     if (height == 1)
303         return;
304
305     src += stride;
306
307     /*
308      * Second line uses top prediction for the first sample,
309      * and median for the rest.
310      */
311     A = B = 0;
312
313     /* Rest of the coded part uses median prediction */
314     for (j = 1; j < height; j++) {
315         c->hdsp.sub_hfyu_median_pred(dst, src - stride, src, width, &A, &B);
316         dst += width;
317         src += stride;
318     }
319 }
320
321 /* Count the usage of values in a plane */
322 static void count_usage(uint8_t *src, int width,
323                         int height, uint64_t *counts)
324 {
325     int i, j;
326
327     for (j = 0; j < height; j++) {
328         for (i = 0; i < width; i++) {
329             counts[src[i]]++;
330         }
331         src += width;
332     }
333 }
334
335 /* Calculate the actual huffman codes from the code lengths */
336 static void calculate_codes(HuffEntry *he)
337 {
338     int last, i;
339     uint32_t code;
340
341     qsort(he, 256, sizeof(*he), ff_ut_huff_cmp_len);
342
343     last = 255;
344     while (he[last].len == 255 && last)
345         last--;
346
347     code = 1;
348     for (i = last; i >= 0; i--) {
349         he[i].code  = code >> (32 - he[i].len);
350         code       += 0x80000000u >> (he[i].len - 1);
351     }
352
353     qsort(he, 256, sizeof(*he), huff_cmp_sym);
354 }
355
356 /* Write huffman bit codes to a memory block */
357 static int write_huff_codes(uint8_t *src, uint8_t *dst, int dst_size,
358                             int width, int height, HuffEntry *he)
359 {
360     PutBitContext pb;
361     int i, j;
362     int count;
363
364     init_put_bits(&pb, dst, dst_size);
365
366     /* Write the codes */
367     for (j = 0; j < height; j++) {
368         for (i = 0; i < width; i++)
369             put_bits(&pb, he[src[i]].len, he[src[i]].code);
370
371         src += width;
372     }
373
374     /* Pad output to a 32bit boundary */
375     count = put_bits_count(&pb) & 0x1F;
376
377     if (count)
378         put_bits(&pb, 32 - count, 0);
379
380     /* Get the amount of bits written */
381     count = put_bits_count(&pb);
382
383     /* Flush the rest with zeroes */
384     flush_put_bits(&pb);
385
386     return count;
387 }
388
389 static int encode_plane(AVCodecContext *avctx, uint8_t *src,
390                         uint8_t *dst, int stride, int plane_no,
391                         int width, int height, PutByteContext *pb)
392 {
393     UtvideoContext *c        = avctx->priv_data;
394     uint8_t  lengths[256];
395     uint64_t counts[256]     = { 0 };
396
397     HuffEntry he[256];
398
399     uint32_t offset = 0, slice_len = 0;
400     const int cmask = ~(!plane_no && avctx->pix_fmt == AV_PIX_FMT_YUV420P);
401     int      i, sstart, send = 0;
402     int      symbol;
403     int      ret;
404
405     /* Do prediction / make planes */
406     switch (c->frame_pred) {
407     case PRED_NONE:
408         for (i = 0; i < c->slices; i++) {
409             sstart = send;
410             send   = height * (i + 1) / c->slices & cmask;
411             av_image_copy_plane(dst + sstart * width, width,
412                                 src + sstart * stride, stride,
413                                 width, send - sstart);
414         }
415         break;
416     case PRED_LEFT:
417         for (i = 0; i < c->slices; i++) {
418             sstart = send;
419             send   = height * (i + 1) / c->slices & cmask;
420             left_predict(src + sstart * stride, dst + sstart * width,
421                          stride, width, send - sstart);
422         }
423         break;
424     case PRED_MEDIAN:
425         for (i = 0; i < c->slices; i++) {
426             sstart = send;
427             send   = height * (i + 1) / c->slices & cmask;
428             median_predict(c, src + sstart * stride, dst + sstart * width,
429                            stride, width, send - sstart);
430         }
431         break;
432     default:
433         av_log(avctx, AV_LOG_ERROR, "Unknown prediction mode: %d\n",
434                c->frame_pred);
435         return AVERROR_OPTION_NOT_FOUND;
436     }
437
438     /* Count the usage of values */
439     count_usage(dst, width, height, counts);
440
441     /* Check for a special case where only one symbol was used */
442     for (symbol = 0; symbol < 256; symbol++) {
443         /* If non-zero count is found, see if it matches width * height */
444         if (counts[symbol]) {
445             /* Special case if only one symbol was used */
446             if (counts[symbol] == width * (int64_t)height) {
447                 /*
448                  * Write a zero for the single symbol
449                  * used in the plane, else 0xFF.
450                  */
451                 for (i = 0; i < 256; i++) {
452                     if (i == symbol)
453                         bytestream2_put_byte(pb, 0);
454                     else
455                         bytestream2_put_byte(pb, 0xFF);
456                 }
457
458                 /* Write zeroes for lengths */
459                 for (i = 0; i < c->slices; i++)
460                     bytestream2_put_le32(pb, 0);
461
462                 /* And that's all for that plane folks */
463                 return 0;
464             }
465             break;
466         }
467     }
468
469     /* Calculate huffman lengths */
470     if ((ret = ff_huff_gen_len_table(lengths, counts, 256, 1)) < 0)
471         return ret;
472
473     /*
474      * Write the plane's header into the output packet:
475      * - huffman code lengths (256 bytes)
476      * - slice end offsets (gotten from the slice lengths)
477      */
478     for (i = 0; i < 256; i++) {
479         bytestream2_put_byte(pb, lengths[i]);
480
481         he[i].len = lengths[i];
482         he[i].sym = i;
483     }
484
485     /* Calculate the huffman codes themselves */
486     calculate_codes(he);
487
488     send = 0;
489     for (i = 0; i < c->slices; i++) {
490         sstart  = send;
491         send    = height * (i + 1) / c->slices & cmask;
492
493         /*
494          * Write the huffman codes to a buffer,
495          * get the offset in bits and convert to bytes.
496          */
497         offset += write_huff_codes(dst + sstart * width, c->slice_bits,
498                                    width * height + 4, width,
499                                    send - sstart, he) >> 3;
500
501         slice_len = offset - slice_len;
502
503         /* Byteswap the written huffman codes */
504         c->bdsp.bswap_buf((uint32_t *) c->slice_bits,
505                           (uint32_t *) c->slice_bits,
506                           slice_len >> 2);
507
508         /* Write the offset to the stream */
509         bytestream2_put_le32(pb, offset);
510
511         /* Seek to the data part of the packet */
512         bytestream2_seek_p(pb, 4 * (c->slices - i - 1) +
513                            offset - slice_len, SEEK_CUR);
514
515         /* Write the slices' data into the output packet */
516         bytestream2_put_buffer(pb, c->slice_bits, slice_len);
517
518         /* Seek back to the slice offsets */
519         bytestream2_seek_p(pb, -4 * (c->slices - i - 1) - offset,
520                            SEEK_CUR);
521
522         slice_len = offset;
523     }
524
525     /* And at the end seek to the end of written slice(s) */
526     bytestream2_seek_p(pb, offset, SEEK_CUR);
527
528     return 0;
529 }
530
531 static int utvideo_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
532                                 const AVFrame *pic, int *got_packet)
533 {
534     UtvideoContext *c = avctx->priv_data;
535     PutByteContext pb;
536
537     uint32_t frame_info;
538
539     uint8_t *dst;
540
541     int width = avctx->width, height = avctx->height;
542     int i, ret = 0;
543
544     /* Allocate a new packet if needed, and set it to the pointer dst */
545     ret = ff_alloc_packet2(avctx, pkt, (256 + 4 * c->slices + width * height) *
546                            c->planes + 4, 0);
547
548     if (ret < 0)
549         return ret;
550
551     dst = pkt->data;
552
553     bytestream2_init_writer(&pb, dst, pkt->size);
554
555     av_fast_padded_malloc(&c->slice_bits, &c->slice_bits_size, width * height + 4);
556
557     if (!c->slice_bits) {
558         av_log(avctx, AV_LOG_ERROR, "Cannot allocate temporary buffer 2.\n");
559         return AVERROR(ENOMEM);
560     }
561
562     /* In case of RGB, mangle the planes to Ut Video's format */
563     if (avctx->pix_fmt == AV_PIX_FMT_RGBA || avctx->pix_fmt == AV_PIX_FMT_RGB24)
564         mangle_rgb_planes(c->slice_buffer, c->slice_stride, pic->data[0],
565                           c->planes, pic->linesize[0], width, height);
566
567     /* Deal with the planes */
568     switch (avctx->pix_fmt) {
569     case AV_PIX_FMT_RGB24:
570     case AV_PIX_FMT_RGBA:
571         for (i = 0; i < c->planes; i++) {
572             ret = encode_plane(avctx, c->slice_buffer[i] + 2 * c->slice_stride,
573                                c->slice_buffer[i], c->slice_stride, i,
574                                width, height, &pb);
575
576             if (ret) {
577                 av_log(avctx, AV_LOG_ERROR, "Error encoding plane %d.\n", i);
578                 return ret;
579             }
580         }
581         break;
582     case AV_PIX_FMT_YUV422P:
583         for (i = 0; i < c->planes; i++) {
584             ret = encode_plane(avctx, pic->data[i], c->slice_buffer[0],
585                                pic->linesize[i], i, width >> !!i, height, &pb);
586
587             if (ret) {
588                 av_log(avctx, AV_LOG_ERROR, "Error encoding plane %d.\n", i);
589                 return ret;
590             }
591         }
592         break;
593     case AV_PIX_FMT_YUV420P:
594         for (i = 0; i < c->planes; i++) {
595             ret = encode_plane(avctx, pic->data[i], c->slice_buffer[0],
596                                pic->linesize[i], i, width >> !!i, height >> !!i,
597                                &pb);
598
599             if (ret) {
600                 av_log(avctx, AV_LOG_ERROR, "Error encoding plane %d.\n", i);
601                 return ret;
602             }
603         }
604         break;
605     default:
606         av_log(avctx, AV_LOG_ERROR, "Unknown pixel format: %d\n",
607                avctx->pix_fmt);
608         return AVERROR_INVALIDDATA;
609     }
610
611     /*
612      * Write frame information (LE 32bit unsigned)
613      * into the output packet.
614      * Contains the prediction method.
615      */
616     frame_info = c->frame_pred << 8;
617     bytestream2_put_le32(&pb, frame_info);
618
619     /*
620      * At least currently Ut Video is IDR only.
621      * Set flags accordingly.
622      */
623 #if FF_API_CODED_FRAME
624 FF_DISABLE_DEPRECATION_WARNINGS
625     avctx->coded_frame->key_frame = 1;
626     avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
627 FF_ENABLE_DEPRECATION_WARNINGS
628 #endif
629
630     pkt->size   = bytestream2_tell_p(&pb);
631     pkt->flags |= AV_PKT_FLAG_KEY;
632
633     /* Packet should be done */
634     *got_packet = 1;
635
636     return 0;
637 }
638
639 #define OFFSET(x) offsetof(UtvideoContext, x)
640 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
641 static const AVOption options[] = {
642 { "pred", "Prediction method", OFFSET(frame_pred), AV_OPT_TYPE_INT, { .i64 = PRED_LEFT }, PRED_NONE, PRED_MEDIAN, VE, "pred" },
643     { "none",     NULL, 0, AV_OPT_TYPE_CONST, { .i64 = PRED_NONE }, INT_MIN, INT_MAX, VE, "pred" },
644     { "left",     NULL, 0, AV_OPT_TYPE_CONST, { .i64 = PRED_LEFT }, INT_MIN, INT_MAX, VE, "pred" },
645     { "gradient", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = PRED_GRADIENT }, INT_MIN, INT_MAX, VE, "pred" },
646     { "median",   NULL, 0, AV_OPT_TYPE_CONST, { .i64 = PRED_MEDIAN }, INT_MIN, INT_MAX, VE, "pred" },
647
648     { NULL},
649 };
650
651 static const AVClass utvideo_class = {
652     .class_name = "utvideo",
653     .item_name  = av_default_item_name,
654     .option     = options,
655     .version    = LIBAVUTIL_VERSION_INT,
656 };
657
658 AVCodec ff_utvideo_encoder = {
659     .name           = "utvideo",
660     .long_name      = NULL_IF_CONFIG_SMALL("Ut Video"),
661     .type           = AVMEDIA_TYPE_VIDEO,
662     .id             = AV_CODEC_ID_UTVIDEO,
663     .priv_data_size = sizeof(UtvideoContext),
664     .priv_class     = &utvideo_class,
665     .init           = utvideo_encode_init,
666     .encode2        = utvideo_encode_frame,
667     .close          = utvideo_encode_close,
668     .capabilities   = AV_CODEC_CAP_FRAME_THREADS | AV_CODEC_CAP_INTRA_ONLY,
669     .pix_fmts       = (const enum AVPixelFormat[]) {
670                           AV_PIX_FMT_RGB24, AV_PIX_FMT_RGBA, AV_PIX_FMT_YUV422P,
671                           AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE
672                       },
673 };