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