2 * DVB subtitle decoding
3 * Copyright (c) 2005 Ian Caulfield
5 * This file is part of FFmpeg.
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.
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.
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
24 #include "bytestream.h"
26 #include "libavutil/colorspace.h"
27 #include "libavutil/imgutils.h"
28 #include "libavutil/opt.h"
30 #define DVBSUB_PAGE_SEGMENT 0x10
31 #define DVBSUB_REGION_SEGMENT 0x11
32 #define DVBSUB_CLUT_SEGMENT 0x12
33 #define DVBSUB_OBJECT_SEGMENT 0x13
34 #define DVBSUB_DISPLAYDEFINITION_SEGMENT 0x14
35 #define DVBSUB_DISPLAY_SEGMENT 0x80
37 #define cm (ff_crop_tab + MAX_NEG_CROP)
39 #define RGBA(r,g,b,a) (((unsigned)(a) << 24) | ((r) << 16) | ((g) << 8) | (b))
41 typedef struct DVBSubCLUT {
47 uint32_t clut256[256];
49 struct DVBSubCLUT *next;
52 static DVBSubCLUT default_clut;
54 typedef struct DVBSubObjectDisplay {
64 struct DVBSubObjectDisplay *region_list_next;
65 struct DVBSubObjectDisplay *object_list_next;
66 } DVBSubObjectDisplay;
68 typedef struct DVBSubObject {
74 DVBSubObjectDisplay *display_list;
76 struct DVBSubObject *next;
79 typedef struct DVBSubRegionDisplay {
85 struct DVBSubRegionDisplay *next;
86 } DVBSubRegionDisplay;
88 typedef struct DVBSubRegion {
99 uint8_t computed_clut[4*256];
100 int has_computed_clut;
106 DVBSubObjectDisplay *display_list;
108 struct DVBSubRegion *next;
111 typedef struct DVBSubDisplayDefinition {
118 } DVBSubDisplayDefinition;
120 typedef struct DVBSubContext {
127 int compute_edt; /**< if 1 end display time calculated using pts
128 if 0 (Default) calculated using time out */
130 int clut_count2[257][256];
133 DVBSubRegion *region_list;
134 DVBSubCLUT *clut_list;
135 DVBSubObject *object_list;
137 DVBSubRegionDisplay *display_list;
138 DVBSubDisplayDefinition *display_definition;
142 static DVBSubObject* get_object(DVBSubContext *ctx, int object_id)
144 DVBSubObject *ptr = ctx->object_list;
146 while (ptr && ptr->id != object_id) {
153 static DVBSubCLUT* get_clut(DVBSubContext *ctx, int clut_id)
155 DVBSubCLUT *ptr = ctx->clut_list;
157 while (ptr && ptr->id != clut_id) {
164 static DVBSubRegion* get_region(DVBSubContext *ctx, int region_id)
166 DVBSubRegion *ptr = ctx->region_list;
168 while (ptr && ptr->id != region_id) {
175 static void delete_region_display_list(DVBSubContext *ctx, DVBSubRegion *region)
177 DVBSubObject *object, *obj2, **obj2_ptr;
178 DVBSubObjectDisplay *display, *obj_disp, **obj_disp_ptr;
180 while (region->display_list) {
181 display = region->display_list;
183 object = get_object(ctx, display->object_id);
186 obj_disp_ptr = &object->display_list;
187 obj_disp = *obj_disp_ptr;
189 while (obj_disp && obj_disp != display) {
190 obj_disp_ptr = &obj_disp->object_list_next;
191 obj_disp = *obj_disp_ptr;
195 *obj_disp_ptr = obj_disp->object_list_next;
197 if (!object->display_list) {
198 obj2_ptr = &ctx->object_list;
201 while (obj2 != object) {
203 obj2_ptr = &obj2->next;
207 *obj2_ptr = obj2->next;
214 region->display_list = display->region_list_next;
221 static void delete_cluts(DVBSubContext *ctx)
223 while (ctx->clut_list) {
224 DVBSubCLUT *clut = ctx->clut_list;
226 ctx->clut_list = clut->next;
232 static void delete_objects(DVBSubContext *ctx)
234 while (ctx->object_list) {
235 DVBSubObject *object = ctx->object_list;
237 ctx->object_list = object->next;
243 static void delete_regions(DVBSubContext *ctx)
245 while (ctx->region_list) {
246 DVBSubRegion *region = ctx->region_list;
248 ctx->region_list = region->next;
250 delete_region_display_list(ctx, region);
252 av_freep(®ion->pbuf);
257 static av_cold int dvbsub_init_decoder(AVCodecContext *avctx)
259 int i, r, g, b, a = 0;
260 DVBSubContext *ctx = avctx->priv_data;
262 if (ctx->substream < 0) {
263 ctx->composition_id = -1;
264 ctx->ancillary_id = -1;
265 } else if (!avctx->extradata || (avctx->extradata_size < 4) || ((avctx->extradata_size % 5 != 0) && (avctx->extradata_size != 4))) {
266 av_log(avctx, AV_LOG_WARNING, "Invalid DVB subtitles stream extradata!\n");
267 ctx->composition_id = -1;
268 ctx->ancillary_id = -1;
270 if (avctx->extradata_size > 5*ctx->substream + 2) {
271 ctx->composition_id = AV_RB16(avctx->extradata + 5*ctx->substream);
272 ctx->ancillary_id = AV_RB16(avctx->extradata + 5*ctx->substream + 2);
274 av_log(avctx, AV_LOG_WARNING, "Selected DVB subtitles sub-stream %d is not available\n", ctx->substream);
275 ctx->composition_id = AV_RB16(avctx->extradata);
276 ctx->ancillary_id = AV_RB16(avctx->extradata + 2);
281 ctx->prev_start = AV_NOPTS_VALUE;
283 default_clut.id = -1;
284 default_clut.next = NULL;
286 default_clut.clut4[0] = RGBA( 0, 0, 0, 0);
287 default_clut.clut4[1] = RGBA(255, 255, 255, 255);
288 default_clut.clut4[2] = RGBA( 0, 0, 0, 255);
289 default_clut.clut4[3] = RGBA(127, 127, 127, 255);
291 default_clut.clut16[0] = RGBA( 0, 0, 0, 0);
292 for (i = 1; i < 16; i++) {
294 r = (i & 1) ? 255 : 0;
295 g = (i & 2) ? 255 : 0;
296 b = (i & 4) ? 255 : 0;
298 r = (i & 1) ? 127 : 0;
299 g = (i & 2) ? 127 : 0;
300 b = (i & 4) ? 127 : 0;
302 default_clut.clut16[i] = RGBA(r, g, b, 255);
305 default_clut.clut256[0] = RGBA( 0, 0, 0, 0);
306 for (i = 1; i < 256; i++) {
308 r = (i & 1) ? 255 : 0;
309 g = (i & 2) ? 255 : 0;
310 b = (i & 4) ? 255 : 0;
315 r = ((i & 1) ? 85 : 0) + ((i & 0x10) ? 170 : 0);
316 g = ((i & 2) ? 85 : 0) + ((i & 0x20) ? 170 : 0);
317 b = ((i & 4) ? 85 : 0) + ((i & 0x40) ? 170 : 0);
321 r = ((i & 1) ? 85 : 0) + ((i & 0x10) ? 170 : 0);
322 g = ((i & 2) ? 85 : 0) + ((i & 0x20) ? 170 : 0);
323 b = ((i & 4) ? 85 : 0) + ((i & 0x40) ? 170 : 0);
327 r = 127 + ((i & 1) ? 43 : 0) + ((i & 0x10) ? 85 : 0);
328 g = 127 + ((i & 2) ? 43 : 0) + ((i & 0x20) ? 85 : 0);
329 b = 127 + ((i & 4) ? 43 : 0) + ((i & 0x40) ? 85 : 0);
333 r = ((i & 1) ? 43 : 0) + ((i & 0x10) ? 85 : 0);
334 g = ((i & 2) ? 43 : 0) + ((i & 0x20) ? 85 : 0);
335 b = ((i & 4) ? 43 : 0) + ((i & 0x40) ? 85 : 0);
340 default_clut.clut256[i] = RGBA(r, g, b, a);
346 static av_cold int dvbsub_close_decoder(AVCodecContext *avctx)
348 DVBSubContext *ctx = avctx->priv_data;
349 DVBSubRegionDisplay *display;
357 av_freep(&ctx->display_definition);
359 while (ctx->display_list) {
360 display = ctx->display_list;
361 ctx->display_list = display->next;
369 static int dvbsub_read_2bit_string(AVCodecContext *avctx,
370 uint8_t *destbuf, int dbuf_len,
371 const uint8_t **srcbuf, int buf_size,
372 int non_mod, uint8_t *map_table, int x_pos)
378 int pixels_read = x_pos;
380 init_get_bits(&gb, *srcbuf, buf_size << 3);
384 while (get_bits_count(&gb) < buf_size << 3 && pixels_read < dbuf_len) {
385 bits = get_bits(&gb, 2);
388 if (non_mod != 1 || bits != 1) {
390 *destbuf++ = map_table[bits];
396 bits = get_bits1(&gb);
398 run_length = get_bits(&gb, 3) + 3;
399 bits = get_bits(&gb, 2);
401 if (non_mod == 1 && bits == 1)
402 pixels_read += run_length;
405 bits = map_table[bits];
406 while (run_length-- > 0 && pixels_read < dbuf_len) {
412 bits = get_bits1(&gb);
414 bits = get_bits(&gb, 2);
416 run_length = get_bits(&gb, 4) + 12;
417 bits = get_bits(&gb, 2);
419 if (non_mod == 1 && bits == 1)
420 pixels_read += run_length;
423 bits = map_table[bits];
424 while (run_length-- > 0 && pixels_read < dbuf_len) {
429 } else if (bits == 3) {
430 run_length = get_bits(&gb, 8) + 29;
431 bits = get_bits(&gb, 2);
433 if (non_mod == 1 && bits == 1)
434 pixels_read += run_length;
437 bits = map_table[bits];
438 while (run_length-- > 0 && pixels_read < dbuf_len) {
443 } else if (bits == 1) {
449 while (run_length-- > 0 && pixels_read < dbuf_len) {
454 (*srcbuf) += (get_bits_count(&gb) + 7) >> 3;
469 if (get_bits(&gb, 6))
470 av_log(avctx, AV_LOG_ERROR, "line overflow\n");
472 (*srcbuf) += (get_bits_count(&gb) + 7) >> 3;
477 static int dvbsub_read_4bit_string(AVCodecContext *avctx, uint8_t *destbuf, int dbuf_len,
478 const uint8_t **srcbuf, int buf_size,
479 int non_mod, uint8_t *map_table, int x_pos)
485 int pixels_read = x_pos;
487 init_get_bits(&gb, *srcbuf, buf_size << 3);
491 while (get_bits_count(&gb) < buf_size << 3 && pixels_read < dbuf_len) {
492 bits = get_bits(&gb, 4);
495 if (non_mod != 1 || bits != 1) {
497 *destbuf++ = map_table[bits];
503 bits = get_bits1(&gb);
505 run_length = get_bits(&gb, 3);
507 if (run_length == 0) {
508 (*srcbuf) += (get_bits_count(&gb) + 7) >> 3;
519 while (run_length-- > 0 && pixels_read < dbuf_len) {
524 bits = get_bits1(&gb);
526 run_length = get_bits(&gb, 2) + 4;
527 bits = get_bits(&gb, 4);
529 if (non_mod == 1 && bits == 1)
530 pixels_read += run_length;
533 bits = map_table[bits];
534 while (run_length-- > 0 && pixels_read < dbuf_len) {
540 bits = get_bits(&gb, 2);
542 run_length = get_bits(&gb, 4) + 9;
543 bits = get_bits(&gb, 4);
545 if (non_mod == 1 && bits == 1)
546 pixels_read += run_length;
549 bits = map_table[bits];
550 while (run_length-- > 0 && pixels_read < dbuf_len) {
555 } else if (bits == 3) {
556 run_length = get_bits(&gb, 8) + 25;
557 bits = get_bits(&gb, 4);
559 if (non_mod == 1 && bits == 1)
560 pixels_read += run_length;
563 bits = map_table[bits];
564 while (run_length-- > 0 && pixels_read < dbuf_len) {
569 } else if (bits == 1) {
575 while (run_length-- > 0 && pixels_read < dbuf_len) {
592 if (get_bits(&gb, 8))
593 av_log(avctx, AV_LOG_ERROR, "line overflow\n");
595 (*srcbuf) += (get_bits_count(&gb) + 7) >> 3;
600 static int dvbsub_read_8bit_string(AVCodecContext *avctx,
601 uint8_t *destbuf, int dbuf_len,
602 const uint8_t **srcbuf, int buf_size,
603 int non_mod, uint8_t *map_table, int x_pos)
605 const uint8_t *sbuf_end = (*srcbuf) + buf_size;
608 int pixels_read = x_pos;
612 while (*srcbuf < sbuf_end && pixels_read < dbuf_len) {
616 if (non_mod != 1 || bits != 1) {
618 *destbuf++ = map_table[bits];
625 run_length = bits & 0x7f;
626 if ((bits & 0x80) == 0) {
627 if (run_length == 0) {
635 if (non_mod == 1 && bits == 1)
636 pixels_read += run_length;
639 bits = map_table[bits];
640 while (run_length-- > 0 && pixels_read < dbuf_len) {
649 av_log(avctx, AV_LOG_ERROR, "line overflow\n");
654 static void compute_default_clut(DVBSubContext *ctx, uint8_t *clut, AVSubtitleRect *rect, int w, int h)
656 uint8_t list[256] = {0};
657 uint8_t list_inv[256];
658 int counttab[256] = {0};
659 int (*counttab2)[256] = ctx->clut_count2;
661 ptrdiff_t stride = rect->linesize[0];
663 memset(ctx->clut_count2, 0 , sizeof(ctx->clut_count2));
665 #define V(x,y) rect->data[0][(x) + (y)*stride]
666 for (y = 0; y<h; y++) {
667 for (x = 0; x<w; x++) {
669 int vl = x ? V(x-1,y) + 1 : 0;
670 int vr = x+1<w ? V(x+1,y) + 1 : 0;
671 int vt = y ? V(x,y-1) + 1 : 0;
672 int vb = y+1<h ? V(x,y+1) + 1 : 0;
673 counttab[v-1] += !!((v!=vl) + (v!=vr) + (v!=vt) + (v!=vb));
674 counttab2[vl][v-1] ++;
675 counttab2[vr][v-1] ++;
676 counttab2[vt][v-1] ++;
677 counttab2[vb][v-1] ++;
680 #define L(x,y) list[d[(x) + (y)*stride]]
682 for (i = 0; i<256; i++) {
683 counttab2[i+1][i] = 0;
685 for (i = 0; i<256; i++) {
689 for (x = 0; x < 256; x++) {
693 scorev += counttab2[0][x];
694 for (y = 0; y < 256; y++) {
695 scorev += list[y] * counttab2[y+1][x];
699 int score = 1024LL*scorev / counttab[x];
700 if (score > bestscore) {
709 list_inv[ i ] = bestv;
712 count = FFMAX(i - 1, 1);
713 for (i--; i >= 0; i--) {
714 int v = i * 255 / count;
715 AV_WN32(clut + 4*list_inv[i], RGBA(v/2,v,v/2,v));
720 static int save_subtitle_set(AVCodecContext *avctx, AVSubtitle *sub, int *got_output)
722 DVBSubContext *ctx = avctx->priv_data;
723 DVBSubRegionDisplay *display;
724 DVBSubDisplayDefinition *display_def = ctx->display_definition;
725 DVBSubRegion *region;
726 AVSubtitleRect *rect;
728 uint32_t *clut_table;
730 int offset_x=0, offset_y=0;
735 offset_x = display_def->x;
736 offset_y = display_def->y;
739 /* Not touching AVSubtitles again*/
740 if (sub->num_rects) {
741 avpriv_request_sample(ctx, "Different Version of Segment asked Twice");
742 return AVERROR_PATCHWELCOME;
744 for (display = ctx->display_list; display; display = display->next) {
745 region = get_region(ctx, display->region_id);
746 if (region && region->dirty)
750 if (ctx->compute_edt == 0) {
751 sub->end_display_time = ctx->time_out * 1000;
753 } else if (ctx->prev_start != AV_NOPTS_VALUE) {
754 sub->end_display_time = av_rescale_q((sub->pts - ctx->prev_start ), AV_TIME_BASE_Q, (AVRational){ 1, 1000 }) - 1;
757 if (sub->num_rects > 0) {
759 sub->rects = av_mallocz_array(sizeof(*sub->rects), sub->num_rects);
761 ret = AVERROR(ENOMEM);
765 for (i = 0; i < sub->num_rects; i++) {
766 sub->rects[i] = av_mallocz(sizeof(*sub->rects[i]));
767 if (!sub->rects[i]) {
768 ret = AVERROR(ENOMEM);
775 for (display = ctx->display_list; display; display = display->next) {
776 region = get_region(ctx, display->region_id);
784 rect = sub->rects[i];
785 rect->x = display->x_pos + offset_x;
786 rect->y = display->y_pos + offset_y;
787 rect->w = region->width;
788 rect->h = region->height;
789 rect->nb_colors = (1 << region->depth);
790 rect->type = SUBTITLE_BITMAP;
791 rect->linesize[0] = region->width;
793 clut = get_clut(ctx, region->clut);
796 clut = &default_clut;
798 switch (region->depth) {
800 clut_table = clut->clut4;
803 clut_table = clut->clut256;
807 clut_table = clut->clut16;
811 rect->data[1] = av_mallocz(AVPALETTE_SIZE);
812 if (!rect->data[1]) {
813 ret = AVERROR(ENOMEM);
816 memcpy(rect->data[1], clut_table, (1 << region->depth) * sizeof(*clut_table));
818 rect->data[0] = av_malloc(region->buf_size);
819 if (!rect->data[0]) {
820 ret = AVERROR(ENOMEM);
824 memcpy(rect->data[0], region->pbuf, region->buf_size);
826 if ((clut == &default_clut && ctx->compute_clut < 0) || ctx->compute_clut == 1) {
827 if (!region->has_computed_clut) {
828 compute_default_clut(ctx, region->computed_clut, rect, rect->w, rect->h);
829 region->has_computed_clut = 1;
832 memcpy(rect->data[1], region->computed_clut, sizeof(region->computed_clut));
836 FF_DISABLE_DEPRECATION_WARNINGS
839 for (j = 0; j < 4; j++) {
840 rect->pict.data[j] = rect->data[j];
841 rect->pict.linesize[j] = rect->linesize[j];
844 FF_ENABLE_DEPRECATION_WARNINGS
854 for (i=0; i < sub->num_rects; i++) {
855 rect = sub->rects[i];
857 av_freep(&rect->data[0]);
858 av_freep(&rect->data[1]);
860 av_freep(&sub->rects[i]);
862 av_freep(&sub->rects);
868 static void dvbsub_parse_pixel_data_block(AVCodecContext *avctx, DVBSubObjectDisplay *display,
869 const uint8_t *buf, int buf_size, int top_bottom, int non_mod)
871 DVBSubContext *ctx = avctx->priv_data;
873 DVBSubRegion *region = get_region(ctx, display->region_id);
874 const uint8_t *buf_end = buf + buf_size;
879 uint8_t map2to4[] = { 0x0, 0x7, 0x8, 0xf};
880 uint8_t map2to8[] = {0x00, 0x77, 0x88, 0xff};
881 uint8_t map4to8[] = {0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77,
882 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff};
886 ff_dlog(avctx, "DVB pixel block size %d, %s field:\n", buf_size,
887 top_bottom ? "bottom" : "top");
889 for (i = 0; i < buf_size; i++) {
891 ff_dlog(avctx, "0x%8p: ", buf+i);
893 ff_dlog(avctx, "%02x ", buf[i]);
895 ff_dlog(avctx, "\n");
899 ff_dlog(avctx, "\n");
908 x_pos = display->x_pos;
909 y_pos = display->y_pos;
913 while (buf < buf_end) {
914 if ((*buf!=0xf0 && x_pos >= region->width) || y_pos >= region->height) {
915 av_log(avctx, AV_LOG_ERROR, "Invalid object location! %d-%d %d-%d %02x\n", x_pos, region->width, y_pos, region->height, *buf);
921 if (region->depth == 8)
923 else if (region->depth == 4)
928 x_pos = dvbsub_read_2bit_string(avctx, pbuf + (y_pos * region->width),
929 region->width, &buf, buf_end - buf,
930 non_mod, map_table, x_pos);
933 if (region->depth < 4) {
934 av_log(avctx, AV_LOG_ERROR, "4-bit pixel string in %d-bit region!\n", region->depth);
938 if (region->depth == 8)
943 x_pos = dvbsub_read_4bit_string(avctx, pbuf + (y_pos * region->width),
944 region->width, &buf, buf_end - buf,
945 non_mod, map_table, x_pos);
948 if (region->depth < 8) {
949 av_log(avctx, AV_LOG_ERROR, "8-bit pixel string in %d-bit region!\n", region->depth);
953 x_pos = dvbsub_read_8bit_string(avctx, pbuf + (y_pos * region->width),
954 region->width, &buf, buf_end - buf,
955 non_mod, NULL, x_pos);
959 map2to4[0] = (*buf) >> 4;
960 map2to4[1] = (*buf++) & 0xf;
961 map2to4[2] = (*buf) >> 4;
962 map2to4[3] = (*buf++) & 0xf;
965 for (i = 0; i < 4; i++)
969 for (i = 0; i < 16; i++)
974 x_pos = display->x_pos;
978 av_log(avctx, AV_LOG_INFO, "Unknown/unsupported pixel block 0x%x\n", *(buf-1));
982 if (ctx->compute_clut != -2)
983 region->has_computed_clut = 0;
986 static int dvbsub_parse_object_segment(AVCodecContext *avctx,
987 const uint8_t *buf, int buf_size)
989 DVBSubContext *ctx = avctx->priv_data;
991 const uint8_t *buf_end = buf + buf_size;
993 DVBSubObject *object;
994 DVBSubObjectDisplay *display;
995 int top_field_len, bottom_field_len;
997 int coding_method, non_modifying_color;
999 object_id = AV_RB16(buf);
1002 object = get_object(ctx, object_id);
1005 return AVERROR_INVALIDDATA;
1007 coding_method = ((*buf) >> 2) & 3;
1008 non_modifying_color = ((*buf++) >> 1) & 1;
1010 if (coding_method == 0) {
1011 top_field_len = AV_RB16(buf);
1013 bottom_field_len = AV_RB16(buf);
1016 if (buf + top_field_len + bottom_field_len > buf_end) {
1017 av_log(avctx, AV_LOG_ERROR, "Field data size %d+%d too large\n", top_field_len, bottom_field_len);
1018 return AVERROR_INVALIDDATA;
1021 for (display = object->display_list; display; display = display->object_list_next) {
1022 const uint8_t *block = buf;
1023 int bfl = bottom_field_len;
1025 dvbsub_parse_pixel_data_block(avctx, display, block, top_field_len, 0,
1026 non_modifying_color);
1028 if (bottom_field_len > 0)
1029 block = buf + top_field_len;
1031 bfl = top_field_len;
1033 dvbsub_parse_pixel_data_block(avctx, display, block, bfl, 1,
1034 non_modifying_color);
1036 } else if (coding_method == 1) {
1037 avpriv_report_missing_feature(avctx, "coded as a string of characters");
1038 return AVERROR_PATCHWELCOME;
1039 } else if (coding_method == 2) {
1040 avpriv_report_missing_feature(avctx, "progressive coding of pixels");
1041 return AVERROR_PATCHWELCOME;
1043 av_log(avctx, AV_LOG_ERROR, "Unknown object coding %d\n", coding_method);
1044 return AVERROR_INVALIDDATA;
1050 static int dvbsub_parse_clut_segment(AVCodecContext *avctx,
1051 const uint8_t *buf, int buf_size)
1053 DVBSubContext *ctx = avctx->priv_data;
1055 const uint8_t *buf_end = buf + buf_size;
1059 int entry_id, depth , full_range;
1060 int y, cr, cb, alpha;
1061 int r, g, b, r_add, g_add, b_add;
1063 ff_dlog(avctx, "DVB clut packet:\n");
1065 for (i=0; i < buf_size; i++) {
1066 ff_dlog(avctx, "%02x ", buf[i]);
1068 ff_dlog(avctx, "\n");
1072 ff_dlog(avctx, "\n");
1075 version = ((*buf)>>4)&15;
1078 clut = get_clut(ctx, clut_id);
1081 clut = av_malloc(sizeof(*clut));
1083 return AVERROR(ENOMEM);
1085 memcpy(clut, &default_clut, sizeof(*clut));
1090 clut->next = ctx->clut_list;
1091 ctx->clut_list = clut;
1094 if (clut->version != version) {
1096 clut->version = version;
1098 while (buf + 4 < buf_end) {
1101 depth = (*buf) & 0xe0;
1104 av_log(avctx, AV_LOG_ERROR, "Invalid clut depth 0x%x!\n", *buf);
1107 full_range = (*buf++) & 1;
1116 cr = (((buf[0] & 3) << 2) | ((buf[1] >> 6) & 3)) << 4;
1117 cb = (buf[1] << 2) & 0xf0;
1118 alpha = (buf[1] << 6) & 0xc0;
1126 YUV_TO_RGB1_CCIR(cb, cr);
1127 YUV_TO_RGB2_CCIR(r, g, b, y);
1129 ff_dlog(avctx, "clut %d := (%d,%d,%d,%d)\n", entry_id, r, g, b, alpha);
1130 if (!!(depth & 0x80) + !!(depth & 0x40) + !!(depth & 0x20) > 1) {
1131 ff_dlog(avctx, "More than one bit level marked: %x\n", depth);
1132 if (avctx->strict_std_compliance > FF_COMPLIANCE_NORMAL)
1133 return AVERROR_INVALIDDATA;
1136 if (depth & 0x80 && entry_id < 4)
1137 clut->clut4[entry_id] = RGBA(r,g,b,255 - alpha);
1138 else if (depth & 0x40 && entry_id < 16)
1139 clut->clut16[entry_id] = RGBA(r,g,b,255 - alpha);
1140 else if (depth & 0x20)
1141 clut->clut256[entry_id] = RGBA(r,g,b,255 - alpha);
1149 static int dvbsub_parse_region_segment(AVCodecContext *avctx,
1150 const uint8_t *buf, int buf_size)
1152 DVBSubContext *ctx = avctx->priv_data;
1154 const uint8_t *buf_end = buf + buf_size;
1155 int region_id, object_id;
1156 int av_unused version;
1157 DVBSubRegion *region;
1158 DVBSubObject *object;
1159 DVBSubObjectDisplay *display;
1164 return AVERROR_INVALIDDATA;
1168 region = get_region(ctx, region_id);
1171 region = av_mallocz(sizeof(*region));
1173 return AVERROR(ENOMEM);
1175 region->id = region_id;
1176 region->version = -1;
1178 region->next = ctx->region_list;
1179 ctx->region_list = region;
1182 version = ((*buf)>>4) & 15;
1183 fill = ((*buf++) >> 3) & 1;
1185 region->width = AV_RB16(buf);
1187 region->height = AV_RB16(buf);
1190 ret = av_image_check_size2(region->width, region->height, avctx->max_pixels, AV_PIX_FMT_PAL8, 0, avctx);
1191 if (ret >= 0 && region->width * region->height * 2 > 320 * 1024 * 8) {
1192 ret = AVERROR_INVALIDDATA;
1193 av_log(avctx, AV_LOG_ERROR, "Pixel buffer memory constraint violated\n");
1196 region->width= region->height= 0;
1200 if (region->width * region->height != region->buf_size) {
1201 av_free(region->pbuf);
1203 region->buf_size = region->width * region->height;
1205 region->pbuf = av_malloc(region->buf_size);
1206 if (!region->pbuf) {
1210 return AVERROR(ENOMEM);
1217 region->depth = 1 << (((*buf++) >> 2) & 7);
1218 if (region->depth < 2 || region->depth > 8) {
1219 av_log(avctx, AV_LOG_ERROR, "region depth %d is invalid\n", region->depth);
1222 region->clut = *buf++;
1224 if (region->depth == 8) {
1225 region->bgcolor = *buf++;
1230 if (region->depth == 4)
1231 region->bgcolor = (((*buf++) >> 4) & 15);
1233 region->bgcolor = (((*buf++) >> 2) & 3);
1236 ff_dlog(avctx, "Region %d, (%dx%d)\n", region_id, region->width, region->height);
1239 memset(region->pbuf, region->bgcolor, region->buf_size);
1240 ff_dlog(avctx, "Fill region (%d)\n", region->bgcolor);
1243 delete_region_display_list(ctx, region);
1245 while (buf + 5 < buf_end) {
1246 object_id = AV_RB16(buf);
1249 object = get_object(ctx, object_id);
1252 object = av_mallocz(sizeof(*object));
1254 return AVERROR(ENOMEM);
1256 object->id = object_id;
1257 object->next = ctx->object_list;
1258 ctx->object_list = object;
1261 object->type = (*buf) >> 6;
1263 display = av_mallocz(sizeof(*display));
1265 return AVERROR(ENOMEM);
1267 display->object_id = object_id;
1268 display->region_id = region_id;
1270 display->x_pos = AV_RB16(buf) & 0xfff;
1272 display->y_pos = AV_RB16(buf) & 0xfff;
1275 if (display->x_pos >= region->width ||
1276 display->y_pos >= region->height) {
1277 av_log(avctx, AV_LOG_ERROR, "Object outside region\n");
1279 return AVERROR_INVALIDDATA;
1282 if ((object->type == 1 || object->type == 2) && buf+1 < buf_end) {
1283 display->fgcolor = *buf++;
1284 display->bgcolor = *buf++;
1287 display->region_list_next = region->display_list;
1288 region->display_list = display;
1290 display->object_list_next = object->display_list;
1291 object->display_list = display;
1297 static int dvbsub_parse_page_segment(AVCodecContext *avctx,
1298 const uint8_t *buf, int buf_size, AVSubtitle *sub, int *got_output)
1300 DVBSubContext *ctx = avctx->priv_data;
1301 DVBSubRegionDisplay *display;
1302 DVBSubRegionDisplay *tmp_display_list, **tmp_ptr;
1304 const uint8_t *buf_end = buf + buf_size;
1311 return AVERROR_INVALIDDATA;
1314 version = ((*buf)>>4) & 15;
1315 page_state = ((*buf++) >> 2) & 3;
1317 if (ctx->version == version) {
1321 ctx->time_out = timeout;
1322 ctx->version = version;
1324 ff_dlog(avctx, "Page time out %ds, state %d\n", ctx->time_out, page_state);
1326 if (ctx->compute_edt == 1)
1327 save_subtitle_set(avctx, sub, got_output);
1329 if (page_state == 1 || page_state == 2) {
1330 delete_regions(ctx);
1331 delete_objects(ctx);
1335 tmp_display_list = ctx->display_list;
1336 ctx->display_list = NULL;
1338 while (buf + 5 < buf_end) {
1342 display = ctx->display_list;
1343 while (display && display->region_id != region_id) {
1344 display = display->next;
1347 av_log(avctx, AV_LOG_ERROR, "duplicate region\n");
1351 display = tmp_display_list;
1352 tmp_ptr = &tmp_display_list;
1354 while (display && display->region_id != region_id) {
1355 tmp_ptr = &display->next;
1356 display = display->next;
1360 display = av_mallocz(sizeof(*display));
1362 return AVERROR(ENOMEM);
1365 display->region_id = region_id;
1367 display->x_pos = AV_RB16(buf);
1369 display->y_pos = AV_RB16(buf);
1372 *tmp_ptr = display->next;
1374 display->next = ctx->display_list;
1375 ctx->display_list = display;
1377 ff_dlog(avctx, "Region %d, (%d,%d)\n", region_id, display->x_pos, display->y_pos);
1380 while (tmp_display_list) {
1381 display = tmp_display_list;
1383 tmp_display_list = display->next;
1393 static void png_save(DVBSubContext *ctx, const char *filename, uint32_t *bitmap, int w, int h)
1397 char fname[40], fname2[40];
1400 snprintf(fname, sizeof(fname), "%s.ppm", filename);
1402 f = fopen(fname, "w");
1411 for(y = 0; y < h; y++) {
1412 for(x = 0; x < w; x++) {
1413 v = bitmap[y * w + x];
1414 putc((v >> 16) & 0xff, f);
1415 putc((v >> 8) & 0xff, f);
1416 putc((v >> 0) & 0xff, f);
1422 snprintf(fname2, sizeof(fname2), "%s-a.pgm", filename);
1424 f = fopen(fname2, "w");
1433 for(y = 0; y < h; y++) {
1434 for(x = 0; x < w; x++) {
1435 v = bitmap[y * w + x];
1436 putc((v >> 24) & 0xff, f);
1441 snprintf(command, sizeof(command), "pnmtopng -alpha %s %s > %s.png 2> /dev/null", fname2, fname, filename);
1442 if (system(command) != 0) {
1443 av_log(ctx, AV_LOG_ERROR, "Error running pnmtopng\n");
1447 snprintf(command, sizeof(command), "rm %s %s", fname, fname2);
1448 if (system(command) != 0) {
1449 av_log(ctx, AV_LOG_ERROR, "Error removing %s and %s\n", fname, fname2);
1454 static int save_display_set(DVBSubContext *ctx)
1456 DVBSubRegion *region;
1457 DVBSubRegionDisplay *display;
1459 uint32_t *clut_table;
1460 int x_pos, y_pos, width, height;
1461 int x, y, y_off, x_off;
1464 static int fileno_index = 0;
1471 for (display = ctx->display_list; display; display = display->next) {
1472 region = get_region(ctx, display->region_id);
1478 x_pos = display->x_pos;
1479 y_pos = display->y_pos;
1480 width = region->width;
1481 height = region->height;
1483 if (display->x_pos < x_pos) {
1484 width += (x_pos - display->x_pos);
1485 x_pos = display->x_pos;
1488 if (display->y_pos < y_pos) {
1489 height += (y_pos - display->y_pos);
1490 y_pos = display->y_pos;
1493 if (display->x_pos + region->width > x_pos + width) {
1494 width = display->x_pos + region->width - x_pos;
1497 if (display->y_pos + region->height > y_pos + height) {
1498 height = display->y_pos + region->height - y_pos;
1505 pbuf = av_malloc(width * height * 4);
1509 for (display = ctx->display_list; display; display = display->next) {
1510 region = get_region(ctx, display->region_id);
1515 x_off = display->x_pos - x_pos;
1516 y_off = display->y_pos - y_pos;
1518 clut = get_clut(ctx, region->clut);
1521 clut = &default_clut;
1523 switch (region->depth) {
1525 clut_table = clut->clut4;
1528 clut_table = clut->clut256;
1532 clut_table = clut->clut16;
1536 for (y = 0; y < region->height; y++) {
1537 for (x = 0; x < region->width; x++) {
1538 pbuf[((y + y_off) * width) + x_off + x] =
1539 clut_table[region->pbuf[y * region->width + x]];
1545 snprintf(filename, sizeof(filename), "dvbs.%d", fileno_index);
1547 png_save(ctx, filename, pbuf, width, height);
1557 static int dvbsub_parse_display_definition_segment(AVCodecContext *avctx,
1561 DVBSubContext *ctx = avctx->priv_data;
1562 DVBSubDisplayDefinition *display_def = ctx->display_definition;
1563 int dds_version, info_byte;
1566 return AVERROR_INVALIDDATA;
1568 info_byte = bytestream_get_byte(&buf);
1569 dds_version = info_byte >> 4;
1570 if (display_def && display_def->version == dds_version)
1571 return 0; // already have this display definition version
1574 display_def = av_mallocz(sizeof(*display_def));
1576 return AVERROR(ENOMEM);
1577 ctx->display_definition = display_def;
1580 display_def->version = dds_version;
1583 display_def->width = bytestream_get_be16(&buf) + 1;
1584 display_def->height = bytestream_get_be16(&buf) + 1;
1585 if (!avctx->width || !avctx->height) {
1586 int ret = ff_set_dimensions(avctx, display_def->width, display_def->height);
1591 if (info_byte & 1<<3) { // display_window_flag
1593 return AVERROR_INVALIDDATA;
1595 display_def->x = bytestream_get_be16(&buf);
1596 display_def->width = bytestream_get_be16(&buf) - display_def->x + 1;
1597 display_def->y = bytestream_get_be16(&buf);
1598 display_def->height = bytestream_get_be16(&buf) - display_def->y + 1;
1604 static int dvbsub_display_end_segment(AVCodecContext *avctx, const uint8_t *buf,
1605 int buf_size, AVSubtitle *sub,int *got_output)
1607 DVBSubContext *ctx = avctx->priv_data;
1609 if (ctx->compute_edt == 0)
1610 save_subtitle_set(avctx, sub, got_output);
1612 save_display_set(ctx);
1617 static int dvbsub_decode(AVCodecContext *avctx,
1618 void *data, int *got_sub_ptr,
1621 const uint8_t *buf = avpkt->data;
1622 int buf_size = avpkt->size;
1623 DVBSubContext *ctx = avctx->priv_data;
1624 AVSubtitle *sub = data;
1625 const uint8_t *p, *p_end;
1631 int got_segment = 0;
1634 ff_dlog(avctx, "DVB sub packet:\n");
1636 for (i=0; i < buf_size; i++) {
1637 ff_dlog(avctx, "%02x ", buf[i]);
1639 ff_dlog(avctx, "\n");
1643 ff_dlog(avctx, "\n");
1645 if (buf_size <= 6 || *buf != 0x0f) {
1646 ff_dlog(avctx, "incomplete or broken packet");
1647 return AVERROR_INVALIDDATA;
1651 p_end = buf + buf_size;
1653 while (p_end - p >= 6 && *p == 0x0f) {
1655 segment_type = *p++;
1656 page_id = AV_RB16(p);
1658 segment_length = AV_RB16(p);
1661 if (avctx->debug & FF_DEBUG_STARTCODE) {
1662 av_log(avctx, AV_LOG_DEBUG, "segment_type:%d page_id:%d segment_length:%d\n", segment_type, page_id, segment_length);
1665 if (p_end - p < segment_length) {
1666 ff_dlog(avctx, "incomplete or broken packet");
1671 if (page_id == ctx->composition_id || page_id == ctx->ancillary_id ||
1672 ctx->composition_id == -1 || ctx->ancillary_id == -1) {
1674 switch (segment_type) {
1675 case DVBSUB_PAGE_SEGMENT:
1676 ret = dvbsub_parse_page_segment(avctx, p, segment_length, sub, got_sub_ptr);
1679 case DVBSUB_REGION_SEGMENT:
1680 ret = dvbsub_parse_region_segment(avctx, p, segment_length);
1683 case DVBSUB_CLUT_SEGMENT:
1684 ret = dvbsub_parse_clut_segment(avctx, p, segment_length);
1685 if (ret < 0) goto end;
1688 case DVBSUB_OBJECT_SEGMENT:
1689 ret = dvbsub_parse_object_segment(avctx, p, segment_length);
1692 case DVBSUB_DISPLAYDEFINITION_SEGMENT:
1693 ret = dvbsub_parse_display_definition_segment(avctx, p,
1697 case DVBSUB_DISPLAY_SEGMENT:
1698 ret = dvbsub_display_end_segment(avctx, p, segment_length, sub, got_sub_ptr);
1699 if (got_segment == 15 && !got_dds && !avctx->width && !avctx->height) {
1700 // Default from ETSI EN 300 743 V1.3.1 (7.2.1)
1702 avctx->height = 576;
1707 ff_dlog(avctx, "Subtitling segment type 0x%x, page id %d, length %d\n",
1708 segment_type, page_id, segment_length);
1715 p += segment_length;
1717 // Some streams do not send a display segment but if we have all the other
1718 // segments then we need no further data.
1719 if (got_segment == 15) {
1720 av_log(avctx, AV_LOG_DEBUG, "Missing display_end_segment, emulating\n");
1721 dvbsub_display_end_segment(avctx, p, 0, sub, got_sub_ptr);
1727 avsubtitle_free(sub);
1730 if (ctx->compute_edt == 1)
1731 FFSWAP(int64_t, ctx->prev_start, sub->pts);
1737 #define DS AV_OPT_FLAG_DECODING_PARAM | AV_OPT_FLAG_SUBTITLE_PARAM
1738 #define OFFSET(x) offsetof(DVBSubContext, x)
1739 static const AVOption options[] = {
1740 {"compute_edt", "compute end of time using pts or timeout", OFFSET(compute_edt), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, DS},
1741 {"compute_clut", "compute clut when not available(-1) or only once (-2) or always(1) or never(0)", OFFSET(compute_clut), AV_OPT_TYPE_BOOL, {.i64 = -1}, -2, 1, DS},
1742 {"dvb_substream", "", OFFSET(substream), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 63, DS},
1745 static const AVClass dvbsubdec_class = {
1746 .class_name = "DVB Sub Decoder",
1747 .item_name = av_default_item_name,
1749 .version = LIBAVUTIL_VERSION_INT,
1752 AVCodec ff_dvbsub_decoder = {
1754 .long_name = NULL_IF_CONFIG_SMALL("DVB subtitles"),
1755 .type = AVMEDIA_TYPE_SUBTITLE,
1756 .id = AV_CODEC_ID_DVB_SUBTITLE,
1757 .priv_data_size = sizeof(DVBSubContext),
1758 .init = dvbsub_init_decoder,
1759 .close = dvbsub_close_decoder,
1760 .decode = dvbsub_decode,
1761 .priv_class = &dvbsubdec_class,