avcodec/qdrw: add support for 0x0001 code
[ffmpeg.git] / libavcodec / qdrw.c
1 /*
2  * QuickDraw (qdrw) codec
3  * Copyright (c) 2004 Konstantin Shishkov
4  * Copyright (c) 2015 Vittorio Giovara
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * Apple QuickDraw codec.
26  * https://developer.apple.com/legacy/library/documentation/mac/QuickDraw/QuickDraw-461.html
27  */
28
29 #include "libavutil/common.h"
30 #include "libavutil/intreadwrite.h"
31 #include "avcodec.h"
32 #include "bytestream.h"
33 #include "internal.h"
34
35 enum QuickdrawOpcodes {
36     CLIP = 0x0001,
37     PACKBITSRECT = 0x0098,
38     PACKBITSRGN,
39     DIRECTBITSRECT,
40     DIRECTBITSRGN,
41     SHORTCOMMENT = 0x00A0,
42     LONGCOMMENT,
43
44     EOP = 0x00FF,
45 };
46
47 static int parse_palette(AVCodecContext *avctx, GetByteContext *gbc,
48                          uint32_t *pal, int colors)
49 {
50     int i;
51
52     for (i = 0; i <= colors; i++) {
53         uint8_t r, g, b;
54         unsigned int idx = bytestream2_get_be16(gbc); /* color index */
55         if (idx > 255) {
56             av_log(avctx, AV_LOG_WARNING,
57                    "Palette index out of range: %u\n", idx);
58             bytestream2_skip(gbc, 6);
59             continue;
60         }
61         r = bytestream2_get_byte(gbc);
62         bytestream2_skip(gbc, 1);
63         g = bytestream2_get_byte(gbc);
64         bytestream2_skip(gbc, 1);
65         b = bytestream2_get_byte(gbc);
66         bytestream2_skip(gbc, 1);
67         pal[idx] = (0xFFU << 24) | (r << 16) | (g << 8) | b;
68     }
69     return 0;
70 }
71
72 static int decode_rle_bpp2(AVCodecContext *avctx, AVFrame *p, GetByteContext *gbc)
73 {
74     int offset = avctx->width;
75     uint8_t *outdata = p->data[0];
76     int i, j;
77
78     for (i = 0; i < avctx->height; i++) {
79         int size, left, code, pix;
80         uint8_t *out = outdata;
81         int pos = 0;
82
83         /* size of packed line */
84         size = left = bytestream2_get_be16(gbc);
85         if (bytestream2_get_bytes_left(gbc) < size)
86             return AVERROR_INVALIDDATA;
87
88         /* decode line */
89         while (left > 0) {
90             code = bytestream2_get_byte(gbc);
91             if (code & 0x80 ) { /* run */
92                 pix = bytestream2_get_byte(gbc);
93                 for (j = 0; j < 257 - code; j++) {
94                     out[pos++] = (pix & 0xC0) >> 6;
95                     out[pos++] = (pix & 0x30) >> 4;
96                     out[pos++] = (pix & 0x0C) >> 2;
97                     out[pos++] = (pix & 0x03);
98                     if (pos >= offset) {
99                         pos -= offset;
100                         pos++;
101                     }
102                     if (pos >= offset)
103                         return AVERROR_INVALIDDATA;
104                 }
105                 left  -= 2;
106             } else { /* copy */
107                 for (j = 0; j < code + 1; j++) {
108                     pix = bytestream2_get_byte(gbc);
109                     out[pos++] = (pix & 0xC0) >> 6;
110                     out[pos++] = (pix & 0x30) >> 4;
111                     out[pos++] = (pix & 0x0C) >> 2;
112                     out[pos++] = (pix & 0x03);
113                     if (pos >= offset) {
114                         pos -= offset;
115                         pos++;
116                     }
117                     if (pos >= offset)
118                         return AVERROR_INVALIDDATA;
119                 }
120                 left  -= 1 + (code + 1);
121             }
122         }
123         outdata += p->linesize[0];
124     }
125     return 0;
126 }
127
128 static int decode_rle_bpp4(AVCodecContext *avctx, AVFrame *p, GetByteContext *gbc)
129 {
130     int offset = avctx->width;
131     uint8_t *outdata = p->data[0];
132     int i, j;
133
134     for (i = 0; i < avctx->height; i++) {
135         int size, left, code, pix;
136         uint8_t *out = outdata;
137         int pos = 0;
138
139         /* size of packed line */
140         size = left = bytestream2_get_be16(gbc);
141         if (bytestream2_get_bytes_left(gbc) < size)
142             return AVERROR_INVALIDDATA;
143
144         /* decode line */
145         while (left > 0) {
146             code = bytestream2_get_byte(gbc);
147             if (code & 0x80 ) { /* run */
148                 pix = bytestream2_get_byte(gbc);
149                 for (j = 0; j < 257 - code; j++) {
150                     out[pos++] = (pix & 0xF0) >> 4;
151                     out[pos++] = pix & 0xF;
152                     if (pos >= offset) {
153                         pos -= offset;
154                         pos++;
155                     }
156                     if (pos >= offset)
157                         return AVERROR_INVALIDDATA;
158                 }
159                 left  -= 2;
160             } else { /* copy */
161                 for (j = 0; j < code + 1; j++) {
162                     pix = bytestream2_get_byte(gbc);
163                     out[pos++] = (pix & 0xF0) >> 4;
164                     out[pos++] = pix & 0xF;
165                     if (pos >= offset) {
166                         pos -= offset;
167                         pos++;
168                     }
169                     if (pos >= offset)
170                         return AVERROR_INVALIDDATA;
171                 }
172                 left  -= 1 + (code + 1);
173             }
174         }
175         outdata += p->linesize[0];
176     }
177     return 0;
178 }
179
180 static int decode_rle16(AVCodecContext *avctx, AVFrame *p, GetByteContext *gbc)
181 {
182     int offset = avctx->width;
183     uint8_t *outdata = p->data[0];
184     int i, j;
185
186     for (i = 0; i < avctx->height; i++) {
187         int size, left, code, pix;
188         uint16_t *out = (uint16_t *)outdata;
189         int pos = 0;
190
191         /* size of packed line */
192         size = left = bytestream2_get_be16(gbc);
193         if (bytestream2_get_bytes_left(gbc) < size)
194             return AVERROR_INVALIDDATA;
195
196         /* decode line */
197         while (left > 0) {
198             code = bytestream2_get_byte(gbc);
199             if (code & 0x80 ) { /* run */
200                 pix = bytestream2_get_be16(gbc);
201                 for (j = 0; j < 257 - code; j++) {
202                     out[pos] = pix;
203                     pos++;
204                     if (pos >= offset) {
205                         pos -= offset;
206                         pos++;
207                     }
208                     if (pos >= offset)
209                         return AVERROR_INVALIDDATA;
210                 }
211                 left  -= 3;
212             } else { /* copy */
213                 for (j = 0; j < code + 1; j++) {
214                     out[pos] = bytestream2_get_be16(gbc);
215                     pos++;
216                     if (pos >= offset) {
217                         pos -= offset;
218                         pos++;
219                     }
220                     if (pos >= offset)
221                         return AVERROR_INVALIDDATA;
222                 }
223                 left  -= 1 + (code + 1) * 2;
224             }
225         }
226         outdata += p->linesize[0];
227     }
228     return 0;
229 }
230
231 static int decode_rle(AVCodecContext *avctx, AVFrame *p, GetByteContext *gbc,
232                       int step)
233 {
234     int i, j;
235     int offset = avctx->width * step;
236     uint8_t *outdata = p->data[0];
237
238     for (i = 0; i < avctx->height; i++) {
239         int size, left, code, pix;
240         uint8_t *out = outdata;
241         int pos = 0;
242
243         /* size of packed line */
244         size = left = bytestream2_get_be16(gbc);
245         if (bytestream2_get_bytes_left(gbc) < size)
246             return AVERROR_INVALIDDATA;
247
248         /* decode line */
249         while (left > 0) {
250             code = bytestream2_get_byte(gbc);
251             if (code & 0x80 ) { /* run */
252                 pix = bytestream2_get_byte(gbc);
253                 for (j = 0; j < 257 - code; j++) {
254                     out[pos] = pix;
255                     pos += step;
256                     if (pos >= offset) {
257                         pos -= offset;
258                         pos++;
259                     }
260                     if (pos >= offset)
261                         return AVERROR_INVALIDDATA;
262                 }
263                 left  -= 2;
264             } else { /* copy */
265                 for (j = 0; j < code + 1; j++) {
266                     out[pos] = bytestream2_get_byte(gbc);
267                     pos += step;
268                     if (pos >= offset) {
269                         pos -= offset;
270                         pos++;
271                     }
272                     if (pos >= offset)
273                         return AVERROR_INVALIDDATA;
274                 }
275                 left  -= 2 + code;
276             }
277         }
278         outdata += p->linesize[0];
279     }
280     return 0;
281 }
282
283 static int check_header(const char *buf, int buf_size)
284 {
285     unsigned w, h, v0, v1;
286
287     if (buf_size < 40)
288         return 0;
289
290     w = AV_RB16(buf+6);
291     h = AV_RB16(buf+8);
292     v0 = AV_RB16(buf+10);
293     v1 = AV_RB16(buf+12);
294
295     if (!w || !h)
296         return 0;
297
298     if (v0 == 0x1101)
299         return 1;
300     if (v0 == 0x0011 && v1 == 0x02FF)
301         return 2;
302     return 0;
303 }
304
305
306 static int decode_frame(AVCodecContext *avctx,
307                         void *data, int *got_frame,
308                         AVPacket *avpkt)
309 {
310     AVFrame * const p      = data;
311     GetByteContext gbc;
312     int colors;
313     int w, h, x0, y0, x1, y1, ret;
314     int ver;
315
316     bytestream2_init(&gbc, avpkt->data, avpkt->size);
317     if (   bytestream2_get_bytes_left(&gbc) >= 552
318            &&  check_header(gbc.buffer + 512, bytestream2_get_bytes_left(&gbc) - 512)
319        )
320         bytestream2_skip(&gbc, 512);
321
322     ver = check_header(gbc.buffer, bytestream2_get_bytes_left(&gbc));
323
324     /* smallest PICT header */
325     if (bytestream2_get_bytes_left(&gbc) < 40) {
326         av_log(avctx, AV_LOG_ERROR, "Frame is too small %d\n",
327                bytestream2_get_bytes_left(&gbc));
328         return AVERROR_INVALIDDATA;
329     }
330
331     bytestream2_skip(&gbc, 6);
332     h = bytestream2_get_be16(&gbc);
333     w = bytestream2_get_be16(&gbc);
334
335     ret = ff_set_dimensions(avctx, w, h);
336     if (ret < 0)
337         return ret;
338
339     /* version 1 is identified by 0x1101
340      * it uses byte-aligned opcodes rather than word-aligned */
341     if (ver == 1) {
342         avpriv_request_sample(avctx, "QuickDraw version 1");
343         return AVERROR_PATCHWELCOME;
344     } else if (ver != 2) {
345         avpriv_request_sample(avctx, "QuickDraw version unknown (%X)", bytestream2_get_be32(&gbc));
346         return AVERROR_PATCHWELCOME;
347     }
348
349     bytestream2_skip(&gbc, 4+26);
350
351     while (bytestream2_get_bytes_left(&gbc) >= 4) {
352         int bppcnt, bpp;
353         int rowbytes, pack_type;
354         int opcode = bytestream2_get_be16(&gbc);
355
356         switch(opcode) {
357         case CLIP:
358             bytestream2_get_be16(&gbc);
359             y0 = bytestream2_get_be16(&gbc);
360             x0 = bytestream2_get_be16(&gbc);
361             y1 = bytestream2_get_be16(&gbc);
362             x1 = bytestream2_get_be16(&gbc);
363             ret = ff_set_dimensions(avctx, x1 - x0, y1 - y0);
364             if (ret < 0)
365                 return ret;
366             break;
367         case PACKBITSRECT:
368         case PACKBITSRGN:
369             av_log(avctx, AV_LOG_DEBUG, "Parsing Packbit opcode\n");
370
371             bytestream2_skip(&gbc, 30);
372             bppcnt = bytestream2_get_be16(&gbc); /* cmpCount */
373             bpp    = bytestream2_get_be16(&gbc); /* cmpSize */
374
375             av_log(avctx, AV_LOG_DEBUG, "bppcount %d bpp %d\n", bppcnt, bpp);
376             if (bppcnt == 1 && bpp == 8) {
377                 avctx->pix_fmt = AV_PIX_FMT_PAL8;
378             } else if (bppcnt == 1 && (bpp == 4 || bpp == 2)) {
379                 avctx->pix_fmt = AV_PIX_FMT_PAL8;
380             } else if (bppcnt == 3 && bpp == 5) {
381                 avctx->pix_fmt = AV_PIX_FMT_RGB555;
382             } else {
383                 av_log(avctx, AV_LOG_ERROR,
384                        "Invalid pixel format (bppcnt %d bpp %d) in Packbit\n",
385                        bppcnt, bpp);
386                 return AVERROR_INVALIDDATA;
387             }
388
389             /* jump to palette */
390             bytestream2_skip(&gbc, 18);
391             colors = bytestream2_get_be16(&gbc);
392
393             if (colors < 0 || colors > 256) {
394                 av_log(avctx, AV_LOG_ERROR,
395                        "Error color count - %i(0x%X)\n", colors, colors);
396                 return AVERROR_INVALIDDATA;
397             }
398             if (bytestream2_get_bytes_left(&gbc) < (colors + 1) * 8) {
399                 av_log(avctx, AV_LOG_ERROR, "Palette is too small %d\n",
400                        bytestream2_get_bytes_left(&gbc));
401                 return AVERROR_INVALIDDATA;
402             }
403             if ((ret = ff_get_buffer(avctx, p, 0)) < 0)
404                 return ret;
405
406             parse_palette(avctx, &gbc, (uint32_t *)p->data[1], colors);
407             p->palette_has_changed = 1;
408
409             /* jump to image data */
410             bytestream2_skip(&gbc, 18);
411
412             if (opcode == PACKBITSRGN) {
413                 bytestream2_skip(&gbc, 2 + 8); /* size + rect */
414                 avpriv_report_missing_feature(avctx, "Packbit mask region");
415             }
416
417             if (avctx->pix_fmt == AV_PIX_FMT_RGB555)
418                 ret = decode_rle16(avctx, p, &gbc);
419             else if (bpp == 2)
420                 ret = decode_rle_bpp2(avctx, p, &gbc);
421             else if (bpp == 4)
422                 ret = decode_rle_bpp4(avctx, p, &gbc);
423             else
424                 ret = decode_rle(avctx, p, &gbc, bppcnt);
425             if (ret < 0)
426                 return ret;
427             *got_frame = 1;
428             break;
429         case DIRECTBITSRECT:
430         case DIRECTBITSRGN:
431             av_log(avctx, AV_LOG_DEBUG, "Parsing Directbit opcode\n");
432
433             bytestream2_skip(&gbc, 4);
434             rowbytes = bytestream2_get_be16(&gbc) & 0x3FFF;
435             if (rowbytes <= 250) {
436                 avpriv_report_missing_feature(avctx, "Short rowbytes");
437                 return AVERROR_PATCHWELCOME;
438             }
439
440             bytestream2_skip(&gbc, 10);
441             pack_type = bytestream2_get_be16(&gbc);
442
443             bytestream2_skip(&gbc, 16);
444             bppcnt = bytestream2_get_be16(&gbc); /* cmpCount */
445             bpp    = bytestream2_get_be16(&gbc); /* cmpSize */
446
447             av_log(avctx, AV_LOG_DEBUG, "bppcount %d bpp %d\n", bppcnt, bpp);
448             if (bppcnt == 3 && bpp == 8) {
449                 avctx->pix_fmt = AV_PIX_FMT_RGB24;
450             } else if (bppcnt == 3 && bpp == 5) {
451                 avctx->pix_fmt = AV_PIX_FMT_RGB555;
452             } else if (bppcnt == 4 && bpp == 8) {
453                 avctx->pix_fmt = AV_PIX_FMT_ARGB;
454             } else {
455                 av_log(avctx, AV_LOG_ERROR,
456                        "Invalid pixel format (bppcnt %d bpp %d) in Directbit\n",
457                        bppcnt, bpp);
458                 return AVERROR_INVALIDDATA;
459             }
460
461             /* set packing when default is selected */
462             if (pack_type == 0)
463                 pack_type = bppcnt;
464
465             if (pack_type != 3 && pack_type != 4) {
466                 avpriv_request_sample(avctx, "Pack type %d", pack_type);
467                 return AVERROR_PATCHWELCOME;
468             }
469             if ((ret = ff_get_buffer(avctx, p, 0)) < 0)
470                 return ret;
471
472             /* jump to data */
473             bytestream2_skip(&gbc, 30);
474
475             if (opcode == DIRECTBITSRGN) {
476                 bytestream2_skip(&gbc, 2 + 8); /* size + rect */
477                 avpriv_report_missing_feature(avctx, "DirectBit mask region");
478             }
479
480             if (avctx->pix_fmt == AV_PIX_FMT_RGB555)
481                 ret = decode_rle16(avctx, p, &gbc);
482             else
483                 ret = decode_rle(avctx, p, &gbc, bppcnt);
484             if (ret < 0)
485                 return ret;
486             *got_frame = 1;
487             break;
488         case LONGCOMMENT:
489             bytestream2_get_be16(&gbc);
490             bytestream2_skip(&gbc, bytestream2_get_be16(&gbc));
491             break;
492         default:
493             av_log(avctx, AV_LOG_TRACE, "Unknown 0x%04X opcode\n", opcode);
494             break;
495         }
496         /* exit the loop when a known pixel block has been found */
497         if (*got_frame) {
498             int eop, trail;
499
500             /* re-align to a word */
501             bytestream2_skip(&gbc, bytestream2_get_bytes_left(&gbc) % 2);
502
503             eop = bytestream2_get_be16(&gbc);
504             trail = bytestream2_get_bytes_left(&gbc);
505             if (eop != EOP)
506                 av_log(avctx, AV_LOG_WARNING,
507                        "Missing end of picture opcode (found 0x%04X)\n", eop);
508             if (trail)
509                 av_log(avctx, AV_LOG_WARNING, "Got %d trailing bytes\n", trail);
510             break;
511         }
512     }
513
514     if (*got_frame) {
515         p->pict_type = AV_PICTURE_TYPE_I;
516         p->key_frame = 1;
517
518         return avpkt->size;
519     } else {
520         av_log(avctx, AV_LOG_ERROR, "Frame contained no usable data\n");
521
522         return AVERROR_INVALIDDATA;
523     }
524 }
525
526 AVCodec ff_qdraw_decoder = {
527     .name           = "qdraw",
528     .long_name      = NULL_IF_CONFIG_SMALL("Apple QuickDraw"),
529     .type           = AVMEDIA_TYPE_VIDEO,
530     .id             = AV_CODEC_ID_QDRAW,
531     .decode         = decode_frame,
532     .capabilities   = AV_CODEC_CAP_DR1,
533 };