Merge commit 'b5f92f9603c2b46c37b20134e9e2338805844f0f' into release/1.1
[ffmpeg.git] / libavcodec / jpeglsdec.c
1 /*
2  * JPEG-LS decoder
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 decoder.
26  */
27
28 #include "avcodec.h"
29 #include "get_bits.h"
30 #include "golomb.h"
31 #include "mathops.h"
32 #include "mjpeg.h"
33 #include "mjpegdec.h"
34 #include "jpegls.h"
35 #include "jpeglsdec.h"
36
37
38 /*
39 * Uncomment this to significantly speed up decoding of broken JPEG-LS
40 * (or test broken JPEG-LS decoder) and slow down ordinary decoding a bit.
41 *
42 * There is no Golomb code with length >= 32 bits possible, so check and
43 * avoid situation of 32 zeros, FFmpeg Golomb decoder is painfully slow
44 * on this errors.
45 */
46 //#define JLS_BROKEN
47
48
49 /**
50  * Decode LSE block with initialization parameters
51  */
52 int ff_jpegls_decode_lse(MJpegDecodeContext *s)
53 {
54     int id;
55
56     skip_bits(&s->gb, 16);  /* length: FIXME: verify field validity */
57     id = get_bits(&s->gb, 8);
58
59     switch(id){
60     case 1:
61         s->maxval= get_bits(&s->gb, 16);
62         s->t1= get_bits(&s->gb, 16);
63         s->t2= get_bits(&s->gb, 16);
64         s->t3= get_bits(&s->gb, 16);
65         s->reset= get_bits(&s->gb, 16);
66
67 //        ff_jpegls_reset_coding_parameters(s, 0);
68         //FIXME quant table?
69         break;
70     case 2:
71     case 3:
72         av_log(s->avctx, AV_LOG_ERROR, "palette not supported\n");
73         return AVERROR(ENOSYS);
74     case 4:
75         av_log(s->avctx, AV_LOG_ERROR, "oversize image not supported\n");
76         return AVERROR(ENOSYS);
77     default:
78         av_log(s->avctx, AV_LOG_ERROR, "invalid id %d\n", id);
79         return AVERROR_INVALIDDATA;
80     }
81     av_dlog(s->avctx, "ID=%i, T=%i,%i,%i\n", id, s->t1, s->t2, s->t3);
82
83     return 0;
84 }
85
86 /**
87  * Get context-dependent Golomb code, decode it and update context
88  */
89 static inline int ls_get_code_regular(GetBitContext *gb, JLSState *state, int Q){
90     int k, ret;
91
92     for(k = 0; (state->N[Q] << k) < state->A[Q]; k++);
93
94 #ifdef JLS_BROKEN
95     if(!show_bits_long(gb, 32))return -1;
96 #endif
97     ret = get_ur_golomb_jpegls(gb, k, state->limit, state->qbpp);
98
99     /* decode mapped error */
100     if(ret & 1)
101         ret = -((ret + 1) >> 1);
102     else
103         ret >>= 1;
104
105     /* for NEAR=0, k=0 and 2*B[Q] <= - N[Q] mapping is reversed */
106     if(!state->near && !k && (2 * state->B[Q] <= -state->N[Q]))
107         ret = -(ret + 1);
108
109     ret= ff_jpegls_update_state_regular(state, Q, ret);
110
111     return ret;
112 }
113
114 /**
115  * Get Golomb code, decode it and update state for run termination
116  */
117 static inline int ls_get_code_runterm(GetBitContext *gb, JLSState *state, int RItype, int limit_add){
118     int k, ret, temp, map;
119     int Q = 365 + RItype;
120
121     temp=  state->A[Q];
122     if(RItype)
123         temp += state->N[Q] >> 1;
124
125     for(k = 0; (state->N[Q] << k) < temp; k++);
126
127 #ifdef JLS_BROKEN
128     if(!show_bits_long(gb, 32))return -1;
129 #endif
130     ret = get_ur_golomb_jpegls(gb, k, state->limit - limit_add - 1, state->qbpp);
131
132     /* decode mapped error */
133     map = 0;
134     if(!k && (RItype || ret) && (2 * state->B[Q] < state->N[Q]))
135         map = 1;
136     ret += RItype + map;
137
138     if(ret & 1){
139         ret = map - ((ret + 1) >> 1);
140         state->B[Q]++;
141     } else {
142         ret = ret >> 1;
143     }
144
145     if(FFABS(ret) > 0xFFFF)
146         return -0x10000;
147     /* update state */
148     state->A[Q] += FFABS(ret) - RItype;
149     ret *= state->twonear;
150     ff_jpegls_downscale_state(state, Q);
151
152     return ret;
153 }
154
155 /**
156  * Decode one line of image
157  */
158 static inline void ls_decode_line(JLSState *state, MJpegDecodeContext *s, void *last, void *dst, int last2, int w, int stride, int comp, int bits){
159     int i, x = 0;
160     int Ra, Rb, Rc, Rd;
161     int D0, D1, D2;
162
163     while(x < w) {
164         int err, pred;
165
166         /* compute gradients */
167         Ra = x ? R(dst, x - stride) : R(last, x);
168         Rb = R(last, x);
169         Rc = x ? R(last, x - stride) : last2;
170         Rd = (x >= w - stride) ? R(last, x) : R(last, x + stride);
171         D0 = Rd - Rb;
172         D1 = Rb - Rc;
173         D2 = Rc - Ra;
174         /* run mode */
175         if((FFABS(D0) <= state->near) && (FFABS(D1) <= state->near) && (FFABS(D2) <= state->near)) {
176             int r;
177             int RItype;
178
179             /* decode full runs while available */
180             while(get_bits1(&s->gb)) {
181                 int r;
182                 r = 1 << ff_log2_run[state->run_index[comp]];
183                 if(x + r * stride > w) {
184                     r = (w - x) / stride;
185                 }
186                 for(i = 0; i < r; i++) {
187                     W(dst, x, Ra);
188                     x += stride;
189                 }
190                 /* if EOL reached, we stop decoding */
191                 if(r != (1 << ff_log2_run[state->run_index[comp]]))
192                     return;
193                 if(state->run_index[comp] < 31)
194                     state->run_index[comp]++;
195                 if(x + stride > w)
196                     return;
197             }
198             /* decode aborted run */
199             r = ff_log2_run[state->run_index[comp]];
200             if(r)
201                 r = get_bits_long(&s->gb, r);
202             if(x + r * stride > w) {
203                 r = (w - x) / stride;
204             }
205             for(i = 0; i < r; i++) {
206                 W(dst, x, Ra);
207                 x += stride;
208             }
209
210             /* decode run termination value */
211             Rb = R(last, x);
212             RItype = (FFABS(Ra - Rb) <= state->near) ? 1 : 0;
213             err = ls_get_code_runterm(&s->gb, state, RItype, ff_log2_run[state->run_index[comp]]);
214             if(state->run_index[comp])
215                 state->run_index[comp]--;
216
217             if(state->near && RItype){
218                 pred = Ra + err;
219             } else {
220                 if(Rb < Ra)
221                     pred = Rb - err;
222                 else
223                     pred = Rb + err;
224             }
225         } else { /* regular mode */
226             int context, sign;
227
228             context = ff_jpegls_quantize(state, D0) * 81 + ff_jpegls_quantize(state, D1) * 9 + ff_jpegls_quantize(state, D2);
229             pred = mid_pred(Ra, Ra + Rb - Rc, Rb);
230
231             if(context < 0){
232                 context = -context;
233                 sign = 1;
234             }else{
235                 sign = 0;
236             }
237
238             if(sign){
239                 pred = av_clip(pred - state->C[context], 0, state->maxval);
240                 err = -ls_get_code_regular(&s->gb, state, context);
241             } else {
242                 pred = av_clip(pred + state->C[context], 0, state->maxval);
243                 err = ls_get_code_regular(&s->gb, state, context);
244             }
245
246             /* we have to do something more for near-lossless coding */
247             pred += err;
248         }
249         if(state->near){
250             if(pred < -state->near)
251                 pred += state->range * state->twonear;
252             else if(pred > state->maxval + state->near)
253                 pred -= state->range * state->twonear;
254             pred = av_clip(pred, 0, state->maxval);
255         }
256
257         pred &= state->maxval;
258         W(dst, x, pred);
259         x += stride;
260     }
261 }
262
263 int ff_jpegls_decode_picture(MJpegDecodeContext *s, int near, int point_transform, int ilv){
264     int i, t = 0;
265     uint8_t *zero, *last, *cur;
266     JLSState *state;
267     int off = 0, stride = 1, width, shift, ret = 0;
268
269     zero = av_mallocz(s->picture.linesize[0]);
270     last = zero;
271     cur = s->picture.data[0];
272
273     state = av_mallocz(sizeof(JLSState));
274     /* initialize JPEG-LS state from JPEG parameters */
275     state->near = near;
276     state->bpp = (s->bits < 2) ? 2 : s->bits;
277     state->maxval = s->maxval;
278     state->T1 = s->t1;
279     state->T2 = s->t2;
280     state->T3 = s->t3;
281     state->reset = s->reset;
282     ff_jpegls_reset_coding_parameters(state, 0);
283     ff_jpegls_init_state(state);
284
285     if(s->bits <= 8)
286         shift = point_transform + (8 - s->bits);
287     else
288         shift = point_transform + (16 - s->bits);
289
290     if (s->avctx->debug & FF_DEBUG_PICT_INFO) {
291         av_log(s->avctx, AV_LOG_DEBUG, "JPEG-LS params: %ix%i NEAR=%i MV=%i T(%i,%i,%i) RESET=%i, LIMIT=%i, qbpp=%i, RANGE=%i\n",
292                 s->width, s->height, state->near, state->maxval,
293                 state->T1, state->T2, state->T3,
294                 state->reset, state->limit, state->qbpp, state->range);
295         av_log(s->avctx, AV_LOG_DEBUG, "JPEG params: ILV=%i Pt=%i BPP=%i, scan = %i\n",
296                 ilv, point_transform, s->bits, s->cur_scan);
297     }
298     if(ilv == 0) { /* separate planes */
299         if (s->cur_scan > s->nb_components) {
300             ret = AVERROR_INVALIDDATA;
301             goto end;
302         }
303         stride = (s->nb_components > 1) ? 3 : 1;
304         off = av_clip(s->cur_scan - 1, 0, stride - 1);
305         width = s->width * stride;
306         cur += off;
307         for(i = 0; i < s->height; i++) {
308             if(s->bits <= 8){
309                 ls_decode_line(state, s, last, cur, t, width, stride, off,  8);
310                 t = last[0];
311             }else{
312                 ls_decode_line(state, s, last, cur, t, width, stride, off, 16);
313                 t = *((uint16_t*)last);
314             }
315             last = cur;
316             cur += s->picture.linesize[0];
317
318             if (s->restart_interval && !--s->restart_count) {
319                 align_get_bits(&s->gb);
320                 skip_bits(&s->gb, 16); /* skip RSTn */
321             }
322         }
323     } else if(ilv == 1) { /* line interleaving */
324         int j;
325         int Rc[3] = {0, 0, 0};
326         stride = (s->nb_components > 1) ? 3 : 1;
327         memset(cur, 0, s->picture.linesize[0]);
328         width = s->width * stride;
329         for(i = 0; i < s->height; i++) {
330             for(j = 0; j < stride; j++) {
331                 ls_decode_line(state, s, last + j, cur + j, Rc[j], width, stride, j, 8);
332                 Rc[j] = last[j];
333
334                 if (s->restart_interval && !--s->restart_count) {
335                     align_get_bits(&s->gb);
336                     skip_bits(&s->gb, 16); /* skip RSTn */
337                 }
338             }
339             last = cur;
340             cur += s->picture.linesize[0];
341         }
342     } else if (ilv == 2) { /* sample interleaving */
343         av_log(s->avctx, AV_LOG_ERROR, "Sample interleaved images are not supported.\n");
344         ret = AVERROR_PATCHWELCOME;
345         goto end;
346     }
347
348     if(shift){ /* we need to do point transform or normalize samples */
349         int x, w;
350
351         w = s->width * s->nb_components;
352
353         if(s->bits <= 8){
354             uint8_t *src = s->picture.data[0];
355
356             for(i = 0; i < s->height; i++){
357                 for(x = off; x < w; x+= stride){
358                     src[x] <<= shift;
359                 }
360                 src += s->picture.linesize[0];
361             }
362         }else{
363             uint16_t *src = (uint16_t*) s->picture.data[0];
364
365             for(i = 0; i < s->height; i++){
366                 for(x = 0; x < w; x++){
367                     src[x] <<= shift;
368                 }
369                 src += s->picture.linesize[0]/2;
370             }
371         }
372     }
373
374 end:
375     av_free(state);
376     av_free(zero);
377
378     return ret;
379 }
380
381
382 AVCodec ff_jpegls_decoder = {
383     .name           = "jpegls",
384     .type           = AVMEDIA_TYPE_VIDEO,
385     .id             = AV_CODEC_ID_JPEGLS,
386     .priv_data_size = sizeof(MJpegDecodeContext),
387     .init           = ff_mjpeg_decode_init,
388     .close          = ff_mjpeg_decode_end,
389     .decode         = ff_mjpeg_decode_frame,
390     .capabilities   = CODEC_CAP_DR1,
391     .long_name      = NULL_IF_CONFIG_SMALL("JPEG-LS"),
392 };