avcodec/dvdsubdec: factor out rectangles reset.
[ffmpeg.git] / libavcodec / dvdsubdec.c
1 /*
2  * DVD subtitle decoding
3  * Copyright (c) 2005 Fabrice Bellard
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 #include "avcodec.h"
22 #include "get_bits.h"
23 #include "dsputil.h"
24 #include "libavutil/attributes.h"
25 #include "libavutil/colorspace.h"
26 #include "libavutil/opt.h"
27 #include "libavutil/imgutils.h"
28 #include "libavutil/avstring.h"
29
30 typedef struct DVDSubContext
31 {
32   AVClass *class;
33   uint32_t palette[16];
34   char    *palette_str;
35   int      has_palette;
36   uint8_t  colormap[4];
37   uint8_t  alpha[256];
38 } DVDSubContext;
39
40 static void yuv_a_to_rgba(const uint8_t *ycbcr, const uint8_t *alpha, uint32_t *rgba, int num_values)
41 {
42     const uint8_t *cm = ff_cropTbl + MAX_NEG_CROP;
43     uint8_t r, g, b;
44     int i, y, cb, cr;
45     int r_add, g_add, b_add;
46
47     for (i = num_values; i > 0; i--) {
48         y = *ycbcr++;
49         cr = *ycbcr++;
50         cb = *ycbcr++;
51         YUV_TO_RGB1_CCIR(cb, cr);
52         YUV_TO_RGB2_CCIR(r, g, b, y);
53         *rgba++ = (*alpha++ << 24) | (r << 16) | (g << 8) | b;
54     }
55 }
56
57 static int decode_run_2bit(GetBitContext *gb, int *color)
58 {
59     unsigned int v, t;
60
61     v = 0;
62     for (t = 1; v < t && t <= 0x40; t <<= 2)
63         v = (v << 4) | get_bits(gb, 4);
64     *color = v & 3;
65     if (v < 4) { /* Code for fill rest of line */
66         return INT_MAX;
67     }
68     return v >> 2;
69 }
70
71 static int decode_run_8bit(GetBitContext *gb, int *color)
72 {
73     int len;
74     int has_run = get_bits1(gb);
75     if (get_bits1(gb))
76         *color = get_bits(gb, 8);
77     else
78         *color = get_bits(gb, 2);
79     if (has_run) {
80         if (get_bits1(gb)) {
81             len = get_bits(gb, 7);
82             if (len == 0)
83                 len = INT_MAX;
84             else
85                 len += 9;
86         } else
87             len = get_bits(gb, 3) + 2;
88     } else
89         len = 1;
90     return len;
91 }
92
93 static int decode_rle(uint8_t *bitmap, int linesize, int w, int h,
94                       const uint8_t *buf, int start, int buf_size, int is_8bit)
95 {
96     GetBitContext gb;
97     int bit_len;
98     int x, y, len, color;
99     uint8_t *d;
100
101     bit_len = (buf_size - start) * 8;
102     init_get_bits(&gb, buf + start, bit_len);
103
104     x = 0;
105     y = 0;
106     d = bitmap;
107     for(;;) {
108         if (get_bits_count(&gb) > bit_len)
109             return -1;
110         if (is_8bit)
111             len = decode_run_8bit(&gb, &color);
112         else
113             len = decode_run_2bit(&gb, &color);
114         len = FFMIN(len, w - x);
115         memset(d + x, color, len);
116         x += len;
117         if (x >= w) {
118             y++;
119             if (y >= h)
120                 break;
121             d += linesize;
122             x = 0;
123             /* byte align */
124             align_get_bits(&gb);
125         }
126     }
127     return 0;
128 }
129
130 static void guess_palette(DVDSubContext* ctx,
131                           uint32_t *rgba_palette,
132                           uint32_t subtitle_color)
133 {
134     static const uint8_t level_map[4][4] = {
135         // this configuration (full range, lowest to highest) in tests
136         // seemed most common, so assume this
137         {0xff},
138         {0x00, 0xff},
139         {0x00, 0x80, 0xff},
140         {0x00, 0x55, 0xaa, 0xff},
141     };
142     uint8_t color_used[16] = { 0 };
143     int nb_opaque_colors, i, level, j, r, g, b;
144     uint8_t *colormap = ctx->colormap, *alpha = ctx->alpha;
145
146     if(ctx->has_palette) {
147         for(i = 0; i < 4; i++)
148             rgba_palette[i] = (ctx->palette[colormap[i]] & 0x00ffffff)
149                               | ((alpha[i] * 17U) << 24);
150         return;
151     }
152
153     for(i = 0; i < 4; i++)
154         rgba_palette[i] = 0;
155
156     nb_opaque_colors = 0;
157     for(i = 0; i < 4; i++) {
158         if (alpha[i] != 0 && !color_used[colormap[i]]) {
159             color_used[colormap[i]] = 1;
160             nb_opaque_colors++;
161         }
162     }
163
164     if (nb_opaque_colors == 0)
165         return;
166
167     j = 0;
168     memset(color_used, 0, 16);
169     for(i = 0; i < 4; i++) {
170         if (alpha[i] != 0) {
171             if (!color_used[colormap[i]])  {
172                 level = level_map[nb_opaque_colors][j];
173                 r = (((subtitle_color >> 16) & 0xff) * level) >> 8;
174                 g = (((subtitle_color >> 8) & 0xff) * level) >> 8;
175                 b = (((subtitle_color >> 0) & 0xff) * level) >> 8;
176                 rgba_palette[i] = b | (g << 8) | (r << 16) | ((alpha[i] * 17) << 24);
177                 color_used[colormap[i]] = (i + 1);
178                 j++;
179             } else {
180                 rgba_palette[i] = (rgba_palette[color_used[colormap[i]] - 1] & 0x00ffffff) |
181                                     ((alpha[i] * 17) << 24);
182             }
183         }
184     }
185 }
186
187 static void reset_rects(AVSubtitle *sub_header)
188 {
189     int i;
190
191     if (sub_header->rects != NULL) {
192         for (i = 0; i < sub_header->num_rects; i++) {
193             av_freep(&sub_header->rects[i]->pict.data[0]);
194             av_freep(&sub_header->rects[i]->pict.data[1]);
195             av_freep(&sub_header->rects[i]);
196         }
197         av_freep(&sub_header->rects);
198         sub_header->num_rects = 0;
199     }
200 }
201
202 #define READ_OFFSET(a) (big_offsets ? AV_RB32(a) : AV_RB16(a))
203
204 static int decode_dvd_subtitles(DVDSubContext *ctx, AVSubtitle *sub_header,
205                                 const uint8_t *buf, int buf_size)
206 {
207     int cmd_pos, pos, cmd, x1, y1, x2, y2, offset1, offset2, next_cmd_pos;
208     int big_offsets, offset_size, is_8bit = 0;
209     const uint8_t *yuv_palette = 0;
210     uint8_t *colormap = ctx->colormap, *alpha = ctx->alpha;
211     int date;
212     int i;
213     int is_menu = 0;
214
215     if (buf_size < 10)
216         return -1;
217
218     if (AV_RB16(buf) == 0) {   /* HD subpicture with 4-byte offsets */
219         big_offsets = 1;
220         offset_size = 4;
221         cmd_pos = 6;
222     } else {
223         big_offsets = 0;
224         offset_size = 2;
225         cmd_pos = 2;
226     }
227
228     cmd_pos = READ_OFFSET(buf + cmd_pos);
229
230     while (cmd_pos > 0 && cmd_pos < buf_size - 2 - offset_size) {
231         date = AV_RB16(buf + cmd_pos);
232         next_cmd_pos = READ_OFFSET(buf + cmd_pos + 2);
233         av_dlog(NULL, "cmd_pos=0x%04x next=0x%04x date=%d\n",
234                 cmd_pos, next_cmd_pos, date);
235         pos = cmd_pos + 2 + offset_size;
236         offset1 = -1;
237         offset2 = -1;
238         x1 = y1 = x2 = y2 = 0;
239         while (pos < buf_size) {
240             cmd = buf[pos++];
241             av_dlog(NULL, "cmd=%02x\n", cmd);
242             switch(cmd) {
243             case 0x00:
244                 /* menu subpicture */
245                 is_menu = 1;
246                 break;
247             case 0x01:
248                 /* set start date */
249                 sub_header->start_display_time = (date << 10) / 90;
250                 break;
251             case 0x02:
252                 /* set end date */
253                 sub_header->end_display_time = (date << 10) / 90;
254                 break;
255             case 0x03:
256                 /* set colormap */
257                 if ((buf_size - pos) < 2)
258                     goto fail;
259                 colormap[3] = buf[pos] >> 4;
260                 colormap[2] = buf[pos] & 0x0f;
261                 colormap[1] = buf[pos + 1] >> 4;
262                 colormap[0] = buf[pos + 1] & 0x0f;
263                 pos += 2;
264                 break;
265             case 0x04:
266                 /* set alpha */
267                 if ((buf_size - pos) < 2)
268                     goto fail;
269                 alpha[3] = buf[pos] >> 4;
270                 alpha[2] = buf[pos] & 0x0f;
271                 alpha[1] = buf[pos + 1] >> 4;
272                 alpha[0] = buf[pos + 1] & 0x0f;
273                 pos += 2;
274             av_dlog(NULL, "alpha=%x%x%x%x\n", alpha[0],alpha[1],alpha[2],alpha[3]);
275                 break;
276             case 0x05:
277             case 0x85:
278                 if ((buf_size - pos) < 6)
279                     goto fail;
280                 x1 = (buf[pos] << 4) | (buf[pos + 1] >> 4);
281                 x2 = ((buf[pos + 1] & 0x0f) << 8) | buf[pos + 2];
282                 y1 = (buf[pos + 3] << 4) | (buf[pos + 4] >> 4);
283                 y2 = ((buf[pos + 4] & 0x0f) << 8) | buf[pos + 5];
284                 if (cmd & 0x80)
285                     is_8bit = 1;
286                 av_dlog(NULL, "x1=%d x2=%d y1=%d y2=%d\n", x1, x2, y1, y2);
287                 pos += 6;
288                 break;
289             case 0x06:
290                 if ((buf_size - pos) < 4)
291                     goto fail;
292                 offset1 = AV_RB16(buf + pos);
293                 offset2 = AV_RB16(buf + pos + 2);
294                 av_dlog(NULL, "offset1=0x%04x offset2=0x%04x\n", offset1, offset2);
295                 pos += 4;
296                 break;
297             case 0x86:
298                 if ((buf_size - pos) < 8)
299                     goto fail;
300                 offset1 = AV_RB32(buf + pos);
301                 offset2 = AV_RB32(buf + pos + 4);
302                 av_dlog(NULL, "offset1=0x%04x offset2=0x%04x\n", offset1, offset2);
303                 pos += 8;
304                 break;
305
306             case 0x83:
307                 /* HD set palette */
308                 if ((buf_size - pos) < 768)
309                     goto fail;
310                 yuv_palette = buf + pos;
311                 pos += 768;
312                 break;
313             case 0x84:
314                 /* HD set contrast (alpha) */
315                 if ((buf_size - pos) < 256)
316                     goto fail;
317                 for (i = 0; i < 256; i++)
318                     alpha[i] = 0xFF - buf[pos+i];
319                 pos += 256;
320                 break;
321
322             case 0xff:
323                 goto the_end;
324             default:
325                 av_dlog(NULL, "unrecognised subpicture command 0x%x\n", cmd);
326                 goto the_end;
327             }
328         }
329     the_end:
330         if (offset1 >= 0) {
331             int w, h;
332             uint8_t *bitmap;
333
334             /* decode the bitmap */
335             w = x2 - x1 + 1;
336             if (w < 0)
337                 w = 0;
338             h = y2 - y1;
339             if (h < 0)
340                 h = 0;
341             if (w > 0 && h > 0) {
342                 reset_rects(sub_header);
343
344                 bitmap = av_malloc(w * h);
345                 sub_header->rects = av_mallocz(sizeof(*sub_header->rects));
346                 sub_header->rects[0] = av_mallocz(sizeof(AVSubtitleRect));
347                 sub_header->num_rects = 1;
348                 sub_header->rects[0]->pict.data[0] = bitmap;
349                 decode_rle(bitmap, w * 2, w, (h + 1) / 2,
350                            buf, offset1, buf_size, is_8bit);
351                 decode_rle(bitmap + w, w * 2, w, h / 2,
352                            buf, offset2, buf_size, is_8bit);
353                 sub_header->rects[0]->pict.data[1] = av_mallocz(AVPALETTE_SIZE);
354                 if (is_8bit) {
355                     if (yuv_palette == 0)
356                         goto fail;
357                     sub_header->rects[0]->nb_colors = 256;
358                     yuv_a_to_rgba(yuv_palette, alpha, (uint32_t*)sub_header->rects[0]->pict.data[1], 256);
359                 } else {
360                     sub_header->rects[0]->nb_colors = 4;
361                     guess_palette(ctx, (uint32_t*)sub_header->rects[0]->pict.data[1],
362                                   0xffff00);
363                 }
364                 sub_header->rects[0]->x = x1;
365                 sub_header->rects[0]->y = y1;
366                 sub_header->rects[0]->w = w;
367                 sub_header->rects[0]->h = h;
368                 sub_header->rects[0]->type = SUBTITLE_BITMAP;
369                 sub_header->rects[0]->pict.linesize[0] = w;
370                 sub_header->rects[0]->flags = is_menu ? AV_SUBTITLE_FLAG_FORCED : 0;
371             }
372         }
373         if (next_cmd_pos < cmd_pos) {
374             av_log(NULL, AV_LOG_ERROR, "Invalid command offset\n");
375             break;
376         }
377         if (next_cmd_pos == cmd_pos)
378             break;
379         cmd_pos = next_cmd_pos;
380     }
381     if (sub_header->num_rects > 0)
382         return is_menu;
383  fail:
384     reset_rects(sub_header);
385     return -1;
386 }
387
388 static int is_transp(const uint8_t *buf, int pitch, int n,
389                      const uint8_t *transp_color)
390 {
391     int i;
392     for(i = 0; i < n; i++) {
393         if (!transp_color[*buf])
394             return 0;
395         buf += pitch;
396     }
397     return 1;
398 }
399
400 /* return 0 if empty rectangle, 1 if non empty */
401 static int find_smallest_bounding_rectangle(AVSubtitle *s)
402 {
403     uint8_t transp_color[256] = { 0 };
404     int y1, y2, x1, x2, y, w, h, i;
405     uint8_t *bitmap;
406
407     if (s->num_rects == 0 || s->rects == NULL || s->rects[0]->w <= 0 || s->rects[0]->h <= 0)
408         return 0;
409
410     for(i = 0; i < s->rects[0]->nb_colors; i++) {
411         if ((((uint32_t*)s->rects[0]->pict.data[1])[i] >> 24) == 0)
412             transp_color[i] = 1;
413     }
414     y1 = 0;
415     while (y1 < s->rects[0]->h && is_transp(s->rects[0]->pict.data[0] + y1 * s->rects[0]->pict.linesize[0],
416                                   1, s->rects[0]->w, transp_color))
417         y1++;
418     if (y1 == s->rects[0]->h) {
419         av_freep(&s->rects[0]->pict.data[0]);
420         s->rects[0]->w = s->rects[0]->h = 0;
421         return 0;
422     }
423
424     y2 = s->rects[0]->h - 1;
425     while (y2 > 0 && is_transp(s->rects[0]->pict.data[0] + y2 * s->rects[0]->pict.linesize[0], 1,
426                                s->rects[0]->w, transp_color))
427         y2--;
428     x1 = 0;
429     while (x1 < (s->rects[0]->w - 1) && is_transp(s->rects[0]->pict.data[0] + x1, s->rects[0]->pict.linesize[0],
430                                         s->rects[0]->h, transp_color))
431         x1++;
432     x2 = s->rects[0]->w - 1;
433     while (x2 > 0 && is_transp(s->rects[0]->pict.data[0] + x2, s->rects[0]->pict.linesize[0], s->rects[0]->h,
434                                   transp_color))
435         x2--;
436     w = x2 - x1 + 1;
437     h = y2 - y1 + 1;
438     bitmap = av_malloc(w * h);
439     if (!bitmap)
440         return 1;
441     for(y = 0; y < h; y++) {
442         memcpy(bitmap + w * y, s->rects[0]->pict.data[0] + x1 + (y1 + y) * s->rects[0]->pict.linesize[0], w);
443     }
444     av_freep(&s->rects[0]->pict.data[0]);
445     s->rects[0]->pict.data[0] = bitmap;
446     s->rects[0]->pict.linesize[0] = w;
447     s->rects[0]->w = w;
448     s->rects[0]->h = h;
449     s->rects[0]->x += x1;
450     s->rects[0]->y += y1;
451     return 1;
452 }
453
454 #ifdef DEBUG
455 #undef fprintf
456 #undef perror
457 #undef exit
458 static void ppm_save(const char *filename, uint8_t *bitmap, int w, int h,
459                      uint32_t *rgba_palette)
460 {
461     int x, y, v;
462     FILE *f;
463
464     f = fopen(filename, "w");
465     if (!f) {
466         perror(filename);
467         exit(1);
468     }
469     fprintf(f, "P6\n"
470             "%d %d\n"
471             "%d\n",
472             w, h, 255);
473     for(y = 0; y < h; y++) {
474         for(x = 0; x < w; x++) {
475             v = rgba_palette[bitmap[y * w + x]];
476             putc((v >> 16) & 0xff, f);
477             putc((v >> 8) & 0xff, f);
478             putc((v >> 0) & 0xff, f);
479         }
480     }
481     fclose(f);
482 }
483 #endif
484
485 static int dvdsub_decode(AVCodecContext *avctx,
486                          void *data, int *data_size,
487                          AVPacket *avpkt)
488 {
489     DVDSubContext *ctx = avctx->priv_data;
490     const uint8_t *buf = avpkt->data;
491     int buf_size = avpkt->size;
492     AVSubtitle *sub = data;
493     int is_menu;
494
495     is_menu = decode_dvd_subtitles(ctx, sub, buf, buf_size);
496
497     if (is_menu < 0) {
498     no_subtitle:
499         *data_size = 0;
500
501         return buf_size;
502     }
503     if (!is_menu && find_smallest_bounding_rectangle(sub) == 0)
504         goto no_subtitle;
505
506 #if defined(DEBUG)
507     av_dlog(NULL, "start=%d ms end =%d ms\n",
508             sub->start_display_time,
509             sub->end_display_time);
510     ppm_save("/tmp/a.ppm", sub->rects[0]->pict.data[0],
511              sub->rects[0]->w, sub->rects[0]->h, sub->rects[0]->pict.data[1]);
512 #endif
513
514     *data_size = 1;
515     return buf_size;
516 }
517
518 static void parse_palette(DVDSubContext *ctx, char *p)
519 {
520     int i;
521
522     ctx->has_palette = 1;
523     for(i=0;i<16;i++) {
524         ctx->palette[i] = strtoul(p, &p, 16);
525         while(*p == ',' || av_isspace(*p))
526             p++;
527     }
528 }
529
530 static int dvdsub_parse_extradata(AVCodecContext *avctx)
531 {
532     DVDSubContext *ctx = (DVDSubContext*) avctx->priv_data;
533     char *dataorig, *data;
534
535     if (!avctx->extradata || !avctx->extradata_size)
536         return 1;
537
538     dataorig = data = av_malloc(avctx->extradata_size+1);
539     if (!data)
540         return AVERROR(ENOMEM);
541     memcpy(data, avctx->extradata, avctx->extradata_size);
542     data[avctx->extradata_size] = '\0';
543
544     for(;;) {
545         int pos = strcspn(data, "\n\r");
546         if (pos==0 && *data==0)
547             break;
548
549         if (strncmp("palette:", data, 8) == 0) {
550             parse_palette(ctx, data + 8);
551         } else if (strncmp("size:", data, 5) == 0) {
552             int w, h;
553             if (sscanf(data + 5, "%dx%d", &w, &h) == 2 &&
554                 av_image_check_size(w, h, 0, avctx) >= 0)
555                 avcodec_set_dimensions(avctx, w, h);
556         }
557
558         data += pos;
559         data += strspn(data, "\n\r");
560     }
561
562     av_free(dataorig);
563     return 1;
564 }
565
566 static av_cold int dvdsub_init(AVCodecContext *avctx)
567 {
568     DVDSubContext *ctx = avctx->priv_data;
569     int ret;
570
571     if ((ret = dvdsub_parse_extradata(avctx)) < 0)
572         return ret;
573
574     if (ctx->palette_str)
575         parse_palette(ctx, ctx->palette_str);
576     if (ctx->has_palette) {
577         int i;
578         av_log(avctx, AV_LOG_DEBUG, "palette:");
579         for(i=0;i<16;i++)
580             av_log(avctx, AV_LOG_DEBUG, " 0x%06x", ctx->palette[i]);
581         av_log(avctx, AV_LOG_DEBUG, "\n");
582     }
583
584     return 1;
585 }
586
587 #define OFFSET(field) offsetof(DVDSubContext, field)
588 #define VD AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM
589 static const AVOption options[] = {
590     { "palette", "set the global palette", OFFSET(palette_str), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, VD },
591     { NULL }
592 };
593 static const AVClass dvdsub_class = {
594     .class_name = "dvdsubdec",
595     .item_name  = av_default_item_name,
596     .option     = options,
597     .version    = LIBAVUTIL_VERSION_INT,
598 };
599
600 AVCodec ff_dvdsub_decoder = {
601     .name           = "dvdsub",
602     .type           = AVMEDIA_TYPE_SUBTITLE,
603     .id             = AV_CODEC_ID_DVD_SUBTITLE,
604     .priv_data_size = sizeof(DVDSubContext),
605     .init           = dvdsub_init,
606     .decode         = dvdsub_decode,
607     .long_name      = NULL_IF_CONFIG_SMALL("DVD subtitles"),
608     .priv_class     = &dvdsub_class,
609 };