FFmpeg
Loading...
Searching...
No Matches
xsubenc.c
Go to the documentation of this file.
1/*
2 * DivX (XSUB) subtitle encoder
3 * Copyright (c) 2005 DivX, Inc.
4 * Copyright (c) 2009 Bjorn Axelsson
5 *
6 * This file is part of FFmpeg.
7 *
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23#include "avcodec.h"
24#include "bytestream.h"
25#include "codec_internal.h"
26#include "put_bits.h"
27
28/**
29 * Number of pixels to pad left and right.
30 *
31 * The official encoder pads the subtitles with two pixels on either side,
32 * but until we find out why, we won't do it (we will pad to have width
33 * divisible by 2 though).
34 */
35#define PADDING 0
36#define PADDING_COLOR 0
37
38/**
39 * Encode a single color run. At most 16 bits will be used.
40 * @param len length of the run, values > 255 mean "until end of line", may not be < 0.
41 * @param color color to encode, only the lowest two bits are used and all others must be 0.
42 */
43static void put_xsub_rle(PutBitContext *pb, int len, int color)
44{
45 if (len <= 255)
46 put_bits(pb, 2 + ((ff_log2_tab[len] >> 1) << 2), len);
47 else
48 put_bits(pb, 14, 0);
49 put_bits(pb, 2, color);
50}
51
52/**
53 * Encode a 4-color bitmap with XSUB rle.
54 *
55 * The encoded bitmap may be wider than the source bitmap due to padding.
56 */
57static int xsub_encode_rle(PutBitContext *pb, const uint8_t *bitmap,
58 int linesize, int w, int h)
59{
60 int x0, x1, y, len, color = PADDING_COLOR;
61
62 for (y = 0; y < h; y++) {
63 x0 = 0;
64 while (x0 < w) {
65 // Make sure we have enough room for at least one run and padding
66 if (put_bytes_left(pb, 1) < 7)
68
69 x1 = x0;
70 color = bitmap[x1++] & 3;
71 while (x1 < w && (bitmap[x1] & 3) == color)
72 x1++;
73 len = x1 - x0;
74 if (PADDING && x0 == 0) {
75 if (color == PADDING_COLOR) {
76 len += PADDING;
77 x0 -= PADDING;
78 } else
80 }
81
82 // Run can't be longer than 255, unless it is the rest of a row
83 if (x1 == w && color == PADDING_COLOR) {
84 len += PADDING + (w&1);
85 } else
86 len = FFMIN(len, 255);
88
89 x0 += len;
90 }
91 if (color != PADDING_COLOR && (PADDING + (w&1)))
93
95
96 bitmap += linesize;
97 }
98
99 return 0;
100}
101
102static int make_tc(uint64_t ms, int *tc)
103{
104 static const int tc_divs[3] = { 1000, 60, 60 };
105 int i;
106 for (i=0; i<3; i++) {
107 tc[i] = ms % tc_divs[i];
108 ms /= tc_divs[i];
109 }
110 tc[3] = ms;
111 return ms > 99;
112}
113
114static int xsub_encode(AVCodecContext *avctx, unsigned char *buf,
115 int bufsize, const AVSubtitle *h)
116{
117 uint64_t startTime = h->pts / 1000; // FIXME: need better solution...
118 uint64_t endTime = startTime + h->end_display_time - h->start_display_time;
119 int start_tc[4], end_tc[4];
120 uint8_t *hdr = buf + 27; // Point behind the timestamp
121 uint8_t *rlelenptr;
122 uint16_t width, height;
123 int i;
124 PutBitContext pb;
125
126 if (bufsize < 27 + 7*2 + 4*3) {
127 av_log(avctx, AV_LOG_ERROR, "Buffer too small for XSUB header.\n");
129 }
130
131 if (!h->num_rects) {
132 av_log(avctx, AV_LOG_ERROR, "No subtitle rectangle to encode.\n");
133 return AVERROR(EINVAL);
134 }
135
136 // TODO: support multiple rects
137 if (h->num_rects > 1)
138 av_log(avctx, AV_LOG_WARNING, "Only single rects supported (%d in subtitle.)\n", h->num_rects);
139
140 // TODO: render text-based subtitles into bitmaps
141 if (!h->rects[0]->data[0] || !h->rects[0]->data[1]) {
142 av_log(avctx, AV_LOG_WARNING, "No subtitle bitmap available.\n");
143 return AVERROR(EINVAL);
144 }
145
146 // TODO: color reduction, similar to dvdsub encoder
147 if (h->rects[0]->nb_colors > 4)
148 av_log(avctx, AV_LOG_WARNING, "No more than 4 subtitle colors supported (%d found.)\n", h->rects[0]->nb_colors);
149
150 // TODO: Palette swapping if color zero is not transparent
151 if (((uint32_t *)h->rects[0]->data[1])[0] & 0xff000000)
152 av_log(avctx, AV_LOG_WARNING, "Color index 0 is not transparent. Transparency will be messed up.\n");
153
154 if (make_tc(startTime, start_tc) || make_tc(endTime, end_tc)) {
155 av_log(avctx, AV_LOG_WARNING, "Time code >= 100 hours.\n");
156 return AVERROR(EINVAL);
157 }
158
159 snprintf(buf, 28,
160 "[%02d:%02d:%02d.%03d-%02d:%02d:%02d.%03d]",
161 start_tc[3], start_tc[2], start_tc[1], start_tc[0],
162 end_tc[3], end_tc[2], end_tc[1], end_tc[0]);
163
164 // Width and height must probably be multiples of 2.
165 // 2 pixels required on either side of subtitle.
166 // Possibly due to limitations of hardware renderers.
167 // TODO: check if the bitmap is already padded
168 width = FFALIGN(h->rects[0]->w, 2) + PADDING * 2;
169 height = FFALIGN(h->rects[0]->h, 2);
170
171 bytestream_put_le16(&hdr, width);
172 bytestream_put_le16(&hdr, height);
173 bytestream_put_le16(&hdr, h->rects[0]->x);
174 bytestream_put_le16(&hdr, h->rects[0]->y);
175 bytestream_put_le16(&hdr, h->rects[0]->x + width -1);
176 bytestream_put_le16(&hdr, h->rects[0]->y + height -1);
177
178 rlelenptr = hdr; // Will store length of first field here later.
179 hdr+=2;
180
181 // Palette
182 for (i=0; i<4; i++)
183 bytestream_put_be24(&hdr, ((uint32_t *)h->rects[0]->data[1])[i]);
184
185 // Bitmap
186 // RLE buffer. Reserve 2 bytes for possible padding after the last row.
187 init_put_bits(&pb, hdr, bufsize - (hdr - buf) - 2);
188 if (xsub_encode_rle(&pb, h->rects[0]->data[0],
189 h->rects[0]->linesize[0] * 2,
190 h->rects[0]->w, (h->rects[0]->h + 1) >> 1))
192 bytestream_put_le16(&rlelenptr, put_bytes_count(&pb, 0)); // Length of first field
193
194 if (xsub_encode_rle(&pb, h->rects[0]->data[0] + h->rects[0]->linesize[0],
195 h->rects[0]->linesize[0] * 2,
196 h->rects[0]->w, h->rects[0]->h >> 1))
198
199 // Enforce total height to be a multiple of 2
200 if (h->rects[0]->h & 1) {
201 put_xsub_rle(&pb, h->rects[0]->w, PADDING_COLOR);
202 }
203
204 flush_put_bits(&pb);
205
206 return hdr - buf + put_bytes_output(&pb);
207}
208
210{
211 if (!avctx->codec_tag)
212 avctx->codec_tag = MKTAG('D','X','S','B');
213
214 avctx->bits_per_coded_sample = 4;
215
216 return 0;
217}
218
220 .p.name = "xsub",
221 CODEC_LONG_NAME("DivX subtitles (XSUB)"),
222 .p.type = AVMEDIA_TYPE_SUBTITLE,
223 .p.id = AV_CODEC_ID_XSUB,
224 .init = xsub_encoder_init,
226};
const FFCodec ff_xsub_encoder
Definition xsubenc.c:219
Libavcodec external API header.
#define i(width, name, range_min, range_max)
Definition cbs_h264.c:63
#define FF_CODEC_ENCODE_SUB_CB(func)
#define CODEC_LONG_NAME(str)
@ AV_CODEC_ID_XSUB
Definition codec_id.h:575
#define AVERROR_BUFFER_TOO_SMALL
Buffer too small.
Definition error.h:53
#define AVERROR(e)
Definition error.h:45
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition log.h:216
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition log.h:210
@ AVMEDIA_TYPE_SUBTITLE
Definition avutil.h:203
const uint8_t ff_log2_tab[256]
Definition log2_tab.c:23
static void put_bits(Jpeg2000EncoderContext *s, int val, int n)
put n times val bit
Definition j2kenc.c:154
#define av_cold
Definition attributes.h:117
uint8_t w
Definition llvidencdsp.c:39
#define FFMIN(a, b)
Definition macros.h:49
#define MKTAG(a, b, c, d)
Definition macros.h:55
#define FFALIGN(x, a)
Definition macros.h:78
bitstream writer API
static void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
Initialize the PutBitContext s.
Definition put_bits.h:62
static int put_bytes_count(const PutBitContext *s, int round_up)
Definition put_bits.h:110
static int put_bytes_left(const PutBitContext *s, int round_up)
Definition put_bits.h:145
static void flush_put_bits(PutBitContext *s)
Pad the end of the output stream with zeros.
Definition put_bits.h:153
static int put_bytes_output(const PutBitContext *s)
Definition put_bits.h:99
static void align_put_bits(PutBitContext *s)
Pad the bitstream with zeros up to the next byte boundary.
Definition put_bits.h:445
main external API structure.
Definition avcodec.h:443
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
Definition avcodec.h:468
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition avcodec.h:1574
#define av_log(a,...)
#define height
Definition dsp.h:99
#define width
Definition dsp.h:99
int len
#define PADDING_COLOR
Definition xsubenc.c:36
#define PADDING
Number of pixels to pad left and right.
Definition xsubenc.c:35
static int xsub_encode_rle(PutBitContext *pb, const uint8_t *bitmap, int linesize, int w, int h)
Encode a 4-color bitmap with XSUB rle.
Definition xsubenc.c:57
static int make_tc(uint64_t ms, int *tc)
Definition xsubenc.c:102
static void put_xsub_rle(PutBitContext *pb, int len, int color)
Encode a single color run.
Definition xsubenc.c:43
static int xsub_encode(AVCodecContext *avctx, unsigned char *buf, int bufsize, const AVSubtitle *h)
Definition xsubenc.c:114
static av_cold int xsub_encoder_init(AVCodecContext *avctx)
Definition xsubenc.c:209