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_full(AVCodecContext *avctx,
30 int play_res_x, int play_res_y,
31 const char *font, int font_size,
32 int primary_color, int secondary_color,
33 int outline_color, int back_color,
34 int bold, int italic, int underline,
35 int border_style, int alignment)
37 avctx->subtitle_header = av_asprintf(
39 "; Script generated by FFmpeg/Lavc%s\r\n"
40 "ScriptType: v4.00+\r\n"
48 "Fontname, Fontsize, "
49 "PrimaryColour, SecondaryColour, OutlineColour, BackColour, "
50 "Bold, Italic, Underline, StrikeOut, "
53 "BorderStyle, Outline, Shadow, "
54 "Alignment, MarginL, MarginR, MarginV, "
59 "%s,%d," /* Font{name,size} */
60 "&H%x,&H%x,&H%x,&H%x," /* {Primary,Secondary,Outline,Back}Colour */
61 "%d,%d,%d,0," /* Bold, Italic, Underline, StrikeOut */
62 "100,100," /* Scale{X,Y} */
63 "0,0," /* Spacing, Angle */
64 "%d,1,0," /* BorderStyle, Outline, Shadow */
65 "%d,10,10,10," /* Alignment, Margin[LRV] */
66 "0\r\n" /* Encoding */
70 "Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text\r\n",
71 !(avctx->flags & AV_CODEC_FLAG_BITEXACT) ? AV_STRINGIFY(LIBAVCODEC_VERSION) : "",
72 play_res_x, play_res_y, font, font_size,
73 primary_color, secondary_color, outline_color, back_color,
74 -bold, -italic, -underline, border_style, alignment);
76 if (!avctx->subtitle_header)
77 return AVERROR(ENOMEM);
78 avctx->subtitle_header_size = strlen(avctx->subtitle_header);
82 int ff_ass_subtitle_header(AVCodecContext *avctx,
83 const char *font, int font_size,
84 int color, int back_color,
85 int bold, int italic, int underline,
86 int border_style, int alignment)
88 return ff_ass_subtitle_header_full(avctx,
89 ASS_DEFAULT_PLAYRESX, ASS_DEFAULT_PLAYRESY,
90 font, font_size, color, color,
91 back_color, back_color,
92 bold, italic, underline,
93 border_style, alignment);
96 int ff_ass_subtitle_header_default(AVCodecContext *avctx)
98 return ff_ass_subtitle_header(avctx, ASS_DEFAULT_FONT,
99 ASS_DEFAULT_FONT_SIZE,
101 ASS_DEFAULT_BACK_COLOR,
104 ASS_DEFAULT_UNDERLINE,
105 ASS_DEFAULT_BORDERSTYLE,
106 ASS_DEFAULT_ALIGNMENT);
109 char *ff_ass_get_dialog(int readorder, int layer, const char *style,
110 const char *speaker, const char *text)
112 return av_asprintf("%d,%d,%s,%s,0,0,0,,%s",
113 readorder, layer, style ? style : "Default",
114 speaker ? speaker : "", text);
117 int ff_ass_add_rect(AVSubtitle *sub, const char *dialog,
118 int readorder, int layer, const char *style,
122 AVSubtitleRect **rects;
124 rects = av_realloc_array(sub->rects, sub->num_rects+1, sizeof(*sub->rects));
126 return AVERROR(ENOMEM);
128 rects[sub->num_rects] = av_mallocz(sizeof(*rects[0]));
129 if (!rects[sub->num_rects])
130 return AVERROR(ENOMEM);
131 rects[sub->num_rects]->type = SUBTITLE_ASS;
132 ass_str = ff_ass_get_dialog(readorder, layer, style, speaker, dialog);
134 return AVERROR(ENOMEM);
135 rects[sub->num_rects]->ass = ass_str;
140 void ff_ass_decoder_flush(AVCodecContext *avctx)
142 FFASSDecoderContext *s = avctx->priv_data;
143 if (!(avctx->flags2 & AV_CODEC_FLAG2_RO_FLUSH_NOOP))
147 void ff_ass_bprint_text_event(AVBPrint *buf, const char *p, int size,
148 const char *linebreaks, int keep_ass_markup)
150 const char *p_end = p + size;
152 for (; p < p_end && *p; p++) {
154 /* forced custom line breaks, not accounted as "normal" EOL */
155 if (linebreaks && strchr(linebreaks, *p)) {
156 av_bprintf(buf, "\\N");
158 /* standard ASS escaping so random characters don't get mis-interpreted
160 } else if (!keep_ass_markup && strchr("{}\\", *p)) {
161 av_bprintf(buf, "\\%c", *p);
163 /* some packets might end abruptly (no \0 at the end, like for example
164 * in some cases of demuxing from a classic video container), some
165 * might be terminated with \n or \r\n which we have to remove (for
166 * consistency with those who haven't), and we also have to deal with
167 * evil cases such as \r at the end of the buffer (and no \0 terminated
169 } else if (p[0] == '\n') {
170 /* some stuff left so we can insert a line break */
172 av_bprintf(buf, "\\N");
173 } else if (p[0] == '\r' && p < p_end - 1 && p[1] == '\n') {
174 /* \r followed by a \n, we can skip it. We don't insert the \N yet
175 * because we don't know if it is followed by more text */
178 /* finally, a sane character */
180 av_bprint_chars(buf, *p, 1);