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