2 * Microsoft Screen 2 (aka Windows Media Video V9 Screen) decoder
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * Microsoft Screen 2 (aka Windows Media Video V9 Screen) decoder
26 #include "libavutil/avassert.h"
27 #include "msmpeg4data.h"
32 typedef struct MSS2Context {
42 static void arith2_normalise(ArithCoder *c)
44 while ((c->high >> 15) - (c->low >> 15) < 2) {
45 if ((c->low ^ c->high) & 0x10000) {
50 c->high = c->high << 8 & 0xFFFFFF | 0xFF;
51 c->value = c->value << 8 & 0xFFFFFF | bytestream2_get_byte(c->gbc.gB);
52 c->low = c->low << 8 & 0xFFFFFF;
58 /* L. Stuiver and A. Moffat: "Piecewise Integer Mapping for Arithmetic Coding."
59 * In Proc. 8th Data Compression Conference (DCC '98), pp. 3-12, Mar. 1998 */
61 static int arith2_get_scaled_value(int value, int n, int range)
63 int split = (n << 1) - range;
66 return split + (value - split >> 1);
71 static void arith2_rescale_interval(ArithCoder *c, int range,
72 int low, int high, int n)
74 int split = (n << 1) - range;
77 c->high = split + (high - split << 1);
81 c->high += c->low - 1;
84 c->low += split + (low - split << 1);
89 static int arith2_get_number(ArithCoder *c, int n)
91 int range = c->high - c->low + 1;
92 int scale = av_log2(range) - av_log2(n);
95 if (n << scale > range)
100 val = arith2_get_scaled_value(c->value - c->low, n, range) >> scale;
102 arith2_rescale_interval(c, range, val << scale, (val + 1) << scale, n);
109 static int arith2_get_prob(ArithCoder *c, int16_t *probs)
111 int range = c->high - c->low + 1, n = *probs;
112 int scale = av_log2(range) - av_log2(n);
115 if (n << scale > range)
120 val = arith2_get_scaled_value(c->value - c->low, n, range) >> scale;
121 while (probs[++i] > val) ;
123 arith2_rescale_interval(c, range,
124 probs[i] << scale, probs[i - 1] << scale, n);
129 ARITH_GET_MODEL_SYM(2)
131 static int arith2_get_consumed_bytes(ArithCoder *c)
133 int diff = (c->high >> 16) - (c->low >> 16);
134 int bp = bytestream2_tell(c->gbc.gB) - 3 << 3;
137 while (!(diff & 0x80)) {
142 return (bits + bp + 7 >> 3) + ((c->low >> 16) + 1 == c->high >> 16);
145 static void arith2_init(ArithCoder *c, GetByteContext *gB)
149 c->value = bytestream2_get_be24(gB);
151 c->get_model_sym = arith2_get_model_sym;
152 c->get_number = arith2_get_number;
155 static int decode_pal_v2(MSS12Context *ctx, const uint8_t *buf, int buf_size)
158 uint32_t *pal = ctx->pal + 256 - ctx->free_colours;
160 if (!ctx->free_colours)
164 if (ncol > ctx->free_colours || buf_size < 2 + ncol * 3)
166 for (i = 0; i < ncol; i++)
167 *pal++ = AV_RB24(buf + 3 * i);
172 static int decode_555(GetByteContext *gB, uint16_t *dst, int stride,
173 int keyframe, int w, int h)
175 int last_symbol = 0, repeat = 0, prev_avail = 0;
178 int x, y, endx, endy, t;
180 #define READ_PAIR(a, b) \
181 a = bytestream2_get_byte(gB) << 4; \
182 t = bytestream2_get_byte(gB); \
184 b = (t & 0xF) << 8; \
185 b |= bytestream2_get_byte(gB); \
190 if (endx >= w || endy >= h || x > endx || y > endy)
192 dst += x + stride * y;
203 int b = bytestream2_get_byte(gB);
205 last_symbol = b << 8 | bytestream2_get_byte(gB);
209 repeat = (repeat << 8) + bytestream2_get_byte(gB) + 1;
210 if (last_symbol == -2) {
211 int skip = FFMIN((unsigned)repeat, dst + w - p);
216 last_symbol = 127 - b;
218 if (last_symbol >= 0)
220 else if (last_symbol == -1 && prev_avail)
222 } while (++p < dst + w);
230 static int decode_rle(GetBitContext *gb, uint8_t *pal_dst, int pal_stride,
231 uint8_t *rgb_dst, int rgb_stride, uint32_t *pal,
232 int keyframe, int kf_slipt, int slice, int w, int h)
234 uint8_t bits[270] = { 0 };
238 int current_length = 0, read_codes = 0, next_code = 0, current_codes = 0;
239 int remaining_codes, surplus_codes, i;
241 const int alphabet_size = 270 - keyframe;
243 int last_symbol = 0, repeat = 0, prev_avail = 0;
246 int x, y, clipw, cliph;
248 x = get_bits(gb, 12);
249 y = get_bits(gb, 12);
250 clipw = get_bits(gb, 12) + 1;
251 cliph = get_bits(gb, 12) + 1;
253 if (x + clipw > w || y + cliph > h)
254 return AVERROR_INVALIDDATA;
255 pal_dst += pal_stride * y + x;
256 rgb_dst += rgb_stride * y + x * 3;
263 pal_dst += pal_stride * kf_slipt;
264 rgb_dst += rgb_stride * kf_slipt;
271 /* read explicit codes */
273 while (current_codes--) {
274 int symbol = get_bits(gb, 8);
275 if (symbol >= 204 - keyframe)
276 symbol += 14 - keyframe;
277 else if (symbol > 189)
278 symbol = get_bits1(gb) + (symbol << 1) - 190;
280 return AVERROR_INVALIDDATA;
281 bits[symbol] = current_length;
282 codes[symbol] = next_code++;
287 remaining_codes = (1 << current_length) - next_code;
288 current_codes = get_bits(gb, av_ceil_log2(remaining_codes + 1));
289 if (current_length > 22 || current_codes > remaining_codes)
290 return AVERROR_INVALIDDATA;
291 } while (current_codes != remaining_codes);
293 remaining_codes = alphabet_size - read_codes;
295 /* determine the minimum length to fit the rest of the alphabet */
296 while ((surplus_codes = (2 << current_length) -
297 (next_code << 1) - remaining_codes) < 0) {
302 /* add the rest of the symbols lexicographically */
303 for (i = 0; i < alphabet_size; i++)
305 if (surplus_codes-- == 0) {
309 bits[i] = current_length;
310 codes[i] = next_code++;
313 if (next_code != 1 << current_length)
314 return AVERROR_INVALIDDATA;
316 if (i = init_vlc(&vlc, 9, alphabet_size, bits, 1, 1, codes, 4, 4, 0))
321 uint8_t *pp = pal_dst;
322 uint8_t *rp = rgb_dst;
325 int b = get_vlc2(gb, vlc.table, 9, 3);
331 b = get_bits(gb, 4) + 10;
336 repeat = get_bits(gb, b);
338 repeat += (1 << b) - 1;
340 if (last_symbol == -2) {
341 int skip = FFMIN(repeat, pal_dst + w - pp);
347 last_symbol = 267 - b;
349 if (last_symbol >= 0) {
351 AV_WB24(rp, pal[last_symbol]);
352 } else if (last_symbol == -1 && prev_avail) {
353 *pp = *(pp - pal_stride);
354 memcpy(rp, rp - rgb_stride, 3);
357 } while (++pp < pal_dst + w);
358 pal_dst += pal_stride;
359 rgb_dst += rgb_stride;
367 static int decode_wmv9(AVCodecContext *avctx, const uint8_t *buf, int buf_size,
368 int x, int y, int w, int h, int wmv9_mask)
370 MSS2Context *ctx = avctx->priv_data;
371 MSS12Context *c = &ctx->c;
372 VC1Context *v = avctx->priv_data;
373 MpegEncContext *s = &v->s;
376 ff_mpeg_flush(avctx);
378 if (s->current_picture_ptr == NULL || s->current_picture_ptr->f.data[0]) {
379 int i = ff_find_unused_picture(s, 0);
382 s->current_picture_ptr = &s->picture[i];
385 init_get_bits(&s->gb, buf, buf_size * 8);
387 s->loop_filter = avctx->skip_loop_filter < AVDISCARD_ALL;
389 if (ff_vc1_parse_frame_header(v, &s->gb) == -1) {
390 av_log(v->s.avctx, AV_LOG_ERROR, "header error\n");
391 return AVERROR_INVALIDDATA;
394 if (s->pict_type != AV_PICTURE_TYPE_I) {
395 av_log(v->s.avctx, AV_LOG_ERROR, "expected I-frame\n");
396 return AVERROR_INVALIDDATA;
399 avctx->pix_fmt = PIX_FMT_YUV420P;
401 if (ff_MPV_frame_start(s, avctx) < 0) {
402 av_log(v->s.avctx, AV_LOG_ERROR, "ff_MPV_frame_start error\n");
403 avctx->pix_fmt = PIX_FMT_RGB24;
407 ff_er_frame_start(s);
409 v->bits = buf_size * 8;
411 v->end_mb_x = (w + 15) >> 4;
412 s->end_mb_y = (h + 15) >> 4;
414 v->end_mb_x = v->end_mb_x + 1 >> 1;
416 s->end_mb_y = s->end_mb_y + 1 >> 1;
418 ff_vc1_decode_blocks(v);
424 f = &s->current_picture.f;
426 if (v->respic == 3) {
427 ctx->dsp.upsample_plane(f->data[0], f->linesize[0], w, h);
428 ctx->dsp.upsample_plane(f->data[1], f->linesize[1], w >> 1, h >> 1);
429 ctx->dsp.upsample_plane(f->data[2], f->linesize[2], w >> 1, h >> 1);
430 } else if (v->respic)
431 av_log_ask_for_sample(v->s.avctx,
432 "Asymmetric WMV9 rectangle subsampling\n");
434 av_assert0(f->linesize[1] == f->linesize[2]);
437 ctx->dsp.mss2_blit_wmv9_masked(c->rgb_pic + y * c->rgb_stride + x * 3,
438 c->rgb_stride, wmv9_mask,
439 c->pal_pic + y * c->pal_stride + x,
441 f->data[0], f->linesize[0],
442 f->data[1], f->data[2], f->linesize[1],
445 ctx->dsp.mss2_blit_wmv9(c->rgb_pic + y * c->rgb_stride + x * 3,
447 f->data[0], f->linesize[0],
448 f->data[1], f->data[2], f->linesize[1],
451 avctx->pix_fmt = PIX_FMT_RGB24;
456 typedef struct Rectangle {
457 int coded, x, y, w, h;
460 #define MAX_WMV9_RECTANGLES 20
461 #define ARITH2_PADDING 2
463 static int mss2_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
466 const uint8_t *buf = avpkt->data;
467 int buf_size = avpkt->size;
468 MSS2Context *ctx = avctx->priv_data;
469 MSS12Context *c = &ctx->c;
474 int keyframe, has_wmv9, has_mv, is_rle, is_555, ret;
476 Rectangle wmv9rects[MAX_WMV9_RECTANGLES], *r;
477 int used_rects = 0, i, implicit_rect, av_uninit(wmv9_mask);
479 av_assert0(FF_INPUT_BUFFER_PADDING_SIZE >=
480 ARITH2_PADDING + (MIN_CACHE_BITS + 7) / 8);
482 init_get_bits(&gb, buf, buf_size * 8);
484 if (keyframe = get_bits1(&gb))
486 has_wmv9 = get_bits1(&gb);
487 has_mv = keyframe ? 0 : get_bits1(&gb);
488 is_rle = get_bits1(&gb);
489 is_555 = is_rle && get_bits1(&gb);
490 if (c->slice_split > 0)
491 ctx->split_position = c->slice_split;
492 else if (c->slice_split < 0) {
493 if (get_bits1(&gb)) {
494 if (get_bits1(&gb)) {
496 ctx->split_position = get_bits(&gb, 16);
498 ctx->split_position = get_bits(&gb, 12);
500 ctx->split_position = get_bits(&gb, 8) << 4;
503 ctx->split_position = avctx->height / 2;
506 ctx->split_position = avctx->height;
508 if (c->slice_split && (ctx->split_position < 1 - is_555 ||
509 ctx->split_position > avctx->height - 1))
510 return AVERROR_INVALIDDATA;
513 buf += get_bits_count(&gb) >> 3;
514 buf_size -= get_bits_count(&gb) >> 3;
517 return AVERROR_INVALIDDATA;
519 if (is_555 && (has_wmv9 || has_mv || c->slice_split && ctx->split_position))
520 return AVERROR_INVALIDDATA;
522 avctx->pix_fmt = is_555 ? PIX_FMT_RGB555 : PIX_FMT_RGB24;
523 if (ctx->pic.data[0] && ctx->pic.format != avctx->pix_fmt)
524 avctx->release_buffer(avctx, &ctx->pic);
527 bytestream2_init(&gB, buf, buf_size + ARITH2_PADDING);
528 arith2_init(&acoder, &gB);
530 implicit_rect = !arith2_get_bit(&acoder);
532 while (arith2_get_bit(&acoder)) {
533 if (used_rects == MAX_WMV9_RECTANGLES)
534 return AVERROR_INVALIDDATA;
535 r = &wmv9rects[used_rects];
537 r->x = arith2_get_number(&acoder, avctx->width);
539 r->x = arith2_get_number(&acoder, avctx->width -
540 wmv9rects[used_rects - 1].x) +
541 wmv9rects[used_rects - 1].x;
542 r->y = arith2_get_number(&acoder, avctx->height);
543 r->w = arith2_get_number(&acoder, avctx->width - r->x) + 1;
544 r->h = arith2_get_number(&acoder, avctx->height - r->y) + 1;
548 if (implicit_rect && used_rects) {
549 av_log(avctx, AV_LOG_ERROR, "implicit_rect && used_rects > 0\n");
550 return AVERROR_INVALIDDATA;
556 wmv9rects[0].w = avctx->width;
557 wmv9rects[0].h = avctx->height;
561 for (i = 0; i < used_rects; i++) {
562 if (!implicit_rect && arith2_get_bit(&acoder)) {
563 av_log(avctx, AV_LOG_ERROR, "Unexpected grandchildren\n");
564 return AVERROR_INVALIDDATA;
567 wmv9_mask = arith2_get_bit(&acoder) - 1;
569 wmv9_mask = arith2_get_number(&acoder, 256);
571 wmv9rects[i].coded = arith2_get_number(&acoder, 2);
574 buf += arith2_get_consumed_bytes(&acoder);
575 buf_size -= arith2_get_consumed_bytes(&acoder);
577 return AVERROR_INVALIDDATA;
581 if (keyframe && !is_555) {
582 if ((i = decode_pal_v2(c, buf, buf_size)) < 0)
583 return AVERROR_INVALIDDATA;
590 return AVERROR_INVALIDDATA;
591 c->mvX = AV_RB16(buf - 4) - avctx->width;
592 c->mvY = AV_RB16(buf - 2) - avctx->height;
595 if (c->mvX < 0 || c->mvY < 0) {
596 FFSWAP(AVFrame, ctx->pic, ctx->last_pic);
597 FFSWAP(uint8_t *, c->pal_pic, c->last_pal_pic);
599 if (ctx->pic.data[0])
600 avctx->release_buffer(avctx, &ctx->pic);
602 ctx->pic.reference = 3;
603 ctx->pic.buffer_hints = FF_BUFFER_HINTS_VALID |
604 FF_BUFFER_HINTS_READABLE |
605 FF_BUFFER_HINTS_PRESERVE |
606 FF_BUFFER_HINTS_REUSABLE;
608 if ((ret = avctx->get_buffer(avctx, &ctx->pic)) < 0) {
609 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
613 if (ctx->last_pic.data[0]) {
614 av_assert0(ctx->pic.linesize[0] == ctx->last_pic.linesize[0]);
615 c->last_rgb_pic = ctx->last_pic.data[0] +
616 ctx->last_pic.linesize[0] * (avctx->height - 1);
618 av_log(avctx, AV_LOG_ERROR, "Missing keyframe\n");
622 if (ctx->last_pic.data[0])
623 avctx->release_buffer(avctx, &ctx->last_pic);
625 ctx->pic.reference = 3;
626 ctx->pic.buffer_hints = FF_BUFFER_HINTS_VALID |
627 FF_BUFFER_HINTS_READABLE |
628 FF_BUFFER_HINTS_PRESERVE |
629 FF_BUFFER_HINTS_REUSABLE;
631 if ((ret = avctx->reget_buffer(avctx, &ctx->pic)) < 0) {
632 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
636 c->last_rgb_pic = NULL;
638 c->rgb_pic = ctx->pic.data[0] +
639 ctx->pic.linesize[0] * (avctx->height - 1);
640 c->rgb_stride = -ctx->pic.linesize[0];
642 ctx->pic.key_frame = keyframe;
643 ctx->pic.pict_type = keyframe ? AV_PICTURE_TYPE_I : AV_PICTURE_TYPE_P;
646 bytestream2_init(&gB, buf, buf_size);
648 if (decode_555(&gB, (uint16_t *)c->rgb_pic, c->rgb_stride >> 1,
649 keyframe, avctx->width, avctx->height))
650 return AVERROR_INVALIDDATA;
652 buf_size -= bytestream2_tell(&gB);
654 init_get_bits(&gb, buf, buf_size * 8);
655 if (ret = decode_rle(&gb, c->pal_pic, c->pal_stride,
656 c->rgb_pic, c->rgb_stride, c->pal, keyframe,
657 ctx->split_position, 0,
658 avctx->width, avctx->height))
663 if (ret = decode_rle(&gb, c->pal_pic, c->pal_stride,
664 c->rgb_pic, c->rgb_stride, c->pal, keyframe,
665 ctx->split_position, 1,
666 avctx->width, avctx->height))
670 buf += get_bits_count(&gb) >> 3;
671 buf_size -= get_bits_count(&gb) >> 3;
675 ff_mss12_slicecontext_reset(&ctx->sc[0]);
677 ff_mss12_slicecontext_reset(&ctx->sc[1]);
679 else if (c->corrupted)
680 return AVERROR_INVALIDDATA;
681 bytestream2_init(&gB, buf, buf_size + ARITH2_PADDING);
682 arith2_init(&acoder, &gB);
683 c->keyframe = keyframe;
684 if (c->corrupted = ff_mss12_decode_rect(&ctx->sc[0], &acoder, 0, 0,
686 ctx->split_position))
687 return AVERROR_INVALIDDATA;
689 buf += arith2_get_consumed_bytes(&acoder);
690 buf_size -= arith2_get_consumed_bytes(&acoder);
691 if (c->slice_split) {
693 return AVERROR_INVALIDDATA;
694 bytestream2_init(&gB, buf, buf_size + ARITH2_PADDING);
695 arith2_init(&acoder, &gB);
696 if (c->corrupted = ff_mss12_decode_rect(&ctx->sc[1], &acoder, 0,
699 avctx->height - ctx->split_position))
700 return AVERROR_INVALIDDATA;
702 buf += arith2_get_consumed_bytes(&acoder);
703 buf_size -= arith2_get_consumed_bytes(&acoder);
708 for (i = 0; i < used_rects; i++) {
709 int x = wmv9rects[i].x;
710 int y = wmv9rects[i].y;
711 int w = wmv9rects[i].w;
712 int h = wmv9rects[i].h;
713 if (wmv9rects[i].coded) {
714 int WMV9codedFrameSize;
715 if (buf_size < 4 || !(WMV9codedFrameSize = AV_RL24(buf)))
716 return AVERROR_INVALIDDATA;
717 if (ret = decode_wmv9(avctx, buf + 3, buf_size - 3,
718 x, y, w, h, wmv9_mask))
720 buf += WMV9codedFrameSize + 3;
721 buf_size -= WMV9codedFrameSize + 3;
723 uint8_t *dst = c->rgb_pic + y * c->rgb_stride + x * 3;
724 if (wmv9_mask != -1) {
725 ctx->dsp.mss2_gray_fill_masked(dst, c->rgb_stride,
727 c->pal_pic + y * c->pal_stride + x,
732 memset(dst, 0x80, w * 3);
733 dst += c->rgb_stride;
741 av_log(avctx, AV_LOG_WARNING, "buffer not fully consumed\n");
743 *data_size = sizeof(AVFrame);
744 *(AVFrame *)data = ctx->pic;
749 static av_cold int wmv9_init(AVCodecContext *avctx)
751 VC1Context *v = avctx->priv_data;
754 avctx->flags |= CODEC_FLAG_EMU_EDGE;
755 v->s.flags |= CODEC_FLAG_EMU_EDGE;
757 if (avctx->idct_algo == FF_IDCT_AUTO)
758 avctx->idct_algo = FF_IDCT_WMV2;
760 if (ff_vc1_init_common(v) < 0)
762 ff_vc1dsp_init(&v->vc1dsp);
764 v->profile = PROFILE_MAIN;
766 v->zz_8x4 = ff_wmv2_scantableA;
767 v->zz_4x8 = ff_wmv2_scantableB;
771 v->frmrtq_postproc = 7;
772 v->bitrtq_postproc = 31;
789 v->s.resync_marker = 0;
792 v->s.max_b_frames = avctx->max_b_frames = 0;
793 v->quantizer_mode = 0;
799 ff_vc1_init_transposed_scantables(v);
801 if (ff_msmpeg4_decode_init(avctx) < 0 ||
802 ff_vc1_decode_init_alloc_tables(v) < 0)
805 /* error concealment */
806 v->s.me.qpel_put = v->s.dsp.put_qpel_pixels_tab;
807 v->s.me.qpel_avg = v->s.dsp.avg_qpel_pixels_tab;
812 static av_cold int mss2_decode_end(AVCodecContext *avctx)
814 MSS2Context *const ctx = avctx->priv_data;
816 if (ctx->pic.data[0])
817 avctx->release_buffer(avctx, &ctx->pic);
818 if (ctx->last_pic.data[0])
819 avctx->release_buffer(avctx, &ctx->last_pic);
821 ff_mss12_decode_end(&ctx->c);
822 av_freep(&ctx->c.pal_pic);
823 av_freep(&ctx->c.last_pal_pic);
824 ff_vc1_decode_end(avctx);
829 static av_cold int mss2_decode_init(AVCodecContext *avctx)
831 MSS2Context * const ctx = avctx->priv_data;
832 MSS12Context *c = &ctx->c;
835 avctx->coded_frame = &ctx->pic;
836 if (ret = ff_mss12_decode_init(c, 1, &ctx->sc[0], &ctx->sc[1]))
838 c->pal_stride = c->mask_stride;
839 c->pal_pic = av_malloc(c->pal_stride * avctx->height);
840 c->last_pal_pic = av_malloc(c->pal_stride * avctx->height);
841 if (!c->pal_pic || !c->last_pal_pic) {
842 mss2_decode_end(avctx);
843 return AVERROR(ENOMEM);
845 if (ret = wmv9_init(avctx)) {
846 mss2_decode_end(avctx);
849 ff_mss2dsp_init(&ctx->dsp);
851 avctx->pix_fmt = c->free_colours == 127 ? PIX_FMT_RGB555
857 AVCodec ff_mss2_decoder = {
859 .type = AVMEDIA_TYPE_VIDEO,
860 .id = AV_CODEC_ID_MSS2,
861 .priv_data_size = sizeof(MSS2Context),
862 .init = mss2_decode_init,
863 .close = mss2_decode_end,
864 .decode = mss2_decode_frame,
865 .capabilities = CODEC_CAP_DR1,
866 .long_name = NULL_IF_CONFIG_SMALL("MS Windows Media Video V9 Screen"),