1 /*
2 * JPEG-LS encoder
3 * Copyright (c) 2003 Michael Niedermayer
4 * Copyright (c) 2006 Konstantin Shishkov
5 *
6 * This file is part of FFmpeg.
7 *
8 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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 "bytestream.h"
30 #include "get_bits.h"
31 #include "put_bits.h"
32 #include "golomb.h"
33 #include "internal.h"
34 #include "mathops.h"
35 #include "mjpeg.h"
36 #include "mjpegenc.h"
37 #include "jpegls.h"
38
39 typedef struct JPEGLSContext {
40 AVClass *class;
41
42 int pred;
43 } JPEGLSContext;
44
put_marker_byteu(PutByteContext * pb,enum JpegMarker code)45 static inline void put_marker_byteu(PutByteContext *pb, enum JpegMarker code)
46 {
47 bytestream2_put_byteu(pb, 0xff);
48 bytestream2_put_byteu(pb, code);
49 }
50
put_marker_byte(PutByteContext * pb,enum JpegMarker code)51 static inline void put_marker_byte(PutByteContext *pb, enum JpegMarker code)
52 {
53 bytestream2_put_byte(pb, 0xff);
54 bytestream2_put_byte(pb, code);
55 }
56
57 /**
58 * Encode error from regular symbol
59 */
ls_encode_regular(JLSState * state,PutBitContext * pb,int Q,int err)60 static inline void ls_encode_regular(JLSState *state, PutBitContext *pb, int Q,
61 int err)
62 {
63 int k;
64 int val;
65 int map;
66
67 for (k = 0; (state->N[Q] << k) < state->A[Q]; k++)
68 ;
69
70 map = !state->near && !k && (2 * state->B[Q] <= -state->N[Q]);
71
72 if (err < 0)
73 err += state->range;
74 if (err >= (state->range + 1 >> 1)) {
75 err -= state->range;
76 val = 2 * FFABS(err) - 1 - map;
77 } else
78 val = 2 * err + map;
79
80 set_ur_golomb_jpegls(pb, val, k, state->limit, state->qbpp);
81
82 ff_jpegls_update_state_regular(state, Q, err);
83 }
84
85 /**
86 * Encode error from run termination
87 */
ls_encode_runterm(JLSState * state,PutBitContext * pb,int RItype,int err,int limit_add)88 static inline void ls_encode_runterm(JLSState *state, PutBitContext *pb,
89 int RItype, int err, int limit_add)
90 {
91 int k;
92 int val, map;
93 int Q = 365 + RItype;
94 int temp;
95
96 temp = state->A[Q];
97 if (RItype)
98 temp += state->N[Q] >> 1;
99 for (k = 0; (state->N[Q] << k) < temp; k++)
100 ;
101 map = 0;
102 if (!k && err && (2 * state->B[Q] < state->N[Q]))
103 map = 1;
104
105 if (err < 0)
106 val = -(2 * err) - 1 - RItype + map;
107 else
108 val = 2 * err - RItype - map;
109 set_ur_golomb_jpegls(pb, val, k, state->limit - limit_add - 1, state->qbpp);
110
111 if (err < 0)
112 state->B[Q]++;
113 state->A[Q] += (val + 1 - RItype) >> 1;
114
115 ff_jpegls_downscale_state(state, Q);
116 }
117
118 /**
119 * Encode run value as specified by JPEG-LS standard
120 */
ls_encode_run(JLSState * state,PutBitContext * pb,int run,int comp,int trail)121 static inline void ls_encode_run(JLSState *state, PutBitContext *pb, int run,
122 int comp, int trail)
123 {
124 while (run >= (1 << ff_log2_run[state->run_index[comp]])) {
125 put_bits(pb, 1, 1);
126 run -= 1 << ff_log2_run[state->run_index[comp]];
127 if (state->run_index[comp] < 31)
128 state->run_index[comp]++;
129 }
130 /* if hit EOL, encode another full run, else encode aborted run */
131 if (!trail && run) {
132 put_bits(pb, 1, 1);
133 } else if (trail) {
134 put_bits(pb, 1, 0);
135 if (ff_log2_run[state->run_index[comp]])
136 put_bits(pb, ff_log2_run[state->run_index[comp]], run);
137 }
138 }
139
140 /**
141 * Encode one line of image
142 */
ls_encode_line(JLSState * state,PutBitContext * pb,void * tmp,const void * in,int last2,int w,int stride,int comp,int bits)143 static inline void ls_encode_line(JLSState *state, PutBitContext *pb,
144 void *tmp, const void *in, int last2, int w,
145 int stride, int comp, int bits)
146 {
147 int x = 0;
148 int Ra = R(tmp, 0), Rb, Rc = last2, Rd;
149 int D0, D1, D2;
150
151 while (x < w) {
152 int err, pred, sign;
153
154 /* compute gradients */
155 Rb = R(tmp, x);
156 Rd = (x >= w - stride) ? R(tmp, x) : R(tmp, x + stride);
157 D0 = Rd - Rb;
158 D1 = Rb - Rc;
159 D2 = Rc - Ra;
160
161 /* run mode */
162 if ((FFABS(D0) <= state->near) &&
163 (FFABS(D1) <= state->near) &&
164 (FFABS(D2) <= state->near)) {
165 int RUNval, RItype, run;
166
167 run = 0;
168 RUNval = Ra;
169 while (x < w && (FFABS(R(in, x) - RUNval) <= state->near)) {
170 run++;
171 W(tmp, x, Ra);
172 x += stride;
173 }
174 ls_encode_run(state, pb, run, comp, x < w);
175 if (x >= w)
176 return;
177 Rb = R(tmp, x);
178 RItype = FFABS(Ra - Rb) <= state->near;
179 pred = RItype ? Ra : Rb;
180 err = R(in, x) - pred;
181
182 if (!RItype && Ra > Rb)
183 err = -err;
184
185 if (state->near) {
186 if (err > 0)
187 err = (state->near + err) / state->twonear;
188 else
189 err = -(state->near - err) / state->twonear;
190
191 if (RItype || (Rb >= Ra))
192 Ra = av_clip(pred + err * state->twonear, 0, state->maxval);
193 else
194 Ra = av_clip(pred - err * state->twonear, 0, state->maxval);
195 } else
196 Ra = R(in, x);
197 W(tmp, x, Ra);
198
199 if (err < 0)
200 err += state->range;
201 if (err >= state->range + 1 >> 1)
202 err -= state->range;
203
204 ls_encode_runterm(state, pb, RItype, err,
205 ff_log2_run[state->run_index[comp]]);
206
207 if (state->run_index[comp] > 0)
208 state->run_index[comp]--;
209 } else { /* regular mode */
210 int context;
211
212 context = ff_jpegls_quantize(state, D0) * 81 +
213 ff_jpegls_quantize(state, D1) * 9 +
214 ff_jpegls_quantize(state, D2);
215 pred = mid_pred(Ra, Ra + Rb - Rc, Rb);
216
217 if (context < 0) {
218 context = -context;
219 sign = 1;
220 pred = av_clip(pred - state->C[context], 0, state->maxval);
221 err = pred - R(in, x);
222 } else {
223 sign = 0;
224 pred = av_clip(pred + state->C[context], 0, state->maxval);
225 err = R(in, x) - pred;
226 }
227
228 if (state->near) {
229 if (err > 0)
230 err = (state->near + err) / state->twonear;
231 else
232 err = -(state->near - err) / state->twonear;
233 if (!sign)
234 Ra = av_clip(pred + err * state->twonear, 0, state->maxval);
235 else
236 Ra = av_clip(pred - err * state->twonear, 0, state->maxval);
237 } else
238 Ra = R(in, x);
239 W(tmp, x, Ra);
240
241 ls_encode_regular(state, pb, context, err);
242 }
243 Rc = Rb;
244 x += stride;
245 }
246 }
247
ls_store_lse(JLSState * state,PutByteContext * pb)248 static void ls_store_lse(JLSState *state, PutByteContext *pb)
249 {
250 /* Test if we have default params and don't need to store LSE */
251 JLSState state2 = { 0 };
252 state2.bpp = state->bpp;
253 state2.near = state->near;
254 ff_jpegls_reset_coding_parameters(&state2, 1);
255 if (state->T1 == state2.T1 &&
256 state->T2 == state2.T2 &&
257 state->T3 == state2.T3 &&
258 state->reset == state2.reset)
259 return;
260 /* store LSE type 1 */
261 put_marker_byteu(pb, LSE);
262 bytestream2_put_be16u(pb, 13);
263 bytestream2_put_byteu(pb, 1);
264 bytestream2_put_be16u(pb, state->maxval);
265 bytestream2_put_be16u(pb, state->T1);
266 bytestream2_put_be16u(pb, state->T2);
267 bytestream2_put_be16u(pb, state->T3);
268 bytestream2_put_be16u(pb, state->reset);
269 }
270
encode_picture_ls(AVCodecContext * avctx,AVPacket * pkt,const AVFrame * pict,int * got_packet)271 static int encode_picture_ls(AVCodecContext *avctx, AVPacket *pkt,
272 const AVFrame *pict, int *got_packet)
273 {
274 JPEGLSContext *ctx = avctx->priv_data;
275 const AVFrame *const p = pict;
276 PutByteContext pb;
277 PutBitContext pb2;
278 GetBitContext gb;
279 const uint8_t *in;
280 uint8_t *last = NULL;
281 JLSState state = { 0 };
282 int i, size, ret;
283 int comps;
284
285 #if FF_API_PRIVATE_OPT
286 FF_DISABLE_DEPRECATION_WARNINGS
287 if (avctx->prediction_method)
288 ctx->pred = avctx->prediction_method;
289 FF_ENABLE_DEPRECATION_WARNINGS
290 #endif
291
292 if (avctx->pix_fmt == AV_PIX_FMT_GRAY8 ||
293 avctx->pix_fmt == AV_PIX_FMT_GRAY16)
294 comps = 1;
295 else
296 comps = 3;
297
298 if ((ret = ff_alloc_packet2(avctx, pkt, avctx->width *avctx->height * comps * 4 +
299 AV_INPUT_BUFFER_MIN_SIZE, 0)) < 0)
300 return ret;
301
302 last = av_malloc((unsigned)pkt->size + FFABS(p->linesize[0]));
303 if (!last)
304 return AVERROR(ENOMEM);
305 memset(last, 0, FFABS(p->linesize[0]));
306
307 bytestream2_init_writer(&pb, pkt->data, pkt->size);
308 init_put_bits(&pb2, last + FFABS(p->linesize[0]), pkt->size);
309
310 /* write our own JPEG header, can't use mjpeg_picture_header */
311 put_marker_byteu(&pb, SOI);
312 put_marker_byteu(&pb, SOF48);
313 bytestream2_put_be16u(&pb, 8 + comps * 3); // header size depends on components
314 bytestream2_put_byteu(&pb, (avctx->pix_fmt == AV_PIX_FMT_GRAY16) ? 16 : 8); // bpp
315 bytestream2_put_be16u(&pb, avctx->height);
316 bytestream2_put_be16u(&pb, avctx->width);
317 bytestream2_put_byteu(&pb, comps); // components
318 for (i = 1; i <= comps; i++) {
319 bytestream2_put_byteu(&pb, i); // component ID
320 bytestream2_put_byteu(&pb, 0x11); // subsampling: none
321 bytestream2_put_byteu(&pb, 0); // Tiq, used by JPEG-LS ext
322 }
323
324 put_marker_byteu(&pb, SOS);
325 bytestream2_put_be16u(&pb, 6 + comps * 2);
326 bytestream2_put_byteu(&pb, comps);
327 for (i = 1; i <= comps; i++) {
328 bytestream2_put_byteu(&pb, i); // component ID
329 bytestream2_put_byteu(&pb, 0); // mapping index: none
330 }
331 bytestream2_put_byteu(&pb, ctx->pred);
332 bytestream2_put_byteu(&pb, (comps > 1) ? 1 : 0); // interleaving: 0 - plane, 1 - line
333 bytestream2_put_byteu(&pb, 0); // point transform: none
334
335 /* initialize JPEG-LS state from JPEG parameters */
336 state.near = ctx->pred;
337 state.bpp = (avctx->pix_fmt == AV_PIX_FMT_GRAY16) ? 16 : 8;
338 ff_jpegls_reset_coding_parameters(&state, 0);
339 ff_jpegls_init_state(&state);
340
341 ls_store_lse(&state, &pb);
342
343 in = p->data[0];
344 if (avctx->pix_fmt == AV_PIX_FMT_GRAY8) {
345 int t = 0;
346
347 for (i = 0; i < avctx->height; i++) {
348 int last0 = last[0];
349 ls_encode_line(&state, &pb2, last, in, t, avctx->width, 1, 0, 8);
350 t = last0;
351 in += p->linesize[0];
352 }
353 } else if (avctx->pix_fmt == AV_PIX_FMT_GRAY16) {
354 int t = 0;
355
356 for (i = 0; i < avctx->height; i++) {
357 int last0 = *((uint16_t *)last);
358 ls_encode_line(&state, &pb2, last, in, t, avctx->width, 1, 0, 16);
359 t = last0;
360 in += p->linesize[0];
361 }
362 } else if (avctx->pix_fmt == AV_PIX_FMT_RGB24) {
363 int j, width;
364 int Rc[3] = { 0, 0, 0 };
365
366 width = avctx->width * 3;
367 for (i = 0; i < avctx->height; i++) {
368 for (j = 0; j < 3; j++) {
369 int last0 = last[j];
370 ls_encode_line(&state, &pb2, last + j, in + j, Rc[j],
371 width, 3, j, 8);
372 Rc[j] = last0;
373 }
374 in += p->linesize[0];
375 }
376 } else if (avctx->pix_fmt == AV_PIX_FMT_BGR24) {
377 int j, width;
378 int Rc[3] = { 0, 0, 0 };
379
380 width = avctx->width * 3;
381 for (i = 0; i < avctx->height; i++) {
382 for (j = 2; j >= 0; j--) {
383 int last0 = last[j];
384 ls_encode_line(&state, &pb2, last + j, in + j, Rc[j],
385 width, 3, j, 8);
386 Rc[j] = last0;
387 }
388 in += p->linesize[0];
389 }
390 }
391
392 /* the specification says that after doing 0xff escaping unused bits in
393 * the last byte must be set to 0, so just append 7 "optional" zero bits
394 * to avoid special-casing. */
395 put_bits(&pb2, 7, 0);
396 size = put_bits_count(&pb2);
397 flush_put_bits(&pb2);
398 /* do escape coding */
399 init_get_bits(&gb, pb2.buf, size);
400 size -= 7;
401 while (get_bits_count(&gb) < size) {
402 int v;
403 v = get_bits(&gb, 8);
404 bytestream2_put_byte(&pb, v);
405 if (v == 0xFF) {
406 v = get_bits(&gb, 7);
407 bytestream2_put_byte(&pb, v);
408 }
409 }
410 av_freep(&last);
411
412 /* End of image */
413 put_marker_byte(&pb, EOI);
414
415 emms_c();
416
417 pkt->size = bytestream2_tell_p(&pb);
418 pkt->flags |= AV_PKT_FLAG_KEY;
419 *got_packet = 1;
420 return 0;
421 }
422
encode_init_ls(AVCodecContext * ctx)423 static av_cold int encode_init_ls(AVCodecContext *ctx)
424 {
425 #if FF_API_CODED_FRAME
426 FF_DISABLE_DEPRECATION_WARNINGS
427 ctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
428 ctx->coded_frame->key_frame = 1;
429 FF_ENABLE_DEPRECATION_WARNINGS
430 #endif
431
432 if (ctx->pix_fmt != AV_PIX_FMT_GRAY8 &&
433 ctx->pix_fmt != AV_PIX_FMT_GRAY16 &&
434 ctx->pix_fmt != AV_PIX_FMT_RGB24 &&
435 ctx->pix_fmt != AV_PIX_FMT_BGR24) {
436 av_log(ctx, AV_LOG_ERROR,
437 "Only grayscale and RGB24/BGR24 images are supported\n");
438 return -1;
439 }
440 return 0;
441 }
442
443 #define OFFSET(x) offsetof(JPEGLSContext, x)
444 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
445 static const AVOption options[] = {
446 { "pred", "Prediction method", OFFSET(pred), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 2, VE, "pred" },
447 { "left", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, INT_MIN, INT_MAX, VE, "pred" },
448 { "plane", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, INT_MIN, INT_MAX, VE, "pred" },
449 { "median", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 2 }, INT_MIN, INT_MAX, VE, "pred" },
450
451 { NULL},
452 };
453
454 static const AVClass jpegls_class = {
455 .class_name = "jpegls",
456 .item_name = av_default_item_name,
457 .option = options,
458 .version = LIBAVUTIL_VERSION_INT,
459 };
460
461 AVCodec ff_jpegls_encoder = {
462 .name = "jpegls",
463 .long_name = NULL_IF_CONFIG_SMALL("JPEG-LS"),
464 .type = AVMEDIA_TYPE_VIDEO,
465 .id = AV_CODEC_ID_JPEGLS,
466 .priv_data_size = sizeof(JPEGLSContext),
467 .priv_class = &jpegls_class,
468 .init = encode_init_ls,
469 .capabilities = AV_CODEC_CAP_FRAME_THREADS,
470 .encode2 = encode_picture_ls,
471 .pix_fmts = (const enum AVPixelFormat[]) {
472 AV_PIX_FMT_BGR24, AV_PIX_FMT_RGB24,
473 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY16,
474 AV_PIX_FMT_NONE
475 },
476 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
477 FF_CODEC_CAP_INIT_CLEANUP,
478 };
479