lavfi/subtitles: split options between ass and subtitles.
[ffmpeg.git] / libavfilter / vf_ass.c
1 /*
2  * Copyright (c) 2011 Baptiste Coudurier
3  * Copyright (c) 2011 Stefano Sabatini
4  * Copyright (c) 2012 Clément Bœsch
5  *
6  * This file is part of FFmpeg.
7  *
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.
12  *
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.
17  *
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
21  */
22
23 /**
24  * @file
25  * Libass subtitles burning filter.
26  *
27  * @see{http://www.matroska.org/technical/specs/subtitles/ssa.html}
28  */
29
30 #include <ass/ass.h>
31
32 #include "config.h"
33 #if CONFIG_SUBTITLES_FILTER
34 # include "libavcodec/avcodec.h"
35 # include "libavformat/avformat.h"
36 #endif
37 #include "libavutil/avstring.h"
38 #include "libavutil/imgutils.h"
39 #include "libavutil/opt.h"
40 #include "libavutil/parseutils.h"
41 #include "drawutils.h"
42 #include "avfilter.h"
43 #include "internal.h"
44 #include "formats.h"
45 #include "video.h"
46
47 typedef struct {
48     const AVClass *class;
49     ASS_Library  *library;
50     ASS_Renderer *renderer;
51     ASS_Track    *track;
52     char *filename;
53     uint8_t rgba_map[4];
54     int     pix_step[4];       ///< steps per pixel for each plane of the main output
55     int original_w, original_h;
56     FFDrawContext draw;
57 } AssContext;
58
59 #define OFFSET(x) offsetof(AssContext, x)
60 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
61
62 #define COMMON_OPTIONS \
63     {"filename",       "set the filename of file to read",                         OFFSET(filename),   AV_OPT_TYPE_STRING,     {.str = NULL},  CHAR_MIN, CHAR_MAX, FLAGS }, \
64     {"f",              "set the filename of file to read",                         OFFSET(filename),   AV_OPT_TYPE_STRING,     {.str = NULL},  CHAR_MIN, CHAR_MAX, FLAGS }, \
65     {"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 }, \
66
67 /* libass supports a log level ranging from 0 to 7 */
68 static const int ass_libavfilter_log_level_map[] = {
69     AV_LOG_QUIET,               /* 0 */
70     AV_LOG_PANIC,               /* 1 */
71     AV_LOG_FATAL,               /* 2 */
72     AV_LOG_ERROR,               /* 3 */
73     AV_LOG_WARNING,             /* 4 */
74     AV_LOG_INFO,                /* 5 */
75     AV_LOG_VERBOSE,             /* 6 */
76     AV_LOG_DEBUG,               /* 7 */
77 };
78
79 static void ass_log(int ass_level, const char *fmt, va_list args, void *ctx)
80 {
81     int level = ass_libavfilter_log_level_map[ass_level];
82
83     av_vlog(ctx, level, fmt, args);
84     av_log(ctx, level, "\n");
85 }
86
87 static av_cold int init(AVFilterContext *ctx, const char *args, const AVClass *class)
88 {
89     AssContext *ass = ctx->priv;
90     static const char *shorthand[] = { "filename", NULL };
91     int ret;
92
93     ass->class = class;
94     av_opt_set_defaults(ass);
95
96     if ((ret = av_opt_set_from_string(ass, args, shorthand, "=", ":")) < 0)
97         return ret;
98
99     if (!ass->filename) {
100         av_log(ctx, AV_LOG_ERROR, "No filename provided!\n");
101         return AVERROR(EINVAL);
102     }
103
104     ass->library = ass_library_init();
105     if (!ass->library) {
106         av_log(ctx, AV_LOG_ERROR, "Could not initialize libass.\n");
107         return AVERROR(EINVAL);
108     }
109     ass_set_message_cb(ass->library, ass_log, ctx);
110
111     ass->renderer = ass_renderer_init(ass->library);
112     if (!ass->renderer) {
113         av_log(ctx, AV_LOG_ERROR, "Could not initialize libass renderer.\n");
114         return AVERROR(EINVAL);
115     }
116
117     ass_set_fonts(ass->renderer, NULL, NULL, 1, NULL, 1);
118     return 0;
119 }
120
121 static av_cold void uninit(AVFilterContext *ctx)
122 {
123     AssContext *ass = ctx->priv;
124
125     av_opt_free(ass);
126     if (ass->track)
127         ass_free_track(ass->track);
128     if (ass->renderer)
129         ass_renderer_done(ass->renderer);
130     if (ass->library)
131         ass_library_done(ass->library);
132 }
133
134 static int query_formats(AVFilterContext *ctx)
135 {
136     ff_set_common_formats(ctx, ff_draw_supported_pixel_formats(0));
137     return 0;
138 }
139
140 static int config_input(AVFilterLink *inlink)
141 {
142     AssContext *ass = inlink->dst->priv;
143
144     ff_draw_init(&ass->draw, inlink->format, 0);
145
146     ass_set_frame_size  (ass->renderer, inlink->w, inlink->h);
147     if (ass->original_w && ass->original_h)
148         ass_set_aspect_ratio(ass->renderer, (double)inlink->w / inlink->h,
149                              (double)ass->original_w / ass->original_h);
150
151     return 0;
152 }
153
154 /* libass stores an RGBA color in the format RRGGBBTT, where TT is the transparency level */
155 #define AR(c)  ( (c)>>24)
156 #define AG(c)  (((c)>>16)&0xFF)
157 #define AB(c)  (((c)>>8) &0xFF)
158 #define AA(c)  ((0xFF-c) &0xFF)
159
160 static void overlay_ass_image(AssContext *ass, AVFilterBufferRef *picref,
161                               const ASS_Image *image)
162 {
163     for (; image; image = image->next) {
164         uint8_t rgba_color[] = {AR(image->color), AG(image->color), AB(image->color), AA(image->color)};
165         FFDrawColor color;
166         ff_draw_color(&ass->draw, &color, rgba_color);
167         ff_blend_mask(&ass->draw, &color,
168                       picref->data, picref->linesize,
169                       picref->video->w, picref->video->h,
170                       image->bitmap, image->stride, image->w, image->h,
171                       3, 0, image->dst_x, image->dst_y);
172     }
173 }
174
175 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *picref)
176 {
177     AVFilterContext *ctx = inlink->dst;
178     AVFilterLink *outlink = ctx->outputs[0];
179     AssContext *ass = ctx->priv;
180     int detect_change = 0;
181     double time_ms = picref->pts * av_q2d(inlink->time_base) * 1000;
182     ASS_Image *image = ass_render_frame(ass->renderer, ass->track,
183                                         time_ms, &detect_change);
184
185     if (detect_change)
186         av_log(ctx, AV_LOG_DEBUG, "Change happened at time ms:%f\n", time_ms);
187
188     overlay_ass_image(ass, picref, image);
189
190     return ff_filter_frame(outlink, picref);
191 }
192
193 static const AVFilterPad ass_inputs[] = {
194     {
195         .name             = "default",
196         .type             = AVMEDIA_TYPE_VIDEO,
197         .filter_frame     = filter_frame,
198         .config_props     = config_input,
199         .min_perms        = AV_PERM_READ | AV_PERM_WRITE,
200     },
201     { NULL }
202 };
203
204 static const AVFilterPad ass_outputs[] = {
205     {
206         .name = "default",
207         .type = AVMEDIA_TYPE_VIDEO,
208     },
209     { NULL }
210 };
211
212 #if CONFIG_ASS_FILTER
213
214 static const AVOption ass_options[] = {
215     COMMON_OPTIONS
216     {NULL},
217 };
218
219 AVFILTER_DEFINE_CLASS(ass);
220
221 static av_cold int init_ass(AVFilterContext *ctx, const char *args)
222 {
223     AssContext *ass = ctx->priv;
224     int ret = init(ctx, args, &ass_class);
225
226     if (ret < 0)
227         return ret;
228
229     ass->track = ass_read_file(ass->library, ass->filename, NULL);
230     if (!ass->track) {
231         av_log(ctx, AV_LOG_ERROR,
232                "Could not create a libass track when reading file '%s'\n",
233                ass->filename);
234         return AVERROR(EINVAL);
235     }
236     return 0;
237 }
238
239 AVFilter avfilter_vf_ass = {
240     .name          = "ass",
241     .description   = NULL_IF_CONFIG_SMALL("Render subtitles onto input video using the libass library."),
242     .priv_size     = sizeof(AssContext),
243     .init          = init_ass,
244     .uninit        = uninit,
245     .query_formats = query_formats,
246     .inputs        = ass_inputs,
247     .outputs       = ass_outputs,
248     .priv_class    = &ass_class,
249 };
250 #endif
251
252 #if CONFIG_SUBTITLES_FILTER
253
254 static const AVOption subtitles_options[] = {
255     COMMON_OPTIONS
256     {NULL},
257 };
258
259 AVFILTER_DEFINE_CLASS(subtitles);
260
261 static av_cold int init_subtitles(AVFilterContext *ctx, const char *args)
262 {
263     int ret, sid;
264     AVFormatContext *fmt = NULL;
265     AVCodecContext *dec_ctx = NULL;
266     AVCodec *dec = NULL;
267     AVStream *st;
268     AVPacket pkt;
269     AssContext *ass = ctx->priv;
270
271     /* Init libass */
272     ret = init(ctx, args, &subtitles_class);
273     if (ret < 0)
274         return ret;
275     ass->track = ass_new_track(ass->library);
276     if (!ass->track) {
277         av_log(ctx, AV_LOG_ERROR, "Could not create a libass track\n");
278         return AVERROR(EINVAL);
279     }
280
281     /* Open subtitles file */
282     ret = avformat_open_input(&fmt, ass->filename, NULL, NULL);
283     if (ret < 0) {
284         av_log(ctx, AV_LOG_ERROR, "Unable to open %s\n", ass->filename);
285         goto end;
286     }
287     ret = avformat_find_stream_info(fmt, NULL);
288     if (ret < 0)
289         goto end;
290
291     /* Locate subtitles stream */
292     ret = av_find_best_stream(fmt, AVMEDIA_TYPE_SUBTITLE, -1, -1, NULL, 0);
293     if (ret < 0) {
294         av_log(ctx, AV_LOG_ERROR, "Unable to locate subtitle stream in %s\n",
295                ass->filename);
296         goto end;
297     }
298     sid = ret;
299     st = fmt->streams[sid];
300
301     /* Open decoder */
302     dec_ctx = st->codec;
303     dec = avcodec_find_decoder(dec_ctx->codec_id);
304     if (!dec) {
305         av_log(ctx, AV_LOG_ERROR, "Failed to find subtitle codec %s\n",
306                avcodec_get_name(dec_ctx->codec_id));
307         return AVERROR(EINVAL);
308     }
309     ret = avcodec_open2(dec_ctx, dec, NULL);
310     if (ret < 0)
311         goto end;
312
313     /* Decode subtitles and push them into the renderer (libass) */
314     if (dec_ctx->subtitle_header)
315         ass_process_codec_private(ass->track,
316                                   dec_ctx->subtitle_header,
317                                   dec_ctx->subtitle_header_size);
318     av_init_packet(&pkt);
319     pkt.data = NULL;
320     pkt.size = 0;
321     while (av_read_frame(fmt, &pkt) >= 0) {
322         int i, got_subtitle;
323         AVSubtitle sub;
324
325         if (pkt.stream_index == sid) {
326             ret = avcodec_decode_subtitle2(dec_ctx, &sub, &got_subtitle, &pkt);
327             if (ret < 0) {
328                 av_log(ctx, AV_LOG_WARNING, "Error decoding: %s (ignored)\n",
329                        av_err2str(ret));
330             } else if (got_subtitle) {
331                 for (i = 0; i < sub.num_rects; i++) {
332                     char *ass_line = sub.rects[i]->ass;
333                     if (!ass_line)
334                         break;
335                     ass_process_data(ass->track, ass_line, strlen(ass_line));
336                 }
337             }
338         }
339         av_free_packet(&pkt);
340         avsubtitle_free(&sub);
341     }
342
343 end:
344     if (dec_ctx)
345         avcodec_close(dec_ctx);
346     if (fmt)
347         avformat_close_input(&fmt);
348     return ret;
349 }
350
351 AVFilter avfilter_vf_subtitles = {
352     .name          = "subtitles",
353     .description   = NULL_IF_CONFIG_SMALL("Render subtitles onto input video using the libass library."),
354     .priv_size     = sizeof(AssContext),
355     .init          = init_subtitles,
356     .uninit        = uninit,
357     .query_formats = query_formats,
358     .inputs        = ass_inputs,
359     .outputs       = ass_outputs,
360     .priv_class    = &subtitles_class,
361 };
362 #endif