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