2 * Discworld II BMV video and audio decoder
3 * Copyright (c) 2011 Konstantin Shishkov
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
23 #include "bytestream.h"
39 #define SCREEN_WIDE 640
40 #define SCREEN_HIGH 429
42 typedef struct BMVDecContext {
43 AVCodecContext *avctx;
46 uint8_t *frame, frame_base[SCREEN_WIDE * (SCREEN_HIGH + 1)];
48 const uint8_t *stream;
51 #define NEXT_BYTE(v) v = forward ? v + 1 : v - 1;
53 static int decode_bmv_frame(const uint8_t *source, int src_len, uint8_t *frame, int frame_off)
55 unsigned val, saved_val = 0;
57 const uint8_t *src, *source_end = source + src_len;
58 uint8_t *frame_end = frame + SCREEN_WIDE * SCREEN_HIGH;
59 uint8_t *dst, *dst_end;
61 int forward = (frame_off <= -SCREEN_WIDE) || (frame_off >= 0);
62 int read_two_nibbles, flag;
75 src = source + src_len - 1;
83 /* The mode/len decoding is a bit strange:
84 * values are coded as variable-length codes with nibble units,
85 * code end is signalled by two top bits in the nibble being nonzero.
86 * And since data is bytepacked and we read two nibbles at a time,
87 * we may get a nibble belonging to the next code.
88 * Hence this convoluted loop.
90 if (!mode || (tmplen == 4)) {
91 if (src < source || src >= source_end)
101 if (!read_two_nibbles) {
102 if (src < source || src >= source_end)
105 val |= *src << shift;
109 // two upper bits of the nibble is zero,
110 // so shift top nibble value down into their place
111 read_two_nibbles = 0;
113 mask = (1 << shift) - 1;
114 val = ((val >> 2) & ~mask) | (val & mask);
116 if ((val & (0xC << shift))) {
127 saved_val = val >> (4 + shift);
129 val &= (1 << (shift + 4)) - 1;
132 advance_mode = val & 1;
133 len = (val >> 1) - 1;
134 mode += 1 + advance_mode;
137 if (FFABS(dst_end - dst) < len)
142 if (dst - frame + SCREEN_WIDE < frame_off ||
143 dst - frame + SCREEN_WIDE + frame_off < 0 ||
144 frame_end - dst < frame_off + len ||
145 frame_end - dst < len)
147 for (i = 0; i < len; i++)
148 dst[i] = dst[frame_off + i];
152 if (dst - frame + SCREEN_WIDE < frame_off ||
153 dst - frame + SCREEN_WIDE + frame_off < 0 ||
154 frame_end - dst < frame_off + len ||
155 frame_end - dst < len)
157 for (i = len - 1; i >= 0; i--)
158 dst[i] = dst[frame_off + i];
163 if (source + src_len - src < len)
165 memcpy(dst, src, len);
169 if (src - source < len)
173 memcpy(dst, src, len);
177 val = forward ? dst[-1] : dst[1];
179 memset(dst, val, len);
183 memset(dst, val, len);
195 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *pkt)
197 BMVDecContext * const c = avctx->priv_data;
200 uint8_t *srcptr, *outptr;
202 c->stream = pkt->data;
203 type = bytestream_get_byte(&c->stream);
204 if (type & BMV_AUDIO) {
205 int blobs = bytestream_get_byte(&c->stream);
206 if (pkt->size < blobs * 65 + 2) {
207 av_log(avctx, AV_LOG_ERROR, "Audio data doesn't fit in frame\n");
208 return AVERROR_INVALIDDATA;
210 c->stream += blobs * 65;
212 if (type & BMV_COMMAND) {
213 int command_size = (type & BMV_PRINT) ? 8 : 10;
214 if (c->stream - pkt->data + command_size > pkt->size) {
215 av_log(avctx, AV_LOG_ERROR, "Command data doesn't fit in frame\n");
216 return AVERROR_INVALIDDATA;
218 c->stream += command_size;
220 if (type & BMV_PALETTE) {
221 if (c->stream - pkt->data > pkt->size - 768) {
222 av_log(avctx, AV_LOG_ERROR, "Palette data doesn't fit in frame\n");
223 return AVERROR_INVALIDDATA;
225 for (i = 0; i < 256; i++)
226 c->pal[i] = bytestream_get_be24(&c->stream);
228 if (type & BMV_SCROLL) {
229 if (c->stream - pkt->data > pkt->size - 2) {
230 av_log(avctx, AV_LOG_ERROR, "Screen offset data doesn't fit in frame\n");
231 return AVERROR_INVALIDDATA;
233 scr_off = (int16_t)bytestream_get_le16(&c->stream);
234 } else if ((type & BMV_INTRA) == BMV_INTRA) {
241 avctx->release_buffer(avctx, &c->pic);
243 c->pic.reference = 3;
244 if ((ret = avctx->get_buffer(avctx, &c->pic)) < 0) {
245 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
249 if (decode_bmv_frame(c->stream, pkt->size - (c->stream - pkt->data), c->frame, scr_off)) {
250 av_log(avctx, AV_LOG_ERROR, "Error decoding frame data\n");
251 return AVERROR_INVALIDDATA;
254 memcpy(c->pic.data[1], c->pal, AVPALETTE_SIZE);
255 c->pic.palette_has_changed = type & BMV_PALETTE;
257 outptr = c->pic.data[0];
260 for (i = 0; i < avctx->height; i++) {
261 memcpy(outptr, srcptr, avctx->width);
262 srcptr += avctx->width;
263 outptr += c->pic.linesize[0];
266 *data_size = sizeof(AVFrame);
267 *(AVFrame*)data = c->pic;
269 /* always report that the buffer was completely consumed */
273 static av_cold int decode_init(AVCodecContext *avctx)
275 BMVDecContext * const c = avctx->priv_data;
278 avctx->pix_fmt = AV_PIX_FMT_PAL8;
280 c->frame = c->frame_base + 640;
285 static av_cold int decode_end(AVCodecContext *avctx)
287 BMVDecContext *c = avctx->priv_data;
290 avctx->release_buffer(avctx, &c->pic);
295 typedef struct BMVAudioDecContext {
297 } BMVAudioDecContext;
299 static const int bmv_aud_mults[16] = {
300 16512, 8256, 4128, 2064, 1032, 516, 258, 192, 129, 88, 64, 56, 48, 40, 36, 32
303 static av_cold int bmv_aud_decode_init(AVCodecContext *avctx)
305 BMVAudioDecContext *c = avctx->priv_data;
307 if (avctx->channels != 2) {
308 av_log(avctx, AV_LOG_INFO, "invalid number of channels\n");
309 return AVERROR(EINVAL);
312 avctx->sample_fmt = AV_SAMPLE_FMT_S16;
314 avcodec_get_frame_defaults(&c->frame);
315 avctx->coded_frame = &c->frame;
320 static int bmv_aud_decode_frame(AVCodecContext *avctx, void *data,
321 int *got_frame_ptr, AVPacket *avpkt)
323 BMVAudioDecContext *c = avctx->priv_data;
324 const uint8_t *buf = avpkt->data;
325 int buf_size = avpkt->size;
326 int blocks = 0, total_blocks, i;
328 int16_t *output_samples;
331 total_blocks = *buf++;
332 if (buf_size < total_blocks * 65 + 1) {
333 av_log(avctx, AV_LOG_ERROR, "expected %d bytes, got %d\n",
334 total_blocks * 65 + 1, buf_size);
335 return AVERROR_INVALIDDATA;
338 /* get output buffer */
339 c->frame.nb_samples = total_blocks * 32;
340 if ((ret = avctx->get_buffer(avctx, &c->frame)) < 0) {
341 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
344 output_samples = (int16_t *)c->frame.data[0];
346 for (blocks = 0; blocks < total_blocks; blocks++) {
347 uint8_t code = *buf++;
348 code = (code >> 1) | (code << 7);
349 scale[0] = bmv_aud_mults[code & 0xF];
350 scale[1] = bmv_aud_mults[code >> 4];
351 for (i = 0; i < 32; i++) {
352 *output_samples++ = av_clip_int16((scale[0] * (int8_t)*buf++) >> 5);
353 *output_samples++ = av_clip_int16((scale[1] * (int8_t)*buf++) >> 5);
358 *(AVFrame *)data = c->frame;
363 AVCodec ff_bmv_video_decoder = {
365 .type = AVMEDIA_TYPE_VIDEO,
366 .id = AV_CODEC_ID_BMV_VIDEO,
367 .priv_data_size = sizeof(BMVDecContext),
370 .decode = decode_frame,
371 .capabilities = CODEC_CAP_DR1,
372 .long_name = NULL_IF_CONFIG_SMALL("Discworld II BMV video"),
375 AVCodec ff_bmv_audio_decoder = {
377 .type = AVMEDIA_TYPE_AUDIO,
378 .id = AV_CODEC_ID_BMV_AUDIO,
379 .priv_data_size = sizeof(BMVAudioDecContext),
380 .init = bmv_aud_decode_init,
381 .decode = bmv_aud_decode_frame,
382 .capabilities = CODEC_CAP_DR1,
383 .long_name = NULL_IF_CONFIG_SMALL("Discworld II BMV audio"),