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