lavfi/ass: add dar option
[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 "libavutil/pixdesc.h"
36 #include "drawutils.h"
37 #include "avfilter.h"
38
39 typedef struct {
40     const AVClass *class;
41     ASS_Library  *library;
42     ASS_Renderer *renderer;
43     ASS_Track    *track;
44     int hsub, vsub;
45     char *filename;
46     uint8_t rgba_map[4];
47     int     pix_step[4];       ///< steps per pixel for each plane of the main output
48     char *dar_str;
49     AVRational dar;
50 } AssContext;
51
52 #define OFFSET(x) offsetof(AssContext, x)
53
54 static const AVOption ass_options[] = {
55     {"dar",  "set subtitles display aspect ratio", OFFSET(dar_str), AV_OPT_TYPE_STRING, {.str = "1.0"},  CHAR_MIN, CHAR_MAX },
56     {NULL},
57 };
58
59 static const char *ass_get_name(void *ctx)
60 {
61     return "ass";
62 }
63
64 static const AVClass ass_class = {
65     "AssContext",
66     ass_get_name,
67     ass_options
68 };
69
70 /* libass supports a log level ranging from 0 to 7 */
71 int ass_libav_log_level_map[] = {
72     AV_LOG_QUIET,               /* 0 */
73     AV_LOG_PANIC,               /* 1 */
74     AV_LOG_FATAL,               /* 2 */
75     AV_LOG_ERROR,               /* 3 */
76     AV_LOG_WARNING,             /* 4 */
77     AV_LOG_INFO,                /* 5 */
78     AV_LOG_VERBOSE,             /* 6 */
79     AV_LOG_DEBUG,               /* 7 */
80 };
81
82 static void ass_log(int ass_level, const char *fmt, va_list args, void *ctx)
83 {
84     int level = ass_libav_log_level_map[ass_level];
85
86     av_vlog(ctx, level, fmt, args);
87     av_log(ctx, level, "\n");
88 }
89
90 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
91 {
92     AssContext *ass = ctx->priv;
93     int ret;
94
95     ass->class = &ass_class;
96     av_opt_set_defaults(ass);
97
98     if (args)
99         ass->filename = av_get_token(&args, ":");
100     if (!ass->filename || !*ass->filename) {
101         av_log(ctx, AV_LOG_ERROR, "No filename provided!\n");
102         return AVERROR(EINVAL);
103     }
104
105     if (*args++ == ':' && (ret = av_set_options_string(ass, args, "=", ":")) < 0) {
106         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
107         return ret;
108     }
109
110     if (av_parse_ratio(&ass->dar, ass->dar_str, 100, 0, ctx) < 0 ||
111         ass->dar.num < 0 || ass->dar.den <= 0) {
112         av_log(ctx, AV_LOG_ERROR,
113                "Invalid string '%s' or value for display aspect ratio.\n", ass->dar_str);
114         return AVERROR(EINVAL);
115     }
116
117     ass->library = ass_library_init();
118     if (!ass->library) {
119         av_log(ctx, AV_LOG_ERROR, "Could not initialize libass.\n");
120         return AVERROR(EINVAL);
121     }
122     ass_set_message_cb(ass->library, ass_log, ctx);
123
124     ass->renderer = ass_renderer_init(ass->library);
125     if (!ass->renderer) {
126         av_log(ctx, AV_LOG_ERROR, "Could not initialize libass renderer.\n");
127         return AVERROR(EINVAL);
128     }
129
130     ass->track = ass_read_file(ass->library, ass->filename, NULL);
131     if (!ass->track) {
132         av_log(ctx, AV_LOG_ERROR,
133                "Could not create a libass track when reading file '%s'\n",
134                ass->filename);
135         return AVERROR(EINVAL);
136     }
137
138     ass_set_fonts(ass->renderer, NULL, NULL, 1, NULL, 1);
139
140     av_log(ctx, AV_LOG_INFO, "dar:%f\n", av_q2d(ass->dar));
141     return 0;
142 }
143
144 static av_cold void uninit(AVFilterContext *ctx)
145 {
146     AssContext *ass = ctx->priv;
147
148     av_freep(&ass->filename);
149     av_freep(&ass->dar_str);
150     if (ass->track)
151         ass_free_track(ass->track);
152     if (ass->renderer)
153         ass_renderer_done(ass->renderer);
154     if (ass->library)
155         ass_library_done(ass->library);
156 }
157
158 static int query_formats(AVFilterContext *ctx)
159 {
160     static const enum PixelFormat pix_fmts[] = {
161         PIX_FMT_ARGB,  PIX_FMT_RGBA,
162         PIX_FMT_ABGR,  PIX_FMT_BGRA,
163         PIX_FMT_RGB24, PIX_FMT_BGR24,
164         PIX_FMT_NONE
165     };
166
167     avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
168
169     return 0;
170 }
171
172 static int config_input(AVFilterLink *inlink)
173 {
174     AssContext *ass = inlink->dst->priv;
175     const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[inlink->format];
176     double sar = inlink->sample_aspect_ratio.num ?
177         av_q2d(inlink->sample_aspect_ratio) : 1;
178
179     av_image_fill_max_pixsteps(ass->pix_step, NULL, pix_desc);
180     ff_fill_rgba_map(ass->rgba_map, inlink->format);
181
182     ass->hsub = pix_desc->log2_chroma_w;
183     ass->vsub = pix_desc->log2_chroma_h;
184
185     ass_set_frame_size  (ass->renderer, inlink->w, inlink->h);
186     ass_set_aspect_ratio(ass->renderer, av_q2d(ass->dar), sar);
187
188     return 0;
189 }
190
191 static void null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir) { }
192
193 #define R 0
194 #define G 1
195 #define B 2
196 #define A 3
197
198 #define SET_PIXEL_RGB(picref, rgba_color, val, x, y, pixel_step, r_off, g_off, b_off) { \
199     p   = picref->data[0] + (x) * pixel_step + ((y) * picref->linesize[0]);             \
200     alpha = rgba_color[A] * (val) * 129;                                                \
201     *(p+r_off) = (alpha * rgba_color[R] + (255*255*129 - alpha) * *(p+r_off)) >> 23;    \
202     *(p+g_off) = (alpha * rgba_color[G] + (255*255*129 - alpha) * *(p+g_off)) >> 23;    \
203     *(p+b_off) = (alpha * rgba_color[B] + (255*255*129 - alpha) * *(p+b_off)) >> 23;    \
204 }
205
206 /* libass stores an RGBA color in the format RRGGBBTT, where TT is the transparency level */
207 #define AR(c)  ( (c)>>24)
208 #define AG(c)  (((c)>>16)&0xFF)
209 #define AB(c)  (((c)>>8) &0xFF)
210 #define AA(c)  ((0xFF-c) &0xFF)
211
212 static void overlay_ass_image(AVFilterBufferRef *picref, const uint8_t *rgba_map, const int pix_step,
213                               const ASS_Image *image)
214 {
215     int i, j;
216     int alpha;
217     uint8_t *p;
218     const int ro = rgba_map[R];
219     const int go = rgba_map[G];
220     const int bo = rgba_map[B];
221
222     for (; image; image = image->next) {
223         uint8_t rgba_color[] = {AR(image->color), AG(image->color), AB(image->color), AA(image->color)};
224         unsigned char *row = image->bitmap;
225
226         for (i = 0; i < image->h; i++) {
227             for (j = 0; j < image->w; j++) {
228                 if (row[j]) {
229                     SET_PIXEL_RGB(picref, rgba_color, row[j], image->dst_x + j, image->dst_y + i, pix_step, ro, go, bo);
230                 }
231             }
232             row += image->stride;
233         }
234     }
235 }
236
237 static void end_frame(AVFilterLink *inlink)
238 {
239     AVFilterContext *ctx = inlink->dst;
240     AVFilterLink *outlink = ctx->outputs[0];
241     AssContext *ass = ctx->priv;
242     AVFilterBufferRef *picref = inlink->cur_buf;
243     int detect_change = 0;
244     double time_ms = picref->pts * av_q2d(inlink->time_base) * 1000;
245     ASS_Image *image = ass_render_frame(ass->renderer, ass->track,
246                                         time_ms, &detect_change);
247
248     if (detect_change)
249         av_log(ctx, AV_LOG_DEBUG, "Change happened at time ms:%f\n", time_ms);
250
251     overlay_ass_image(picref, ass->rgba_map, ass->pix_step[0], image);
252
253     avfilter_draw_slice(outlink, 0, picref->video->h, 1);
254     avfilter_end_frame(outlink);
255 }
256
257 AVFilter avfilter_vf_ass = {
258     .name          = "ass",
259     .description   = NULL_IF_CONFIG_SMALL("Render subtitles onto input video using the libass library."),
260     .priv_size     = sizeof(AssContext),
261     .init          = init,
262     .uninit        = uninit,
263     .query_formats = query_formats,
264
265     .inputs = (const AVFilterPad[]) {
266         { .name             = "default",
267           .type             = AVMEDIA_TYPE_VIDEO,
268           .get_video_buffer = avfilter_null_get_video_buffer,
269           .start_frame      = avfilter_null_start_frame,
270           .draw_slice       = null_draw_slice,
271           .end_frame        = end_frame,
272           .config_props     = config_input,
273           .min_perms        = AV_PERM_WRITE | AV_PERM_READ,
274           .rej_perms        = AV_PERM_PRESERVE },
275         { .name = NULL}
276     },
277     .outputs = (const AVFilterPad[]) {
278         { .name             = "default",
279           .type             = AVMEDIA_TYPE_VIDEO, },
280         { .name = NULL}
281     },
282 };