Line | Branch | Exec | Source |
---|---|---|---|
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 "codec_internal.h" | ||
30 | #include "decode.h" | ||
31 | #include "mathops.h" | ||
32 | |||
33 | #include "libavutil/colorspace.h" | ||
34 | #include "libavutil/opt.h" | ||
35 | |||
36 | #define RGBA(r,g,b,a) (((unsigned)(a) << 24) | ((r) << 16) | ((g) << 8) | (b)) | ||
37 | #define MAX_EPOCH_PALETTES 8 // Max 8 allowed per PGS epoch | ||
38 | #define MAX_EPOCH_OBJECTS 64 // Max 64 allowed per PGS epoch | ||
39 | #define MAX_OBJECT_REFS 2 // Max objects per display set | ||
40 | |||
41 | enum SegmentType { | ||
42 | PALETTE_SEGMENT = 0x14, | ||
43 | OBJECT_SEGMENT = 0x15, | ||
44 | PRESENTATION_SEGMENT = 0x16, | ||
45 | WINDOW_SEGMENT = 0x17, | ||
46 | DISPLAY_SEGMENT = 0x80, | ||
47 | }; | ||
48 | |||
49 | typedef struct PGSSubObjectRef { | ||
50 | int id; | ||
51 | int window_id; | ||
52 | uint8_t composition_flag; | ||
53 | int x; | ||
54 | int y; | ||
55 | int crop_x; | ||
56 | int crop_y; | ||
57 | int crop_w; | ||
58 | int crop_h; | ||
59 | } PGSSubObjectRef; | ||
60 | |||
61 | typedef struct PGSSubPresentation { | ||
62 | int id_number; | ||
63 | int palette_id; | ||
64 | int object_count; | ||
65 | PGSSubObjectRef objects[MAX_OBJECT_REFS]; | ||
66 | int64_t pts; | ||
67 | } PGSSubPresentation; | ||
68 | |||
69 | typedef struct PGSSubObject { | ||
70 | int id; | ||
71 | int w; | ||
72 | int h; | ||
73 | uint8_t *rle; | ||
74 | unsigned int rle_buffer_size, rle_data_len; | ||
75 | unsigned int rle_remaining_len; | ||
76 | } PGSSubObject; | ||
77 | |||
78 | typedef struct PGSSubObjects { | ||
79 | int count; | ||
80 | PGSSubObject object[MAX_EPOCH_OBJECTS]; | ||
81 | } PGSSubObjects; | ||
82 | |||
83 | typedef struct PGSSubPalette { | ||
84 | int id; | ||
85 | uint32_t clut[256]; | ||
86 | } PGSSubPalette; | ||
87 | |||
88 | typedef struct PGSSubPalettes { | ||
89 | int count; | ||
90 | PGSSubPalette palette[MAX_EPOCH_PALETTES]; | ||
91 | } PGSSubPalettes; | ||
92 | |||
93 | typedef struct PGSSubContext { | ||
94 | AVClass *class; | ||
95 | PGSSubPresentation presentation; | ||
96 | PGSSubPalettes palettes; | ||
97 | PGSSubObjects objects; | ||
98 | int forced_subs_only; | ||
99 | } PGSSubContext; | ||
100 | |||
101 | 17 | static void flush_cache(AVCodecContext *avctx) | |
102 | { | ||
103 | 17 | PGSSubContext *ctx = avctx->priv_data; | |
104 | int i; | ||
105 | |||
106 |
2/2✓ Branch 0 taken 7 times.
✓ Branch 1 taken 17 times.
|
24 | for (i = 0; i < ctx->objects.count; i++) { |
107 | 7 | av_freep(&ctx->objects.object[i].rle); | |
108 | 7 | ctx->objects.object[i].rle_buffer_size = 0; | |
109 | 7 | ctx->objects.object[i].rle_remaining_len = 0; | |
110 | } | ||
111 | 17 | ctx->objects.count = 0; | |
112 | 17 | ctx->palettes.count = 0; | |
113 | 17 | } | |
114 | |||
115 | 13 | static PGSSubObject * find_object(int id, PGSSubObjects *objects) | |
116 | { | ||
117 | int i; | ||
118 | |||
119 |
2/2✓ Branch 0 taken 12 times.
✓ Branch 1 taken 7 times.
|
19 | for (i = 0; i < objects->count; i++) { |
120 |
2/2✓ Branch 0 taken 6 times.
✓ Branch 1 taken 6 times.
|
12 | if (objects->object[i].id == id) |
121 | 6 | return &objects->object[i]; | |
122 | } | ||
123 | 7 | return NULL; | |
124 | } | ||
125 | |||
126 | 7 | static PGSSubPalette * find_palette(int id, PGSSubPalettes *palettes) | |
127 | { | ||
128 | int i; | ||
129 | |||
130 |
2/2✓ Branch 0 taken 3 times.
✓ Branch 1 taken 4 times.
|
7 | for (i = 0; i < palettes->count; i++) { |
131 |
1/2✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
|
3 | if (palettes->palette[i].id == id) |
132 | 3 | return &palettes->palette[i]; | |
133 | } | ||
134 | 4 | return NULL; | |
135 | } | ||
136 | |||
137 | 8 | static av_cold int init_decoder(AVCodecContext *avctx) | |
138 | { | ||
139 | 8 | avctx->pix_fmt = AV_PIX_FMT_PAL8; | |
140 | |||
141 | 8 | return 0; | |
142 | } | ||
143 | |||
144 | 8 | static av_cold int close_decoder(AVCodecContext *avctx) | |
145 | { | ||
146 | 8 | flush_cache(avctx); | |
147 | |||
148 | 8 | return 0; | |
149 | } | ||
150 | |||
151 | /** | ||
152 | * Decode the RLE data. | ||
153 | * | ||
154 | * The subtitle is stored as a Run Length Encoded image. | ||
155 | * | ||
156 | * @param avctx contains the current codec context | ||
157 | * @param sub pointer to the processed subtitle data | ||
158 | * @param buf pointer to the RLE data to process | ||
159 | * @param buf_size size of the RLE data to process | ||
160 | */ | ||
161 | 6 | static int decode_rle(AVCodecContext *avctx, AVSubtitleRect *rect, | |
162 | const uint8_t *buf, unsigned int buf_size) | ||
163 | { | ||
164 | const uint8_t *rle_bitmap_end; | ||
165 | int pixel_count, line_count; | ||
166 | |||
167 | 6 | rle_bitmap_end = buf + buf_size; | |
168 | |||
169 | 6 | rect->data[0] = av_malloc_array(rect->w, rect->h); | |
170 | |||
171 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
|
6 | if (!rect->data[0]) |
172 | ✗ | return AVERROR(ENOMEM); | |
173 | |||
174 | 6 | pixel_count = 0; | |
175 | 6 | line_count = 0; | |
176 | |||
177 |
3/4✓ Branch 0 taken 47181 times.
✓ Branch 1 taken 6 times.
✓ Branch 2 taken 47181 times.
✗ Branch 3 not taken.
|
47187 | while (buf < rle_bitmap_end && line_count < rect->h) { |
178 | uint8_t flags, color; | ||
179 | int run; | ||
180 | |||
181 | 47181 | color = bytestream_get_byte(&buf); | |
182 | 47181 | run = 1; | |
183 | |||
184 |
2/2✓ Branch 0 taken 17154 times.
✓ Branch 1 taken 30027 times.
|
47181 | if (color == 0x00) { |
185 | 17154 | flags = bytestream_get_byte(&buf); | |
186 | 17154 | run = flags & 0x3f; | |
187 |
2/2✓ Branch 0 taken 762 times.
✓ Branch 1 taken 16392 times.
|
17154 | if (flags & 0x40) |
188 | 762 | run = (run << 8) + bytestream_get_byte(&buf); | |
189 |
2/2✓ Branch 0 taken 12555 times.
✓ Branch 1 taken 4599 times.
|
17154 | color = flags & 0x80 ? bytestream_get_byte(&buf) : 0; |
190 | } | ||
191 | |||
192 |
3/4✓ Branch 0 taken 46791 times.
✓ Branch 1 taken 390 times.
✓ Branch 2 taken 46791 times.
✗ Branch 3 not taken.
|
47181 | if (run > 0 && pixel_count + run <= rect->w * rect->h) { |
193 | 46791 | memset(rect->data[0] + pixel_count, color, run); | |
194 | 46791 | pixel_count += run; | |
195 |
1/2✓ Branch 0 taken 390 times.
✗ Branch 1 not taken.
|
390 | } else if (!run) { |
196 | /* | ||
197 | * New Line. Check if correct pixels decoded, if not display warning | ||
198 | * and adjust bitmap pointer to correct new line position. | ||
199 | */ | ||
200 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 390 times.
|
390 | if (pixel_count % rect->w > 0) { |
201 | ✗ | av_log(avctx, AV_LOG_ERROR, "Decoded %d pixels, when line should be %d pixels\n", | |
202 | ✗ | pixel_count % rect->w, rect->w); | |
203 | ✗ | if (avctx->err_recognition & AV_EF_EXPLODE) { | |
204 | ✗ | return AVERROR_INVALIDDATA; | |
205 | } | ||
206 | } | ||
207 | 390 | line_count++; | |
208 | } | ||
209 | } | ||
210 | |||
211 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
|
6 | if (pixel_count < rect->w * rect->h) { |
212 | ✗ | av_log(avctx, AV_LOG_ERROR, "Insufficient RLE data for subtitle\n"); | |
213 | ✗ | return AVERROR_INVALIDDATA; | |
214 | } | ||
215 | |||
216 | ff_dlog(avctx, "Pixel Count = %d, Area = %d\n", pixel_count, rect->w * rect->h); | ||
217 | |||
218 | 6 | return 0; | |
219 | } | ||
220 | |||
221 | /** | ||
222 | * Parse the picture segment packet. | ||
223 | * | ||
224 | * The picture segment contains details on the sequence id, | ||
225 | * width, height and Run Length Encoded (RLE) bitmap data. | ||
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 | 7 | static int parse_object_segment(AVCodecContext *avctx, | |
232 | const uint8_t *buf, int buf_size) | ||
233 | { | ||
234 | 7 | PGSSubContext *ctx = avctx->priv_data; | |
235 | PGSSubObject *object; | ||
236 | |||
237 | uint8_t sequence_desc; | ||
238 | unsigned int rle_bitmap_len, width, height; | ||
239 | int id; | ||
240 | |||
241 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
|
7 | if (buf_size <= 4) |
242 | ✗ | return AVERROR_INVALIDDATA; | |
243 | 7 | buf_size -= 4; | |
244 | |||
245 | 7 | id = bytestream_get_be16(&buf); | |
246 | 7 | object = find_object(id, &ctx->objects); | |
247 |
1/2✓ Branch 0 taken 7 times.
✗ Branch 1 not taken.
|
7 | if (!object) { |
248 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
|
7 | if (ctx->objects.count >= MAX_EPOCH_OBJECTS) { |
249 | ✗ | av_log(avctx, AV_LOG_ERROR, "Too many objects in epoch\n"); | |
250 | ✗ | return AVERROR_INVALIDDATA; | |
251 | } | ||
252 | 7 | object = &ctx->objects.object[ctx->objects.count++]; | |
253 | 7 | object->id = id; | |
254 | } | ||
255 | |||
256 | /* skip object version number */ | ||
257 | 7 | buf += 1; | |
258 | |||
259 | /* Read the Sequence Description to determine if start of RLE data or appended to previous RLE */ | ||
260 | 7 | sequence_desc = bytestream_get_byte(&buf); | |
261 | |||
262 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
|
7 | if (!(sequence_desc & 0x80)) { |
263 | /* Additional RLE data */ | ||
264 | ✗ | if (buf_size > object->rle_remaining_len) | |
265 | ✗ | return AVERROR_INVALIDDATA; | |
266 | |||
267 | ✗ | memcpy(object->rle + object->rle_data_len, buf, buf_size); | |
268 | ✗ | object->rle_data_len += buf_size; | |
269 | ✗ | object->rle_remaining_len -= buf_size; | |
270 | |||
271 | ✗ | return 0; | |
272 | } | ||
273 | |||
274 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
|
7 | if (buf_size <= 7) |
275 | ✗ | return AVERROR_INVALIDDATA; | |
276 | 7 | buf_size -= 7; | |
277 | |||
278 | /* Decode rle bitmap length, stored size includes width/height data */ | ||
279 | 7 | rle_bitmap_len = bytestream_get_be24(&buf) - 2*2; | |
280 | |||
281 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
|
7 | if (buf_size > rle_bitmap_len) { |
282 | ✗ | av_log(avctx, AV_LOG_ERROR, | |
283 | "Buffer dimension %d larger than the expected RLE data %d\n", | ||
284 | buf_size, rle_bitmap_len); | ||
285 | ✗ | return AVERROR_INVALIDDATA; | |
286 | } | ||
287 | |||
288 | /* Get bitmap dimensions from data */ | ||
289 | 7 | width = bytestream_get_be16(&buf); | |
290 | 7 | height = bytestream_get_be16(&buf); | |
291 | |||
292 | /* Make sure the bitmap is not too large */ | ||
293 |
4/8✓ Branch 0 taken 7 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 7 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 7 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 7 times.
|
7 | if (avctx->width < width || avctx->height < height || !width || !height) { |
294 | ✗ | av_log(avctx, AV_LOG_ERROR, "Bitmap dimensions (%dx%d) invalid.\n", width, height); | |
295 | ✗ | return AVERROR_INVALIDDATA; | |
296 | } | ||
297 | |||
298 | 7 | object->w = width; | |
299 | 7 | object->h = height; | |
300 | |||
301 | 7 | av_fast_padded_malloc(&object->rle, &object->rle_buffer_size, rle_bitmap_len); | |
302 | |||
303 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 7 times.
|
7 | if (!object->rle) { |
304 | ✗ | object->rle_data_len = 0; | |
305 | ✗ | object->rle_remaining_len = 0; | |
306 | ✗ | return AVERROR(ENOMEM); | |
307 | } | ||
308 | |||
309 | 7 | memcpy(object->rle, buf, buf_size); | |
310 | 7 | object->rle_data_len = buf_size; | |
311 | 7 | object->rle_remaining_len = rle_bitmap_len - buf_size; | |
312 | |||
313 | 7 | return 0; | |
314 | } | ||
315 | |||
316 | /** | ||
317 | * Parse the palette segment packet. | ||
318 | * | ||
319 | * The palette segment contains details of the palette, | ||
320 | * a maximum of 256 colors can be defined. | ||
321 | * | ||
322 | * @param avctx contains the current codec context | ||
323 | * @param buf pointer to the packet to process | ||
324 | * @param buf_size size of packet to process | ||
325 | */ | ||
326 | 4 | static int parse_palette_segment(AVCodecContext *avctx, | |
327 | const uint8_t *buf, int buf_size) | ||
328 | { | ||
329 | 4 | PGSSubContext *ctx = avctx->priv_data; | |
330 | PGSSubPalette *palette; | ||
331 | |||
332 | 4 | const uint8_t *buf_end = buf + buf_size; | |
333 | 4 | const uint8_t *cm = ff_crop_tab + MAX_NEG_CROP; | |
334 | int color_id; | ||
335 | int y, cb, cr, alpha; | ||
336 | int r, g, b, r_add, g_add, b_add; | ||
337 | int id; | ||
338 | |||
339 | 4 | id = bytestream_get_byte(&buf); | |
340 | 4 | palette = find_palette(id, &ctx->palettes); | |
341 |
1/2✓ Branch 0 taken 4 times.
✗ Branch 1 not taken.
|
4 | if (!palette) { |
342 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
|
4 | if (ctx->palettes.count >= MAX_EPOCH_PALETTES) { |
343 | ✗ | av_log(avctx, AV_LOG_ERROR, "Too many palettes in epoch\n"); | |
344 | ✗ | return AVERROR_INVALIDDATA; | |
345 | } | ||
346 | 4 | palette = &ctx->palettes.palette[ctx->palettes.count++]; | |
347 | 4 | palette->id = id; | |
348 | } | ||
349 | |||
350 | /* Skip palette version */ | ||
351 | 4 | buf += 1; | |
352 | |||
353 |
2/2✓ Branch 0 taken 124 times.
✓ Branch 1 taken 4 times.
|
128 | while (buf < buf_end) { |
354 | 124 | color_id = bytestream_get_byte(&buf); | |
355 | 124 | y = bytestream_get_byte(&buf); | |
356 | 124 | cr = bytestream_get_byte(&buf); | |
357 | 124 | cb = bytestream_get_byte(&buf); | |
358 | 124 | alpha = bytestream_get_byte(&buf); | |
359 | |||
360 | /* Default to BT.709 colorspace. In case of <= 576 height use BT.601 */ | ||
361 |
2/4✓ Branch 0 taken 124 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 124 times.
✗ Branch 3 not taken.
|
124 | if (avctx->height <= 0 || avctx->height > 576) { |
362 | 124 | YUV_TO_RGB1_CCIR_BT709(cb, cr); | |
363 | } else { | ||
364 | ✗ | YUV_TO_RGB1_CCIR(cb, cr); | |
365 | } | ||
366 | |||
367 | 124 | YUV_TO_RGB2_CCIR(r, g, b, y); | |
368 | |||
369 | ff_dlog(avctx, "Color %d := (%d,%d,%d,%d)\n", color_id, r, g, b, alpha); | ||
370 | |||
371 | /* Store color in palette */ | ||
372 | 124 | palette->clut[color_id] = RGBA(r,g,b,alpha); | |
373 | } | ||
374 | 4 | return 0; | |
375 | } | ||
376 | |||
377 | /** | ||
378 | * Parse the presentation segment packet. | ||
379 | * | ||
380 | * The presentation segment contains details on the video | ||
381 | * width, video height, x & y subtitle position. | ||
382 | * | ||
383 | * @param avctx contains the current codec context | ||
384 | * @param buf pointer to the packet to process | ||
385 | * @param buf_size size of packet to process | ||
386 | * @todo TODO: Implement cropping | ||
387 | */ | ||
388 | 9 | static int parse_presentation_segment(AVCodecContext *avctx, | |
389 | const uint8_t *buf, int buf_size, | ||
390 | int64_t pts) | ||
391 | { | ||
392 | 9 | PGSSubContext *ctx = avctx->priv_data; | |
393 | int i, state, ret; | ||
394 | 9 | const uint8_t *buf_end = buf + buf_size; | |
395 | |||
396 | // Video descriptor | ||
397 | 9 | int w = bytestream_get_be16(&buf); | |
398 | 9 | int h = bytestream_get_be16(&buf); | |
399 | |||
400 | 9 | ctx->presentation.pts = pts; | |
401 | |||
402 | ff_dlog(avctx, "Video Dimensions %dx%d\n", | ||
403 | w, h); | ||
404 | 9 | ret = ff_set_dimensions(avctx, w, h); | |
405 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 9 times.
|
9 | if (ret < 0) |
406 | ✗ | return ret; | |
407 | |||
408 | /* Skip 1 bytes of unknown, frame rate */ | ||
409 | 9 | buf++; | |
410 | |||
411 | // Composition descriptor | ||
412 | 9 | ctx->presentation.id_number = bytestream_get_be16(&buf); | |
413 | /* | ||
414 | * state is a 2 bit field that defines pgs epoch boundaries | ||
415 | * 00 - Normal, previously defined objects and palettes are still valid | ||
416 | * 01 - Acquisition point, previous objects and palettes can be released | ||
417 | * 10 - Epoch start, previous objects and palettes can be released | ||
418 | * 11 - Epoch continue, previous objects and palettes can be released | ||
419 | * | ||
420 | * reserved 6 bits discarded | ||
421 | */ | ||
422 | 9 | state = bytestream_get_byte(&buf) >> 6; | |
423 |
1/2✓ Branch 0 taken 9 times.
✗ Branch 1 not taken.
|
9 | if (state != 0) { |
424 | 9 | flush_cache(avctx); | |
425 | } | ||
426 | |||
427 | /* | ||
428 | * skip palette_update_flag (0x80), | ||
429 | */ | ||
430 | 9 | buf += 1; | |
431 | 9 | ctx->presentation.palette_id = bytestream_get_byte(&buf); | |
432 | 9 | ctx->presentation.object_count = bytestream_get_byte(&buf); | |
433 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 9 times.
|
9 | if (ctx->presentation.object_count > MAX_OBJECT_REFS) { |
434 | ✗ | av_log(avctx, AV_LOG_ERROR, | |
435 | "Invalid number of presentation objects %d\n", | ||
436 | ctx->presentation.object_count); | ||
437 | ✗ | ctx->presentation.object_count = 2; | |
438 | ✗ | if (avctx->err_recognition & AV_EF_EXPLODE) { | |
439 | ✗ | return AVERROR_INVALIDDATA; | |
440 | } | ||
441 | } | ||
442 | |||
443 | |||
444 |
2/2✓ Branch 0 taken 18 times.
✓ Branch 1 taken 9 times.
|
27 | for (i = 0; i < ctx->presentation.object_count; i++) |
445 | { | ||
446 | 18 | PGSSubObjectRef *const object = &ctx->presentation.objects[i]; | |
447 | |||
448 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 18 times.
|
18 | if (buf_end - buf < 8) { |
449 | ✗ | av_log(avctx, AV_LOG_ERROR, "Insufficent space for object\n"); | |
450 | ✗ | ctx->presentation.object_count = i; | |
451 | ✗ | return AVERROR_INVALIDDATA; | |
452 | } | ||
453 | |||
454 | 18 | object->id = bytestream_get_be16(&buf); | |
455 | 18 | object->window_id = bytestream_get_byte(&buf); | |
456 | 18 | object->composition_flag = bytestream_get_byte(&buf); | |
457 | |||
458 | 18 | object->x = bytestream_get_be16(&buf); | |
459 | 18 | object->y = bytestream_get_be16(&buf); | |
460 | |||
461 | // If cropping | ||
462 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 18 times.
|
18 | if (object->composition_flag & 0x80) { |
463 | ✗ | object->crop_x = bytestream_get_be16(&buf); | |
464 | ✗ | object->crop_y = bytestream_get_be16(&buf); | |
465 | ✗ | object->crop_w = bytestream_get_be16(&buf); | |
466 | ✗ | object->crop_h = bytestream_get_be16(&buf); | |
467 | } | ||
468 | |||
469 | ff_dlog(avctx, "Subtitle Placement x=%d, y=%d\n", | ||
470 | object->x, object->y); | ||
471 | |||
472 |
2/4✓ Branch 0 taken 18 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 18 times.
|
18 | if (object->x > avctx->width || object->y > avctx->height) { |
473 | ✗ | av_log(avctx, AV_LOG_ERROR, "Subtitle out of video bounds. x = %d, y = %d, video width = %d, video height = %d.\n", | |
474 | object->x, object->y, | ||
475 | avctx->width, avctx->height); | ||
476 | ✗ | object->y = object->x = 0; | |
477 | ✗ | if (avctx->err_recognition & AV_EF_EXPLODE) { | |
478 | ✗ | return AVERROR_INVALIDDATA; | |
479 | } | ||
480 | } | ||
481 | } | ||
482 | |||
483 | 9 | return 0; | |
484 | } | ||
485 | |||
486 | /** | ||
487 | * Parse the display segment packet. | ||
488 | * | ||
489 | * The display segment controls the updating of the display. | ||
490 | * | ||
491 | * @param avctx contains the current codec context | ||
492 | * @param data pointer to the data pertaining the subtitle to display | ||
493 | * @param buf pointer to the packet to process | ||
494 | * @param buf_size size of packet to process | ||
495 | */ | ||
496 | 3 | static int display_end_segment(AVCodecContext *avctx, AVSubtitle *sub, | |
497 | const uint8_t *buf, int buf_size) | ||
498 | { | ||
499 | 3 | PGSSubContext *ctx = avctx->priv_data; | |
500 | int64_t pts; | ||
501 | PGSSubPalette *palette; | ||
502 | int i, ret; | ||
503 | |||
504 |
1/2✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
|
3 | pts = ctx->presentation.pts != AV_NOPTS_VALUE ? ctx->presentation.pts : sub->pts; |
505 | 3 | memset(sub, 0, sizeof(*sub)); | |
506 | 3 | sub->pts = pts; | |
507 | 3 | ctx->presentation.pts = AV_NOPTS_VALUE; | |
508 | 3 | sub->start_display_time = 0; | |
509 | // There is no explicit end time for PGS subtitles. The end time | ||
510 | // is defined by the start of the next sub which may contain no | ||
511 | // objects (i.e. clears the previous sub) | ||
512 | 3 | sub->end_display_time = UINT32_MAX; | |
513 | 3 | sub->format = 0; | |
514 | |||
515 | // Blank if last object_count was 0. | ||
516 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
|
3 | if (!ctx->presentation.object_count) |
517 | ✗ | return 1; | |
518 | 3 | sub->rects = av_calloc(ctx->presentation.object_count, sizeof(*sub->rects)); | |
519 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
|
3 | if (!sub->rects) { |
520 | ✗ | return AVERROR(ENOMEM); | |
521 | } | ||
522 | 3 | palette = find_palette(ctx->presentation.palette_id, &ctx->palettes); | |
523 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
|
3 | if (!palette) { |
524 | // Missing palette. Should only happen with damaged streams. | ||
525 | ✗ | av_log(avctx, AV_LOG_ERROR, "Invalid palette id %d\n", | |
526 | ctx->presentation.palette_id); | ||
527 | ✗ | avsubtitle_free(sub); | |
528 | ✗ | return AVERROR_INVALIDDATA; | |
529 | } | ||
530 |
2/2✓ Branch 0 taken 6 times.
✓ Branch 1 taken 3 times.
|
9 | for (i = 0; i < ctx->presentation.object_count; i++) { |
531 | 6 | AVSubtitleRect *const rect = av_mallocz(sizeof(*rect)); | |
532 | PGSSubObject *object; | ||
533 | |||
534 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
|
6 | if (!rect) |
535 | ✗ | return AVERROR(ENOMEM); | |
536 | 6 | sub->rects[sub->num_rects++] = rect; | |
537 | 6 | rect->type = SUBTITLE_BITMAP; | |
538 | |||
539 | /* Process bitmap */ | ||
540 | 6 | object = find_object(ctx->presentation.objects[i].id, &ctx->objects); | |
541 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
|
6 | if (!object) { |
542 | // Missing object. Should only happen with damaged streams. | ||
543 | ✗ | av_log(avctx, AV_LOG_ERROR, "Invalid object id %d\n", | |
544 | ctx->presentation.objects[i].id); | ||
545 | ✗ | if (avctx->err_recognition & AV_EF_EXPLODE) | |
546 | ✗ | return AVERROR_INVALIDDATA; | |
547 | // Leaves rect empty with 0 width and height. | ||
548 | ✗ | continue; | |
549 | } | ||
550 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
|
6 | if (ctx->presentation.objects[i].composition_flag & 0x40) |
551 | ✗ | rect->flags |= AV_SUBTITLE_FLAG_FORCED; | |
552 | |||
553 | 6 | rect->x = ctx->presentation.objects[i].x; | |
554 | 6 | rect->y = ctx->presentation.objects[i].y; | |
555 | |||
556 |
1/2✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
|
6 | if (object->rle) { |
557 | 6 | rect->w = object->w; | |
558 | 6 | rect->h = object->h; | |
559 | |||
560 | 6 | rect->linesize[0] = object->w; | |
561 | |||
562 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
|
6 | if (object->rle_remaining_len) { |
563 | ✗ | av_log(avctx, AV_LOG_ERROR, "RLE data length %u is %u bytes shorter than expected\n", | |
564 | object->rle_data_len, object->rle_remaining_len); | ||
565 | ✗ | if (avctx->err_recognition & AV_EF_EXPLODE) | |
566 | ✗ | return AVERROR_INVALIDDATA; | |
567 | } | ||
568 | 6 | ret = decode_rle(avctx, rect, object->rle, object->rle_data_len); | |
569 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
|
6 | if (ret < 0) { |
570 | ✗ | if ((avctx->err_recognition & AV_EF_EXPLODE) || | |
571 | ret == AVERROR(ENOMEM)) { | ||
572 | ✗ | return ret; | |
573 | } | ||
574 | ✗ | rect->w = 0; | |
575 | ✗ | rect->h = 0; | |
576 | ✗ | continue; | |
577 | } | ||
578 | } | ||
579 | /* Allocate memory for colors */ | ||
580 | 6 | rect->nb_colors = 256; | |
581 | 6 | rect->data[1] = av_mallocz(AVPALETTE_SIZE); | |
582 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
|
6 | if (!rect->data[1]) |
583 | ✗ | return AVERROR(ENOMEM); | |
584 | |||
585 |
1/4✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
|
6 | if (!ctx->forced_subs_only || ctx->presentation.objects[i].composition_flag & 0x40) |
586 | 6 | memcpy(rect->data[1], palette->clut, rect->nb_colors * sizeof(uint32_t)); | |
587 | } | ||
588 | 3 | return 1; | |
589 | } | ||
590 | |||
591 | 17 | static int decode(AVCodecContext *avctx, AVSubtitle *sub, | |
592 | int *got_sub_ptr, const AVPacket *avpkt) | ||
593 | { | ||
594 | 17 | const uint8_t *buf = avpkt->data; | |
595 | 17 | int buf_size = avpkt->size; | |
596 | |||
597 | const uint8_t *buf_end; | ||
598 | uint8_t segment_type; | ||
599 | int segment_length; | ||
600 | int i, ret; | ||
601 | |||
602 | ff_dlog(avctx, "PGS sub packet:\n"); | ||
603 | |||
604 |
2/2✓ Branch 0 taken 101686 times.
✓ Branch 1 taken 17 times.
|
101703 | for (i = 0; i < buf_size; i++) { |
605 | ff_dlog(avctx, "%02x ", buf[i]); | ||
606 | 101686 | if (i % 16 == 15) | |
607 | ff_dlog(avctx, "\n"); | ||
608 | } | ||
609 | |||
610 | 17 | if (i & 15) | |
611 | ff_dlog(avctx, "\n"); | ||
612 | |||
613 | 17 | *got_sub_ptr = 0; | |
614 | |||
615 | /* Ensure that we have received at a least a segment code and segment length */ | ||
616 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 17 times.
|
17 | if (buf_size < 3) |
617 | ✗ | return -1; | |
618 | |||
619 | 17 | buf_end = buf + buf_size; | |
620 | |||
621 | /* Step through buffer to identify segments */ | ||
622 |
2/2✓ Branch 0 taken 27 times.
✓ Branch 1 taken 17 times.
|
44 | while (buf < buf_end) { |
623 | 27 | segment_type = bytestream_get_byte(&buf); | |
624 | 27 | segment_length = bytestream_get_be16(&buf); | |
625 | |||
626 | ff_dlog(avctx, "Segment Length %d, Segment Type %x\n", segment_length, segment_type); | ||
627 | |||
628 |
3/4✓ Branch 0 taken 24 times.
✓ Branch 1 taken 3 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 24 times.
|
27 | if (segment_type != DISPLAY_SEGMENT && segment_length > buf_end - buf) |
629 | ✗ | break; | |
630 | |||
631 | 27 | ret = 0; | |
632 |
5/6✓ Branch 0 taken 4 times.
✓ Branch 1 taken 7 times.
✓ Branch 2 taken 9 times.
✓ Branch 3 taken 4 times.
✓ Branch 4 taken 3 times.
✗ Branch 5 not taken.
|
27 | switch (segment_type) { |
633 | 4 | case PALETTE_SEGMENT: | |
634 | 4 | ret = parse_palette_segment(avctx, buf, segment_length); | |
635 | 4 | break; | |
636 | 7 | case OBJECT_SEGMENT: | |
637 | 7 | ret = parse_object_segment(avctx, buf, segment_length); | |
638 | 7 | break; | |
639 | 9 | case PRESENTATION_SEGMENT: | |
640 | 9 | ret = parse_presentation_segment(avctx, buf, segment_length, sub->pts); | |
641 | 9 | break; | |
642 | 4 | case WINDOW_SEGMENT: | |
643 | /* | ||
644 | * Window Segment Structure (No new information provided): | ||
645 | * 2 bytes: Unknown, | ||
646 | * 2 bytes: X position of subtitle, | ||
647 | * 2 bytes: Y position of subtitle, | ||
648 | * 2 bytes: Width of subtitle, | ||
649 | * 2 bytes: Height of subtitle. | ||
650 | */ | ||
651 | 4 | break; | |
652 | 3 | case DISPLAY_SEGMENT: | |
653 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
|
3 | if (*got_sub_ptr) { |
654 | ✗ | av_log(avctx, AV_LOG_ERROR, "Duplicate display segment\n"); | |
655 | ✗ | ret = AVERROR_INVALIDDATA; | |
656 | ✗ | break; | |
657 | } | ||
658 | 3 | ret = display_end_segment(avctx, sub, buf, segment_length); | |
659 |
1/2✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
|
3 | if (ret >= 0) |
660 | 3 | *got_sub_ptr = ret; | |
661 | 3 | break; | |
662 | ✗ | default: | |
663 | ✗ | av_log(avctx, AV_LOG_ERROR, "Unknown subtitle segment type 0x%x, length %d\n", | |
664 | segment_type, segment_length); | ||
665 | ✗ | ret = AVERROR_INVALIDDATA; | |
666 | ✗ | break; | |
667 | } | ||
668 |
1/4✗ Branch 0 not taken.
✓ Branch 1 taken 27 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
|
27 | if (ret < 0 && (ret == AVERROR(ENOMEM) || |
669 | ✗ | avctx->err_recognition & AV_EF_EXPLODE)) | |
670 | ✗ | return ret; | |
671 | |||
672 | 27 | buf += segment_length; | |
673 | } | ||
674 | |||
675 | 17 | return buf_size; | |
676 | } | ||
677 | |||
678 | #define OFFSET(x) offsetof(PGSSubContext, x) | ||
679 | #define SD AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM | ||
680 | static const AVOption options[] = { | ||
681 | {"forced_subs_only", "Only show forced subtitles", OFFSET(forced_subs_only), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, SD}, | ||
682 | { NULL }, | ||
683 | }; | ||
684 | |||
685 | static const AVClass pgsdec_class = { | ||
686 | .class_name = "PGS subtitle decoder", | ||
687 | .item_name = av_default_item_name, | ||
688 | .option = options, | ||
689 | .version = LIBAVUTIL_VERSION_INT, | ||
690 | }; | ||
691 | |||
692 | const FFCodec ff_pgssub_decoder = { | ||
693 | .p.name = "pgssub", | ||
694 | CODEC_LONG_NAME("HDMV Presentation Graphic Stream subtitles"), | ||
695 | .p.type = AVMEDIA_TYPE_SUBTITLE, | ||
696 | .p.id = AV_CODEC_ID_HDMV_PGS_SUBTITLE, | ||
697 | .priv_data_size = sizeof(PGSSubContext), | ||
698 | .init = init_decoder, | ||
699 | .close = close_decoder, | ||
700 | FF_CODEC_DECODE_SUB_CB(decode), | ||
701 | .p.priv_class = &pgsdec_class, | ||
702 | }; | ||
703 |