2 * SSA/ASS common functions
3 * Copyright (c) 2010 Aurelien Jacobs <aurel@gnuage.org>
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 "libavutil/avassert.h"
25 #include "libavutil/avstring.h"
26 #include "libavutil/bprint.h"
27 #include "libavutil/common.h"
29 int ff_ass_subtitle_header(AVCodecContext *avctx,
30 const char *font, int font_size,
31 int color, int back_color,
32 int bold, int italic, int underline,
33 int border_style, int alignment)
35 avctx->subtitle_header = av_asprintf(
37 "; Script generated by FFmpeg/Lavc%s\r\n"
38 "ScriptType: v4.00+\r\n"
46 "Fontname, Fontsize, "
47 "PrimaryColour, SecondaryColour, OutlineColour, BackColour, "
48 "Bold, Italic, Underline, StrikeOut, "
51 "BorderStyle, Outline, Shadow, "
52 "Alignment, MarginL, MarginR, MarginV, "
57 "%s,%d," /* Font{name,size} */
58 "&H%x,&H%x,&H%x,&H%x," /* {Primary,Secondary,Outline,Back}Colour */
59 "%d,%d,%d,0," /* Bold, Italic, Underline, StrikeOut */
60 "100,100," /* Scale{X,Y} */
61 "0,0," /* Spacing, Angle */
62 "%d,1,0," /* BorderStyle, Outline, Shadow */
63 "%d,10,10,10," /* Alignment, Margin[LRV] */
64 "0\r\n" /* Encoding */
68 "Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text\r\n",
69 !(avctx->flags & AV_CODEC_FLAG_BITEXACT) ? AV_STRINGIFY(LIBAVCODEC_VERSION) : "",
70 ASS_DEFAULT_PLAYRESX, ASS_DEFAULT_PLAYRESY,
71 font, font_size, color, color, back_color, back_color,
72 -bold, -italic, -underline, border_style, alignment);
74 if (!avctx->subtitle_header)
75 return AVERROR(ENOMEM);
76 avctx->subtitle_header_size = strlen(avctx->subtitle_header);
80 int ff_ass_subtitle_header_default(AVCodecContext *avctx)
82 return ff_ass_subtitle_header(avctx, ASS_DEFAULT_FONT,
83 ASS_DEFAULT_FONT_SIZE,
85 ASS_DEFAULT_BACK_COLOR,
88 ASS_DEFAULT_UNDERLINE,
89 ASS_DEFAULT_BORDERSTYLE,
90 ASS_DEFAULT_ALIGNMENT);
93 static void insert_ts(AVBPrint *buf, int ts)
96 av_bprintf(buf, "9:59:59.99,");
100 h = ts/360000; ts -= 360000*h;
101 m = ts/ 6000; ts -= 6000*m;
102 s = ts/ 100; ts -= 100*s;
103 av_bprintf(buf, "%d:%02d:%02d.%02d,", h, m, s, ts);
107 int ff_ass_bprint_dialog(AVBPrint *buf, const char *dialog,
108 int ts_start, int duration, int raw)
112 if (!raw || raw == 2) {
117 dialog = strchr(dialog, ',');
119 return AVERROR_INVALIDDATA;
122 /* extract Layer or Marked */
123 layer = strtol(dialog, (char**)&dialog, 10);
125 return AVERROR_INVALIDDATA;
128 av_bprintf(buf, "Dialogue: %ld,", layer);
129 insert_ts(buf, ts_start);
130 insert_ts(buf, duration == -1 ? -1 : ts_start + duration);
132 av_bprintf(buf, "Default,,0,0,0,,");
135 dlen = strcspn(dialog, "\n");
136 dlen += dialog[dlen] == '\n';
138 av_bprintf(buf, "%.*s", dlen, dialog);
140 av_bprintf(buf, "\r\n");
145 int ff_ass_add_rect(AVSubtitle *sub, const char *dialog,
146 int ts_start, int duration, int raw)
150 AVSubtitleRect **rects;
152 av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
153 if ((ret = ff_ass_bprint_dialog(&buf, dialog, ts_start, duration, raw)) < 0)
156 if (!av_bprint_is_complete(&buf))
159 rects = av_realloc_array(sub->rects, (sub->num_rects+1), sizeof(*sub->rects));
163 sub->end_display_time = FFMAX(sub->end_display_time, 10 * duration);
164 rects[sub->num_rects] = av_mallocz(sizeof(*rects[0]));
165 if (!rects[sub->num_rects])
167 rects[sub->num_rects]->type = SUBTITLE_ASS;
168 ret = av_bprint_finalize(&buf, &rects[sub->num_rects]->ass);
175 ret = AVERROR(ENOMEM);
177 av_bprint_finalize(&buf, NULL);
181 int ff_ass_add_rect_bprint(AVSubtitle *sub, AVBPrint *buf,
182 int ts_start, int duration)
184 av_bprintf(buf, "\r\n");
185 if (!av_bprint_is_complete(buf))
186 return AVERROR(ENOMEM);
187 return ff_ass_add_rect(sub, buf->str, ts_start, duration, 0);
190 void ff_ass_bprint_text_event(AVBPrint *buf, const char *p, int size,
191 const char *linebreaks, int keep_ass_markup)
193 const char *p_end = p + size;
195 for (; p < p_end && *p; p++) {
197 /* forced custom line breaks, not accounted as "normal" EOL */
198 if (linebreaks && strchr(linebreaks, *p)) {
199 av_bprintf(buf, "\\N");
201 /* standard ASS escaping so random characters don't get mis-interpreted
203 } else if (!keep_ass_markup && strchr("{}\\", *p)) {
204 av_bprintf(buf, "\\%c", *p);
206 /* some packets might end abruptly (no \0 at the end, like for example
207 * in some cases of demuxing from a classic video container), some
208 * might be terminated with \n or \r\n which we have to remove (for
209 * consistency with those who haven't), and we also have to deal with
210 * evil cases such as \r at the end of the buffer (and no \0 terminated
212 } else if (p[0] == '\n') {
213 /* some stuff left so we can insert a line break */
215 av_bprintf(buf, "\\N");
216 } else if (p[0] == '\r' && p < p_end - 1 && p[1] == '\n') {
217 /* \r followed by a \n, we can skip it. We don't insert the \N yet
218 * because we don't know if it is followed by more text */
221 /* finally, a sane character */
223 av_bprint_chars(buf, *p, 1);