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