2 * Copyright (c) 2011 Baptiste Coudurier
3 * Copyright (c) 2011 Stefano Sabatini
4 * Copyright (c) 2012 Clément Bœsch
6 * This file is part of FFmpeg.
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.
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.
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
25 * Libass subtitles burning filter.
27 * @see{http://www.matroska.org/technical/specs/subtitles/ssa.html}
33 #if CONFIG_SUBTITLES_FILTER
34 # include "libavcodec/avcodec.h"
35 # include "libavformat/avformat.h"
37 #include "libavutil/avstring.h"
38 #include "libavutil/imgutils.h"
39 #include "libavutil/opt.h"
40 #include "libavutil/parseutils.h"
41 #include "drawutils.h"
50 ASS_Renderer *renderer;
57 int pix_step[4]; ///< steps per pixel for each plane of the main output
58 int original_w, original_h;
63 #define OFFSET(x) offsetof(AssContext, x)
64 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
66 #define COMMON_OPTIONS \
67 {"filename", "set the filename of file to read", OFFSET(filename), AV_OPT_TYPE_STRING, {.str = NULL}, CHAR_MIN, CHAR_MAX, FLAGS }, \
68 {"f", "set the filename of file to read", OFFSET(filename), AV_OPT_TYPE_STRING, {.str = NULL}, CHAR_MIN, CHAR_MAX, FLAGS }, \
69 {"original_size", "set the size of the original video (used to scale fonts)", OFFSET(original_w), AV_OPT_TYPE_IMAGE_SIZE, {.str = NULL}, CHAR_MIN, CHAR_MAX, FLAGS }, \
71 /* libass supports a log level ranging from 0 to 7 */
72 static const int ass_libavfilter_log_level_map[] = {
73 [0] = AV_LOG_FATAL, /* MSGL_FATAL */
74 [1] = AV_LOG_ERROR, /* MSGL_ERR */
75 [2] = AV_LOG_WARNING, /* MSGL_WARN */
76 [3] = AV_LOG_WARNING, /* <undefined> */
77 [4] = AV_LOG_INFO, /* MSGL_INFO */
78 [5] = AV_LOG_INFO, /* <undefined> */
79 [6] = AV_LOG_VERBOSE, /* MSGL_V */
80 [7] = AV_LOG_DEBUG, /* MSGL_DBG2 */
83 static void ass_log(int ass_level, const char *fmt, va_list args, void *ctx)
85 const int ass_level_clip = av_clip(ass_level, 0,
86 FF_ARRAY_ELEMS(ass_libavfilter_log_level_map) - 1);
87 const int level = ass_libavfilter_log_level_map[ass_level_clip];
89 av_vlog(ctx, level, fmt, args);
90 av_log(ctx, level, "\n");
93 static av_cold int init(AVFilterContext *ctx)
95 AssContext *ass = ctx->priv;
98 av_log(ctx, AV_LOG_ERROR, "No filename provided!\n");
99 return AVERROR(EINVAL);
102 ass->library = ass_library_init();
104 av_log(ctx, AV_LOG_ERROR, "Could not initialize libass.\n");
105 return AVERROR(EINVAL);
107 ass_set_message_cb(ass->library, ass_log, ctx);
109 ass->renderer = ass_renderer_init(ass->library);
110 if (!ass->renderer) {
111 av_log(ctx, AV_LOG_ERROR, "Could not initialize libass renderer.\n");
112 return AVERROR(EINVAL);
118 static av_cold void uninit(AVFilterContext *ctx)
120 AssContext *ass = ctx->priv;
123 ass_free_track(ass->track);
125 ass_renderer_done(ass->renderer);
127 ass_library_done(ass->library);
130 static int query_formats(AVFilterContext *ctx)
132 return ff_set_common_formats(ctx, ff_draw_supported_pixel_formats(0));
135 static int config_input(AVFilterLink *inlink)
137 AssContext *ass = inlink->dst->priv;
139 ff_draw_init(&ass->draw, inlink->format, 0);
141 ass_set_frame_size (ass->renderer, inlink->w, inlink->h);
142 if (ass->original_w && ass->original_h)
143 ass_set_aspect_ratio(ass->renderer, (double)inlink->w / inlink->h,
144 (double)ass->original_w / ass->original_h);
145 if (ass->shaping != -1)
146 ass_set_shaper(ass->renderer, ass->shaping);
151 /* libass stores an RGBA color in the format RRGGBBTT, where TT is the transparency level */
152 #define AR(c) ( (c)>>24)
153 #define AG(c) (((c)>>16)&0xFF)
154 #define AB(c) (((c)>>8) &0xFF)
155 #define AA(c) ((0xFF-(c)) &0xFF)
157 static void overlay_ass_image(AssContext *ass, AVFrame *picref,
158 const ASS_Image *image)
160 for (; image; image = image->next) {
161 uint8_t rgba_color[] = {AR(image->color), AG(image->color), AB(image->color), AA(image->color)};
163 ff_draw_color(&ass->draw, &color, rgba_color);
164 ff_blend_mask(&ass->draw, &color,
165 picref->data, picref->linesize,
166 picref->width, picref->height,
167 image->bitmap, image->stride, image->w, image->h,
168 3, 0, image->dst_x, image->dst_y);
172 static int filter_frame(AVFilterLink *inlink, AVFrame *picref)
174 AVFilterContext *ctx = inlink->dst;
175 AVFilterLink *outlink = ctx->outputs[0];
176 AssContext *ass = ctx->priv;
177 int detect_change = 0;
178 double time_ms = picref->pts * av_q2d(inlink->time_base) * 1000;
179 ASS_Image *image = ass_render_frame(ass->renderer, ass->track,
180 time_ms, &detect_change);
183 av_log(ctx, AV_LOG_DEBUG, "Change happened at time ms:%f\n", time_ms);
185 overlay_ass_image(ass, picref, image);
187 return ff_filter_frame(outlink, picref);
190 static const AVFilterPad ass_inputs[] = {
193 .type = AVMEDIA_TYPE_VIDEO,
194 .filter_frame = filter_frame,
195 .config_props = config_input,
201 static const AVFilterPad ass_outputs[] = {
204 .type = AVMEDIA_TYPE_VIDEO,
209 #if CONFIG_ASS_FILTER
211 static const AVOption ass_options[] = {
213 {"shaping", "set shaping engine", OFFSET(shaping), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 1, FLAGS, "shaping_mode"},
214 {"auto", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = -1}, INT_MIN, INT_MAX, FLAGS, "shaping_mode"},
215 {"simple", "simple shaping", 0, AV_OPT_TYPE_CONST, {.i64 = ASS_SHAPING_SIMPLE}, INT_MIN, INT_MAX, FLAGS, "shaping_mode"},
216 {"complex", "complex shaping", 0, AV_OPT_TYPE_CONST, {.i64 = ASS_SHAPING_COMPLEX}, INT_MIN, INT_MAX, FLAGS, "shaping_mode"},
220 AVFILTER_DEFINE_CLASS(ass);
222 static av_cold int init_ass(AVFilterContext *ctx)
224 AssContext *ass = ctx->priv;
230 /* Initialize fonts */
231 ass_set_fonts(ass->renderer, NULL, NULL, 1, NULL, 1);
233 ass->track = ass_read_file(ass->library, ass->filename, NULL);
235 av_log(ctx, AV_LOG_ERROR,
236 "Could not create a libass track when reading file '%s'\n",
238 return AVERROR(EINVAL);
243 AVFilter ff_vf_ass = {
245 .description = NULL_IF_CONFIG_SMALL("Render ASS subtitles onto input video using the libass library."),
246 .priv_size = sizeof(AssContext),
249 .query_formats = query_formats,
250 .inputs = ass_inputs,
251 .outputs = ass_outputs,
252 .priv_class = &ass_class,
256 #if CONFIG_SUBTITLES_FILTER
258 static const AVOption subtitles_options[] = {
260 {"charenc", "set input character encoding", OFFSET(charenc), AV_OPT_TYPE_STRING, {.str = NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
261 {"stream_index", "set stream index", OFFSET(stream_index), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS},
262 {"si", "set stream index", OFFSET(stream_index), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS},
263 {"force_style", "force subtitle style", OFFSET(force_style), AV_OPT_TYPE_STRING, {.str = NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
267 static const char * const font_mimetypes[] = {
268 "application/x-truetype-font",
269 "application/vnd.ms-opentype",
270 "application/x-font-ttf",
274 static int attachment_is_font(AVStream * st)
276 const AVDictionaryEntry *tag = NULL;
279 tag = av_dict_get(st->metadata, "mimetype", NULL, AV_DICT_MATCH_CASE);
282 for (n = 0; font_mimetypes[n]; n++) {
283 if (av_strcasecmp(font_mimetypes[n], tag->value) == 0)
290 AVFILTER_DEFINE_CLASS(subtitles);
292 static av_cold int init_subtitles(AVFilterContext *ctx)
296 AVDictionary *codec_opts = NULL;
297 AVFormatContext *fmt = NULL;
298 AVCodecContext *dec_ctx = NULL;
300 const AVCodecDescriptor *dec_desc;
303 AssContext *ass = ctx->priv;
309 ass->track = ass_new_track(ass->library);
311 av_log(ctx, AV_LOG_ERROR, "Could not create a libass track\n");
312 return AVERROR(EINVAL);
315 /* Open subtitles file */
316 ret = avformat_open_input(&fmt, ass->filename, NULL, NULL);
318 av_log(ctx, AV_LOG_ERROR, "Unable to open %s\n", ass->filename);
321 ret = avformat_find_stream_info(fmt, NULL);
325 /* Locate subtitles stream */
326 if (ass->stream_index < 0)
327 ret = av_find_best_stream(fmt, AVMEDIA_TYPE_SUBTITLE, -1, -1, NULL, 0);
330 if (ass->stream_index < fmt->nb_streams) {
331 for (j = 0; j < fmt->nb_streams; j++) {
332 if (fmt->streams[j]->codec->codec_type == AVMEDIA_TYPE_SUBTITLE) {
333 if (ass->stream_index == k) {
344 av_log(ctx, AV_LOG_ERROR, "Unable to locate subtitle stream in %s\n",
349 st = fmt->streams[sid];
351 /* Load attached fonts */
352 for (j = 0; j < fmt->nb_streams; j++) {
353 AVStream *st = fmt->streams[j];
354 if (st->codec->codec_type == AVMEDIA_TYPE_ATTACHMENT &&
355 attachment_is_font(st)) {
356 const AVDictionaryEntry *tag = NULL;
357 tag = av_dict_get(st->metadata, "filename", NULL,
361 av_log(ctx, AV_LOG_DEBUG, "Loading attached font: %s\n",
363 ass_add_font(ass->library, tag->value,
364 st->codec->extradata,
365 st->codec->extradata_size);
367 av_log(ctx, AV_LOG_WARNING,
368 "Font attachment has no filename, ignored.\n");
373 /* Initialize fonts */
374 ass_set_fonts(ass->renderer, NULL, NULL, 1, NULL, 1);
378 dec = avcodec_find_decoder(dec_ctx->codec_id);
380 av_log(ctx, AV_LOG_ERROR, "Failed to find subtitle codec %s\n",
381 avcodec_get_name(dec_ctx->codec_id));
382 return AVERROR(EINVAL);
384 dec_desc = avcodec_descriptor_get(dec_ctx->codec_id);
385 if (dec_desc && !(dec_desc->props & AV_CODEC_PROP_TEXT_SUB)) {
386 av_log(ctx, AV_LOG_ERROR,
387 "Only text based subtitles are currently supported\n");
388 return AVERROR_PATCHWELCOME;
391 av_dict_set(&codec_opts, "sub_charenc", ass->charenc, 0);
392 ret = avcodec_open2(dec_ctx, dec, &codec_opts);
396 if (ass->force_style) {
399 char *ptr = av_strtok(ass->force_style, ",", &temp);
402 av_dynarray_add(&list, &i, ptr);
404 ret = AVERROR(ENOMEM);
407 ptr = av_strtok(NULL, ",", &temp);
409 av_dynarray_add(&list, &i, NULL);
411 ret = AVERROR(ENOMEM);
414 ass_set_style_overrides(ass->library, list);
417 /* Decode subtitles and push them into the renderer (libass) */
418 if (dec_ctx->subtitle_header)
419 ass_process_codec_private(ass->track,
420 dec_ctx->subtitle_header,
421 dec_ctx->subtitle_header_size);
422 av_init_packet(&pkt);
425 while (av_read_frame(fmt, &pkt) >= 0) {
427 AVSubtitle sub = {0};
429 if (pkt.stream_index == sid) {
430 ret = avcodec_decode_subtitle2(dec_ctx, &sub, &got_subtitle, &pkt);
432 av_log(ctx, AV_LOG_WARNING, "Error decoding: %s (ignored)\n",
434 } else if (got_subtitle) {
435 for (i = 0; i < sub.num_rects; i++) {
436 char *ass_line = sub.rects[i]->ass;
439 ass_process_data(ass->track, ass_line, strlen(ass_line));
443 av_free_packet(&pkt);
444 avsubtitle_free(&sub);
448 av_dict_free(&codec_opts);
450 avcodec_close(dec_ctx);
452 avformat_close_input(&fmt);
456 AVFilter ff_vf_subtitles = {
458 .description = NULL_IF_CONFIG_SMALL("Render text subtitles onto input video using the libass library."),
459 .priv_size = sizeof(AssContext),
460 .init = init_subtitles,
462 .query_formats = query_formats,
463 .inputs = ass_inputs,
464 .outputs = ass_outputs,
465 .priv_class = &subtitles_class,