2 * VMware Screen Codec (VMnc) decoder
3 * Copyright (c) 2006 Konstantin Shishkov
5 * This file is part of FFmpeg.
7 * FFmpeg 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 * FFmpeg 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 FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * VMware Screen Codec (VMnc) decoder
26 * As Alex Beregszaszi discovered, this is effectively RFB data dump
36 MAGIC_WMVd = 0x574D5664,
46 HT_RAW = 1, // tile is raw
47 HT_BKG = 2, // background color is present
48 HT_FG = 4, // foreground color is present
49 HT_SUB = 8, // subrects are present
50 HT_CLR = 16 // each subrect has own color
56 typedef struct VmncContext {
57 AVCodecContext *avctx;
70 uint8_t* curbits, *curmask;
74 /* read pixel value from stream */
75 static av_always_inline int vmnc_get_pixel(uint8_t* buf, int bpp, int be) {
76 switch(bpp * 2 + be) {
79 case 4: return AV_RL16(buf);
80 case 5: return AV_RB16(buf);
81 case 8: return AV_RL32(buf);
82 case 9: return AV_RB32(buf);
87 static void load_cursor(VmncContext *c, uint8_t *src)
90 const int bpp = c->bpp2;
91 uint8_t *dst8 = c->curbits;
92 uint16_t *dst16 = (uint16_t*)c->curbits;
93 uint32_t *dst32 = (uint32_t*)c->curbits;
95 for(j = 0; j < c->cur_h; j++) {
96 for(i = 0; i < c->cur_w; i++) {
97 p = vmnc_get_pixel(src, bpp, c->bigendian);
99 if(bpp == 1) *dst8++ = p;
100 if(bpp == 2) *dst16++ = p;
101 if(bpp == 4) *dst32++ = p;
105 dst16 = (uint16_t*)c->curmask;
106 dst32 = (uint32_t*)c->curmask;
107 for(j = 0; j < c->cur_h; j++) {
108 for(i = 0; i < c->cur_w; i++) {
109 p = vmnc_get_pixel(src, bpp, c->bigendian);
111 if(bpp == 1) *dst8++ = p;
112 if(bpp == 2) *dst16++ = p;
113 if(bpp == 4) *dst32++ = p;
118 static void put_cursor(uint8_t *dst, int stride, VmncContext *c, int dx, int dy)
123 if(c->width < c->cur_x + c->cur_w) w = c->width - c->cur_x;
125 if(c->height < c->cur_y + c->cur_h) h = c->height - c->cur_y;
137 if((w < 1) || (h < 1)) return;
138 dst += x * c->bpp2 + y * stride;
141 uint8_t* cd = c->curbits, *msk = c->curmask;
142 for(j = 0; j < h; j++) {
143 for(i = 0; i < w; i++)
144 dst[i] = (dst[i] & cd[i]) ^ msk[i];
149 } else if(c->bpp2 == 2) {
150 uint16_t* cd = (uint16_t*)c->curbits, *msk = (uint16_t*)c->curmask;
152 for(j = 0; j < h; j++) {
153 dst2 = (uint16_t*)dst;
154 for(i = 0; i < w; i++)
155 dst2[i] = (dst2[i] & cd[i]) ^ msk[i];
160 } else if(c->bpp2 == 4) {
161 uint32_t* cd = (uint32_t*)c->curbits, *msk = (uint32_t*)c->curmask;
163 for(j = 0; j < h; j++) {
164 dst2 = (uint32_t*)dst;
165 for(i = 0; i < w; i++)
166 dst2[i] = (dst2[i] & cd[i]) ^ msk[i];
174 /* fill rectangle with given colour */
175 static av_always_inline void paint_rect(uint8_t *dst, int dx, int dy, int w, int h, int color, int bpp, int stride)
178 dst += dx * bpp + dy * stride;
180 for(j = 0; j < h; j++) {
181 memset(dst, color, w);
186 for(j = 0; j < h; j++) {
187 dst2 = (uint16_t*)dst;
188 for(i = 0; i < w; i++) {
195 for(j = 0; j < h; j++) {
196 dst2 = (uint32_t*)dst;
197 for(i = 0; i < w; i++) {
205 static av_always_inline void paint_raw(uint8_t *dst, int w, int h, uint8_t* src, int bpp, int be, int stride)
208 for(j = 0; j < h; j++) {
209 for(i = 0; i < w; i++) {
210 p = vmnc_get_pixel(src, bpp, be);
217 ((uint16_t*)dst)[i] = p;
220 ((uint32_t*)dst)[i] = p;
228 static int decode_hextile(VmncContext *c, uint8_t* dst, uint8_t* src, int ssize, int w, int h, int stride)
231 int bg = 0, fg = 0, rects, color, flags, xy, wh;
232 const int bpp = c->bpp2;
234 int bw = 16, bh = 16;
237 for(j = 0; j < h; j += 16) {
240 if(j + 16 > h) bh = h - j;
241 for(i = 0; i < w; i += 16, dst2 += 16 * bpp) {
242 if(src - ssrc >= ssize) {
243 av_log(c->avctx, AV_LOG_ERROR, "Premature end of data!\n");
246 if(i + 16 > w) bw = w - i;
249 if(src - ssrc > ssize - bw * bh * bpp) {
250 av_log(c->avctx, AV_LOG_ERROR, "Premature end of data!\n");
253 paint_raw(dst2, bw, bh, src, bpp, c->bigendian, stride);
254 src += bw * bh * bpp;
257 bg = vmnc_get_pixel(src, bpp, c->bigendian); src += bpp;
260 fg = vmnc_get_pixel(src, bpp, c->bigendian); src += bpp;
265 color = !!(flags & HT_CLR);
267 paint_rect(dst2, 0, 0, bw, bh, bg, bpp, stride);
269 if(src - ssrc > ssize - rects * (color * bpp + 2)) {
270 av_log(c->avctx, AV_LOG_ERROR, "Premature end of data!\n");
273 for(k = 0; k < rects; k++) {
275 fg = vmnc_get_pixel(src, bpp, c->bigendian); src += bpp;
279 paint_rect(dst2, xy >> 4, xy & 0xF, (wh>>4)+1, (wh & 0xF)+1, fg, bpp, stride);
288 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, uint8_t *buf, int buf_size)
290 VmncContext * const c = (VmncContext *)avctx->priv_data;
293 int dx, dy, w, h, depth, enc, chunks, res, size_left;
295 c->pic.reference = 1;
296 c->pic.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
297 if(avctx->reget_buffer(avctx, &c->pic) < 0){
298 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
302 c->pic.key_frame = 0;
303 c->pic.pict_type = FF_P_TYPE;
305 //restore screen after cursor
309 if(c->width < c->cur_x + w) w = c->width - c->cur_x;
311 if(c->height < c->cur_y + h) h = c->height - c->cur_y;
322 if((w > 0) && (h > 0)) {
323 outptr = c->pic.data[0] + dx * c->bpp2 + dy * c->pic.linesize[0];
324 for(i = 0; i < h; i++) {
325 memcpy(outptr, c->screendta + i * c->cur_w * c->bpp2, w * c->bpp2);
326 outptr += c->pic.linesize[0];
331 chunks = AV_RB16(src); src += 2;
333 dx = AV_RB16(src); src += 2;
334 dy = AV_RB16(src); src += 2;
335 w = AV_RB16(src); src += 2;
336 h = AV_RB16(src); src += 2;
337 enc = AV_RB32(src); src += 4;
338 outptr = c->pic.data[0] + dx * c->bpp2 + dy * c->pic.linesize[0];
339 size_left = buf_size - (src - buf);
341 case MAGIC_WMVd: // cursor
342 if(size_left < 2 + w * h * c->bpp2 * 2) {
343 av_log(avctx, AV_LOG_ERROR, "Premature end of data! (need %i got %i)\n", 2 + w * h * c->bpp2 * 2, size_left);
351 if((c->cur_hx > c->cur_w) || (c->cur_hy > c->cur_h)) {
352 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);
353 c->cur_hx = c->cur_hy = 0;
355 c->curbits = av_realloc(c->curbits, c->cur_w * c->cur_h * c->bpp2);
356 c->curmask = av_realloc(c->curmask, c->cur_w * c->cur_h * c->bpp2);
357 c->screendta = av_realloc(c->screendta, c->cur_w * c->cur_h * c->bpp2);
359 src += w * h * c->bpp2 * 2;
361 case MAGIC_WMVe: // unknown
364 case MAGIC_WMVf: // update cursor position
365 c->cur_x = dx - c->cur_hx;
366 c->cur_y = dy - c->cur_hy;
368 case MAGIC_WMVg: // unknown
371 case MAGIC_WMVh: // unknown
374 case MAGIC_WMVi: // ServerInitialization struct
375 c->pic.key_frame = 1;
376 c->pic.pict_type = FF_I_TYPE;
378 if(depth != c->bpp) {
379 av_log(avctx, AV_LOG_INFO, "Depth mismatch. Container %i bpp, Frame data: %i bpp\n", c->bpp, depth);
382 c->bigendian = *src++;
383 if(c->bigendian & (~1)) {
384 av_log(avctx, AV_LOG_INFO, "Invalid header: bigendian flag = %i\n", c->bigendian);
387 //skip the rest of pixel format data
390 case MAGIC_WMVj: // unknown
393 case 0x00000000: // raw rectangle data
394 if((dx + w > c->width) || (dy + h > c->height)) {
395 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);
398 if(size_left < w * h * c->bpp2) {
399 av_log(avctx, AV_LOG_ERROR, "Premature end of data! (need %i got %i)\n", w * h * c->bpp2, size_left);
402 paint_raw(outptr, w, h, src, c->bpp2, c->bigendian, c->pic.linesize[0]);
403 src += w * h * c->bpp2;
405 case 0x00000005: // HexTile encoded rectangle
406 if((dx + w > c->width) || (dy + h > c->height)) {
407 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);
410 res = decode_hextile(c, outptr, src, size_left, w, h, c->pic.linesize[0]);
416 av_log(avctx, AV_LOG_ERROR, "Unsupported block type 0x%08X\n", enc);
417 chunks = 0; // leave chunks decoding loop
422 //save screen data before painting cursor
424 if(c->width < c->cur_x + w) w = c->width - c->cur_x;
426 if(c->height < c->cur_y + h) h = c->height - c->cur_y;
437 if((w > 0) && (h > 0)) {
438 outptr = c->pic.data[0] + dx * c->bpp2 + dy * c->pic.linesize[0];
439 for(i = 0; i < h; i++) {
440 memcpy(c->screendta + i * c->cur_w * c->bpp2, outptr, w * c->bpp2);
441 outptr += c->pic.linesize[0];
443 outptr = c->pic.data[0];
444 put_cursor(outptr, c->pic.linesize[0], c, c->cur_x, c->cur_y);
447 *data_size = sizeof(AVFrame);
448 *(AVFrame*)data = c->pic;
450 /* always report that the buffer was completely consumed */
461 static int decode_init(AVCodecContext *avctx)
463 VmncContext * const c = (VmncContext *)avctx->priv_data;
466 avctx->has_b_frames = 0;
468 c->pic.data[0] = NULL;
469 c->width = avctx->width;
470 c->height = avctx->height;
472 if (avcodec_check_dimensions(avctx, avctx->width, avctx->height) < 0) {
475 c->bpp = avctx->bits_per_sample;
480 avctx->pix_fmt = PIX_FMT_PAL8;
483 avctx->pix_fmt = PIX_FMT_RGB555;
486 avctx->pix_fmt = PIX_FMT_RGB32;
489 av_log(avctx, AV_LOG_ERROR, "Unsupported bitdepth %i\n", c->bpp);
499 * Uninit VMnc decoder
502 static int decode_end(AVCodecContext *avctx)
504 VmncContext * const c = (VmncContext *)avctx->priv_data;
507 avctx->release_buffer(avctx, &c->pic);
511 av_free(c->screendta);
515 AVCodec vmnc_decoder = {