avcodec/pgssubdec: Bail out of decode_rle() if error and AV_EF_EXPLODE is set
[ffmpeg.git] / libavcodec / pgssubdec.c
1 /*
2  * PGS subtitle decoder
3  * Copyright (c) 2009 Stephen Backway
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
22 /**
23  * @file
24  * PGS subtitle decoder
25  */
26
27 #include "avcodec.h"
28 #include "bytestream.h"
29 #include "internal.h"
30 #include "mathops.h"
31
32 #include "libavutil/colorspace.h"
33 #include "libavutil/imgutils.h"
34 #include "libavutil/opt.h"
35
36 #define RGBA(r,g,b,a) (((a) << 24) | ((r) << 16) | ((g) << 8) | (b))
37
38 enum SegmentType {
39     PALETTE_SEGMENT      = 0x14,
40     OBJECT_SEGMENT       = 0x15,
41     PRESENTATION_SEGMENT = 0x16,
42     WINDOW_SEGMENT       = 0x17,
43     DISPLAY_SEGMENT      = 0x80,
44 };
45
46 typedef struct PGSSubPictureReference {
47     int x;
48     int y;
49     int picture_id;
50     int composition;
51 } PGSSubPictureReference;
52
53 typedef struct PGSSubPresentation {
54     int                    id_number;
55     int                    object_count;
56     PGSSubPictureReference *objects;
57     int64_t pts;
58 } PGSSubPresentation;
59
60 typedef struct PGSSubPicture {
61     int          w;
62     int          h;
63     uint8_t      *rle;
64     unsigned int rle_buffer_size, rle_data_len;
65     unsigned int rle_remaining_len;
66 } PGSSubPicture;
67
68 typedef struct PGSSubContext {
69     AVClass *class;
70     PGSSubPresentation presentation;
71     uint32_t           clut[256];
72     PGSSubPicture      pictures[UINT16_MAX];
73     int forced_subs_only;
74 } PGSSubContext;
75
76 static void flush_cache(AVCodecContext *avctx)
77 {
78     PGSSubContext *ctx = avctx->priv_data;
79     uint16_t picture;
80
81     av_freep(&ctx->presentation.objects);
82     ctx->presentation.object_count = 0;
83
84     for (picture = 0; picture < UINT16_MAX; ++picture) {
85         av_freep(&ctx->pictures[picture].rle);
86         ctx->pictures[picture].rle_buffer_size = 0;
87     }
88 }
89
90 static av_cold int init_decoder(AVCodecContext *avctx)
91 {
92     avctx->pix_fmt     = AV_PIX_FMT_PAL8;
93
94     return 0;
95 }
96
97 static av_cold int close_decoder(AVCodecContext *avctx)
98 {
99     flush_cache(avctx);
100
101     return 0;
102 }
103
104 /**
105  * Decode the RLE data.
106  *
107  * The subtitle is stored as a Run Length Encoded image.
108  *
109  * @param avctx contains the current codec context
110  * @param sub pointer to the processed subtitle data
111  * @param buf pointer to the RLE data to process
112  * @param buf_size size of the RLE data to process
113  */
114 static int decode_rle(AVCodecContext *avctx, AVSubtitleRect *rect,
115                       const uint8_t *buf, unsigned int buf_size)
116 {
117     const uint8_t *rle_bitmap_end;
118     int pixel_count, line_count;
119
120     rle_bitmap_end = buf + buf_size;
121
122     rect->pict.data[0] = av_malloc(rect->w * rect->h);
123
124     if (!rect->pict.data[0])
125         return AVERROR(ENOMEM);
126
127     pixel_count = 0;
128     line_count  = 0;
129
130     while (buf < rle_bitmap_end && line_count < rect->h) {
131         uint8_t flags, color;
132         int run;
133
134         color = bytestream_get_byte(&buf);
135         run   = 1;
136
137         if (color == 0x00) {
138             flags = bytestream_get_byte(&buf);
139             run   = flags & 0x3f;
140             if (flags & 0x40)
141                 run = (run << 8) + bytestream_get_byte(&buf);
142             color = flags & 0x80 ? bytestream_get_byte(&buf) : 0;
143         }
144
145         if (run > 0 && pixel_count + run <= rect->w * rect->h) {
146             memset(rect->pict.data[0] + pixel_count, color, run);
147             pixel_count += run;
148         } else if (!run) {
149             /*
150              * New Line. Check if correct pixels decoded, if not display warning
151              * and adjust bitmap pointer to correct new line position.
152              */
153             if (pixel_count % rect->w > 0) {
154                 av_log(avctx, AV_LOG_ERROR, "Decoded %d pixels, when line should be %d pixels\n",
155                        pixel_count % rect->w, rect->w);
156                 if (avctx->err_recognition & AV_EF_EXPLODE) {
157                     return AVERROR_INVALIDDATA;
158                 }
159             }
160             line_count++;
161         }
162     }
163
164     if (pixel_count < rect->w * rect->h) {
165         av_log(avctx, AV_LOG_ERROR, "Insufficient RLE data for subtitle\n");
166         return AVERROR_INVALIDDATA;
167     }
168
169     av_dlog(avctx, "Pixel Count = %d, Area = %d\n", pixel_count, rect->w * rect->h);
170
171     return 0;
172 }
173
174 /**
175  * Parse the picture segment packet.
176  *
177  * The picture segment contains details on the sequence id,
178  * width, height and Run Length Encoded (RLE) bitmap data.
179  *
180  * @param avctx contains the current codec context
181  * @param buf pointer to the packet to process
182  * @param buf_size size of packet to process
183  * @todo TODO: Enable support for RLE data over multiple packets
184  */
185 static int parse_picture_segment(AVCodecContext *avctx,
186                                   const uint8_t *buf, int buf_size)
187 {
188     PGSSubContext *ctx = avctx->priv_data;
189
190     uint8_t sequence_desc;
191     unsigned int rle_bitmap_len, width, height;
192     uint16_t picture_id;
193
194     if (buf_size <= 4)
195         return AVERROR_INVALIDDATA;
196     buf_size -= 4;
197
198     picture_id = bytestream_get_be16(&buf);
199
200     /* skip 1 unknown byte: Version Number */
201     buf++;
202
203     /* Read the Sequence Description to determine if start of RLE data or appended to previous RLE */
204     sequence_desc = bytestream_get_byte(&buf);
205
206     if (!(sequence_desc & 0x80)) {
207         /* Additional RLE data */
208         if (buf_size > ctx->pictures[picture_id].rle_remaining_len)
209             return AVERROR_INVALIDDATA;
210
211         memcpy(ctx->pictures[picture_id].rle + ctx->pictures[picture_id].rle_data_len, buf, buf_size);
212         ctx->pictures[picture_id].rle_data_len += buf_size;
213         ctx->pictures[picture_id].rle_remaining_len -= buf_size;
214
215         return 0;
216     }
217
218     if (buf_size <= 7)
219         return AVERROR_INVALIDDATA;
220     buf_size -= 7;
221
222     /* Decode rle bitmap length, stored size includes width/height data */
223     rle_bitmap_len = bytestream_get_be24(&buf) - 2*2;
224
225     /* Get bitmap dimensions from data */
226     width  = bytestream_get_be16(&buf);
227     height = bytestream_get_be16(&buf);
228
229     /* Make sure the bitmap is not too large */
230     if (avctx->width < width || avctx->height < height) {
231         av_log(avctx, AV_LOG_ERROR, "Bitmap dimensions larger than video.\n");
232         return AVERROR_INVALIDDATA;
233     }
234
235     if (buf_size > rle_bitmap_len) {
236         av_log(avctx, AV_LOG_ERROR, "too much RLE data\n");
237         return AVERROR_INVALIDDATA;
238     }
239
240     ctx->pictures[picture_id].w = width;
241     ctx->pictures[picture_id].h = height;
242
243     av_fast_padded_malloc(&ctx->pictures[picture_id].rle, &ctx->pictures[picture_id].rle_buffer_size, rle_bitmap_len);
244
245     if (!ctx->pictures[picture_id].rle)
246         return AVERROR(ENOMEM);
247
248     memcpy(ctx->pictures[picture_id].rle, buf, buf_size);
249     ctx->pictures[picture_id].rle_data_len      = buf_size;
250     ctx->pictures[picture_id].rle_remaining_len = rle_bitmap_len - buf_size;
251
252     return 0;
253 }
254
255 /**
256  * Parse the palette segment packet.
257  *
258  * The palette segment contains details of the palette,
259  * a maximum of 256 colors can be defined.
260  *
261  * @param avctx contains the current codec context
262  * @param buf pointer to the packet to process
263  * @param buf_size size of packet to process
264  */
265 static int parse_palette_segment(AVCodecContext *avctx,
266                                   const uint8_t *buf, int buf_size)
267 {
268     PGSSubContext *ctx = avctx->priv_data;
269
270     const uint8_t *buf_end = buf + buf_size;
271     const uint8_t *cm      = ff_crop_tab + MAX_NEG_CROP;
272     int color_id;
273     int y, cb, cr, alpha;
274     int r, g, b, r_add, g_add, b_add;
275
276     /* Skip two null bytes */
277     buf += 2;
278
279     while (buf < buf_end) {
280         color_id  = bytestream_get_byte(&buf);
281         y         = bytestream_get_byte(&buf);
282         cr        = bytestream_get_byte(&buf);
283         cb        = bytestream_get_byte(&buf);
284         alpha     = bytestream_get_byte(&buf);
285
286         YUV_TO_RGB1(cb, cr);
287         YUV_TO_RGB2(r, g, b, y);
288
289         av_dlog(avctx, "Color %d := (%d,%d,%d,%d)\n", color_id, r, g, b, alpha);
290
291         /* Store color in palette */
292         ctx->clut[color_id] = RGBA(r,g,b,alpha);
293     }
294     return 0;
295 }
296
297 /**
298  * Parse the presentation segment packet.
299  *
300  * The presentation segment contains details on the video
301  * width, video height, x & y subtitle position.
302  *
303  * @param avctx contains the current codec context
304  * @param buf pointer to the packet to process
305  * @param buf_size size of packet to process
306  * @todo TODO: Implement cropping
307  */
308 static int parse_presentation_segment(AVCodecContext *avctx,
309                                       const uint8_t *buf, int buf_size,
310                                       int64_t pts)
311 {
312     PGSSubContext *ctx = avctx->priv_data;
313     int ret;
314
315     int w = bytestream_get_be16(&buf);
316     int h = bytestream_get_be16(&buf);
317
318     uint16_t object_index;
319
320     ctx->presentation.pts = pts;
321
322     av_dlog(avctx, "Video Dimensions %dx%d\n",
323             w, h);
324     ret = ff_set_dimensions(avctx, w, h);
325     if (ret < 0)
326         return ret;
327
328     /* Skip 1 bytes of unknown, frame rate? */
329     buf++;
330
331     ctx->presentation.id_number = bytestream_get_be16(&buf);
332
333     /*
334      * Skip 3 bytes of unknown:
335      *     state
336      *     palette_update_flag (0x80),
337      *     palette_id_to_use,
338      */
339     buf += 3;
340
341     ctx->presentation.object_count = bytestream_get_byte(&buf);
342     if (!ctx->presentation.object_count)
343         return 0;
344
345     /* Verify that enough bytes are remaining for all of the objects. */
346     buf_size -= 11;
347     if (buf_size < ctx->presentation.object_count * 8) {
348         ctx->presentation.object_count = 0;
349         return AVERROR_INVALIDDATA;
350     }
351
352     av_freep(&ctx->presentation.objects);
353     ctx->presentation.objects = av_malloc_array(ctx->presentation.object_count, sizeof(PGSSubPictureReference));
354     if (!ctx->presentation.objects) {
355         ctx->presentation.object_count = 0;
356         return AVERROR(ENOMEM);
357     }
358
359     for (object_index = 0; object_index < ctx->presentation.object_count; ++object_index) {
360         PGSSubPictureReference *reference = &ctx->presentation.objects[object_index];
361         reference->picture_id             = bytestream_get_be16(&buf);
362
363         /* Skip window_id_ref */
364         buf++;
365         /* composition_flag (0x80 - object cropped, 0x40 - object forced) */
366         reference->composition = bytestream_get_byte(&buf);
367
368         reference->x = bytestream_get_be16(&buf);
369         reference->y = bytestream_get_be16(&buf);
370
371         /* TODO If cropping, cropping_x, cropping_y, cropping_width, cropping_height (all 2 bytes).*/
372         av_dlog(avctx, "Subtitle Placement ID=%d, x=%d, y=%d\n", reference->picture_id, reference->x, reference->y);
373
374         if (reference->x > avctx->width || reference->y > avctx->height) {
375             av_log(avctx, AV_LOG_ERROR, "Subtitle out of video bounds. x = %d, y = %d, video width = %d, video height = %d.\n",
376                    reference->x, reference->y, avctx->width, avctx->height);
377             reference->x = 0;
378             reference->y = 0;
379         }
380     }
381
382     return 0;
383 }
384
385 /**
386  * Parse the display segment packet.
387  *
388  * The display segment controls the updating of the display.
389  *
390  * @param avctx contains the current codec context
391  * @param data pointer to the data pertaining the subtitle to display
392  * @param buf pointer to the packet to process
393  * @param buf_size size of packet to process
394  * @todo TODO: Fix start time, relies on correct PTS, currently too late
395  *
396  * @todo TODO: Fix end time, normally cleared by a second display
397  * @todo       segment, which is currently ignored as it clears
398  * @todo       the subtitle too early.
399  */
400 static int display_end_segment(AVCodecContext *avctx, void *data,
401                                const uint8_t *buf, int buf_size)
402 {
403     AVSubtitle    *sub = data;
404     PGSSubContext *ctx = avctx->priv_data;
405     int64_t pts;
406
407     uint16_t rect;
408
409     /*
410      *      The end display time is a timeout value and is only reached
411      *      if the next subtitle is later than timeout or subtitle has
412      *      not been cleared by a subsequent empty display command.
413      */
414
415     pts = ctx->presentation.pts != AV_NOPTS_VALUE ? ctx->presentation.pts : sub->pts;
416     memset(sub, 0, sizeof(*sub));
417     sub->pts = pts;
418     ctx->presentation.pts = AV_NOPTS_VALUE;
419
420     // Blank if last object_count was 0.
421     if (!ctx->presentation.object_count)
422         return 1;
423
424     sub->start_display_time = 0;
425     sub->end_display_time   = 20000;
426     sub->format             = 0;
427
428     sub->num_rects = ctx->presentation.object_count;
429     sub->rects     = av_mallocz_array(sub->num_rects, sizeof(*sub->rects));
430
431     for (rect = 0; rect < sub->num_rects; ++rect) {
432         uint16_t picture_id    = ctx->presentation.objects[rect].picture_id;
433         sub->rects[rect]       = av_mallocz(sizeof(*sub->rects[rect]));
434         sub->rects[rect]->x    = ctx->presentation.objects[rect].x;
435         sub->rects[rect]->y    = ctx->presentation.objects[rect].y;
436         sub->rects[rect]->w    = ctx->pictures[picture_id].w;
437         sub->rects[rect]->h    = ctx->pictures[picture_id].h;
438         sub->rects[rect]->type = SUBTITLE_BITMAP;
439
440         /* Process bitmap */
441         sub->rects[rect]->pict.linesize[0] = ctx->pictures[picture_id].w;
442         if (ctx->pictures[picture_id].rle) {
443             if (ctx->pictures[picture_id].rle_remaining_len)
444                 av_log(avctx, AV_LOG_ERROR, "RLE data length %u is %u bytes shorter than expected\n",
445                        ctx->pictures[picture_id].rle_data_len, ctx->pictures[picture_id].rle_remaining_len);
446             if (decode_rle(avctx, sub->rects[rect], ctx->pictures[picture_id].rle, ctx->pictures[picture_id].rle_data_len) < 0)
447                 return 0;
448         }
449
450         /* Allocate memory for colors */
451         sub->rects[rect]->nb_colors    = 256;
452         sub->rects[rect]->pict.data[1] = av_mallocz(AVPALETTE_SIZE);
453
454         /* Copy the forced flag */
455         sub->rects[rect]->flags = (ctx->presentation.objects[rect].composition & 0x40) != 0 ? AV_SUBTITLE_FLAG_FORCED : 0;
456
457         if (!ctx->forced_subs_only || ctx->presentation.objects[rect].composition & 0x40)
458         memcpy(sub->rects[rect]->pict.data[1], ctx->clut, sub->rects[rect]->nb_colors * sizeof(uint32_t));
459     }
460
461     return 1;
462 }
463
464 static int decode(AVCodecContext *avctx, void *data, int *data_size,
465                   AVPacket *avpkt)
466 {
467     const uint8_t *buf = avpkt->data;
468     int buf_size       = avpkt->size;
469     AVSubtitle *sub    = data;
470
471     const uint8_t *buf_end;
472     uint8_t       segment_type;
473     int           segment_length;
474     int i, ret;
475
476     av_dlog(avctx, "PGS sub packet:\n");
477
478     for (i = 0; i < buf_size; i++) {
479         av_dlog(avctx, "%02x ", buf[i]);
480         if (i % 16 == 15)
481             av_dlog(avctx, "\n");
482     }
483
484     if (i & 15)
485         av_dlog(avctx, "\n");
486
487     *data_size = 0;
488
489     /* Ensure that we have received at a least a segment code and segment length */
490     if (buf_size < 3)
491         return -1;
492
493     buf_end = buf + buf_size;
494
495     /* Step through buffer to identify segments */
496     while (buf < buf_end) {
497         segment_type   = bytestream_get_byte(&buf);
498         segment_length = bytestream_get_be16(&buf);
499
500         av_dlog(avctx, "Segment Length %d, Segment Type %x\n", segment_length, segment_type);
501
502         if (segment_type != DISPLAY_SEGMENT && segment_length > buf_end - buf)
503             break;
504
505         ret = 0;
506         switch (segment_type) {
507         case PALETTE_SEGMENT:
508             ret = parse_palette_segment(avctx, buf, segment_length);
509             break;
510         case OBJECT_SEGMENT:
511             ret = parse_picture_segment(avctx, buf, segment_length);
512             break;
513         case PRESENTATION_SEGMENT:
514             ret = parse_presentation_segment(avctx, buf, segment_length, sub->pts);
515             break;
516         case WINDOW_SEGMENT:
517             /*
518              * Window Segment Structure (No new information provided):
519              *     2 bytes: Unknown,
520              *     2 bytes: X position of subtitle,
521              *     2 bytes: Y position of subtitle,
522              *     2 bytes: Width of subtitle,
523              *     2 bytes: Height of subtitle.
524              */
525             break;
526         case DISPLAY_SEGMENT:
527             ret = display_end_segment(avctx, data, buf, segment_length);
528             if (ret >= 0)
529                 *data_size = ret;
530             break;
531         default:
532             av_log(avctx, AV_LOG_ERROR, "Unknown subtitle segment type 0x%x, length %d\n",
533                    segment_type, segment_length);
534             ret = AVERROR_INVALIDDATA;
535             break;
536         }
537         if (ret < 0 && (avctx->err_recognition & AV_EF_EXPLODE))
538             return ret;
539
540         buf += segment_length;
541     }
542
543     return buf_size;
544 }
545
546 #define OFFSET(x) offsetof(PGSSubContext, x)
547 #define SD AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM
548 static const AVOption options[] = {
549     {"forced_subs_only", "Only show forced subtitles", OFFSET(forced_subs_only), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, SD},
550     { NULL },
551 };
552
553 static const AVClass pgsdec_class = {
554     .class_name = "PGS subtitle decoder",
555     .item_name  = av_default_item_name,
556     .option     = options,
557     .version    = LIBAVUTIL_VERSION_INT,
558 };
559
560 AVCodec ff_pgssub_decoder = {
561     .name           = "pgssub",
562     .long_name      = NULL_IF_CONFIG_SMALL("HDMV Presentation Graphic Stream subtitles"),
563     .type           = AVMEDIA_TYPE_SUBTITLE,
564     .id             = AV_CODEC_ID_HDMV_PGS_SUBTITLE,
565     .priv_data_size = sizeof(PGSSubContext),
566     .init           = init_decoder,
567     .close          = close_decoder,
568     .decode         = decode,
569     .priv_class     = &pgsdec_class,
570 };