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