Merge commit '9d218d573f8088c606d873e80df572582e6773ef'
[ffmpeg.git] / libavcodec / ass.c
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/avassert.h"
25 #include "libavutil/avstring.h"
26 #include "libavutil/bprint.h"
27 #include "libavutil/common.h"
28
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 alignment)
34 {
35     avctx->subtitle_header = av_asprintf(
36              "[Script Info]\r\n"
37              "; Script generated by FFmpeg/Lavc%s\r\n"
38              "ScriptType: v4.00+\r\n"
39              "PlayResX: %d\r\n"
40              "PlayResY: %d\r\n"
41              "\r\n"
42              "[V4+ Styles]\r\n"
43
44              /* ASSv4 header */
45              "Format: Name, "
46              "Fontname, Fontsize, "
47              "PrimaryColour, SecondaryColour, OutlineColour, BackColour, "
48              "Bold, Italic, Underline, StrikeOut, "
49              "ScaleX, ScaleY, "
50              "Spacing, Angle, "
51              "BorderStyle, Outline, Shadow, "
52              "Alignment, MarginL, MarginR, MarginV, "
53              "Encoding\r\n"
54
55              "Style: "
56              "Default,"             /* Name */
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              "1,1,0,"               /* BorderStyle, Outline, Shadow */
63              "%d,10,10,10,"         /* Alignment, Margin[LRV] */
64              "0\r\n"                /* Encoding */
65
66              "\r\n"
67              "[Events]\r\n"
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, alignment);
73
74     if (!avctx->subtitle_header)
75         return AVERROR(ENOMEM);
76     avctx->subtitle_header_size = strlen(avctx->subtitle_header);
77     return 0;
78 }
79
80 int ff_ass_subtitle_header_default(AVCodecContext *avctx)
81 {
82     return ff_ass_subtitle_header(avctx, ASS_DEFAULT_FONT,
83                                ASS_DEFAULT_FONT_SIZE,
84                                ASS_DEFAULT_COLOR,
85                                ASS_DEFAULT_BACK_COLOR,
86                                ASS_DEFAULT_BOLD,
87                                ASS_DEFAULT_ITALIC,
88                                ASS_DEFAULT_UNDERLINE,
89                                ASS_DEFAULT_ALIGNMENT);
90 }
91
92 static void insert_ts(AVBPrint *buf, int ts)
93 {
94     if (ts == -1) {
95         av_bprintf(buf, "9:59:59.99,");
96     } else {
97         int h, m, s;
98
99         h = ts/360000;  ts -= 360000*h;
100         m = ts/  6000;  ts -=   6000*m;
101         s = ts/   100;  ts -=    100*s;
102         av_bprintf(buf, "%d:%02d:%02d.%02d,", h, m, s, ts);
103     }
104 }
105
106 int ff_ass_bprint_dialog(AVBPrint *buf, const char *dialog,
107                          int ts_start, int duration, int raw)
108 {
109     int dlen;
110
111     if (!raw || raw == 2) {
112         long int layer = 0;
113
114         if (raw == 2) {
115             /* skip ReadOrder */
116             dialog = strchr(dialog, ',');
117             if (!dialog)
118                 return AVERROR_INVALIDDATA;
119             dialog++;
120
121             /* extract Layer or Marked */
122             layer = strtol(dialog, (char**)&dialog, 10);
123             if (*dialog != ',')
124                 return AVERROR_INVALIDDATA;
125             dialog++;
126         }
127         av_bprintf(buf, "Dialogue: %ld,", layer);
128         insert_ts(buf, ts_start);
129         insert_ts(buf, duration == -1 ? -1 : ts_start + duration);
130         if (raw != 2)
131             av_bprintf(buf, "Default,,0,0,0,,");
132     }
133
134     dlen = strcspn(dialog, "\n");
135     dlen += dialog[dlen] == '\n';
136
137     av_bprintf(buf, "%.*s", dlen, dialog);
138     if (raw == 2)
139         av_bprintf(buf, "\r\n");
140
141     return dlen;
142 }
143
144 int ff_ass_add_rect(AVSubtitle *sub, const char *dialog,
145                     int ts_start, int duration, int raw)
146 {
147     AVBPrint buf;
148     int ret, dlen;
149     AVSubtitleRect **rects;
150
151     av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
152     if ((ret = ff_ass_bprint_dialog(&buf, dialog, ts_start, duration, raw)) < 0)
153         goto err;
154     dlen = ret;
155     if (!av_bprint_is_complete(&buf))
156         goto errnomem;
157
158     rects = av_realloc_array(sub->rects, (sub->num_rects+1), sizeof(*sub->rects));
159     if (!rects)
160         goto errnomem;
161     sub->rects = rects;
162     sub->end_display_time = FFMAX(sub->end_display_time, 10 * duration);
163     rects[sub->num_rects]       = av_mallocz(sizeof(*rects[0]));
164     if (!rects[sub->num_rects])
165         goto errnomem;
166     rects[sub->num_rects]->type = SUBTITLE_ASS;
167     ret = av_bprint_finalize(&buf, &rects[sub->num_rects]->ass);
168     if (ret < 0)
169         goto err;
170     sub->num_rects++;
171     return dlen;
172
173 errnomem:
174     ret = AVERROR(ENOMEM);
175 err:
176     av_bprint_finalize(&buf, NULL);
177     return ret;
178 }
179
180 int ff_ass_add_rect_bprint(AVSubtitle *sub, AVBPrint *buf,
181                            int ts_start, int duration)
182 {
183     av_bprintf(buf, "\r\n");
184     if (!av_bprint_is_complete(buf))
185         return AVERROR(ENOMEM);
186     return ff_ass_add_rect(sub, buf->str, ts_start, duration, 0);
187 }
188
189 void ff_ass_bprint_text_event(AVBPrint *buf, const char *p, int size,
190                              const char *linebreaks, int keep_ass_markup)
191 {
192     const char *p_end = p + size;
193
194     for (; p < p_end && *p; p++) {
195
196         /* forced custom line breaks, not accounted as "normal" EOL */
197         if (linebreaks && strchr(linebreaks, *p)) {
198             av_bprintf(buf, "\\N");
199
200         /* standard ASS escaping so random characters don't get mis-interpreted
201          * as ASS */
202         } else if (!keep_ass_markup && strchr("{}\\", *p)) {
203             av_bprintf(buf, "\\%c", *p);
204
205         /* some packets might end abruptly (no \0 at the end, like for example
206          * in some cases of demuxing from a classic video container), some
207          * might be terminated with \n or \r\n which we have to remove (for
208          * consistency with those who haven't), and we also have to deal with
209          * evil cases such as \r at the end of the buffer (and no \0 terminated
210          * character) */
211         } else if (p[0] == '\n') {
212             /* some stuff left so we can insert a line break */
213             if (p < p_end - 1)
214                 av_bprintf(buf, "\\N");
215         } else if (p[0] == '\r' && p < p_end - 1 && p[1] == '\n') {
216             /* \r followed by a \n, we can skip it. We don't insert the \N yet
217              * because we don't know if it is followed by more text */
218             continue;
219
220         /* finally, a sane character */
221         } else {
222             av_bprint_chars(buf, *p, 1);
223         }
224     }
225 }