vmnc: make code independent of sizeof(AVFrame)
[ffmpeg.git] / libavcodec / vmnc.c
1 /*
2  * VMware Screen Codec (VMnc) decoder
3  * Copyright (c) 2006 Konstantin Shishkov
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * VMware Screen Codec (VMnc) decoder
25  * As Alex Beregszaszi discovered, this is effectively RFB data dump
26  */
27
28 #include <stdio.h>
29 #include <stdlib.h>
30
31 #include "libavutil/common.h"
32 #include "libavutil/intreadwrite.h"
33 #include "avcodec.h"
34 #include "internal.h"
35
36 enum EncTypes {
37     MAGIC_WMVd = 0x574D5664,
38     MAGIC_WMVe,
39     MAGIC_WMVf,
40     MAGIC_WMVg,
41     MAGIC_WMVh,
42     MAGIC_WMVi,
43     MAGIC_WMVj
44 };
45
46 enum HexTile_Flags {
47     HT_RAW =  1, // tile is raw
48     HT_BKG =  2, // background color is present
49     HT_FG  =  4, // foreground color is present
50     HT_SUB =  8, // subrects are present
51     HT_CLR = 16  // each subrect has own color
52 };
53
54 /*
55  * Decoder context
56  */
57 typedef struct VmncContext {
58     AVCodecContext *avctx;
59     AVFrame *frame;
60
61     int bpp;
62     int bpp2;
63     int bigendian;
64     uint8_t pal[768];
65     int width, height;
66
67     /* cursor data */
68     int cur_w, cur_h;
69     int cur_x, cur_y;
70     int cur_hx, cur_hy;
71     uint8_t* curbits, *curmask;
72     uint8_t* screendta;
73 } VmncContext;
74
75 /* read pixel value from stream */
76 static av_always_inline int vmnc_get_pixel(const uint8_t* buf, int bpp, int be) {
77     switch(bpp * 2 + be) {
78     case 2:
79     case 3: return *buf;
80     case 4: return AV_RL16(buf);
81     case 5: return AV_RB16(buf);
82     case 8: return AV_RL32(buf);
83     case 9: return AV_RB32(buf);
84     default: return 0;
85     }
86 }
87
88 static void load_cursor(VmncContext *c, const uint8_t *src)
89 {
90     int i, j, p;
91     const int bpp = c->bpp2;
92     uint8_t  *dst8  = c->curbits;
93     uint16_t *dst16 = (uint16_t*)c->curbits;
94     uint32_t *dst32 = (uint32_t*)c->curbits;
95
96     for(j = 0; j < c->cur_h; j++) {
97         for(i = 0; i < c->cur_w; i++) {
98             p = vmnc_get_pixel(src, bpp, c->bigendian);
99             src += bpp;
100             if(bpp == 1) *dst8++ = p;
101             if(bpp == 2) *dst16++ = p;
102             if(bpp == 4) *dst32++ = p;
103         }
104     }
105     dst8 = c->curmask;
106     dst16 = (uint16_t*)c->curmask;
107     dst32 = (uint32_t*)c->curmask;
108     for(j = 0; j < c->cur_h; j++) {
109         for(i = 0; i < c->cur_w; i++) {
110             p = vmnc_get_pixel(src, bpp, c->bigendian);
111             src += bpp;
112             if(bpp == 1) *dst8++ = p;
113             if(bpp == 2) *dst16++ = p;
114             if(bpp == 4) *dst32++ = p;
115         }
116     }
117 }
118
119 static void put_cursor(uint8_t *dst, int stride, VmncContext *c, int dx, int dy)
120 {
121     int i, j;
122     int w, h, x, y;
123     w = c->cur_w;
124     if(c->width < c->cur_x + c->cur_w) w = c->width - c->cur_x;
125     h = c->cur_h;
126     if(c->height < c->cur_y + c->cur_h) h = c->height - c->cur_y;
127     x = c->cur_x;
128     y = c->cur_y;
129     if(x < 0) {
130         w += x;
131         x = 0;
132     }
133     if(y < 0) {
134         h += y;
135         y = 0;
136     }
137
138     if((w < 1) || (h < 1)) return;
139     dst += x * c->bpp2 + y * stride;
140
141     if(c->bpp2 == 1) {
142         uint8_t* cd = c->curbits, *msk = c->curmask;
143         for(j = 0; j < h; j++) {
144             for(i = 0; i < w; i++)
145                 dst[i] = (dst[i] & cd[i]) ^ msk[i];
146             msk += c->cur_w;
147             cd += c->cur_w;
148             dst += stride;
149         }
150     } else if(c->bpp2 == 2) {
151         uint16_t* cd = (uint16_t*)c->curbits, *msk = (uint16_t*)c->curmask;
152         uint16_t* dst2;
153         for(j = 0; j < h; j++) {
154             dst2 = (uint16_t*)dst;
155             for(i = 0; i < w; i++)
156                 dst2[i] = (dst2[i] & cd[i]) ^ msk[i];
157             msk += c->cur_w;
158             cd += c->cur_w;
159             dst += stride;
160         }
161     } else if(c->bpp2 == 4) {
162         uint32_t* cd = (uint32_t*)c->curbits, *msk = (uint32_t*)c->curmask;
163         uint32_t* dst2;
164         for(j = 0; j < h; j++) {
165             dst2 = (uint32_t*)dst;
166             for(i = 0; i < w; i++)
167                 dst2[i] = (dst2[i] & cd[i]) ^ msk[i];
168             msk += c->cur_w;
169             cd += c->cur_w;
170             dst += stride;
171         }
172     }
173 }
174
175 /* fill rectangle with given color */
176 static av_always_inline void paint_rect(uint8_t *dst, int dx, int dy, int w, int h, int color, int bpp, int stride)
177 {
178     int i, j;
179     dst += dx * bpp + dy * stride;
180     if(bpp == 1){
181         for(j = 0; j < h; j++) {
182             memset(dst, color, w);
183             dst += stride;
184         }
185     }else if(bpp == 2){
186         uint16_t* dst2;
187         for(j = 0; j < h; j++) {
188             dst2 = (uint16_t*)dst;
189             for(i = 0; i < w; i++) {
190                 *dst2++ = color;
191             }
192             dst += stride;
193         }
194     }else if(bpp == 4){
195         uint32_t* dst2;
196         for(j = 0; j < h; j++) {
197             dst2 = (uint32_t*)dst;
198             for(i = 0; i < w; i++) {
199                 dst2[i] = color;
200             }
201             dst += stride;
202         }
203     }
204 }
205
206 static av_always_inline void paint_raw(uint8_t *dst, int w, int h, const uint8_t* src, int bpp, int be, int stride)
207 {
208     int i, j, p;
209     for(j = 0; j < h; j++) {
210         for(i = 0; i < w; i++) {
211             p = vmnc_get_pixel(src, bpp, be);
212             src += bpp;
213             switch(bpp){
214             case 1:
215                 dst[i] = p;
216                 break;
217             case 2:
218                 ((uint16_t*)dst)[i] = p;
219                 break;
220             case 4:
221                 ((uint32_t*)dst)[i] = p;
222                 break;
223             }
224         }
225         dst += stride;
226     }
227 }
228
229 static int decode_hextile(VmncContext *c, uint8_t* dst, const uint8_t* src, int ssize, int w, int h, int stride)
230 {
231     int i, j, k;
232     int bg = 0, fg = 0, rects, color, flags, xy, wh;
233     const int bpp = c->bpp2;
234     uint8_t *dst2;
235     int bw = 16, bh = 16;
236     const uint8_t *ssrc=src;
237
238     for(j = 0; j < h; j += 16) {
239         dst2 = dst;
240         bw = 16;
241         if(j + 16 > h) bh = h - j;
242         for(i = 0; i < w; i += 16, dst2 += 16 * bpp) {
243             if(src - ssrc >= ssize) {
244                 av_log(c->avctx, AV_LOG_ERROR, "Premature end of data!\n");
245                 return -1;
246             }
247             if(i + 16 > w) bw = w - i;
248             flags = *src++;
249             if(flags & HT_RAW) {
250                 if(src - ssrc > ssize - bw * bh * bpp) {
251                     av_log(c->avctx, AV_LOG_ERROR, "Premature end of data!\n");
252                     return -1;
253                 }
254                 paint_raw(dst2, bw, bh, src, bpp, c->bigendian, stride);
255                 src += bw * bh * bpp;
256             } else {
257                 if(flags & HT_BKG) {
258                     bg = vmnc_get_pixel(src, bpp, c->bigendian); src += bpp;
259                 }
260                 if(flags & HT_FG) {
261                     fg = vmnc_get_pixel(src, bpp, c->bigendian); src += bpp;
262                 }
263                 rects = 0;
264                 if(flags & HT_SUB)
265                     rects = *src++;
266                 color = !!(flags & HT_CLR);
267
268                 paint_rect(dst2, 0, 0, bw, bh, bg, bpp, stride);
269
270                 if(src - ssrc > ssize - rects * (color * bpp + 2)) {
271                     av_log(c->avctx, AV_LOG_ERROR, "Premature end of data!\n");
272                     return -1;
273                 }
274                 for(k = 0; k < rects; k++) {
275                     if(color) {
276                         fg = vmnc_get_pixel(src, bpp, c->bigendian); src += bpp;
277                     }
278                     xy = *src++;
279                     wh = *src++;
280                     paint_rect(dst2, xy >> 4, xy & 0xF, (wh>>4)+1, (wh & 0xF)+1, fg, bpp, stride);
281                 }
282             }
283         }
284         dst += stride * 16;
285     }
286     return src - ssrc;
287 }
288
289 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
290                         AVPacket *avpkt)
291 {
292     const uint8_t *buf = avpkt->data;
293     int buf_size = avpkt->size;
294     VmncContext * const c = avctx->priv_data;
295     uint8_t *outptr;
296     const uint8_t *src = buf;
297     int dx, dy, w, h, depth, enc, chunks, res, size_left, ret;
298     AVFrame *frame = c->frame;
299
300     if ((ret = ff_reget_buffer(avctx, frame)) < 0)
301         return ret;
302
303     frame->key_frame = 0;
304     frame->pict_type = AV_PICTURE_TYPE_P;
305
306     //restore screen after cursor
307     if(c->screendta) {
308         int i;
309         w = c->cur_w;
310         if(c->width < c->cur_x + w) w = c->width - c->cur_x;
311         h = c->cur_h;
312         if(c->height < c->cur_y + h) h = c->height - c->cur_y;
313         dx = c->cur_x;
314         if(dx < 0) {
315             w += dx;
316             dx = 0;
317         }
318         dy = c->cur_y;
319         if(dy < 0) {
320             h += dy;
321             dy = 0;
322         }
323         if((w > 0) && (h > 0)) {
324             outptr = frame->data[0] + dx * c->bpp2 + dy * frame->linesize[0];
325             for(i = 0; i < h; i++) {
326                 memcpy(outptr, c->screendta + i * c->cur_w * c->bpp2, w * c->bpp2);
327                 outptr += frame->linesize[0];
328             }
329         }
330     }
331     src += 2;
332     chunks = AV_RB16(src); src += 2;
333     while(chunks--) {
334         if(buf_size - (src - buf) < 12) {
335             av_log(avctx, AV_LOG_ERROR, "Premature end of data!\n");
336             return -1;
337         }
338         dx = AV_RB16(src); src += 2;
339         dy = AV_RB16(src); src += 2;
340         w  = AV_RB16(src); src += 2;
341         h  = AV_RB16(src); src += 2;
342         enc = AV_RB32(src); src += 4;
343         outptr = frame->data[0] + dx * c->bpp2 + dy * frame->linesize[0];
344         size_left = buf_size - (src - buf);
345         switch(enc) {
346         case MAGIC_WMVd: // cursor
347             if (w*(int64_t)h*c->bpp2 > INT_MAX/2 - 2) {
348                 av_log(avctx, AV_LOG_ERROR, "dimensions too large\n");
349                 return AVERROR_INVALIDDATA;
350             }
351             if(size_left < 2 + w * h * c->bpp2 * 2) {
352                 av_log(avctx, AV_LOG_ERROR, "Premature end of data! (need %i got %i)\n", 2 + w * h * c->bpp2 * 2, size_left);
353                 return -1;
354             }
355             src += 2;
356             c->cur_w = w;
357             c->cur_h = h;
358             c->cur_hx = dx;
359             c->cur_hy = dy;
360             if((c->cur_hx > c->cur_w) || (c->cur_hy > c->cur_h)) {
361                 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);
362                 c->cur_hx = c->cur_hy = 0;
363             }
364             c->curbits = av_realloc(c->curbits, c->cur_w * c->cur_h * c->bpp2);
365             c->curmask = av_realloc(c->curmask, c->cur_w * c->cur_h * c->bpp2);
366             c->screendta = av_realloc(c->screendta, c->cur_w * c->cur_h * c->bpp2);
367             load_cursor(c, src);
368             src += w * h * c->bpp2 * 2;
369             break;
370         case MAGIC_WMVe: // unknown
371             src += 2;
372             break;
373         case MAGIC_WMVf: // update cursor position
374             c->cur_x = dx - c->cur_hx;
375             c->cur_y = dy - c->cur_hy;
376             break;
377         case MAGIC_WMVg: // unknown
378             src += 10;
379             break;
380         case MAGIC_WMVh: // unknown
381             src += 4;
382             break;
383         case MAGIC_WMVi: // ServerInitialization struct
384             frame->key_frame = 1;
385             frame->pict_type = AV_PICTURE_TYPE_I;
386             depth = *src++;
387             if(depth != c->bpp) {
388                 av_log(avctx, AV_LOG_INFO, "Depth mismatch. Container %i bpp, Frame data: %i bpp\n", c->bpp, depth);
389             }
390             src++;
391             c->bigendian = *src++;
392             if(c->bigendian & (~1)) {
393                 av_log(avctx, AV_LOG_INFO, "Invalid header: bigendian flag = %i\n", c->bigendian);
394                 return -1;
395             }
396             //skip the rest of pixel format data
397             src += 13;
398             break;
399         case MAGIC_WMVj: // unknown
400             src += 2;
401             break;
402         case 0x00000000: // raw rectangle data
403             if((dx + w > c->width) || (dy + h > c->height)) {
404                 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);
405                 return -1;
406             }
407             if(size_left < w * h * c->bpp2) {
408                 av_log(avctx, AV_LOG_ERROR, "Premature end of data! (need %i got %i)\n", w * h * c->bpp2, size_left);
409                 return -1;
410             }
411             paint_raw(outptr, w, h, src, c->bpp2, c->bigendian, frame->linesize[0]);
412             src += w * h * c->bpp2;
413             break;
414         case 0x00000005: // HexTile encoded rectangle
415             if((dx + w > c->width) || (dy + h > c->height)) {
416                 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);
417                 return -1;
418             }
419             res = decode_hextile(c, outptr, src, size_left, w, h, frame->linesize[0]);
420             if(res < 0)
421                 return -1;
422             src += res;
423             break;
424         default:
425             av_log(avctx, AV_LOG_ERROR, "Unsupported block type 0x%08X\n", enc);
426             chunks = 0; // leave chunks decoding loop
427         }
428     }
429     if(c->screendta){
430         int i;
431         //save screen data before painting cursor
432         w = c->cur_w;
433         if(c->width < c->cur_x + w) w = c->width - c->cur_x;
434         h = c->cur_h;
435         if(c->height < c->cur_y + h) h = c->height - c->cur_y;
436         dx = c->cur_x;
437         if(dx < 0) {
438             w += dx;
439             dx = 0;
440         }
441         dy = c->cur_y;
442         if(dy < 0) {
443             h += dy;
444             dy = 0;
445         }
446         if((w > 0) && (h > 0)) {
447             outptr = frame->data[0] + dx * c->bpp2 + dy * frame->linesize[0];
448             for(i = 0; i < h; i++) {
449                 memcpy(c->screendta + i * c->cur_w * c->bpp2, outptr, w * c->bpp2);
450                 outptr += frame->linesize[0];
451             }
452             outptr = frame->data[0];
453             put_cursor(outptr, frame->linesize[0], c, c->cur_x, c->cur_y);
454         }
455     }
456     *got_frame      = 1;
457     if ((ret = av_frame_ref(data, frame)) < 0)
458         return ret;
459
460     /* always report that the buffer was completely consumed */
461     return buf_size;
462 }
463
464
465
466 /*
467  *
468  * Init VMnc decoder
469  *
470  */
471 static av_cold int decode_init(AVCodecContext *avctx)
472 {
473     VmncContext * const c = avctx->priv_data;
474
475     c->avctx = avctx;
476
477     c->width = avctx->width;
478     c->height = avctx->height;
479
480     c->bpp = avctx->bits_per_coded_sample;
481     c->bpp2 = c->bpp/8;
482
483     switch(c->bpp){
484     case 8:
485         avctx->pix_fmt = AV_PIX_FMT_PAL8;
486         break;
487     case 16:
488         avctx->pix_fmt = AV_PIX_FMT_RGB555;
489         break;
490     case 32:
491         avctx->pix_fmt = AV_PIX_FMT_RGB32;
492         break;
493     default:
494         av_log(avctx, AV_LOG_ERROR, "Unsupported bitdepth %i\n", c->bpp);
495         return AVERROR_INVALIDDATA;
496     }
497
498     c->frame = av_frame_alloc();
499     if (!c->frame)
500         return AVERROR(ENOMEM);
501
502     return 0;
503 }
504
505
506
507 /*
508  *
509  * Uninit VMnc decoder
510  *
511  */
512 static av_cold int decode_end(AVCodecContext *avctx)
513 {
514     VmncContext * const c = avctx->priv_data;
515
516     av_frame_free(&c->frame);
517
518     av_free(c->curbits);
519     av_free(c->curmask);
520     av_free(c->screendta);
521     return 0;
522 }
523
524 AVCodec ff_vmnc_decoder = {
525     .name           = "vmnc",
526     .type           = AVMEDIA_TYPE_VIDEO,
527     .id             = AV_CODEC_ID_VMNC,
528     .priv_data_size = sizeof(VmncContext),
529     .init           = decode_init,
530     .close          = decode_end,
531     .decode         = decode_frame,
532     .capabilities   = CODEC_CAP_DR1,
533     .long_name      = NULL_IF_CONFIG_SMALL("VMware Screen Codec / VMware Video"),
534 };