lavfi: use designated initializers for AVClass
[ffmpeg.git] / libavfilter / vf_ass.c
1 /*
2  * Copyright (c) 2011 Baptiste Coudurier
3  * Copyright (c) 2011 Stefano Sabatini
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 /**
23  * @file
24  * Libass subtitles burning filter.
25  *
26  * @see{http://www.matroska.org/technical/specs/subtitles/ssa.html}
27  */
28
29 #include <ass/ass.h>
30
31 #include "libavutil/avstring.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/parseutils.h"
35 #include "drawutils.h"
36 #include "avfilter.h"
37
38 typedef struct {
39     const AVClass *class;
40     ASS_Library  *library;
41     ASS_Renderer *renderer;
42     ASS_Track    *track;
43     char *filename;
44     uint8_t rgba_map[4];
45     int     pix_step[4];       ///< steps per pixel for each plane of the main output
46     int original_w, original_h;
47     FFDrawContext draw;
48 } AssContext;
49
50 #define OFFSET(x) offsetof(AssContext, x)
51
52 static const AVOption ass_options[] = {
53     {"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 },
54     {NULL},
55 };
56
57 static const AVClass ass_class = {
58     .class_name = "ass",
59     .item_name  = av_default_item_name,
60     .option     = ass_options,
61     .version    = LIBAVUTIL_VERSION_INT,
62     .category   = AV_CLASS_CATEGORY_FILTER,
63 };
64
65 /* libass supports a log level ranging from 0 to 7 */
66 int ass_libav_log_level_map[] = {
67     AV_LOG_QUIET,               /* 0 */
68     AV_LOG_PANIC,               /* 1 */
69     AV_LOG_FATAL,               /* 2 */
70     AV_LOG_ERROR,               /* 3 */
71     AV_LOG_WARNING,             /* 4 */
72     AV_LOG_INFO,                /* 5 */
73     AV_LOG_VERBOSE,             /* 6 */
74     AV_LOG_DEBUG,               /* 7 */
75 };
76
77 static void ass_log(int ass_level, const char *fmt, va_list args, void *ctx)
78 {
79     int level = ass_libav_log_level_map[ass_level];
80
81     av_vlog(ctx, level, fmt, args);
82     av_log(ctx, level, "\n");
83 }
84
85 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
86 {
87     AssContext *ass = ctx->priv;
88     int ret;
89
90     ass->class = &ass_class;
91     av_opt_set_defaults(ass);
92
93     if (args)
94         ass->filename = av_get_token(&args, ":");
95     if (!ass->filename || !*ass->filename) {
96         av_log(ctx, AV_LOG_ERROR, "No filename provided!\n");
97         return AVERROR(EINVAL);
98     }
99
100     if (*args++ == ':' && (ret = av_set_options_string(ass, args, "=", ":")) < 0) {
101         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
102         return ret;
103     }
104
105     ass->library = ass_library_init();
106     if (!ass->library) {
107         av_log(ctx, AV_LOG_ERROR, "Could not initialize libass.\n");
108         return AVERROR(EINVAL);
109     }
110     ass_set_message_cb(ass->library, ass_log, ctx);
111
112     ass->renderer = ass_renderer_init(ass->library);
113     if (!ass->renderer) {
114         av_log(ctx, AV_LOG_ERROR, "Could not initialize libass renderer.\n");
115         return AVERROR(EINVAL);
116     }
117
118     ass->track = ass_read_file(ass->library, ass->filename, NULL);
119     if (!ass->track) {
120         av_log(ctx, AV_LOG_ERROR,
121                "Could not create a libass track when reading file '%s'\n",
122                ass->filename);
123         return AVERROR(EINVAL);
124     }
125
126     ass_set_fonts(ass->renderer, NULL, NULL, 1, NULL, 1);
127     return 0;
128 }
129
130 static av_cold void uninit(AVFilterContext *ctx)
131 {
132     AssContext *ass = ctx->priv;
133
134     av_freep(&ass->filename);
135     if (ass->track)
136         ass_free_track(ass->track);
137     if (ass->renderer)
138         ass_renderer_done(ass->renderer);
139     if (ass->library)
140         ass_library_done(ass->library);
141 }
142
143 static int query_formats(AVFilterContext *ctx)
144 {
145     avfilter_set_common_pixel_formats(ctx, ff_draw_supported_pixel_formats(0));
146     return 0;
147 }
148
149 static int config_input(AVFilterLink *inlink)
150 {
151     AssContext *ass = inlink->dst->priv;
152
153     ff_draw_init(&ass->draw, inlink->format, 0);
154
155     ass_set_frame_size  (ass->renderer, inlink->w, inlink->h);
156     if (ass->original_w && ass->original_h)
157         ass_set_aspect_ratio(ass->renderer, (double)inlink->w / inlink->h,
158                              (double)ass->original_w / ass->original_h);
159
160     return 0;
161 }
162
163 static void null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir) { }
164
165 /* libass stores an RGBA color in the format RRGGBBTT, where TT is the transparency level */
166 #define AR(c)  ( (c)>>24)
167 #define AG(c)  (((c)>>16)&0xFF)
168 #define AB(c)  (((c)>>8) &0xFF)
169 #define AA(c)  ((0xFF-c) &0xFF)
170
171 static void overlay_ass_image(AssContext *ass, AVFilterBufferRef *picref,
172                               const ASS_Image *image)
173 {
174     for (; image; image = image->next) {
175         uint8_t rgba_color[] = {AR(image->color), AG(image->color), AB(image->color), AA(image->color)};
176         FFDrawColor color;
177         ff_draw_color(&ass->draw, &color, rgba_color);
178         ff_blend_mask(&ass->draw, &color,
179                       picref->data, picref->linesize,
180                       picref->video->w, picref->video->h,
181                       image->bitmap, image->stride, image->w, image->h,
182                       3, 0, image->dst_x, image->dst_y);
183     }
184 }
185
186 static void end_frame(AVFilterLink *inlink)
187 {
188     AVFilterContext *ctx = inlink->dst;
189     AVFilterLink *outlink = ctx->outputs[0];
190     AssContext *ass = ctx->priv;
191     AVFilterBufferRef *picref = inlink->cur_buf;
192     int detect_change = 0;
193     double time_ms = picref->pts * av_q2d(inlink->time_base) * 1000;
194     ASS_Image *image = ass_render_frame(ass->renderer, ass->track,
195                                         time_ms, &detect_change);
196
197     if (detect_change)
198         av_log(ctx, AV_LOG_DEBUG, "Change happened at time ms:%f\n", time_ms);
199
200     overlay_ass_image(ass, picref, image);
201
202     avfilter_draw_slice(outlink, 0, picref->video->h, 1);
203     avfilter_end_frame(outlink);
204 }
205
206 AVFilter avfilter_vf_ass = {
207     .name          = "ass",
208     .description   = NULL_IF_CONFIG_SMALL("Render subtitles onto input video using the libass library."),
209     .priv_size     = sizeof(AssContext),
210     .init          = init,
211     .uninit        = uninit,
212     .query_formats = query_formats,
213
214     .inputs = (const AVFilterPad[]) {
215         { .name             = "default",
216           .type             = AVMEDIA_TYPE_VIDEO,
217           .get_video_buffer = avfilter_null_get_video_buffer,
218           .start_frame      = avfilter_null_start_frame,
219           .draw_slice       = null_draw_slice,
220           .end_frame        = end_frame,
221           .config_props     = config_input,
222           .min_perms        = AV_PERM_WRITE | AV_PERM_READ,
223           .rej_perms        = AV_PERM_PRESERVE },
224         { .name = NULL}
225     },
226     .outputs = (const AVFilterPad[]) {
227         { .name             = "default",
228           .type             = AVMEDIA_TYPE_VIDEO, },
229         { .name = NULL}
230     },
231 };