2 * Escape 124 Video Decoder
3 * Copyright (C) 2008 Eli Friedman (eli.friedman@gmail.com)
5 * This file is part of Libav.
7 * Libav 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.
12 * Libav 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.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #define BITSTREAM_READER_LE
28 typedef union MacroBlock {
33 typedef union SuperBlock {
35 uint32_t pixels32[32];
38 typedef struct CodeBook {
44 typedef struct Escape124Context {
47 unsigned num_superblocks;
49 CodeBook codebooks[3];
52 static int can_safely_read(GetBitContext* gb, int bits) {
53 return get_bits_left(gb) >= bits;
57 * Initialize the decoder
58 * @param avctx decoder context
59 * @return 0 success, negative on error
61 static av_cold int escape124_decode_init(AVCodecContext *avctx)
63 Escape124Context *s = avctx->priv_data;
65 avctx->pix_fmt = AV_PIX_FMT_RGB555;
67 s->num_superblocks = ((unsigned)avctx->width / 8) *
68 ((unsigned)avctx->height / 8);
70 s->frame = av_frame_alloc();
72 return AVERROR(ENOMEM);
77 static av_cold int escape124_decode_close(AVCodecContext *avctx)
80 Escape124Context *s = avctx->priv_data;
82 for (i = 0; i < 3; i++)
83 av_free(s->codebooks[i].blocks);
85 av_frame_free(&s->frame);
90 static CodeBook unpack_codebook(GetBitContext* gb, unsigned depth,
96 if (!can_safely_read(gb, size * 34))
99 if (size >= INT_MAX / sizeof(MacroBlock))
101 cb.blocks = av_malloc(size ? size * sizeof(MacroBlock) : 1);
107 for (i = 0; i < size; i++) {
108 unsigned mask_bits = get_bits(gb, 4);
109 unsigned color0 = get_bits(gb, 15);
110 unsigned color1 = get_bits(gb, 15);
112 for (j = 0; j < 4; j++) {
113 if (mask_bits & (1 << j))
114 cb.blocks[i].pixels[j] = color1;
116 cb.blocks[i].pixels[j] = color0;
122 static unsigned decode_skip_count(GetBitContext* gb)
125 // This function reads a maximum of 23 bits,
126 // which is within the padding space
127 if (!can_safely_read(gb, 1))
129 value = get_bits1(gb);
133 value += get_bits(gb, 3);
134 if (value != (1 + ((1 << 3) - 1)))
137 value += get_bits(gb, 7);
138 if (value != (1 + ((1 << 3) - 1)) + ((1 << 7) - 1))
141 return value + get_bits(gb, 12);
144 static MacroBlock decode_macroblock(Escape124Context* s, GetBitContext* gb,
145 int* codebook_index, int superblock_index)
147 // This function reads a maximum of 22 bits; the callers
148 // guard this function appropriately
149 unsigned block_index, depth;
152 static const char transitions[3][2] = { {2, 1}, {0, 2}, {1, 0} };
153 *codebook_index = transitions[*codebook_index][get_bits1(gb)];
156 depth = s->codebooks[*codebook_index].depth;
158 // depth = 0 means that this shouldn't read any bits;
159 // in theory, this is the same as get_bits(gb, 0), but
160 // that doesn't actually work.
161 block_index = depth ? get_bits(gb, depth) : 0;
163 if (*codebook_index == 1) {
164 block_index += superblock_index << s->codebooks[1].depth;
167 // This condition can occur with invalid bitstreams and
168 // *codebook_index == 2
169 if (block_index >= s->codebooks[*codebook_index].size)
170 return (MacroBlock) { { 0 } };
172 return s->codebooks[*codebook_index].blocks[block_index];
175 static void insert_mb_into_sb(SuperBlock* sb, MacroBlock mb, unsigned index) {
176 // Formula: ((index / 4) * 16 + (index % 4) * 2) / 2
177 uint32_t *dst = sb->pixels32 + index + (index & -4);
179 // This technically violates C99 aliasing rules, but it should be safe.
180 dst[0] = mb.pixels32[0];
181 dst[4] = mb.pixels32[1];
184 static void copy_superblock(uint16_t* dest, unsigned dest_stride,
185 uint16_t* src, unsigned src_stride)
189 for (y = 0; y < 8; y++)
190 memcpy(dest + y * dest_stride, src + y * src_stride,
191 sizeof(uint16_t) * 8);
193 for (y = 0; y < 8; y++)
194 memset(dest + y * dest_stride, 0, sizeof(uint16_t) * 8);
197 static const uint16_t mask_matrix[] = {0x1, 0x2, 0x10, 0x20,
198 0x4, 0x8, 0x40, 0x80,
199 0x100, 0x200, 0x1000, 0x2000,
200 0x400, 0x800, 0x4000, 0x8000};
202 static int escape124_decode_frame(AVCodecContext *avctx,
203 void *data, int *got_frame,
206 const uint8_t *buf = avpkt->data;
207 int buf_size = avpkt->size;
208 Escape124Context *s = avctx->priv_data;
209 AVFrame *frame = data;
212 unsigned frame_flags, frame_size;
215 unsigned superblock_index, cb_index = 1,
216 superblock_col_index = 0,
217 superblocks_per_row = avctx->width / 8, skip = -1;
219 uint16_t* old_frame_data, *new_frame_data;
220 unsigned old_stride, new_stride;
223 init_get_bits(&gb, buf, buf_size * 8);
225 // This call also guards the potential depth reads for the
226 // codebook unpacking.
227 if (!can_safely_read(&gb, 64))
230 frame_flags = get_bits_long(&gb, 32);
231 frame_size = get_bits_long(&gb, 32);
233 // Leave last frame unchanged
234 // FIXME: Is this necessary? I haven't seen it in any real samples
235 if (!(frame_flags & 0x114) || !(frame_flags & 0x7800000)) {
236 if (!s->frame->data[0])
237 return AVERROR_INVALIDDATA;
239 av_log(NULL, AV_LOG_DEBUG, "Skipping frame\n");
242 if ((ret = av_frame_ref(frame, s->frame)) < 0)
248 for (i = 0; i < 3; i++) {
249 if (frame_flags & (1 << (17 + i))) {
250 unsigned cb_depth, cb_size;
252 // This codebook can be cut off at places other than
253 // powers of 2, leaving some of the entries undefined.
254 cb_size = get_bits_long(&gb, 20);
255 cb_depth = av_log2(cb_size - 1) + 1;
257 cb_depth = get_bits(&gb, 4);
259 // This is the most basic codebook: pow(2,depth) entries
260 // for a depth-length key
261 cb_size = 1 << cb_depth;
263 // This codebook varies per superblock
264 // FIXME: I don't think this handles integer overflow
266 cb_size = s->num_superblocks << cb_depth;
269 av_free(s->codebooks[i].blocks);
270 s->codebooks[i] = unpack_codebook(&gb, cb_depth, cb_size);
271 if (!s->codebooks[i].blocks)
276 if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0) {
277 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
281 new_frame_data = (uint16_t*)frame->data[0];
282 new_stride = frame->linesize[0] / 2;
283 old_frame_data = (uint16_t*)s->frame->data[0];
284 old_stride = s->frame->linesize[0] / 2;
286 for (superblock_index = 0; superblock_index < s->num_superblocks;
287 superblock_index++) {
290 unsigned multi_mask = 0;
293 // Note that this call will make us skip the rest of the blocks
294 // if the frame prematurely ends
295 skip = decode_skip_count(&gb);
299 copy_superblock(new_frame_data, new_stride,
300 old_frame_data, old_stride);
302 copy_superblock(sb.pixels, 8,
303 old_frame_data, old_stride);
305 while (can_safely_read(&gb, 1) && !get_bits1(&gb)) {
307 mb = decode_macroblock(s, &gb, &cb_index, superblock_index);
308 mask = get_bits(&gb, 16);
310 for (i = 0; i < 16; i++) {
311 if (mask & mask_matrix[i]) {
312 insert_mb_into_sb(&sb, mb, i);
317 if (can_safely_read(&gb, 1) && !get_bits1(&gb)) {
318 unsigned inv_mask = get_bits(&gb, 4);
319 for (i = 0; i < 4; i++) {
320 if (inv_mask & (1 << i)) {
321 multi_mask ^= 0xF << i*4;
323 multi_mask ^= get_bits(&gb, 4) << i*4;
327 for (i = 0; i < 16; i++) {
328 if (multi_mask & mask_matrix[i]) {
329 if (!can_safely_read(&gb, 1))
331 mb = decode_macroblock(s, &gb, &cb_index,
333 insert_mb_into_sb(&sb, mb, i);
336 } else if (frame_flags & (1 << 16)) {
337 while (can_safely_read(&gb, 1) && !get_bits1(&gb)) {
338 mb = decode_macroblock(s, &gb, &cb_index, superblock_index);
339 insert_mb_into_sb(&sb, mb, get_bits(&gb, 4));
343 copy_superblock(new_frame_data, new_stride, sb.pixels, 8);
346 superblock_col_index++;
350 if (superblock_col_index == superblocks_per_row) {
351 new_frame_data += new_stride * 8 - superblocks_per_row * 8;
353 old_frame_data += old_stride * 8 - superblocks_per_row * 8;
354 superblock_col_index = 0;
359 av_log(NULL, AV_LOG_DEBUG,
360 "Escape sizes: %i, %i, %i\n",
361 frame_size, buf_size, get_bits_count(&gb) / 8);
363 av_frame_unref(s->frame);
364 if ((ret = av_frame_ref(s->frame, frame)) < 0)
373 AVCodec ff_escape124_decoder = {
375 .long_name = NULL_IF_CONFIG_SMALL("Escape 124"),
376 .type = AVMEDIA_TYPE_VIDEO,
377 .id = AV_CODEC_ID_ESCAPE124,
378 .priv_data_size = sizeof(Escape124Context),
379 .init = escape124_decode_init,
380 .close = escape124_decode_close,
381 .decode = escape124_decode_frame,
382 .capabilities = CODEC_CAP_DR1,