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
22 #include "libavutil/avassert.h"
23 #include "libavutil/channel_layout.h"
25 #include "bytestream.h"
42 #define SCREEN_WIDE 640
43 #define SCREEN_HIGH 429
45 typedef struct BMVDecContext {
46 AVCodecContext *avctx;
49 uint8_t *frame, frame_base[SCREEN_WIDE * (SCREEN_HIGH + 1)];
51 const uint8_t *stream;
54 #define NEXT_BYTE(v) v = forward ? v + 1 : v - 1;
56 static int decode_bmv_frame(const uint8_t *source, int src_len, uint8_t *frame, int frame_off)
58 unsigned val, saved_val = 0;
60 const uint8_t *src, *source_end = source + src_len;
61 uint8_t *frame_end = frame + SCREEN_WIDE * SCREEN_HIGH;
62 uint8_t *dst, *dst_end;
64 int forward = (frame_off <= -SCREEN_WIDE) || (frame_off >= 0);
65 int read_two_nibbles, flag;
71 return AVERROR_INVALIDDATA;
78 src = source + src_len - 1;
86 /* The mode/len decoding is a bit strange:
87 * values are coded as variable-length codes with nibble units,
88 * code end is signalled by two top bits in the nibble being nonzero.
89 * And since data is bytepacked and we read two nibbles at a time,
90 * we may get a nibble belonging to the next code.
91 * Hence this convoluted loop.
93 if (!mode || (tmplen == 4)) {
94 if (src < source || src >= source_end)
95 return AVERROR_INVALIDDATA;
100 read_two_nibbles = 0;
106 if (!read_two_nibbles) {
107 if (src < source || src >= source_end)
108 return AVERROR_INVALIDDATA;
110 val |= *src << shift;
114 // two upper bits of the nibble is zero,
115 // so shift top nibble value down into their place
116 read_two_nibbles = 0;
118 mask = (1 << shift) - 1;
119 val = ((val >> 2) & ~mask) | (val & mask);
121 if ((val & (0xC << shift))) {
132 saved_val = val >> (4 + shift);
134 val &= (1 << (shift + 4)) - 1;
137 advance_mode = val & 1;
138 len = (val >> 1) - 1;
140 mode += 1 + advance_mode;
143 if (FFABS(dst_end - dst) < len)
144 return AVERROR_INVALIDDATA;
148 if (dst - frame + SCREEN_WIDE < frame_off ||
149 dst - frame + SCREEN_WIDE + frame_off < 0 ||
150 frame_end - dst < frame_off + len ||
151 frame_end - dst < len)
152 return AVERROR_INVALIDDATA;
153 for (i = 0; i < len; i++)
154 dst[i] = dst[frame_off + i];
158 if (dst - frame + SCREEN_WIDE < frame_off ||
159 dst - frame + SCREEN_WIDE + frame_off < 0 ||
160 frame_end - dst < frame_off + len ||
161 frame_end - dst < len)
162 return AVERROR_INVALIDDATA;
163 for (i = len - 1; i >= 0; i--)
164 dst[i] = dst[frame_off + i];
169 if (source + src_len - src < len)
170 return AVERROR_INVALIDDATA;
171 memcpy(dst, src, len);
175 if (src - source < len)
176 return AVERROR_INVALIDDATA;
179 memcpy(dst, src, len);
183 val = forward ? dst[-1] : dst[1];
185 memset(dst, val, len);
189 memset(dst, val, len);
199 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
202 BMVDecContext * const c = avctx->priv_data;
205 uint8_t *srcptr, *outptr;
207 c->stream = pkt->data;
208 type = bytestream_get_byte(&c->stream);
209 if (type & BMV_AUDIO) {
210 int blobs = bytestream_get_byte(&c->stream);
211 if (pkt->size < blobs * 65 + 2) {
212 av_log(avctx, AV_LOG_ERROR, "Audio data doesn't fit in frame\n");
213 return AVERROR_INVALIDDATA;
215 c->stream += blobs * 65;
217 if (type & BMV_COMMAND) {
218 int command_size = (type & BMV_PRINT) ? 8 : 10;
219 if (c->stream - pkt->data + command_size > pkt->size) {
220 av_log(avctx, AV_LOG_ERROR, "Command data doesn't fit in frame\n");
221 return AVERROR_INVALIDDATA;
223 c->stream += command_size;
225 if (type & BMV_PALETTE) {
226 if (c->stream - pkt->data > pkt->size - 768) {
227 av_log(avctx, AV_LOG_ERROR, "Palette data doesn't fit in frame\n");
228 return AVERROR_INVALIDDATA;
230 for (i = 0; i < 256; i++)
231 c->pal[i] = 0xFFU << 24 | bytestream_get_be24(&c->stream);
233 if (type & BMV_SCROLL) {
234 if (c->stream - pkt->data > pkt->size - 2) {
235 av_log(avctx, AV_LOG_ERROR, "Screen offset data doesn't fit in frame\n");
236 return AVERROR_INVALIDDATA;
238 scr_off = (int16_t)bytestream_get_le16(&c->stream);
239 } else if ((type & BMV_INTRA) == BMV_INTRA) {
246 avctx->release_buffer(avctx, &c->pic);
248 c->pic.reference = 3;
249 if ((ret = ff_get_buffer(avctx, &c->pic)) < 0) {
250 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
254 if (decode_bmv_frame(c->stream, pkt->size - (c->stream - pkt->data), c->frame, scr_off)) {
255 av_log(avctx, AV_LOG_ERROR, "Error decoding frame data\n");
256 return AVERROR_INVALIDDATA;
259 memcpy(c->pic.data[1], c->pal, AVPALETTE_SIZE);
260 c->pic.palette_has_changed = type & BMV_PALETTE;
262 outptr = c->pic.data[0];
265 for (i = 0; i < avctx->height; i++) {
266 memcpy(outptr, srcptr, avctx->width);
267 srcptr += avctx->width;
268 outptr += c->pic.linesize[0];
272 *(AVFrame*)data = c->pic;
274 /* always report that the buffer was completely consumed */
278 static av_cold int decode_init(AVCodecContext *avctx)
280 BMVDecContext * const c = avctx->priv_data;
283 avctx->pix_fmt = AV_PIX_FMT_PAL8;
285 if (avctx->width != SCREEN_WIDE || avctx->height != SCREEN_HIGH) {
286 av_log(avctx, AV_LOG_ERROR, "Invalid dimension %dx%d\n", avctx->width, avctx->height);
287 return AVERROR_INVALIDDATA;
290 c->frame = c->frame_base + 640;
295 static av_cold int decode_end(AVCodecContext *avctx)
297 BMVDecContext *c = avctx->priv_data;
300 avctx->release_buffer(avctx, &c->pic);
305 typedef struct BMVAudioDecContext {
307 } BMVAudioDecContext;
309 static const int bmv_aud_mults[16] = {
310 16512, 8256, 4128, 2064, 1032, 516, 258, 192, 129, 88, 64, 56, 48, 40, 36, 32
313 static av_cold int bmv_aud_decode_init(AVCodecContext *avctx)
315 BMVAudioDecContext *c = avctx->priv_data;
318 avctx->channel_layout = AV_CH_LAYOUT_STEREO;
319 avctx->sample_fmt = AV_SAMPLE_FMT_S16;
321 avcodec_get_frame_defaults(&c->frame);
322 avctx->coded_frame = &c->frame;
327 static int bmv_aud_decode_frame(AVCodecContext *avctx, void *data,
328 int *got_frame_ptr, AVPacket *avpkt)
330 BMVAudioDecContext *c = avctx->priv_data;
331 const uint8_t *buf = avpkt->data;
332 int buf_size = avpkt->size;
333 int blocks = 0, total_blocks, i;
335 int16_t *output_samples;
338 total_blocks = *buf++;
339 if (buf_size < total_blocks * 65 + 1) {
340 av_log(avctx, AV_LOG_ERROR, "expected %d bytes, got %d\n",
341 total_blocks * 65 + 1, buf_size);
342 return AVERROR_INVALIDDATA;
345 /* get output buffer */
346 c->frame.nb_samples = total_blocks * 32;
347 if ((ret = ff_get_buffer(avctx, &c->frame)) < 0) {
348 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
351 output_samples = (int16_t *)c->frame.data[0];
353 for (blocks = 0; blocks < total_blocks; blocks++) {
354 uint8_t code = *buf++;
355 code = (code >> 1) | (code << 7);
356 scale[0] = bmv_aud_mults[code & 0xF];
357 scale[1] = bmv_aud_mults[code >> 4];
358 for (i = 0; i < 32; i++) {
359 *output_samples++ = av_clip_int16((scale[0] * (int8_t)*buf++) >> 5);
360 *output_samples++ = av_clip_int16((scale[1] * (int8_t)*buf++) >> 5);
365 *(AVFrame *)data = c->frame;
370 AVCodec ff_bmv_video_decoder = {
372 .type = AVMEDIA_TYPE_VIDEO,
373 .id = AV_CODEC_ID_BMV_VIDEO,
374 .priv_data_size = sizeof(BMVDecContext),
377 .decode = decode_frame,
378 .capabilities = CODEC_CAP_DR1,
379 .long_name = NULL_IF_CONFIG_SMALL("Discworld II BMV video"),
382 AVCodec ff_bmv_audio_decoder = {
384 .type = AVMEDIA_TYPE_AUDIO,
385 .id = AV_CODEC_ID_BMV_AUDIO,
386 .priv_data_size = sizeof(BMVAudioDecContext),
387 .init = bmv_aud_decode_init,
388 .decode = bmv_aud_decode_frame,
389 .capabilities = CODEC_CAP_DR1,
390 .long_name = NULL_IF_CONFIG_SMALL("Discworld II BMV audio"),