]> git.sesse.net Git - ffmpeg/blob - libavcodec/jpeglsenc.c
lavc doxy: document that avcodec_flush_buffers() invalidates decoded frames
[ffmpeg] / libavcodec / jpeglsenc.c
1 /*
2  * JPEG-LS encoder
3  * Copyright (c) 2003 Michael Niedermayer
4  * Copyright (c) 2006 Konstantin Shishkov
5  *
6  * This file is part of Libav.
7  *
8  * Libav is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * Libav is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with Libav; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * JPEG-LS encoder.
26  */
27
28 #include "avcodec.h"
29 #include "get_bits.h"
30 #include "golomb.h"
31 #include "internal.h"
32 #include "mathops.h"
33 #include "mjpeg.h"
34 #include "jpegls.h"
35
36 /**
37  * Encode error from regular symbol
38  */
39 static inline void ls_encode_regular(JLSState *state, PutBitContext *pb, int Q,
40                                      int err)
41 {
42     int k;
43     int val;
44     int map;
45
46     for (k = 0; (state->N[Q] << k) < state->A[Q]; k++)
47         ;
48
49     map = !state->near && !k && (2 * state->B[Q] <= -state->N[Q]);
50
51     if (err < 0)
52         err += state->range;
53     if (err >= (state->range + 1 >> 1)) {
54         err -= state->range;
55         val  = 2 * FFABS(err) - 1 - map;
56     } else
57         val = 2 * err + map;
58
59     set_ur_golomb_jpegls(pb, val, k, state->limit, state->qbpp);
60
61     ff_jpegls_update_state_regular(state, Q, err);
62 }
63
64 /**
65  * Encode error from run termination
66  */
67 static inline void ls_encode_runterm(JLSState *state, PutBitContext *pb,
68                                      int RItype, int err, int limit_add)
69 {
70     int k;
71     int val, map;
72     int Q = 365 + RItype;
73     int temp;
74
75     temp = state->A[Q];
76     if (RItype)
77         temp += state->N[Q] >> 1;
78     for (k = 0; (state->N[Q] << k) < temp; k++)
79         ;
80     map = 0;
81     if (!k && err && (2 * state->B[Q] < state->N[Q]))
82         map = 1;
83
84     if (err < 0)
85         val = -(2 * err) - 1 - RItype + map;
86     else
87         val = 2 * err - RItype - map;
88     set_ur_golomb_jpegls(pb, val, k, state->limit - limit_add - 1, state->qbpp);
89
90     if (err < 0)
91         state->B[Q]++;
92     state->A[Q] += (val + 1 - RItype) >> 1;
93
94     ff_jpegls_downscale_state(state, Q);
95 }
96
97 /**
98  * Encode run value as specified by JPEG-LS standard
99  */
100 static inline void ls_encode_run(JLSState *state, PutBitContext *pb, int run,
101                                  int comp, int trail)
102 {
103     while (run >= (1 << ff_log2_run[state->run_index[comp]])) {
104         put_bits(pb, 1, 1);
105         run -= 1 << ff_log2_run[state->run_index[comp]];
106         if (state->run_index[comp] < 31)
107             state->run_index[comp]++;
108     }
109     /* if hit EOL, encode another full run, else encode aborted run */
110     if (!trail && run) {
111         put_bits(pb, 1, 1);
112     } else if (trail) {
113         put_bits(pb, 1, 0);
114         if (ff_log2_run[state->run_index[comp]])
115             put_bits(pb, ff_log2_run[state->run_index[comp]], run);
116     }
117 }
118
119 /**
120  * Encode one line of image
121  */
122 static inline void ls_encode_line(JLSState *state, PutBitContext *pb,
123                                   void *last, void *cur, int last2, int w,
124                                   int stride, int comp, int bits)
125 {
126     int x = 0;
127     int Ra, Rb, Rc, Rd;
128     int D0, D1, D2;
129
130     while (x < w) {
131         int err, pred, sign;
132
133         /* compute gradients */
134         Ra = x ? R(cur, x - stride) : R(last, x);
135         Rb = R(last, x);
136         Rc = x ? R(last, x - stride) : last2;
137         Rd = (x >= w - stride) ? R(last, x) : R(last, x + stride);
138         D0 = Rd - Rb;
139         D1 = Rb - Rc;
140         D2 = Rc - Ra;
141
142         /* run mode */
143         if ((FFABS(D0) <= state->near) &&
144             (FFABS(D1) <= state->near) &&
145             (FFABS(D2) <= state->near)) {
146             int RUNval, RItype, run;
147
148             run    = 0;
149             RUNval = Ra;
150             while (x < w && (FFABS(R(cur, x) - RUNval) <= state->near)) {
151                 run++;
152                 W(cur, x, Ra);
153                 x += stride;
154             }
155             ls_encode_run(state, pb, run, comp, x < w);
156             if (x >= w)
157                 return;
158             Rb     = R(last, x);
159             RItype = FFABS(Ra - Rb) <= state->near;
160             pred   = RItype ? Ra : Rb;
161             err    = R(cur, x) - pred;
162
163             if (!RItype && Ra > Rb)
164                 err = -err;
165
166             if (state->near) {
167                 if (err > 0)
168                     err =  (state->near + err) / state->twonear;
169                 else
170                     err = -(state->near - err) / state->twonear;
171
172                 if (RItype || (Rb >= Ra))
173                     Ra = av_clip(pred + err * state->twonear, 0, state->maxval);
174                 else
175                     Ra = av_clip(pred - err * state->twonear, 0, state->maxval);
176                 W(cur, x, Ra);
177             }
178             if (err < 0)
179                 err += state->range;
180             if (err >= state->range + 1 >> 1)
181                 err -= state->range;
182
183             ls_encode_runterm(state, pb, RItype, err,
184                               ff_log2_run[state->run_index[comp]]);
185
186             if (state->run_index[comp] > 0)
187                 state->run_index[comp]--;
188         } else { /* regular mode */
189             int context;
190
191             context = ff_jpegls_quantize(state, D0) * 81 +
192                       ff_jpegls_quantize(state, D1) *  9 +
193                       ff_jpegls_quantize(state, D2);
194             pred    = mid_pred(Ra, Ra + Rb - Rc, Rb);
195
196             if (context < 0) {
197                 context = -context;
198                 sign    = 1;
199                 pred    = av_clip(pred - state->C[context], 0, state->maxval);
200                 err     = pred - R(cur, x);
201             } else {
202                 sign = 0;
203                 pred = av_clip(pred + state->C[context], 0, state->maxval);
204                 err  = R(cur, x) - pred;
205             }
206
207             if (state->near) {
208                 if (err > 0)
209                     err =  (state->near + err) / state->twonear;
210                 else
211                     err = -(state->near - err) / state->twonear;
212                 if (!sign)
213                     Ra = av_clip(pred + err * state->twonear, 0, state->maxval);
214                 else
215                     Ra = av_clip(pred - err * state->twonear, 0, state->maxval);
216                 W(cur, x, Ra);
217             }
218
219             ls_encode_regular(state, pb, context, err);
220         }
221         x += stride;
222     }
223 }
224
225 static void ls_store_lse(JLSState *state, PutBitContext *pb)
226 {
227     /* Test if we have default params and don't need to store LSE */
228     JLSState state2 = { 0 };
229     state2.bpp  = state->bpp;
230     state2.near = state->near;
231     ff_jpegls_reset_coding_parameters(&state2, 1);
232     if (state->T1 == state2.T1 &&
233         state->T2 == state2.T2 &&
234         state->T3 == state2.T3 &&
235         state->reset == state2.reset)
236         return;
237     /* store LSE type 1 */
238     put_marker(pb, LSE);
239     put_bits(pb, 16, 13);
240     put_bits(pb, 8, 1);
241     put_bits(pb, 16, state->maxval);
242     put_bits(pb, 16, state->T1);
243     put_bits(pb, 16, state->T2);
244     put_bits(pb, 16, state->T3);
245     put_bits(pb, 16, state->reset);
246 }
247
248 static int encode_picture_ls(AVCodecContext *avctx, AVPacket *pkt,
249                              const AVFrame *pict, int *got_packet)
250 {
251     JpeglsContext *const s = avctx->priv_data;
252     AVFrame *const p       = &s->picture;
253     const int near         = avctx->prediction_method;
254     PutBitContext pb, pb2;
255     GetBitContext gb;
256     uint8_t *buf2, *zero, *cur, *last;
257     JLSState *state;
258     int i, size, ret;
259     int comps;
260
261     *p           = *pict;
262     p->pict_type = AV_PICTURE_TYPE_I;
263     p->key_frame = 1;
264
265     if (avctx->pix_fmt == AV_PIX_FMT_GRAY8 ||
266         avctx->pix_fmt == AV_PIX_FMT_GRAY16)
267         comps = 1;
268     else
269         comps = 3;
270
271     if ((ret = ff_alloc_packet(pkt, avctx->width * avctx->height * comps * 4 +
272                                FF_MIN_BUFFER_SIZE)) < 0) {
273         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
274         return ret;
275     }
276
277     buf2 = av_malloc(pkt->size);
278
279     init_put_bits(&pb, pkt->data, pkt->size);
280     init_put_bits(&pb2, buf2, pkt->size);
281
282     /* write our own JPEG header, can't use mjpeg_picture_header */
283     put_marker(&pb, SOI);
284     put_marker(&pb, SOF48);
285     put_bits(&pb, 16, 8 + comps * 3); // header size depends on components
286     put_bits(&pb, 8, (avctx->pix_fmt == AV_PIX_FMT_GRAY16) ? 16 : 8);  // bpp
287     put_bits(&pb, 16, avctx->height);
288     put_bits(&pb, 16, avctx->width);
289     put_bits(&pb, 8, comps);          // components
290     for (i = 1; i <= comps; i++) {
291         put_bits(&pb, 8, i);     // component ID
292         put_bits(&pb, 8, 0x11);  // subsampling: none
293         put_bits(&pb, 8, 0);     // Tiq, used by JPEG-LS ext
294     }
295
296     put_marker(&pb, SOS);
297     put_bits(&pb, 16, 6 + comps * 2);
298     put_bits(&pb, 8, comps);
299     for (i = 1; i <= comps; i++) {
300         put_bits(&pb, 8, i);   // component ID
301         put_bits(&pb, 8, 0);   // mapping index: none
302     }
303     put_bits(&pb, 8, near);
304     put_bits(&pb, 8, (comps > 1) ? 1 : 0);  // interleaving: 0 - plane, 1 - line
305     put_bits(&pb, 8, 0);  // point transform: none
306
307     state = av_mallocz(sizeof(JLSState));
308     /* initialize JPEG-LS state from JPEG parameters */
309     state->near = near;
310     state->bpp  = (avctx->pix_fmt == AV_PIX_FMT_GRAY16) ? 16 : 8;
311     ff_jpegls_reset_coding_parameters(state, 0);
312     ff_jpegls_init_state(state);
313
314     ls_store_lse(state, &pb);
315
316     zero = av_mallocz(p->linesize[0]);
317     last = zero;
318     cur  = p->data[0];
319     if (avctx->pix_fmt == AV_PIX_FMT_GRAY8) {
320         int t = 0;
321
322         for (i = 0; i < avctx->height; i++) {
323             ls_encode_line(state, &pb2, last, cur, t, avctx->width, 1, 0, 8);
324             t    = last[0];
325             last = cur;
326             cur += p->linesize[0];
327         }
328     } else if (avctx->pix_fmt == AV_PIX_FMT_GRAY16) {
329         int t = 0;
330
331         for (i = 0; i < avctx->height; i++) {
332             ls_encode_line(state, &pb2, last, cur, t, avctx->width, 1, 0, 16);
333             t    = *((uint16_t *)last);
334             last = cur;
335             cur += p->linesize[0];
336         }
337     } else if (avctx->pix_fmt == AV_PIX_FMT_RGB24) {
338         int j, width;
339         int Rc[3] = { 0, 0, 0 };
340
341         width = avctx->width * 3;
342         for (i = 0; i < avctx->height; i++) {
343             for (j = 0; j < 3; j++) {
344                 ls_encode_line(state, &pb2, last + j, cur + j, Rc[j],
345                                width, 3, j, 8);
346                 Rc[j] = last[j];
347             }
348             last = cur;
349             cur += s->picture.linesize[0];
350         }
351     } else if (avctx->pix_fmt == AV_PIX_FMT_BGR24) {
352         int j, width;
353         int Rc[3] = { 0, 0, 0 };
354
355         width = avctx->width * 3;
356         for (i = 0; i < avctx->height; i++) {
357             for (j = 2; j >= 0; j--) {
358                 ls_encode_line(state, &pb2, last + j, cur + j, Rc[j],
359                                width, 3, j, 8);
360                 Rc[j] = last[j];
361             }
362             last = cur;
363             cur += s->picture.linesize[0];
364         }
365     }
366
367     av_free(zero);
368     av_free(state);
369
370     /* the specification says that after doing 0xff escaping unused bits in
371      * the last byte must be set to 0, so just append 7 "optional" zero-bits
372      * to avoid special-casing. */
373     put_bits(&pb2, 7, 0);
374     size = put_bits_count(&pb2);
375     flush_put_bits(&pb2);
376     /* do escape coding */
377     init_get_bits(&gb, buf2, size);
378     size -= 7;
379     while (get_bits_count(&gb) < size) {
380         int v;
381         v = get_bits(&gb, 8);
382         put_bits(&pb, 8, v);
383         if (v == 0xFF) {
384             v = get_bits(&gb, 7);
385             put_bits(&pb, 8, v);
386         }
387     }
388     avpriv_align_put_bits(&pb);
389     av_free(buf2);
390
391     /* End of image */
392     put_marker(&pb, EOI);
393     flush_put_bits(&pb);
394
395     emms_c();
396
397     pkt->size   = put_bits_count(&pb) >> 3;
398     pkt->flags |= AV_PKT_FLAG_KEY;
399     *got_packet = 1;
400     return 0;
401 }
402
403 static av_cold int encode_init_ls(AVCodecContext *ctx)
404 {
405     JpeglsContext *c = (JpeglsContext *)ctx->priv_data;
406
407     c->avctx         = ctx;
408     ctx->coded_frame = &c->picture;
409
410     if (ctx->pix_fmt != AV_PIX_FMT_GRAY8  &&
411         ctx->pix_fmt != AV_PIX_FMT_GRAY16 &&
412         ctx->pix_fmt != AV_PIX_FMT_RGB24  &&
413         ctx->pix_fmt != AV_PIX_FMT_BGR24) {
414         av_log(ctx, AV_LOG_ERROR,
415                "Only grayscale and RGB24/BGR24 images are supported\n");
416         return -1;
417     }
418     return 0;
419 }
420
421 AVCodec ff_jpegls_encoder = {
422     .name           = "jpegls",
423     .long_name      = NULL_IF_CONFIG_SMALL("JPEG-LS"),
424     .type           = AVMEDIA_TYPE_VIDEO,
425     .id             = AV_CODEC_ID_JPEGLS,
426     .priv_data_size = sizeof(JpeglsContext),
427     .init           = encode_init_ls,
428     .encode2        = encode_picture_ls,
429     .pix_fmts       = (const enum AVPixelFormat[]) {
430         AV_PIX_FMT_BGR24, AV_PIX_FMT_RGB24,
431         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY16,
432         AV_PIX_FMT_NONE
433     },
434 };