annotate xsubdec.c @ 7900:37f62a3dc645 libavcodec

Correct comment in the direct mode code. (note, yes this is unrelated to the previous simplification, the code always behaved like it is documented now.)
author michael
date Sun, 21 Sep 2008 23:49:53 +0000
parents e943e1409077
children aa45029f5cd7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5493
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
1 /*
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
2 * XSUB subtitle decoder
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
3 * Copyright (c) 2007 Reimar Döffinger
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
4 *
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
5 * This file is part of FFmpeg.
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
6 *
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
7 * FFmpeg is free software; you can redistribute it and/or
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
8 * modify it under the terms of the GNU Lesser General Public
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
9 * License as published by the Free Software Foundation; either
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
10 * version 2.1 of the License, or (at your option) any later version.
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
11 *
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
12 * FFmpeg is distributed in the hope that it will be useful,
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
15 * Lesser General Public License for more details.
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
16 *
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
17 * You should have received a copy of the GNU Lesser General Public
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
18 * License along with FFmpeg; if not, write to the Free Software
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
80b481ec72a6 Add proper license header
reimar
parents: 5492
diff changeset
20 */
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
21 #include "avcodec.h"
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
22 #include "bitstream.h"
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
23 #include "bytestream.h"
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
24
6517
48759bfbd073 Apply 'cold' attribute to init/uninit functions in libavcodec
zuxy
parents: 6218
diff changeset
25 static av_cold int decode_init(AVCodecContext *avctx) {
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
26 avctx->pix_fmt = PIX_FMT_PAL8;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
27 return 0;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
28 }
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
29
5484
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
30 static const uint8_t tc_offsets[9] = { 0, 1, 3, 4, 6, 7, 9, 10, 11 };
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
31 static const uint8_t tc_muls[9] = { 10, 6, 10, 6, 10, 6, 10, 10, 1 };
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
32
6218
michael
parents: 5982
diff changeset
33 static uint64_t parse_timecode(const uint8_t *buf) {
5484
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
34 int i;
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
35 int64_t ms = 0;
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
36 if (buf[2] != ':' || buf[5] != ':' || buf[8] != '.')
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
37 return AV_NOPTS_VALUE;
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
38 for (i = 0; i < sizeof(tc_offsets); i++) {
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
39 uint8_t c = buf[tc_offsets[i]] - '0';
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
40 if (c > 9) return AV_NOPTS_VALUE;
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
41 ms = (ms + c) * tc_muls[i];
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
42 }
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
43 return ms;
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
44 }
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
45
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
46 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size,
6218
michael
parents: 5982
diff changeset
47 const uint8_t *buf, int buf_size) {
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
48 AVSubtitle *sub = data;
6218
michael
parents: 5982
diff changeset
49 const uint8_t *buf_end = buf + buf_size;
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
50 uint8_t *bitmap;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
51 int w, h, x, y, rlelen, i;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
52 GetBitContext gb;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
53
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
54 // check that at least header fits
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
55 if (buf_size < 27 + 7 * 2 + 4 * 3) {
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
56 av_log(avctx, AV_LOG_ERROR, "coded frame too small\n");
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
57 return -1;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
58 }
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
59
5484
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
60 // read start and end time
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
61 if (buf[0] != '[' || buf[13] != '-' || buf[26] != ']') {
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
62 av_log(avctx, AV_LOG_ERROR, "invalid time code\n");
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
63 return -1;
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
64 }
5492
922a668222f0 Remove AVCodecContext parameter from parse_timecode function
reimar
parents: 5491
diff changeset
65 sub->start_display_time = parse_timecode(buf + 1);
922a668222f0 Remove AVCodecContext parameter from parse_timecode function
reimar
parents: 5491
diff changeset
66 sub->end_display_time = parse_timecode(buf + 14);
5484
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
67 buf += 27;
ad3e24850727 Add forgotten xsub timecode parsing
reimar
parents: 5483
diff changeset
68
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
69 // read header
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
70 w = bytestream_get_le16(&buf);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
71 h = bytestream_get_le16(&buf);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
72 if (avcodec_check_dimensions(avctx, w, h) < 0)
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
73 return -1;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
74 x = bytestream_get_le16(&buf);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
75 y = bytestream_get_le16(&buf);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
76 // skip bottom right position, it gives no new information
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
77 bytestream_get_le16(&buf);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
78 bytestream_get_le16(&buf);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
79 rlelen = bytestream_get_le16(&buf);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
80
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
81 // allocate sub and set values
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
82 if (!sub->rects) {
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
83 sub->rects = av_mallocz(sizeof(AVSubtitleRect));
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
84 sub->num_rects = 1;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
85 }
5485
e41873bf253a 100l, wrong argument to av_freep
reimar
parents: 5484
diff changeset
86 av_freep(&sub->rects[0].bitmap);
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
87 sub->rects[0].x = x; sub->rects[0].y = y;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
88 sub->rects[0].w = w; sub->rects[0].h = h;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
89 sub->rects[0].linesize = w;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
90 sub->rects[0].bitmap = av_malloc(w * h);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
91 sub->rects[0].nb_colors = 4;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
92 sub->rects[0].rgba_palette = av_malloc(sub->rects[0].nb_colors * 4);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
93
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
94 // read palette
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
95 for (i = 0; i < sub->rects[0].nb_colors; i++)
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
96 sub->rects[0].rgba_palette[i] = bytestream_get_be24(&buf);
5489
dc54869af30b Colours except background should not be transparent
reimar
parents: 5488
diff changeset
97 // make all except background (first entry) non-transparent
dc54869af30b Colours except background should not be transparent
reimar
parents: 5488
diff changeset
98 for (i = 1; i < sub->rects[0].nb_colors; i++)
dc54869af30b Colours except background should not be transparent
reimar
parents: 5488
diff changeset
99 sub->rects[0].rgba_palette[i] |= 0xff000000;
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
100
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
101 // process RLE-compressed data
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
102 rlelen = FFMIN(rlelen, buf_end - buf);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
103 init_get_bits(&gb, buf, rlelen * 8);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
104 bitmap = sub->rects[0].bitmap;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
105 for (y = 0; y < h; y++) {
5490
12d77ed34985 Deinterlace xsub subtitles
reimar
parents: 5489
diff changeset
106 // interlaced: do odd lines
5491
d847cbc8756b Fix deinterlacing for odd height
reimar
parents: 5490
diff changeset
107 if (y == (h + 1) / 2) bitmap = sub->rects[0].bitmap + w;
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
108 for (x = 0; x < w; ) {
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
109 int log2 = ff_log2_tab[show_bits(&gb, 8)];
5487
3039b660bf35 get rid of xsubdec array and calculate value instead
reimar
parents: 5486
diff changeset
110 int run = get_bits(&gb, 14 - 4 * (log2 >> 1));
5982
1900b70712ab colour --> color in variable names
diego
parents: 5493
diff changeset
111 int color = get_bits(&gb, 2);
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
112 run = FFMIN(run, w - x);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
113 // run length 0 means till end of row
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
114 if (!run) run = w - x;
5982
1900b70712ab colour --> color in variable names
diego
parents: 5493
diff changeset
115 memset(bitmap, color, run);
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
116 bitmap += run;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
117 x += run;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
118 }
5490
12d77ed34985 Deinterlace xsub subtitles
reimar
parents: 5489
diff changeset
119 // interlaced, skip every second line
12d77ed34985 Deinterlace xsub subtitles
reimar
parents: 5489
diff changeset
120 bitmap += w;
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
121 align_get_bits(&gb);
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
122 }
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
123 *data_size = 1;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
124 return buf_size;
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
125 }
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
126
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
127 AVCodec xsub_decoder = {
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
128 "xsub",
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
129 CODEC_TYPE_SUBTITLE,
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
130 CODEC_ID_XSUB,
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
131 0,
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
132 decode_init,
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
133 NULL,
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
134 NULL,
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
135 decode_frame,
7040
e943e1409077 Make AVCodec long_names definition conditional depending on CONFIG_SMALL.
stefano
parents: 6710
diff changeset
136 .long_name = NULL_IF_CONFIG_SMALL("XSUB"),
5483
447409d8770f First version of xsub decoder, not yet tested
reimar
parents:
diff changeset
137 };