Fail RLE decoding if insufficient data for a complete bitmap was decoded.
[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 "dsputil.h"
29 #include "bytestream.h"
30 #include "libavutil/colorspace.h"
31 #include "libavcore/imgutils.h"
32
33 //#define DEBUG_PACKET_CONTENTS
34
35 #define RGBA(r,g,b,a) (((a) << 24) | ((r) << 16) | ((g) << 8) | (b))
36
37 enum SegmentType {
38     PALETTE_SEGMENT      = 0x14,
39     PICTURE_SEGMENT      = 0x15,
40     PRESENTATION_SEGMENT = 0x16,
41     WINDOW_SEGMENT       = 0x17,
42     DISPLAY_SEGMENT      = 0x80,
43 };
44
45 typedef struct PGSSubPresentation {
46     int x;
47     int y;
48     int id_number;
49     int object_number;
50 } PGSSubPresentation;
51
52 typedef struct PGSSubPicture {
53     int          w;
54     int          h;
55     uint8_t      *rle;
56     unsigned int rle_buffer_size, rle_data_len;
57     unsigned int rle_remaining_len;
58 } PGSSubPicture;
59
60 typedef struct PGSSubContext {
61     PGSSubPresentation presentation;
62     uint32_t           clut[256];
63     PGSSubPicture      picture;
64 } PGSSubContext;
65
66 static av_cold int init_decoder(AVCodecContext *avctx)
67 {
68     avctx->pix_fmt = PIX_FMT_PAL8;
69
70     return 0;
71 }
72
73 static av_cold int close_decoder(AVCodecContext *avctx)
74 {
75     PGSSubContext *ctx = avctx->priv_data;
76
77     av_freep(&ctx->picture.rle);
78     ctx->picture.rle_buffer_size  = 0;
79
80     return 0;
81 }
82
83 /**
84  * Decode the RLE data.
85  *
86  * The subtitle is stored as an Run Length Encoded image.
87  *
88  * @param avctx contains the current codec context
89  * @param sub pointer to the processed subtitle data
90  * @param buf pointer to the RLE data to process
91  * @param buf_size size of the RLE data to process
92  */
93 static int decode_rle(AVCodecContext *avctx, AVSubtitle *sub,
94                       const uint8_t *buf, unsigned int buf_size)
95 {
96     const uint8_t *rle_bitmap_end;
97     int pixel_count, line_count;
98
99     rle_bitmap_end = buf + buf_size;
100
101     sub->rects[0]->pict.data[0] = av_malloc(sub->rects[0]->w * sub->rects[0]->h);
102
103     if (!sub->rects[0]->pict.data[0])
104         return -1;
105
106     pixel_count = 0;
107     line_count  = 0;
108
109     while (buf < rle_bitmap_end && line_count < sub->rects[0]->h) {
110         uint8_t flags, color;
111         int run;
112
113         color = bytestream_get_byte(&buf);
114         run   = 1;
115
116         if (color == 0x00) {
117             flags = bytestream_get_byte(&buf);
118             run   = flags & 0x3f;
119             if (flags & 0x40)
120                 run = (run << 8) + bytestream_get_byte(&buf);
121             color = flags & 0x80 ? bytestream_get_byte(&buf) : 0;
122         }
123
124         if (run > 0 && pixel_count + run <= sub->rects[0]->w * sub->rects[0]->h) {
125             memset(sub->rects[0]->pict.data[0] + pixel_count, color, run);
126             pixel_count += run;
127         } else if (!run) {
128             /*
129              * New Line. Check if correct pixels decoded, if not display warning
130              * and adjust bitmap pointer to correct new line position.
131              */
132             if (pixel_count % sub->rects[0]->w > 0)
133                 av_log(avctx, AV_LOG_ERROR, "Decoded %d pixels, when line should be %d pixels\n",
134                        pixel_count % sub->rects[0]->w, sub->rects[0]->w);
135             line_count++;
136         }
137     }
138
139     if (pixel_count < sub->rects[0]->w * sub->rects[0]->h) {
140         av_log(avctx, AV_LOG_ERROR, "Insufficient RLE data for subtitle\n");
141         return -1;
142     }
143
144     dprintf(avctx, "Pixel Count = %d, Area = %d\n", pixel_count, sub->rects[0]->w * sub->rects[0]->h);
145
146     return 0;
147 }
148
149 /**
150  * Parse the picture segment packet.
151  *
152  * The picture segment contains details on the sequence id,
153  * width, height and Run Length Encoded (RLE) bitmap data.
154  *
155  * @param avctx contains the current codec context
156  * @param buf pointer to the packet to process
157  * @param buf_size size of packet to process
158  * @todo TODO: Enable support for RLE data over multiple packets
159  */
160 static int parse_picture_segment(AVCodecContext *avctx,
161                                   const uint8_t *buf, int buf_size)
162 {
163     PGSSubContext *ctx = avctx->priv_data;
164
165     uint8_t sequence_desc;
166     unsigned int rle_bitmap_len, width, height;
167
168     if (buf_size <= 4)
169         return -1;
170     buf_size -= 4;
171
172     /* skip 3 unknown bytes: Object ID (2 bytes), Version Number */
173     buf += 3;
174
175     /* Read the Sequence Description to determine if start of RLE data or appended to previous RLE */
176     sequence_desc = bytestream_get_byte(&buf);
177
178     if (!(sequence_desc & 0x80)) {
179         /* Additional RLE data */
180         if (buf_size > ctx->picture.rle_remaining_len)
181             return -1;
182
183         memcpy(ctx->picture.rle + ctx->picture.rle_data_len, buf, buf_size);
184         ctx->picture.rle_data_len += buf_size;
185
186         return 0;
187     }
188
189     if (buf_size <= 7)
190         return -1;
191     buf_size -= 7;
192
193     /* Decode rle bitmap length, stored size includes width/height data */
194     rle_bitmap_len = bytestream_get_be24(&buf) - 2*2;
195
196     /* Get bitmap dimensions from data */
197     width  = bytestream_get_be16(&buf);
198     height = bytestream_get_be16(&buf);
199
200     /* Make sure the bitmap is not too large */
201     if (avctx->width < width || avctx->height < height) {
202         av_log(avctx, AV_LOG_ERROR, "Bitmap dimensions larger then video.\n");
203         return -1;
204     }
205
206     ctx->picture.w = width;
207     ctx->picture.h = height;
208
209     av_fast_malloc(&ctx->picture.rle, &ctx->picture.rle_buffer_size, rle_bitmap_len);
210
211     if (!ctx->picture.rle)
212         return -1;
213
214     memcpy(ctx->picture.rle, buf, buf_size);
215     ctx->picture.rle_data_len = buf_size;
216     ctx->picture.rle_remaining_len = rle_bitmap_len - buf_size;
217
218     return 0;
219 }
220
221 /**
222  * Parse the palette segment packet.
223  *
224  * The palette segment contains details of the palette,
225  * a maximum of 256 colors can be defined.
226  *
227  * @param avctx contains the current codec context
228  * @param buf pointer to the packet to process
229  * @param buf_size size of packet to process
230  */
231 static void parse_palette_segment(AVCodecContext *avctx,
232                                   const uint8_t *buf, int buf_size)
233 {
234     PGSSubContext *ctx = avctx->priv_data;
235
236     const uint8_t *buf_end = buf + buf_size;
237     const uint8_t *cm      = ff_cropTbl + MAX_NEG_CROP;
238     int color_id;
239     int y, cb, cr, alpha;
240     int r, g, b, r_add, g_add, b_add;
241
242     /* Skip two null bytes */
243     buf += 2;
244
245     while (buf < buf_end) {
246         color_id  = bytestream_get_byte(&buf);
247         y         = bytestream_get_byte(&buf);
248         cb        = bytestream_get_byte(&buf);
249         cr        = bytestream_get_byte(&buf);
250         alpha     = bytestream_get_byte(&buf);
251
252         YUV_TO_RGB1(cb, cr);
253         YUV_TO_RGB2(r, g, b, y);
254
255         dprintf(avctx, "Color %d := (%d,%d,%d,%d)\n", color_id, r, g, b, alpha);
256
257         /* Store color in palette */
258         ctx->clut[color_id] = RGBA(r,g,b,alpha);
259     }
260 }
261
262 /**
263  * Parse the presentation segment packet.
264  *
265  * The presentation segment contains details on the video
266  * width, video height, x & y subtitle position.
267  *
268  * @param avctx contains the current codec context
269  * @param buf pointer to the packet to process
270  * @param buf_size size of packet to process
271  * @todo TODO: Implement cropping
272  * @todo TODO: Implement forcing of subtitles
273  */
274 static void parse_presentation_segment(AVCodecContext *avctx,
275                                        const uint8_t *buf, int buf_size)
276 {
277     PGSSubContext *ctx = avctx->priv_data;
278
279     int x, y;
280
281     int w = bytestream_get_be16(&buf);
282     int h = bytestream_get_be16(&buf);
283
284     dprintf(avctx, "Video Dimensions %dx%d\n",
285             w, h);
286     if (av_image_check_size(w, h, 0, avctx) >= 0)
287         avcodec_set_dimensions(avctx, w, h);
288
289     /* Skip 1 bytes of unknown, frame rate? */
290     buf++;
291
292     ctx->presentation.id_number = bytestream_get_be16(&buf);
293
294     /*
295      * Skip 3 bytes of unknown:
296      *     state
297      *     palette_update_flag (0x80),
298      *     palette_id_to_use,
299      */
300     buf += 3;
301
302     ctx->presentation.object_number = bytestream_get_byte(&buf);
303     if (!ctx->presentation.object_number)
304         return;
305
306     /*
307      * Skip 4 bytes of unknown:
308      *     object_id_ref (2 bytes),
309      *     window_id_ref,
310      *     composition_flag (0x80 - object cropped, 0x40 - object forced)
311      */
312     buf += 4;
313
314     x = bytestream_get_be16(&buf);
315     y = bytestream_get_be16(&buf);
316
317     /* TODO If cropping, cropping_x, cropping_y, cropping_width, cropping_height (all 2 bytes).*/
318
319     dprintf(avctx, "Subtitle Placement x=%d, y=%d\n", x, y);
320
321     if (x > avctx->width || y > avctx->height) {
322         av_log(avctx, AV_LOG_ERROR, "Subtitle out of video bounds. x = %d, y = %d, video width = %d, video height = %d.\n",
323                x, y, avctx->width, avctx->height);
324         x = 0; y = 0;
325     }
326
327     /* Fill in dimensions */
328     ctx->presentation.x = x;
329     ctx->presentation.y = y;
330 }
331
332 /**
333  * Parse the display segment packet.
334  *
335  * The display segment controls the updating of the display.
336  *
337  * @param avctx contains the current codec context
338  * @param data pointer to the data pertaining the subtitle to display
339  * @param buf pointer to the packet to process
340  * @param buf_size size of packet to process
341  * @todo TODO: Fix start time, relies on correct PTS, currently too late
342  *
343  * @todo TODO: Fix end time, normally cleared by a second display
344  * @todo       segment, which is currently ignored as it clears
345  * @todo       the subtitle too early.
346  */
347 static int display_end_segment(AVCodecContext *avctx, void *data,
348                                const uint8_t *buf, int buf_size)
349 {
350     AVSubtitle    *sub = data;
351     PGSSubContext *ctx = avctx->priv_data;
352
353     /*
354      *      The end display time is a timeout value and is only reached
355      *      if the next subtitle is later then timeout or subtitle has
356      *      not been cleared by a subsequent empty display command.
357      */
358
359     memset(sub, 0, sizeof(*sub));
360     // Blank if last object_number was 0.
361     // Note that this may be wrong for more complex subtitles.
362     if (!ctx->presentation.object_number)
363         return 1;
364     sub->start_display_time = 0;
365     sub->end_display_time   = 20000;
366     sub->format             = 0;
367
368     sub->rects     = av_mallocz(sizeof(*sub->rects));
369     sub->rects[0]  = av_mallocz(sizeof(*sub->rects[0]));
370     sub->num_rects = 1;
371
372     sub->rects[0]->x    = ctx->presentation.x;
373     sub->rects[0]->y    = ctx->presentation.y;
374     sub->rects[0]->w    = ctx->picture.w;
375     sub->rects[0]->h    = ctx->picture.h;
376     sub->rects[0]->type = SUBTITLE_BITMAP;
377
378     /* Process bitmap */
379     sub->rects[0]->pict.linesize[0] = ctx->picture.w;
380
381     if (ctx->picture.rle) {
382         if (ctx->picture.rle_remaining_len)
383             av_log(avctx, AV_LOG_ERROR, "RLE data length %u is %u bytes shorter than expected\n",
384                    ctx->picture.rle_data_len, ctx->picture.rle_remaining_len);
385         if(decode_rle(avctx, sub, ctx->picture.rle, ctx->picture.rle_data_len) < 0)
386             return 0;
387     }
388     /* Allocate memory for colors */
389     sub->rects[0]->nb_colors    = 256;
390     sub->rects[0]->pict.data[1] = av_mallocz(AVPALETTE_SIZE);
391
392     memcpy(sub->rects[0]->pict.data[1], ctx->clut, sub->rects[0]->nb_colors * sizeof(uint32_t));
393
394     return 1;
395 }
396
397 static int decode(AVCodecContext *avctx, void *data, int *data_size,
398                   AVPacket *avpkt)
399 {
400     const uint8_t *buf = avpkt->data;
401     int buf_size       = avpkt->size;
402
403     const uint8_t *buf_end;
404     uint8_t       segment_type;
405     int           segment_length;
406
407 #ifdef DEBUG_PACKET_CONTENTS
408     int i;
409
410     av_log(avctx, AV_LOG_INFO, "PGS sub packet:\n");
411
412     for (i = 0; i < buf_size; i++) {
413         av_log(avctx, AV_LOG_INFO, "%02x ", buf[i]);
414         if (i % 16 == 15)
415             av_log(avctx, AV_LOG_INFO, "\n");
416     }
417
418     if (i & 15)
419         av_log(avctx, AV_LOG_INFO, "\n");
420 #endif
421
422     *data_size = 0;
423
424     /* Ensure that we have received at a least a segment code and segment length */
425     if (buf_size < 3)
426         return -1;
427
428     buf_end = buf + buf_size;
429
430     /* Step through buffer to identify segments */
431     while (buf < buf_end) {
432         segment_type   = bytestream_get_byte(&buf);
433         segment_length = bytestream_get_be16(&buf);
434
435         dprintf(avctx, "Segment Length %d, Segment Type %x\n", segment_length, segment_type);
436
437         if (segment_type != DISPLAY_SEGMENT && segment_length > buf_end - buf)
438             break;
439
440         switch (segment_type) {
441         case PALETTE_SEGMENT:
442             parse_palette_segment(avctx, buf, segment_length);
443             break;
444         case PICTURE_SEGMENT:
445             parse_picture_segment(avctx, buf, segment_length);
446             break;
447         case PRESENTATION_SEGMENT:
448             parse_presentation_segment(avctx, buf, segment_length);
449             break;
450         case WINDOW_SEGMENT:
451             /*
452              * Window Segment Structure (No new information provided):
453              *     2 bytes: Unkown,
454              *     2 bytes: X position of subtitle,
455              *     2 bytes: Y position of subtitle,
456              *     2 bytes: Width of subtitle,
457              *     2 bytes: Height of subtitle.
458              */
459             break;
460         case DISPLAY_SEGMENT:
461             *data_size = display_end_segment(avctx, data, buf, segment_length);
462             break;
463         default:
464             av_log(avctx, AV_LOG_ERROR, "Unknown subtitle segment type 0x%x, length %d\n",
465                    segment_type, segment_length);
466             break;
467         }
468
469         buf += segment_length;
470     }
471
472     return buf_size;
473 }
474
475 AVCodec pgssub_decoder = {
476     "pgssub",
477     AVMEDIA_TYPE_SUBTITLE,
478     CODEC_ID_HDMV_PGS_SUBTITLE,
479     sizeof(PGSSubContext),
480     init_decoder,
481     NULL,
482     close_decoder,
483     decode,
484     .long_name = NULL_IF_CONFIG_SMALL("HDMV Presentation Graphic Stream subtitles"),
485 };