5fb414b4111cbad00edfaa49d29b58645905908b
[ffmpeg.git] / libavcodec / loco.c
1 /*
2  * LOCO codec
3  * Copyright (c) 2005 Konstantin Shishkov
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  * LOCO codec.
25  */
26
27 #include "avcodec.h"
28 #include "get_bits.h"
29 #include "golomb.h"
30 #include "internal.h"
31 #include "mathops.h"
32
33 enum LOCO_MODE {
34     LOCO_UNKN  =  0,
35     LOCO_CYUY2 = -1,
36     LOCO_CRGB  = -2,
37     LOCO_CRGBA = -3,
38     LOCO_CYV12 = -4,
39     LOCO_YUY2  =  1,
40     LOCO_UYVY  =  2,
41     LOCO_RGB   =  3,
42     LOCO_RGBA  =  4,
43     LOCO_YV12  =  5,
44 };
45
46 typedef struct LOCOContext {
47     AVCodecContext *avctx;
48     int lossy;
49     enum LOCO_MODE mode;
50 } LOCOContext;
51
52 typedef struct RICEContext {
53     GetBitContext gb;
54     int save, run, run2; /* internal rice decoder state */
55     int sum, count; /* sum and count for getting rice parameter */
56     int lossy;
57 } RICEContext;
58
59 static int loco_get_rice_param(RICEContext *r)
60 {
61     int cnt = 0;
62     int val = r->count;
63
64     while (r->sum > val && cnt < 9) {
65         val <<= 1;
66         cnt++;
67     }
68
69     return cnt;
70 }
71
72 static inline void loco_update_rice_param(RICEContext *r, int val)
73 {
74     r->sum += val;
75     r->count++;
76
77     if (r->count == 16) {
78         r->sum   >>= 1;
79         r->count >>= 1;
80     }
81 }
82
83 static inline int loco_get_rice(RICEContext *r)
84 {
85     int v;
86     if (r->run > 0) { /* we have zero run */
87         r->run--;
88         loco_update_rice_param(r, 0);
89         return 0;
90     }
91     if (get_bits_left(&r->gb) < 1)
92         return INT_MIN;
93     v = get_ur_golomb_jpegls(&r->gb, loco_get_rice_param(r), INT_MAX, 0);
94     loco_update_rice_param(r, (v + 1) >> 1);
95     if (!v) {
96         if (r->save >= 0) {
97             r->run = get_ur_golomb_jpegls(&r->gb, 2, INT_MAX, 0);
98             if (r->run > 1)
99                 r->save += r->run + 1;
100             else
101                 r->save -= 3;
102         } else
103             r->run2++;
104     } else {
105         v = ((v >> 1) + r->lossy) ^ -(v & 1);
106         if (r->run2 > 0) {
107             if (r->run2 > 2)
108                 r->save += r->run2;
109             else
110                 r->save -= 3;
111             r->run2 = 0;
112         }
113     }
114
115     return v;
116 }
117
118 /* LOCO main predictor - LOCO-I/JPEG-LS predictor */
119 static inline int loco_predict(uint8_t* data, int stride)
120 {
121     int a, b, c;
122
123     a = data[-stride];
124     b = data[-1];
125     c = data[-stride - 1];
126
127     return mid_pred(a, a + b - c, b);
128 }
129
130 static int loco_decode_plane(LOCOContext *l, uint8_t *data, int width, int height,
131                              int stride, const uint8_t *buf, int buf_size)
132 {
133     RICEContext rc;
134     int val;
135     int ret;
136     int i, j;
137
138     if(buf_size<=0)
139         return -1;
140
141     if ((ret = init_get_bits8(&rc.gb, buf, buf_size)) < 0)
142         return ret;
143
144     rc.save  = 0;
145     rc.run   = 0;
146     rc.run2  = 0;
147     rc.lossy = l->lossy;
148
149     rc.sum   = 8;
150     rc.count = 1;
151
152     /* restore top left pixel */
153     val     = loco_get_rice(&rc);
154     data[0] = 128 + val;
155     /* restore top line */
156     for (i = 1; i < width; i++) {
157         val = loco_get_rice(&rc);
158         data[i] = data[i - 1] + val;
159     }
160     data += stride;
161     for (j = 1; j < height; j++) {
162         /* restore left column */
163         val = loco_get_rice(&rc);
164         data[0] = data[-stride] + val;
165         /* restore all other pixels */
166         for (i = 1; i < width; i++) {
167             val = loco_get_rice(&rc);
168             if (val == INT_MIN)
169                 return -1;
170             data[i] = loco_predict(&data[i], stride) + val;
171         }
172         data += stride;
173     }
174
175     return (get_bits_count(&rc.gb) + 7) >> 3;
176 }
177
178 static void rotate_faulty_loco(uint8_t *data, int width, int height, int stride)
179 {
180     int y;
181
182     for (y=1; y<height; y++) {
183         if (width>=y) {
184             memmove(data + y*stride,
185                     data + y*(stride + 1),
186                     (width-y));
187             if (y+1 < height)
188                 memmove(data + y*stride + (width-y),
189                         data + (y+1)*stride, y);
190         }
191     }
192 }
193
194 static int decode_frame(AVCodecContext *avctx,
195                         void *data, int *got_frame,
196                         AVPacket *avpkt)
197 {
198     LOCOContext * const l = avctx->priv_data;
199     const uint8_t *buf    = avpkt->data;
200     int buf_size          = avpkt->size;
201     AVFrame * const p     = data;
202     int decoded, ret;
203
204     if ((ret = ff_get_buffer(avctx, p, 0)) < 0)
205         return ret;
206     p->key_frame = 1;
207
208 #define ADVANCE_BY_DECODED do { \
209     if (decoded < 0 || decoded >= buf_size) goto buf_too_small; \
210     buf += decoded; buf_size -= decoded; \
211 } while(0)
212     switch(l->mode) {
213     case LOCO_CYUY2: case LOCO_YUY2: case LOCO_UYVY:
214         decoded = loco_decode_plane(l, p->data[0], avctx->width, avctx->height,
215                                     p->linesize[0], buf, buf_size);
216         ADVANCE_BY_DECODED;
217         decoded = loco_decode_plane(l, p->data[1], avctx->width / 2, avctx->height,
218                                     p->linesize[1], buf, buf_size);
219         ADVANCE_BY_DECODED;
220         decoded = loco_decode_plane(l, p->data[2], avctx->width / 2, avctx->height,
221                                     p->linesize[2], buf, buf_size);
222         break;
223     case LOCO_CYV12: case LOCO_YV12:
224         decoded = loco_decode_plane(l, p->data[0], avctx->width, avctx->height,
225                                     p->linesize[0], buf, buf_size);
226         ADVANCE_BY_DECODED;
227         decoded = loco_decode_plane(l, p->data[2], avctx->width / 2, avctx->height / 2,
228                                     p->linesize[2], buf, buf_size);
229         ADVANCE_BY_DECODED;
230         decoded = loco_decode_plane(l, p->data[1], avctx->width / 2, avctx->height / 2,
231                                     p->linesize[1], buf, buf_size);
232         break;
233     case LOCO_CRGB: case LOCO_RGB:
234         decoded = loco_decode_plane(l, p->data[1] + p->linesize[1]*(avctx->height-1), avctx->width, avctx->height,
235                                     -p->linesize[1], buf, buf_size);
236         ADVANCE_BY_DECODED;
237         decoded = loco_decode_plane(l, p->data[0] + p->linesize[0]*(avctx->height-1), avctx->width, avctx->height,
238                                     -p->linesize[0], buf, buf_size);
239         ADVANCE_BY_DECODED;
240         decoded = loco_decode_plane(l, p->data[2] + p->linesize[2]*(avctx->height-1), avctx->width, avctx->height,
241                                     -p->linesize[2], buf, buf_size);
242         if (avctx->width & 1) {
243             rotate_faulty_loco(p->data[0] + p->linesize[0]*(avctx->height-1), avctx->width, avctx->height, -p->linesize[0]);
244             rotate_faulty_loco(p->data[1] + p->linesize[1]*(avctx->height-1), avctx->width, avctx->height, -p->linesize[1]);
245             rotate_faulty_loco(p->data[2] + p->linesize[2]*(avctx->height-1), avctx->width, avctx->height, -p->linesize[2]);
246         }
247         break;
248     case LOCO_CRGBA:
249     case LOCO_RGBA:
250         decoded = loco_decode_plane(l, p->data[1] + p->linesize[1]*(avctx->height-1), avctx->width, avctx->height,
251                                     -p->linesize[1], buf, buf_size);
252         ADVANCE_BY_DECODED;
253         decoded = loco_decode_plane(l, p->data[0] + p->linesize[0]*(avctx->height-1), avctx->width, avctx->height,
254                                     -p->linesize[0], buf, buf_size);
255         ADVANCE_BY_DECODED;
256         decoded = loco_decode_plane(l, p->data[2] + p->linesize[2]*(avctx->height-1), avctx->width, avctx->height,
257                                     -p->linesize[2], buf, buf_size);
258         ADVANCE_BY_DECODED;
259         decoded = loco_decode_plane(l, p->data[3] + p->linesize[3]*(avctx->height-1), avctx->width, avctx->height,
260                                     -p->linesize[3], buf, buf_size);
261         break;
262     default:
263         av_assert0(0);
264     }
265
266     if (decoded < 0 || decoded > buf_size)
267         goto buf_too_small;
268     buf_size -= decoded;
269
270     *got_frame      = 1;
271
272     return avpkt->size - buf_size;
273 buf_too_small:
274     av_log(avctx, AV_LOG_ERROR, "Input data too small.\n");
275     return AVERROR(EINVAL);
276 }
277
278 static av_cold int decode_init(AVCodecContext *avctx)
279 {
280     LOCOContext * const l = avctx->priv_data;
281     int version;
282
283     l->avctx = avctx;
284     if (avctx->extradata_size < 12) {
285         av_log(avctx, AV_LOG_ERROR, "Extradata size must be >= 12 instead of %i\n",
286                avctx->extradata_size);
287         return AVERROR_INVALIDDATA;
288     }
289     version = AV_RL32(avctx->extradata);
290     switch (version) {
291     case 1:
292         l->lossy = 0;
293         break;
294     case 2:
295         l->lossy = AV_RL32(avctx->extradata + 8);
296         break;
297     default:
298         l->lossy = AV_RL32(avctx->extradata + 8);
299         avpriv_request_sample(avctx, "LOCO codec version %i", version);
300     }
301
302     if (l->lossy > 65536U) {
303         av_log(avctx, AV_LOG_ERROR, "lossy %i is too large\n", l->lossy);
304         return AVERROR_INVALIDDATA;
305     }
306
307     l->mode = AV_RL32(avctx->extradata + 4);
308     switch (l->mode) {
309     case LOCO_CYUY2:
310     case LOCO_YUY2:
311     case LOCO_UYVY:
312         avctx->pix_fmt = AV_PIX_FMT_YUV422P;
313         break;
314     case LOCO_CRGB:
315     case LOCO_RGB:
316         avctx->pix_fmt = AV_PIX_FMT_GBRP;
317         break;
318     case LOCO_CYV12:
319     case LOCO_YV12:
320         avctx->pix_fmt = AV_PIX_FMT_YUV420P;
321         break;
322     case LOCO_CRGBA:
323     case LOCO_RGBA:
324         avctx->pix_fmt = AV_PIX_FMT_GBRAP;
325         break;
326     default:
327         av_log(avctx, AV_LOG_INFO, "Unknown colorspace, index = %i\n", l->mode);
328         return AVERROR_INVALIDDATA;
329     }
330     if (avctx->debug & FF_DEBUG_PICT_INFO)
331         av_log(avctx, AV_LOG_INFO, "lossy:%i, version:%i, mode: %i\n", l->lossy, version, l->mode);
332
333     return 0;
334 }
335
336 AVCodec ff_loco_decoder = {
337     .name           = "loco",
338     .long_name      = NULL_IF_CONFIG_SMALL("LOCO"),
339     .type           = AVMEDIA_TYPE_VIDEO,
340     .id             = AV_CODEC_ID_LOCO,
341     .priv_data_size = sizeof(LOCOContext),
342     .init           = decode_init,
343     .decode         = decode_frame,
344     .capabilities   = AV_CODEC_CAP_DR1,
345 };