FFmpeg
ass.c
Go to the documentation of this file.
1 /*
2  * SSA/ASS common functions
3  * Copyright (c) 2010 Aurelien Jacobs <aurel@gnuage.org>
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21 
22 #include "avcodec.h"
23 #include "ass.h"
24 #include "libavutil/avstring.h"
25 #include "libavutil/bprint.h"
26 #include "libavutil/common.h"
27 #include "version.h"
28 
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)
36 {
38  "[Script Info]\r\n"
39  "; Script generated by FFmpeg/Lavc%s\r\n"
40  "ScriptType: v4.00+\r\n"
41  "PlayResX: %d\r\n"
42  "PlayResY: %d\r\n"
43  "ScaledBorderAndShadow: yes\r\n"
44  "YCbCr Matrix: None\r\n"
45  "\r\n"
46  "[V4+ Styles]\r\n"
47 
48  /* ASS (v4+) header */
49  "Format: Name, "
50  "Fontname, Fontsize, "
51  "PrimaryColour, SecondaryColour, OutlineColour, BackColour, "
52  "Bold, Italic, Underline, StrikeOut, "
53  "ScaleX, ScaleY, "
54  "Spacing, Angle, "
55  "BorderStyle, Outline, Shadow, "
56  "Alignment, MarginL, MarginR, MarginV, "
57  "Encoding\r\n"
58 
59  "Style: "
60  "Default," /* Name */
61  "%s,%d," /* Font{name,size} */
62  "&H%x,&H%x,&H%x,&H%x," /* {Primary,Secondary,Outline,Back}Colour */
63  "%d,%d,%d,0," /* Bold, Italic, Underline, StrikeOut */
64  "100,100," /* Scale{X,Y} */
65  "0,0," /* Spacing, Angle */
66  "%d,1,0," /* BorderStyle, Outline, Shadow */
67  "%d,10,10,10," /* Alignment, Margin[LRV] */
68  "1\r\n" /* Encoding */
69 
70  "\r\n"
71  "[Events]\r\n"
72  "Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text\r\n",
74  play_res_x, play_res_y, font, font_size,
75  primary_color, secondary_color, outline_color, back_color,
76  -bold, -italic, -underline, border_style, alignment);
77 
78  if (!avctx->subtitle_header)
79  return AVERROR(ENOMEM);
80  avctx->subtitle_header_size = strlen(avctx->subtitle_header);
81  return 0;
82 }
83 
85  const char *font, int font_size,
86  int color, int back_color,
87  int bold, int italic, int underline,
88  int border_style, int alignment)
89 {
90  return ff_ass_subtitle_header_full(avctx,
92  font, font_size, color, color,
93  back_color, back_color,
94  bold, italic, underline,
95  border_style, alignment);
96 }
97 
99 {
109 }
110 
111 char *ff_ass_get_dialog(int readorder, int layer, const char *style,
112  const char *speaker, const char *text)
113 {
114  return av_asprintf("%d,%d,%s,%s,0,0,0,,%s",
115  readorder, layer, style ? style : "Default",
116  speaker ? speaker : "", text);
117 }
118 
119 int ff_ass_add_rect2(AVSubtitle *sub, const char *dialog,
120  int readorder, int layer, const char *style,
121  const char *speaker, unsigned *nb_rect_allocated)
122 {
123  AVSubtitleRect **rects = sub->rects, *rect;
124  char *ass_str;
125  uint64_t new_nb = 0;
126 
127  if (sub->num_rects >= UINT_MAX)
128  return AVERROR(ENOMEM);
129 
130  if (nb_rect_allocated && *nb_rect_allocated <= sub->num_rects) {
131  if (sub->num_rects < UINT_MAX / 17 * 16) {
132  new_nb = sub->num_rects + sub->num_rects/16 + 1;
133  } else
134  new_nb = UINT_MAX;
135  } else if (!nb_rect_allocated)
136  new_nb = sub->num_rects + 1;
137 
138  if (new_nb) {
139  rects = av_realloc_array(rects, new_nb, sizeof(*sub->rects));
140  if (!rects)
141  return AVERROR(ENOMEM);
142  if (nb_rect_allocated)
143  *nb_rect_allocated = new_nb;
144  sub->rects = rects;
145  }
146 
147  rect = av_mallocz(sizeof(*rect));
148  if (!rect)
149  return AVERROR(ENOMEM);
150  rects[sub->num_rects++] = rect;
151  rect->type = SUBTITLE_ASS;
152  ass_str = ff_ass_get_dialog(readorder, layer, style, speaker, dialog);
153  if (!ass_str)
154  return AVERROR(ENOMEM);
155  rect->ass = ass_str;
156  return 0;
157 }
158 
159 int ff_ass_add_rect(AVSubtitle *sub, const char *dialog,
160  int readorder, int layer, const char *style,
161  const char *speaker)
162 {
163  return ff_ass_add_rect2(sub, dialog, readorder, layer, style, speaker, NULL);
164 }
165 
167 {
168  FFASSDecoderContext *s = avctx->priv_data;
169  if (!(avctx->flags2 & AV_CODEC_FLAG2_RO_FLUSH_NOOP))
170  s->readorder = 0;
171 }
172 
173 void ff_ass_bprint_text_event(AVBPrint *buf, const char *p, int size,
174  const char *linebreaks, int keep_ass_markup)
175 {
176  const char *p_end = p + size;
177 
178  for (; p < p_end && *p; p++) {
179 
180  /* forced custom line breaks, not accounted as "normal" EOL */
181  if (linebreaks && strchr(linebreaks, *p)) {
182  av_bprintf(buf, "\\N");
183 
184  /* standard ASS escaping so random characters don't get mis-interpreted
185  * as ASS */
186  } else if (!keep_ass_markup && strchr("{}\\", *p)) {
187  av_bprintf(buf, "\\%c", *p);
188 
189  /* some packets might end abruptly (no \0 at the end, like for example
190  * in some cases of demuxing from a classic video container), some
191  * might be terminated with \n or \r\n which we have to remove (for
192  * consistency with those who haven't), and we also have to deal with
193  * evil cases such as \r at the end of the buffer (and no \0 terminated
194  * character) */
195  } else if (p[0] == '\n') {
196  /* some stuff left so we can insert a line break */
197  if (p < p_end - 1)
198  av_bprintf(buf, "\\N");
199  } else if (p[0] == '\r' && p < p_end - 1 && p[1] == '\n') {
200  /* \r followed by a \n, we can skip it. We don't insert the \N yet
201  * because we don't know if it is followed by more text */
202  continue;
203 
204  /* finally, a sane character */
205  } else {
206  av_bprint_chars(buf, *p, 1);
207  }
208  }
209 }
LIBAVCODEC_VERSION
#define LIBAVCODEC_VERSION
Definition: version.h:38
ff_ass_subtitle_header
int ff_ass_subtitle_header(AVCodecContext *avctx, const char *font, int font_size, int color, int back_color, int bold, int italic, int underline, int border_style, int alignment)
Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS.
Definition: ass.c:84
AVSubtitle
Definition: avcodec.h:2308
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
ff_ass_subtitle_header_default
int ff_ass_subtitle_header_default(AVCodecContext *avctx)
Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS with default style.
Definition: ass.c:98
color
Definition: vf_paletteuse.c:601
sub
static float sub(float src0, float src1)
Definition: dnn_backend_native_layer_mathbinary.c:31
rect
Definition: f_ebur128.c:76
AVSubtitleRect
Definition: avcodec.h:2280
av_asprintf
char * av_asprintf(const char *fmt,...)
Definition: avstring.c:116
ASS_DEFAULT_ALIGNMENT
#define ASS_DEFAULT_ALIGNMENT
Definition: ass.h:42
ff_ass_add_rect
int ff_ass_add_rect(AVSubtitle *sub, const char *dialog, int readorder, int layer, const char *style, const char *speaker)
Add an ASS dialog to a subtitle.
Definition: ass.c:159
AVCodecContext::subtitle_header
uint8_t * subtitle_header
Header containing style information for text subtitles.
Definition: avcodec.h:1708
version.h
ASS_DEFAULT_BORDERSTYLE
#define ASS_DEFAULT_BORDERSTYLE
Definition: ass.h:43
SUBTITLE_ASS
@ SUBTITLE_ASS
Formatted text, the ass field must be set by the decoder and is authoritative.
Definition: avcodec.h:2275
ff_ass_add_rect2
int ff_ass_add_rect2(AVSubtitle *sub, const char *dialog, int readorder, int layer, const char *style, const char *speaker, unsigned *nb_rect_allocated)
Add an ASS dialog to a subtitle.
Definition: ass.c:119
AVCodecContext::flags
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:478
ass.h
ff_ass_get_dialog
char * ff_ass_get_dialog(int readorder, int layer, const char *style, const char *speaker, const char *text)
Craft an ASS dialog string.
Definition: ass.c:111
ASS_DEFAULT_FONT
#define ASS_DEFAULT_FONT
Definition: ass.h:35
s
#define s(width, name)
Definition: cbs_vp9.c:256
av_realloc_array
void * av_realloc_array(void *ptr, size_t nmemb, size_t size)
Definition: mem.c:225
ff_ass_bprint_text_event
void ff_ass_bprint_text_event(AVBPrint *buf, const char *p, int size, const char *linebreaks, int keep_ass_markup)
Escape a text subtitle using ASS syntax into an AVBPrint buffer.
Definition: ass.c:173
ff_ass_subtitle_header_full
int ff_ass_subtitle_header_full(AVCodecContext *avctx, int play_res_x, int play_res_y, const char *font, int font_size, int primary_color, int secondary_color, int outline_color, int back_color, int bold, int italic, int underline, int border_style, int alignment)
Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS.
Definition: ass.c:29
ASS_DEFAULT_BACK_COLOR
#define ASS_DEFAULT_BACK_COLOR
Definition: ass.h:38
NULL
#define NULL
Definition: coverity.c:32
AVCodecContext::subtitle_header_size
int subtitle_header_size
Definition: avcodec.h:1709
ASS_DEFAULT_PLAYRESY
#define ASS_DEFAULT_PLAYRESY
Definition: ass.h:29
AVCodecContext::flags2
int flags2
AV_CODEC_FLAG2_*.
Definition: avcodec.h:485
ASS_DEFAULT_BOLD
#define ASS_DEFAULT_BOLD
Definition: ass.h:39
size
int size
Definition: twinvq_data.h:10344
ASS_DEFAULT_PLAYRESX
#define ASS_DEFAULT_PLAYRESX
Definition: ass.h:28
ASS_DEFAULT_UNDERLINE
#define ASS_DEFAULT_UNDERLINE
Definition: ass.h:41
ff_ass_decoder_flush
void ff_ass_decoder_flush(AVCodecContext *avctx)
Helper to flush a text subtitles decoder making use of the FFASSDecoderContext.
Definition: ass.c:166
bprint.h
common.h
AV_STRINGIFY
#define AV_STRINGIFY(s)
Definition: macros.h:66
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:264
ASS_DEFAULT_ITALIC
#define ASS_DEFAULT_ITALIC
Definition: ass.h:40
ASS_DEFAULT_COLOR
#define ASS_DEFAULT_COLOR
Definition: ass.h:37
avcodec.h
av_bprintf
void av_bprintf(AVBPrint *buf, const char *fmt,...)
Definition: bprint.c:94
ASS_DEFAULT_FONT_SIZE
#define ASS_DEFAULT_FONT_SIZE
Definition: ass.h:36
AVCodecContext
main external API structure.
Definition: avcodec.h:398
AV_CODEC_FLAG_BITEXACT
#define AV_CODEC_FLAG_BITEXACT
Use only bitexact stuff (except (I)DCT).
Definition: avcodec.h:288
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:425
FFASSDecoderContext
Definition: ass.h:46
av_bprint_chars
void av_bprint_chars(AVBPrint *buf, char c, unsigned n)
Append char c n times to a print buffer.
Definition: bprint.c:140
avstring.h
AV_CODEC_FLAG2_RO_FLUSH_NOOP
#define AV_CODEC_FLAG2_RO_FLUSH_NOOP
Do not reset ASS ReadOrder field on flush (subtitles decoding)
Definition: avcodec.h:343