yading@10: /*
yading@10:  * VMware Screen Codec (VMnc) decoder
yading@10:  * Copyright (c) 2006 Konstantin Shishkov
yading@10:  *
yading@10:  * This file is part of FFmpeg.
yading@10:  *
yading@10:  * FFmpeg is free software; you can redistribute it and/or
yading@10:  * modify it under the terms of the GNU Lesser General Public
yading@10:  * License as published by the Free Software Foundation; either
yading@10:  * version 2.1 of the License, or (at your option) any later version.
yading@10:  *
yading@10:  * FFmpeg is distributed in the hope that it will be useful,
yading@10:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@10:  * Lesser General Public License for more details.
yading@10:  *
yading@10:  * You should have received a copy of the GNU Lesser General Public
yading@10:  * License along with FFmpeg; if not, write to the Free Software
yading@10:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@10:  */
yading@10: 
yading@10: /**
yading@10:  * @file
yading@10:  * VMware Screen Codec (VMnc) decoder
yading@10:  * As Alex Beregszaszi discovered, this is effectively RFB data dump
yading@10:  */
yading@10: 
yading@10: #include <stdio.h>
yading@10: #include <stdlib.h>
yading@10: 
yading@10: #include "libavutil/common.h"
yading@10: #include "libavutil/intreadwrite.h"
yading@10: #include "avcodec.h"
yading@10: #include "internal.h"
yading@10: 
yading@10: enum EncTypes {
yading@10:     MAGIC_WMVd = 0x574D5664,
yading@10:     MAGIC_WMVe,
yading@10:     MAGIC_WMVf,
yading@10:     MAGIC_WMVg,
yading@10:     MAGIC_WMVh,
yading@10:     MAGIC_WMVi,
yading@10:     MAGIC_WMVj
yading@10: };
yading@10: 
yading@10: enum HexTile_Flags {
yading@10:     HT_RAW =  1, // tile is raw
yading@10:     HT_BKG =  2, // background color is present
yading@10:     HT_FG  =  4, // foreground color is present
yading@10:     HT_SUB =  8, // subrects are present
yading@10:     HT_CLR = 16  // each subrect has own color
yading@10: };
yading@10: 
yading@10: /*
yading@10:  * Decoder context
yading@10:  */
yading@10: typedef struct VmncContext {
yading@10:     AVCodecContext *avctx;
yading@10:     AVFrame pic;
yading@10: 
yading@10:     int bpp;
yading@10:     int bpp2;
yading@10:     int bigendian;
yading@10:     uint8_t pal[768];
yading@10:     int width, height;
yading@10: 
yading@10:     /* cursor data */
yading@10:     int cur_w, cur_h;
yading@10:     int cur_x, cur_y;
yading@10:     int cur_hx, cur_hy;
yading@10:     uint8_t* curbits, *curmask;
yading@10:     uint8_t* screendta;
yading@10: } VmncContext;
yading@10: 
yading@10: /* read pixel value from stream */
yading@10: static av_always_inline int vmnc_get_pixel(const uint8_t* buf, int bpp, int be) {
yading@10:     switch(bpp * 2 + be) {
yading@10:     case 2:
yading@10:     case 3: return *buf;
yading@10:     case 4: return AV_RL16(buf);
yading@10:     case 5: return AV_RB16(buf);
yading@10:     case 8: return AV_RL32(buf);
yading@10:     case 9: return AV_RB32(buf);
yading@10:     default: return 0;
yading@10:     }
yading@10: }
yading@10: 
yading@10: static void load_cursor(VmncContext *c, const uint8_t *src)
yading@10: {
yading@10:     int i, j, p;
yading@10:     const int bpp = c->bpp2;
yading@10:     uint8_t  *dst8  = c->curbits;
yading@10:     uint16_t *dst16 = (uint16_t*)c->curbits;
yading@10:     uint32_t *dst32 = (uint32_t*)c->curbits;
yading@10: 
yading@10:     for(j = 0; j < c->cur_h; j++) {
yading@10:         for(i = 0; i < c->cur_w; i++) {
yading@10:             p = vmnc_get_pixel(src, bpp, c->bigendian);
yading@10:             src += bpp;
yading@10:             if(bpp == 1) *dst8++ = p;
yading@10:             if(bpp == 2) *dst16++ = p;
yading@10:             if(bpp == 4) *dst32++ = p;
yading@10:         }
yading@10:     }
yading@10:     dst8 = c->curmask;
yading@10:     dst16 = (uint16_t*)c->curmask;
yading@10:     dst32 = (uint32_t*)c->curmask;
yading@10:     for(j = 0; j < c->cur_h; j++) {
yading@10:         for(i = 0; i < c->cur_w; i++) {
yading@10:             p = vmnc_get_pixel(src, bpp, c->bigendian);
yading@10:             src += bpp;
yading@10:             if(bpp == 1) *dst8++ = p;
yading@10:             if(bpp == 2) *dst16++ = p;
yading@10:             if(bpp == 4) *dst32++ = p;
yading@10:         }
yading@10:     }
yading@10: }
yading@10: 
yading@10: static void put_cursor(uint8_t *dst, int stride, VmncContext *c, int dx, int dy)
yading@10: {
yading@10:     int i, j;
yading@10:     int w, h, x, y;
yading@10:     w = c->cur_w;
yading@10:     if(c->width < c->cur_x + c->cur_w) w = c->width - c->cur_x;
yading@10:     h = c->cur_h;
yading@10:     if(c->height < c->cur_y + c->cur_h) h = c->height - c->cur_y;
yading@10:     x = c->cur_x;
yading@10:     y = c->cur_y;
yading@10:     if(x < 0) {
yading@10:         w += x;
yading@10:         x = 0;
yading@10:     }
yading@10:     if(y < 0) {
yading@10:         h += y;
yading@10:         y = 0;
yading@10:     }
yading@10: 
yading@10:     if((w < 1) || (h < 1)) return;
yading@10:     dst += x * c->bpp2 + y * stride;
yading@10: 
yading@10:     if(c->bpp2 == 1) {
yading@10:         uint8_t* cd = c->curbits, *msk = c->curmask;
yading@10:         for(j = 0; j < h; j++) {
yading@10:             for(i = 0; i < w; i++)
yading@10:                 dst[i] = (dst[i] & cd[i]) ^ msk[i];
yading@10:             msk += c->cur_w;
yading@10:             cd += c->cur_w;
yading@10:             dst += stride;
yading@10:         }
yading@10:     } else if(c->bpp2 == 2) {
yading@10:         uint16_t* cd = (uint16_t*)c->curbits, *msk = (uint16_t*)c->curmask;
yading@10:         uint16_t* dst2;
yading@10:         for(j = 0; j < h; j++) {
yading@10:             dst2 = (uint16_t*)dst;
yading@10:             for(i = 0; i < w; i++)
yading@10:                 dst2[i] = (dst2[i] & cd[i]) ^ msk[i];
yading@10:             msk += c->cur_w;
yading@10:             cd += c->cur_w;
yading@10:             dst += stride;
yading@10:         }
yading@10:     } else if(c->bpp2 == 4) {
yading@10:         uint32_t* cd = (uint32_t*)c->curbits, *msk = (uint32_t*)c->curmask;
yading@10:         uint32_t* dst2;
yading@10:         for(j = 0; j < h; j++) {
yading@10:             dst2 = (uint32_t*)dst;
yading@10:             for(i = 0; i < w; i++)
yading@10:                 dst2[i] = (dst2[i] & cd[i]) ^ msk[i];
yading@10:             msk += c->cur_w;
yading@10:             cd += c->cur_w;
yading@10:             dst += stride;
yading@10:         }
yading@10:     }
yading@10: }
yading@10: 
yading@10: /* fill rectangle with given color */
yading@10: static av_always_inline void paint_rect(uint8_t *dst, int dx, int dy, int w, int h, int color, int bpp, int stride)
yading@10: {
yading@10:     int i, j;
yading@10:     dst += dx * bpp + dy * stride;
yading@10:     if(bpp == 1){
yading@10:         for(j = 0; j < h; j++) {
yading@10:             memset(dst, color, w);
yading@10:             dst += stride;
yading@10:         }
yading@10:     }else if(bpp == 2){
yading@10:         uint16_t* dst2;
yading@10:         for(j = 0; j < h; j++) {
yading@10:             dst2 = (uint16_t*)dst;
yading@10:             for(i = 0; i < w; i++) {
yading@10:                 *dst2++ = color;
yading@10:             }
yading@10:             dst += stride;
yading@10:         }
yading@10:     }else if(bpp == 4){
yading@10:         uint32_t* dst2;
yading@10:         for(j = 0; j < h; j++) {
yading@10:             dst2 = (uint32_t*)dst;
yading@10:             for(i = 0; i < w; i++) {
yading@10:                 dst2[i] = color;
yading@10:             }
yading@10:             dst += stride;
yading@10:         }
yading@10:     }
yading@10: }
yading@10: 
yading@10: static av_always_inline void paint_raw(uint8_t *dst, int w, int h, const uint8_t* src, int bpp, int be, int stride)
yading@10: {
yading@10:     int i, j, p;
yading@10:     for(j = 0; j < h; j++) {
yading@10:         for(i = 0; i < w; i++) {
yading@10:             p = vmnc_get_pixel(src, bpp, be);
yading@10:             src += bpp;
yading@10:             switch(bpp){
yading@10:             case 1:
yading@10:                 dst[i] = p;
yading@10:                 break;
yading@10:             case 2:
yading@10:                 ((uint16_t*)dst)[i] = p;
yading@10:                 break;
yading@10:             case 4:
yading@10:                 ((uint32_t*)dst)[i] = p;
yading@10:                 break;
yading@10:             }
yading@10:         }
yading@10:         dst += stride;
yading@10:     }
yading@10: }
yading@10: 
yading@10: static int decode_hextile(VmncContext *c, uint8_t* dst, const uint8_t* src, int ssize, int w, int h, int stride)
yading@10: {
yading@10:     int i, j, k;
yading@10:     int bg = 0, fg = 0, rects, color, flags, xy, wh;
yading@10:     const int bpp = c->bpp2;
yading@10:     uint8_t *dst2;
yading@10:     int bw = 16, bh = 16;
yading@10:     const uint8_t *ssrc=src;
yading@10: 
yading@10:     for(j = 0; j < h; j += 16) {
yading@10:         dst2 = dst;
yading@10:         bw = 16;
yading@10:         if(j + 16 > h) bh = h - j;
yading@10:         for(i = 0; i < w; i += 16, dst2 += 16 * bpp) {
yading@10:             if(src - ssrc >= ssize) {
yading@10:                 av_log(c->avctx, AV_LOG_ERROR, "Premature end of data!\n");
yading@10:                 return -1;
yading@10:             }
yading@10:             if(i + 16 > w) bw = w - i;
yading@10:             flags = *src++;
yading@10:             if(flags & HT_RAW) {
yading@10:                 if(src - ssrc > ssize - bw * bh * bpp) {
yading@10:                     av_log(c->avctx, AV_LOG_ERROR, "Premature end of data!\n");
yading@10:                     return -1;
yading@10:                 }
yading@10:                 paint_raw(dst2, bw, bh, src, bpp, c->bigendian, stride);
yading@10:                 src += bw * bh * bpp;
yading@10:             } else {
yading@10:                 if(flags & HT_BKG) {
yading@10:                     bg = vmnc_get_pixel(src, bpp, c->bigendian); src += bpp;
yading@10:                 }
yading@10:                 if(flags & HT_FG) {
yading@10:                     fg = vmnc_get_pixel(src, bpp, c->bigendian); src += bpp;
yading@10:                 }
yading@10:                 rects = 0;
yading@10:                 if(flags & HT_SUB)
yading@10:                     rects = *src++;
yading@10:                 color = !!(flags & HT_CLR);
yading@10: 
yading@10:                 paint_rect(dst2, 0, 0, bw, bh, bg, bpp, stride);
yading@10: 
yading@10:                 if(src - ssrc > ssize - rects * (color * bpp + 2)) {
yading@10:                     av_log(c->avctx, AV_LOG_ERROR, "Premature end of data!\n");
yading@10:                     return -1;
yading@10:                 }
yading@10:                 for(k = 0; k < rects; k++) {
yading@10:                     if(color) {
yading@10:                         fg = vmnc_get_pixel(src, bpp, c->bigendian); src += bpp;
yading@10:                     }
yading@10:                     xy = *src++;
yading@10:                     wh = *src++;
yading@10:                     paint_rect(dst2, xy >> 4, xy & 0xF, (wh>>4)+1, (wh & 0xF)+1, fg, bpp, stride);
yading@10:                 }
yading@10:             }
yading@10:         }
yading@10:         dst += stride * 16;
yading@10:     }
yading@10:     return src - ssrc;
yading@10: }
yading@10: 
yading@10: static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
yading@10:                         AVPacket *avpkt)
yading@10: {
yading@10:     const uint8_t *buf = avpkt->data;
yading@10:     int buf_size = avpkt->size;
yading@10:     VmncContext * const c = avctx->priv_data;
yading@10:     uint8_t *outptr;
yading@10:     const uint8_t *src = buf;
yading@10:     int dx, dy, w, h, depth, enc, chunks, res, size_left, ret;
yading@10: 
yading@10:     if ((ret = ff_reget_buffer(avctx, &c->pic)) < 0)
yading@10:         return ret;
yading@10: 
yading@10:     c->pic.key_frame = 0;
yading@10:     c->pic.pict_type = AV_PICTURE_TYPE_P;
yading@10: 
yading@10:     //restore screen after cursor
yading@10:     if(c->screendta) {
yading@10:         int i;
yading@10:         w = c->cur_w;
yading@10:         if(c->width < c->cur_x + w) w = c->width - c->cur_x;
yading@10:         h = c->cur_h;
yading@10:         if(c->height < c->cur_y + h) h = c->height - c->cur_y;
yading@10:         dx = c->cur_x;
yading@10:         if(dx < 0) {
yading@10:             w += dx;
yading@10:             dx = 0;
yading@10:         }
yading@10:         dy = c->cur_y;
yading@10:         if(dy < 0) {
yading@10:             h += dy;
yading@10:             dy = 0;
yading@10:         }
yading@10:         if((w > 0) && (h > 0)) {
yading@10:             outptr = c->pic.data[0] + dx * c->bpp2 + dy * c->pic.linesize[0];
yading@10:             for(i = 0; i < h; i++) {
yading@10:                 memcpy(outptr, c->screendta + i * c->cur_w * c->bpp2, w * c->bpp2);
yading@10:                 outptr += c->pic.linesize[0];
yading@10:             }
yading@10:         }
yading@10:     }
yading@10:     src += 2;
yading@10:     chunks = AV_RB16(src); src += 2;
yading@10:     while(chunks--) {
yading@10:         if(buf_size - (src - buf) < 12) {
yading@10:             av_log(avctx, AV_LOG_ERROR, "Premature end of data!\n");
yading@10:             return -1;
yading@10:         }
yading@10:         dx = AV_RB16(src); src += 2;
yading@10:         dy = AV_RB16(src); src += 2;
yading@10:         w  = AV_RB16(src); src += 2;
yading@10:         h  = AV_RB16(src); src += 2;
yading@10:         enc = AV_RB32(src); src += 4;
yading@10:         outptr = c->pic.data[0] + dx * c->bpp2 + dy * c->pic.linesize[0];
yading@10:         size_left = buf_size - (src - buf);
yading@10:         switch(enc) {
yading@10:         case MAGIC_WMVd: // cursor
yading@10:             if (w*(int64_t)h*c->bpp2 > INT_MAX/2 - 2) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "dimensions too large\n");
yading@10:                 return AVERROR_INVALIDDATA;
yading@10:             }
yading@10:             if(size_left < 2 + w * h * c->bpp2 * 2) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "Premature end of data! (need %i got %i)\n", 2 + w * h * c->bpp2 * 2, size_left);
yading@10:                 return -1;
yading@10:             }
yading@10:             src += 2;
yading@10:             c->cur_w = w;
yading@10:             c->cur_h = h;
yading@10:             c->cur_hx = dx;
yading@10:             c->cur_hy = dy;
yading@10:             if((c->cur_hx > c->cur_w) || (c->cur_hy > c->cur_h)) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "Cursor hot spot is not in image: %ix%i of %ix%i cursor size\n", c->cur_hx, c->cur_hy, c->cur_w, c->cur_h);
yading@10:                 c->cur_hx = c->cur_hy = 0;
yading@10:             }
yading@10:             c->curbits = av_realloc(c->curbits, c->cur_w * c->cur_h * c->bpp2);
yading@10:             c->curmask = av_realloc(c->curmask, c->cur_w * c->cur_h * c->bpp2);
yading@10:             c->screendta = av_realloc(c->screendta, c->cur_w * c->cur_h * c->bpp2);
yading@10:             load_cursor(c, src);
yading@10:             src += w * h * c->bpp2 * 2;
yading@10:             break;
yading@10:         case MAGIC_WMVe: // unknown
yading@10:             src += 2;
yading@10:             break;
yading@10:         case MAGIC_WMVf: // update cursor position
yading@10:             c->cur_x = dx - c->cur_hx;
yading@10:             c->cur_y = dy - c->cur_hy;
yading@10:             break;
yading@10:         case MAGIC_WMVg: // unknown
yading@10:             src += 10;
yading@10:             break;
yading@10:         case MAGIC_WMVh: // unknown
yading@10:             src += 4;
yading@10:             break;
yading@10:         case MAGIC_WMVi: // ServerInitialization struct
yading@10:             c->pic.key_frame = 1;
yading@10:             c->pic.pict_type = AV_PICTURE_TYPE_I;
yading@10:             depth = *src++;
yading@10:             if(depth != c->bpp) {
yading@10:                 av_log(avctx, AV_LOG_INFO, "Depth mismatch. Container %i bpp, Frame data: %i bpp\n", c->bpp, depth);
yading@10:             }
yading@10:             src++;
yading@10:             c->bigendian = *src++;
yading@10:             if(c->bigendian & (~1)) {
yading@10:                 av_log(avctx, AV_LOG_INFO, "Invalid header: bigendian flag = %i\n", c->bigendian);
yading@10:                 return -1;
yading@10:             }
yading@10:             //skip the rest of pixel format data
yading@10:             src += 13;
yading@10:             break;
yading@10:         case MAGIC_WMVj: // unknown
yading@10:             src += 2;
yading@10:             break;
yading@10:         case 0x00000000: // raw rectangle data
yading@10:             if((dx + w > c->width) || (dy + h > c->height)) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "Incorrect frame size: %ix%i+%ix%i of %ix%i\n", w, h, dx, dy, c->width, c->height);
yading@10:                 return -1;
yading@10:             }
yading@10:             if(size_left < w * h * c->bpp2) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "Premature end of data! (need %i got %i)\n", w * h * c->bpp2, size_left);
yading@10:                 return -1;
yading@10:             }
yading@10:             paint_raw(outptr, w, h, src, c->bpp2, c->bigendian, c->pic.linesize[0]);
yading@10:             src += w * h * c->bpp2;
yading@10:             break;
yading@10:         case 0x00000005: // HexTile encoded rectangle
yading@10:             if((dx + w > c->width) || (dy + h > c->height)) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "Incorrect frame size: %ix%i+%ix%i of %ix%i\n", w, h, dx, dy, c->width, c->height);
yading@10:                 return -1;
yading@10:             }
yading@10:             res = decode_hextile(c, outptr, src, size_left, w, h, c->pic.linesize[0]);
yading@10:             if(res < 0)
yading@10:                 return -1;
yading@10:             src += res;
yading@10:             break;
yading@10:         default:
yading@10:             av_log(avctx, AV_LOG_ERROR, "Unsupported block type 0x%08X\n", enc);
yading@10:             chunks = 0; // leave chunks decoding loop
yading@10:         }
yading@10:     }
yading@10:     if(c->screendta){
yading@10:         int i;
yading@10:         //save screen data before painting cursor
yading@10:         w = c->cur_w;
yading@10:         if(c->width < c->cur_x + w) w = c->width - c->cur_x;
yading@10:         h = c->cur_h;
yading@10:         if(c->height < c->cur_y + h) h = c->height - c->cur_y;
yading@10:         dx = c->cur_x;
yading@10:         if(dx < 0) {
yading@10:             w += dx;
yading@10:             dx = 0;
yading@10:         }
yading@10:         dy = c->cur_y;
yading@10:         if(dy < 0) {
yading@10:             h += dy;
yading@10:             dy = 0;
yading@10:         }
yading@10:         if((w > 0) && (h > 0)) {
yading@10:             outptr = c->pic.data[0] + dx * c->bpp2 + dy * c->pic.linesize[0];
yading@10:             for(i = 0; i < h; i++) {
yading@10:                 memcpy(c->screendta + i * c->cur_w * c->bpp2, outptr, w * c->bpp2);
yading@10:                 outptr += c->pic.linesize[0];
yading@10:             }
yading@10:             outptr = c->pic.data[0];
yading@10:             put_cursor(outptr, c->pic.linesize[0], c, c->cur_x, c->cur_y);
yading@10:         }
yading@10:     }
yading@10:     *got_frame      = 1;
yading@10:     if ((ret = av_frame_ref(data, &c->pic)) < 0)
yading@10:         return ret;
yading@10: 
yading@10:     /* always report that the buffer was completely consumed */
yading@10:     return buf_size;
yading@10: }
yading@10: 
yading@10: 
yading@10: 
yading@10: /*
yading@10:  *
yading@10:  * Init VMnc decoder
yading@10:  *
yading@10:  */
yading@10: static av_cold int decode_init(AVCodecContext *avctx)
yading@10: {
yading@10:     VmncContext * const c = avctx->priv_data;
yading@10: 
yading@10:     c->avctx = avctx;
yading@10: 
yading@10:     c->width = avctx->width;
yading@10:     c->height = avctx->height;
yading@10: 
yading@10:     c->bpp = avctx->bits_per_coded_sample;
yading@10:     c->bpp2 = c->bpp/8;
yading@10:     avcodec_get_frame_defaults(&c->pic);
yading@10: 
yading@10:     switch(c->bpp){
yading@10:     case 8:
yading@10:         avctx->pix_fmt = AV_PIX_FMT_PAL8;
yading@10:         break;
yading@10:     case 16:
yading@10:         avctx->pix_fmt = AV_PIX_FMT_RGB555;
yading@10:         break;
yading@10:     case 32:
yading@10:         avctx->pix_fmt = AV_PIX_FMT_RGB32;
yading@10:         break;
yading@10:     default:
yading@10:         av_log(avctx, AV_LOG_ERROR, "Unsupported bitdepth %i\n", c->bpp);
yading@10:         return AVERROR_INVALIDDATA;
yading@10:     }
yading@10: 
yading@10:     avcodec_get_frame_defaults(&c->pic);
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: 
yading@10: 
yading@10: /*
yading@10:  *
yading@10:  * Uninit VMnc decoder
yading@10:  *
yading@10:  */
yading@10: static av_cold int decode_end(AVCodecContext *avctx)
yading@10: {
yading@10:     VmncContext * const c = avctx->priv_data;
yading@10: 
yading@10:     av_frame_unref(&c->pic);
yading@10: 
yading@10:     av_free(c->curbits);
yading@10:     av_free(c->curmask);
yading@10:     av_free(c->screendta);
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: AVCodec ff_vmnc_decoder = {
yading@10:     .name           = "vmnc",
yading@10:     .type           = AVMEDIA_TYPE_VIDEO,
yading@10:     .id             = AV_CODEC_ID_VMNC,
yading@10:     .priv_data_size = sizeof(VmncContext),
yading@10:     .init           = decode_init,
yading@10:     .close          = decode_end,
yading@10:     .decode         = decode_frame,
yading@10:     .capabilities   = CODEC_CAP_DR1,
yading@10:     .long_name      = NULL_IF_CONFIG_SMALL("VMware Screen Codec / VMware Video"),
yading@10: };