Merge commit '06c20d3e32c33c4da6d9fbc43aebaeb38c45b859'
[ffmpeg.git] / libavcodec / mjpegenc.c
1 /*
2  * MJPEG encoder
3  * Copyright (c) 2000, 2001 Fabrice Bellard
4  * Copyright (c) 2003 Alex Beregszaszi
5  * Copyright (c) 2003-2004 Michael Niedermayer
6  *
7  * Support for external huffman table, various fixes (AVID workaround),
8  * aspecting, new decode_frame mechanism and apple mjpeg-b support
9  *                                  by Alex Beregszaszi
10  *
11  * This file is part of FFmpeg.
12  *
13  * FFmpeg is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU Lesser General Public
15  * License as published by the Free Software Foundation; either
16  * version 2.1 of the License, or (at your option) any later version.
17  *
18  * FFmpeg is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21  * Lesser General Public License for more details.
22  *
23  * You should have received a copy of the GNU Lesser General Public
24  * License along with FFmpeg; if not, write to the Free Software
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26  */
27
28 /**
29  * @file
30  * MJPEG encoder.
31  */
32
33 #include "libavutil/pixdesc.h"
34
35 #include "avcodec.h"
36 #include "jpegtables.h"
37 #include "mjpegenc_common.h"
38 #include "mpegvideo.h"
39 #include "mjpeg.h"
40 #include "mjpegenc.h"
41
42 static int alloc_huffman(MpegEncContext *s)
43 {
44     MJpegContext *m = s->mjpeg_ctx;
45     size_t num_mbs, num_blocks, num_codes;
46     int blocks_per_mb;
47
48     // We need to init this here as the mjpeg init is called before the common init,
49     s->mb_width  = (s->width  + 15) / 16;
50     s->mb_height = (s->height + 15) / 16;
51
52     switch (s->chroma_format) {
53     case CHROMA_420: blocks_per_mb =  6; break;
54     case CHROMA_422: blocks_per_mb =  8; break;
55     case CHROMA_444: blocks_per_mb = 12; break;
56     default: av_assert0(0);
57     };
58
59     // Make sure we have enough space to hold this frame.
60     num_mbs = s->mb_width * s->mb_height;
61     num_blocks = num_mbs * blocks_per_mb;
62     num_codes = num_blocks * 64;
63
64     m->huff_buffer = av_malloc_array(num_codes, sizeof(MJpegHuffmanCode));
65     if (!m->huff_buffer)
66         return AVERROR(ENOMEM);
67     return 0;
68 }
69
70 av_cold int ff_mjpeg_encode_init(MpegEncContext *s)
71 {
72     MJpegContext *m;
73
74     av_assert0(s->slice_context_count == 1);
75
76     if (s->width > 65500 || s->height > 65500) {
77         av_log(s, AV_LOG_ERROR, "JPEG does not support resolutions above 65500x65500\n");
78         return AVERROR(EINVAL);
79     }
80
81     m = av_mallocz(sizeof(MJpegContext));
82     if (!m)
83         return AVERROR(ENOMEM);
84
85     s->min_qcoeff=-1023;
86     s->max_qcoeff= 1023;
87
88     // Build default Huffman tables.
89     // These may be overwritten later with more optimal Huffman tables, but
90     // they are needed at least right now for some processes like trellis.
91     ff_mjpeg_build_huffman_codes(m->huff_size_dc_luminance,
92                                  m->huff_code_dc_luminance,
93                                  avpriv_mjpeg_bits_dc_luminance,
94                                  avpriv_mjpeg_val_dc);
95     ff_mjpeg_build_huffman_codes(m->huff_size_dc_chrominance,
96                                  m->huff_code_dc_chrominance,
97                                  avpriv_mjpeg_bits_dc_chrominance,
98                                  avpriv_mjpeg_val_dc);
99     ff_mjpeg_build_huffman_codes(m->huff_size_ac_luminance,
100                                  m->huff_code_ac_luminance,
101                                  avpriv_mjpeg_bits_ac_luminance,
102                                  avpriv_mjpeg_val_ac_luminance);
103     ff_mjpeg_build_huffman_codes(m->huff_size_ac_chrominance,
104                                  m->huff_code_ac_chrominance,
105                                  avpriv_mjpeg_bits_ac_chrominance,
106                                  avpriv_mjpeg_val_ac_chrominance);
107
108     ff_init_uni_ac_vlc(m->huff_size_ac_luminance,   m->uni_ac_vlc_len);
109     ff_init_uni_ac_vlc(m->huff_size_ac_chrominance, m->uni_chroma_ac_vlc_len);
110     s->intra_ac_vlc_length      =
111     s->intra_ac_vlc_last_length = m->uni_ac_vlc_len;
112     s->intra_chroma_ac_vlc_length      =
113     s->intra_chroma_ac_vlc_last_length = m->uni_chroma_ac_vlc_len;
114
115     // Buffers start out empty.
116     m->huff_ncode = 0;
117     s->mjpeg_ctx = m;
118
119     if(s->huffman == HUFFMAN_TABLE_OPTIMAL)
120         return alloc_huffman(s);
121
122     return 0;
123 }
124
125 av_cold void ff_mjpeg_encode_close(MpegEncContext *s)
126 {
127     av_freep(&s->mjpeg_ctx->huff_buffer);
128     av_freep(&s->mjpeg_ctx);
129 }
130
131 /**
132  * Add code and table_id to the JPEG buffer.
133  *
134  * @param s The MJpegContext which contains the JPEG buffer.
135  * @param table_id Which Huffman table the code belongs to.
136  * @param code The encoded exponent of the coefficients and the run-bits.
137  */
138 static inline void ff_mjpeg_encode_code(MJpegContext *s, uint8_t table_id, int code)
139 {
140     MJpegHuffmanCode *c = &s->huff_buffer[s->huff_ncode++];
141     c->table_id = table_id;
142     c->code = code;
143 }
144
145 /**
146  * Add the coefficient's data to the JPEG buffer.
147  *
148  * @param s The MJpegContext which contains the JPEG buffer.
149  * @param table_id Which Huffman table the code belongs to.
150  * @param val The coefficient.
151  * @param run The run-bits.
152  */
153 static void ff_mjpeg_encode_coef(MJpegContext *s, uint8_t table_id, int val, int run)
154 {
155     int mant, code;
156
157     if (val == 0) {
158         av_assert0(run == 0);
159         ff_mjpeg_encode_code(s, table_id, 0);
160     } else {
161         mant = val;
162         if (val < 0) {
163             val = -val;
164             mant--;
165         }
166
167         code = (run << 4) | (av_log2_16bit(val) + 1);
168
169         s->huff_buffer[s->huff_ncode].mant = mant;
170         ff_mjpeg_encode_code(s, table_id, code);
171     }
172 }
173
174 /**
175  * Add the block's data into the JPEG buffer.
176  *
177  * @param s The MJpegEncContext that contains the JPEG buffer.
178  * @param block The block.
179  * @param n The block's index or number.
180  */
181 static void record_block(MpegEncContext *s, int16_t *block, int n)
182 {
183     int i, j, table_id;
184     int component, dc, last_index, val, run;
185     MJpegContext *m = s->mjpeg_ctx;
186
187     /* DC coef */
188     component = (n <= 3 ? 0 : (n&1) + 1);
189     table_id = (n <= 3 ? 0 : 1);
190     dc = block[0]; /* overflow is impossible */
191     val = dc - s->last_dc[component];
192
193     ff_mjpeg_encode_coef(m, table_id, val, 0);
194
195     s->last_dc[component] = dc;
196
197     /* AC coefs */
198
199     run = 0;
200     last_index = s->block_last_index[n];
201     table_id |= 2;
202
203     for(i=1;i<=last_index;i++) {
204         j = s->intra_scantable.permutated[i];
205         val = block[j];
206
207         if (val == 0) {
208             run++;
209         } else {
210             while (run >= 16) {
211                 ff_mjpeg_encode_code(m, table_id, 0xf0);
212                 run -= 16;
213             }
214             ff_mjpeg_encode_coef(m, table_id, val, run);
215             run = 0;
216         }
217     }
218
219     /* output EOB only if not already 64 values */
220     if (last_index < 63 || run != 0)
221         ff_mjpeg_encode_code(m, table_id, 0);
222 }
223
224 static void encode_block(MpegEncContext *s, int16_t *block, int n)
225 {
226     int mant, nbits, code, i, j;
227     int component, dc, run, last_index, val;
228     MJpegContext *m = s->mjpeg_ctx;
229     uint8_t *huff_size_ac;
230     uint16_t *huff_code_ac;
231
232     /* DC coef */
233     component = (n <= 3 ? 0 : (n&1) + 1);
234     dc = block[0]; /* overflow is impossible */
235     val = dc - s->last_dc[component];
236     if (n < 4) {
237         ff_mjpeg_encode_dc(&s->pb, val, m->huff_size_dc_luminance, m->huff_code_dc_luminance);
238         huff_size_ac = m->huff_size_ac_luminance;
239         huff_code_ac = m->huff_code_ac_luminance;
240     } else {
241         ff_mjpeg_encode_dc(&s->pb, val, m->huff_size_dc_chrominance, m->huff_code_dc_chrominance);
242         huff_size_ac = m->huff_size_ac_chrominance;
243         huff_code_ac = m->huff_code_ac_chrominance;
244     }
245     s->last_dc[component] = dc;
246
247     /* AC coefs */
248
249     run = 0;
250     last_index = s->block_last_index[n];
251     for(i=1;i<=last_index;i++) {
252         j = s->intra_scantable.permutated[i];
253         val = block[j];
254         if (val == 0) {
255             run++;
256         } else {
257             while (run >= 16) {
258                 put_bits(&s->pb, huff_size_ac[0xf0], huff_code_ac[0xf0]);
259                 run -= 16;
260             }
261             mant = val;
262             if (val < 0) {
263                 val = -val;
264                 mant--;
265             }
266
267             nbits= av_log2_16bit(val) + 1;
268             code = (run << 4) | nbits;
269
270             put_bits(&s->pb, huff_size_ac[code], huff_code_ac[code]);
271
272             put_sbits(&s->pb, nbits, mant);
273             run = 0;
274         }
275     }
276
277     /* output EOB only if not already 64 values */
278     if (last_index < 63 || run != 0)
279         put_bits(&s->pb, huff_size_ac[0], huff_code_ac[0]);
280 }
281
282 void ff_mjpeg_encode_mb(MpegEncContext *s, int16_t block[12][64])
283 {
284     int i;
285     if (s->huffman == HUFFMAN_TABLE_OPTIMAL) {
286         if (s->chroma_format == CHROMA_444) {
287             record_block(s, block[0], 0);
288             record_block(s, block[2], 2);
289             record_block(s, block[4], 4);
290             record_block(s, block[8], 8);
291             record_block(s, block[5], 5);
292             record_block(s, block[9], 9);
293
294             if (16*s->mb_x+8 < s->width) {
295                 record_block(s, block[1], 1);
296                 record_block(s, block[3], 3);
297                 record_block(s, block[6], 6);
298                 record_block(s, block[10], 10);
299                 record_block(s, block[7], 7);
300                 record_block(s, block[11], 11);
301             }
302         } else {
303             for(i=0;i<5;i++) {
304                 record_block(s, block[i], i);
305             }
306             if (s->chroma_format == CHROMA_420) {
307                 record_block(s, block[5], 5);
308             } else {
309                 record_block(s, block[6], 6);
310                 record_block(s, block[5], 5);
311                 record_block(s, block[7], 7);
312             }
313         }
314     } else {
315         if (s->chroma_format == CHROMA_444) {
316             encode_block(s, block[0], 0);
317             encode_block(s, block[2], 2);
318             encode_block(s, block[4], 4);
319             encode_block(s, block[8], 8);
320             encode_block(s, block[5], 5);
321             encode_block(s, block[9], 9);
322
323             if (16*s->mb_x+8 < s->width) {
324                 encode_block(s, block[1], 1);
325                 encode_block(s, block[3], 3);
326                 encode_block(s, block[6], 6);
327                 encode_block(s, block[10], 10);
328                 encode_block(s, block[7], 7);
329                 encode_block(s, block[11], 11);
330             }
331         } else {
332             for(i=0;i<5;i++) {
333                 encode_block(s, block[i], i);
334             }
335             if (s->chroma_format == CHROMA_420) {
336                 encode_block(s, block[5], 5);
337             } else {
338                 encode_block(s, block[6], 6);
339                 encode_block(s, block[5], 5);
340                 encode_block(s, block[7], 7);
341             }
342         }
343
344         s->i_tex_bits += get_bits_diff(s);
345     }
346 }
347
348 #if CONFIG_AMV_ENCODER
349 // maximum over s->mjpeg_vsample[i]
350 #define V_MAX 2
351 static int amv_encode_picture(AVCodecContext *avctx, AVPacket *pkt,
352                               const AVFrame *pic_arg, int *got_packet)
353 {
354     MpegEncContext *s = avctx->priv_data;
355     AVFrame *pic;
356     int i, ret;
357     int chroma_h_shift, chroma_v_shift;
358
359     av_pix_fmt_get_chroma_sub_sample(avctx->pix_fmt, &chroma_h_shift, &chroma_v_shift);
360
361 #if FF_API_EMU_EDGE
362     //CODEC_FLAG_EMU_EDGE have to be cleared
363     if(s->avctx->flags & CODEC_FLAG_EMU_EDGE)
364         return AVERROR(EINVAL);
365 #endif
366
367     if ((avctx->height & 15) && avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL) {
368         av_log(avctx, AV_LOG_ERROR,
369                "Heights which are not a multiple of 16 might fail with some decoders, "
370                "use vstrict=-1 / -strict -1 to use %d anyway.\n", avctx->height);
371         av_log(avctx, AV_LOG_WARNING, "If you have a device that plays AMV videos, please test if videos "
372                "with such heights work with it and report your findings to ffmpeg-devel@ffmpeg.org\n");
373         return AVERROR_EXPERIMENTAL;
374     }
375
376     pic = av_frame_clone(pic_arg);
377     if (!pic)
378         return AVERROR(ENOMEM);
379     //picture should be flipped upside-down
380     for(i=0; i < 3; i++) {
381         int vsample = i ? 2 >> chroma_v_shift : 2;
382         pic->data[i] += pic->linesize[i] * (vsample * s->height / V_MAX - 1);
383         pic->linesize[i] *= -1;
384     }
385     ret = ff_mpv_encode_picture(avctx, pkt, pic, got_packet);
386     av_frame_free(&pic);
387     return ret;
388 }
389 #endif
390
391 #define OFFSET(x) offsetof(MpegEncContext, x)
392 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
393 static const AVOption options[] = {
394 FF_MPV_COMMON_OPTS
395 { "pred", "Prediction method", OFFSET(pred), AV_OPT_TYPE_INT, { .i64 = 1 }, 1, 3, VE, "pred" },
396     { "left",   NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, INT_MIN, INT_MAX, VE, "pred" },
397     { "plane",  NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 2 }, INT_MIN, INT_MAX, VE, "pred" },
398     { "median", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 3 }, INT_MIN, INT_MAX, VE, "pred" },
399 { "huffman", "Huffman table strategy", OFFSET(huffman), AV_OPT_TYPE_INT, { .i64 = HUFFMAN_TABLE_OPTIMAL }, 0, NB_HUFFMAN_TABLE_OPTION - 1, VE, "huffman" },
400     { "default", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = HUFFMAN_TABLE_DEFAULT }, INT_MIN, INT_MAX, VE, "huffman" },
401     { "optimal", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = HUFFMAN_TABLE_OPTIMAL }, INT_MIN, INT_MAX, VE, "huffman" },
402 { NULL},
403 };
404
405 #if CONFIG_MJPEG_ENCODER
406 static const AVClass mjpeg_class = {
407     .class_name = "mjpeg encoder",
408     .item_name  = av_default_item_name,
409     .option     = options,
410     .version    = LIBAVUTIL_VERSION_INT,
411 };
412
413 AVCodec ff_mjpeg_encoder = {
414     .name           = "mjpeg",
415     .long_name      = NULL_IF_CONFIG_SMALL("MJPEG (Motion JPEG)"),
416     .type           = AVMEDIA_TYPE_VIDEO,
417     .id             = AV_CODEC_ID_MJPEG,
418     .priv_data_size = sizeof(MpegEncContext),
419     .init           = ff_mpv_encode_init,
420     .encode2        = ff_mpv_encode_picture,
421     .close          = ff_mpv_encode_end,
422     .capabilities   = AV_CODEC_CAP_SLICE_THREADS | AV_CODEC_CAP_FRAME_THREADS | AV_CODEC_CAP_INTRA_ONLY,
423     .pix_fmts       = (const enum AVPixelFormat[]) {
424         AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_NONE
425     },
426     .priv_class     = &mjpeg_class,
427 };
428 #endif
429
430 #if CONFIG_AMV_ENCODER
431 static const AVClass amv_class = {
432     .class_name = "amv encoder",
433     .item_name  = av_default_item_name,
434     .option     = options,
435     .version    = LIBAVUTIL_VERSION_INT,
436 };
437
438 AVCodec ff_amv_encoder = {
439     .name           = "amv",
440     .long_name      = NULL_IF_CONFIG_SMALL("AMV Video"),
441     .type           = AVMEDIA_TYPE_VIDEO,
442     .id             = AV_CODEC_ID_AMV,
443     .priv_data_size = sizeof(MpegEncContext),
444     .init           = ff_mpv_encode_init,
445     .encode2        = amv_encode_picture,
446     .close          = ff_mpv_encode_end,
447     .pix_fmts       = (const enum AVPixelFormat[]) {
448         AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_NONE
449     },
450     .priv_class     = &amv_class,
451 };
452 #endif