2 * Copyright (c) 2013 Paul B Mahol
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * audio to video multimedia vectorscope filter
26 #include "libavutil/avassert.h"
27 #include "libavutil/channel_layout.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/parseutils.h"
36 enum VectorScopeMode {
43 enum VectorScopeDraw {
49 enum VectorScopeScale {
57 typedef struct AudioVectorScopeContext {
70 unsigned prev_x, prev_y;
71 AVRational frame_rate;
72 } AudioVectorScopeContext;
74 #define OFFSET(x) offsetof(AudioVectorScopeContext, x)
75 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
77 static const AVOption avectorscope_options[] = {
78 { "mode", "set mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=LISSAJOUS}, 0, MODE_NB-1, FLAGS, "mode" },
79 { "m", "set mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=LISSAJOUS}, 0, MODE_NB-1, FLAGS, "mode" },
80 { "lissajous", "", 0, AV_OPT_TYPE_CONST, {.i64=LISSAJOUS}, 0, 0, FLAGS, "mode" },
81 { "lissajous_xy", "", 0, AV_OPT_TYPE_CONST, {.i64=LISSAJOUS_XY}, 0, 0, FLAGS, "mode" },
82 { "polar", "", 0, AV_OPT_TYPE_CONST, {.i64=POLAR}, 0, 0, FLAGS, "mode" },
83 { "rate", "set video rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str="25"}, 0, INT_MAX, FLAGS },
84 { "r", "set video rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str="25"}, 0, INT_MAX, FLAGS },
85 { "size", "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str="400x400"}, 0, 0, FLAGS },
86 { "s", "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str="400x400"}, 0, 0, FLAGS },
87 { "rc", "set red contrast", OFFSET(contrast[0]), AV_OPT_TYPE_INT, {.i64=40}, 0, 255, FLAGS },
88 { "gc", "set green contrast", OFFSET(contrast[1]), AV_OPT_TYPE_INT, {.i64=160}, 0, 255, FLAGS },
89 { "bc", "set blue contrast", OFFSET(contrast[2]), AV_OPT_TYPE_INT, {.i64=80}, 0, 255, FLAGS },
90 { "ac", "set alpha contrast", OFFSET(contrast[3]), AV_OPT_TYPE_INT, {.i64=255}, 0, 255, FLAGS },
91 { "rf", "set red fade", OFFSET(fade[0]), AV_OPT_TYPE_INT, {.i64=15}, 0, 255, FLAGS },
92 { "gf", "set green fade", OFFSET(fade[1]), AV_OPT_TYPE_INT, {.i64=10}, 0, 255, FLAGS },
93 { "bf", "set blue fade", OFFSET(fade[2]), AV_OPT_TYPE_INT, {.i64=5}, 0, 255, FLAGS },
94 { "af", "set alpha fade", OFFSET(fade[3]), AV_OPT_TYPE_INT, {.i64=5}, 0, 255, FLAGS },
95 { "zoom", "set zoom factor", OFFSET(zoom), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0, 10, FLAGS },
96 { "draw", "set draw mode", OFFSET(draw), AV_OPT_TYPE_INT, {.i64=DOT}, 0, DRAW_NB-1, FLAGS, "draw" },
97 { "dot", "", 0, AV_OPT_TYPE_CONST, {.i64=DOT} , 0, 0, FLAGS, "draw" },
98 { "line", "", 0, AV_OPT_TYPE_CONST, {.i64=LINE}, 0, 0, FLAGS, "draw" },
99 { "scale", "set amplitude scale mode", OFFSET(scale), AV_OPT_TYPE_INT, {.i64=LIN}, 0, SCALE_NB-1, FLAGS, "scale" },
100 { "lin", "linear", 0, AV_OPT_TYPE_CONST, {.i64=LIN}, 0, 0, FLAGS, "scale" },
101 { "sqrt", "square root", 0, AV_OPT_TYPE_CONST, {.i64=SQRT}, 0, 0, FLAGS, "scale" },
102 { "cbrt", "cube root", 0, AV_OPT_TYPE_CONST, {.i64=CBRT}, 0, 0, FLAGS, "scale" },
103 { "log", "logarithmic", 0, AV_OPT_TYPE_CONST, {.i64=LOG}, 0, 0, FLAGS, "scale" },
104 { "swap", "swap x axis with y axis", OFFSET(swap), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
105 { "mirror", "mirror axis", OFFSET(mirror), AV_OPT_TYPE_INT, {.i64=0}, 0, 3, FLAGS, "mirror" },
106 { "none", "no mirror", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "mirror" },
107 { "x", "mirror x", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "mirror" },
108 { "y", "mirror y", 0, AV_OPT_TYPE_CONST, {.i64=2}, 0, 0, FLAGS, "mirror" },
109 { "xy", "mirror both", 0, AV_OPT_TYPE_CONST, {.i64=3}, 0, 0, FLAGS, "mirror" },
113 AVFILTER_DEFINE_CLASS(avectorscope);
115 static void draw_dot(AudioVectorScopeContext *s, unsigned x, unsigned y)
117 const int linesize = s->outpicref->linesize[0];
121 if (y >= s->h || x >= s->w)
124 y = FFMIN(y, s->h - 1);
125 x = FFMIN(x, s->w - 1);
128 dst = &s->outpicref->data[0][y * linesize + x * 4];
129 dst[0] = FFMIN(dst[0] + s->contrast[0], 255);
130 dst[1] = FFMIN(dst[1] + s->contrast[1], 255);
131 dst[2] = FFMIN(dst[2] + s->contrast[2], 255);
132 dst[3] = FFMIN(dst[3] + s->contrast[3], 255);
135 static void draw_line(AudioVectorScopeContext *s, int x0, int y0, int x1, int y1)
137 int dx = FFABS(x1-x0), sx = x0 < x1 ? 1 : -1;
138 int dy = FFABS(y1-y0), sy = y0 < y1 ? 1 : -1;
139 int err = (dx>dy ? dx : -dy) / 2, e2;
144 if (x0 == x1 && y0 == y1)
161 static void fade(AudioVectorScopeContext *s)
163 const int linesize = s->outpicref->linesize[0];
166 if (s->fade[0] || s->fade[1] || s->fade[2]) {
167 uint8_t *d = s->outpicref->data[0];
168 for (i = 0; i < s->h; i++) {
169 for (j = 0; j < s->w*4; j+=4) {
170 d[j+0] = FFMAX(d[j+0] - s->fade[0], 0);
171 d[j+1] = FFMAX(d[j+1] - s->fade[1], 0);
172 d[j+2] = FFMAX(d[j+2] - s->fade[2], 0);
173 d[j+3] = FFMAX(d[j+3] - s->fade[3], 0);
180 static int query_formats(AVFilterContext *ctx)
182 AVFilterFormats *formats = NULL;
183 AVFilterChannelLayouts *layout = NULL;
184 AVFilterLink *inlink = ctx->inputs[0];
185 AVFilterLink *outlink = ctx->outputs[0];
186 static const enum AVSampleFormat sample_fmts[] = { AV_SAMPLE_FMT_S16, AV_SAMPLE_FMT_FLT, AV_SAMPLE_FMT_NONE };
187 static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_RGBA, AV_PIX_FMT_NONE };
190 formats = ff_make_format_list(sample_fmts);
191 if ((ret = ff_formats_ref (formats, &inlink->out_formats )) < 0 ||
192 (ret = ff_add_channel_layout (&layout, AV_CH_LAYOUT_STEREO )) < 0 ||
193 (ret = ff_channel_layouts_ref (layout , &inlink->out_channel_layouts)) < 0)
196 formats = ff_all_samplerates();
197 if ((ret = ff_formats_ref(formats, &inlink->out_samplerates)) < 0)
200 formats = ff_make_format_list(pix_fmts);
201 if ((ret = ff_formats_ref(formats, &outlink->in_formats)) < 0)
207 static int config_input(AVFilterLink *inlink)
209 AVFilterContext *ctx = inlink->dst;
210 AudioVectorScopeContext *s = ctx->priv;
213 nb_samples = FFMAX(1024, ((double)inlink->sample_rate / av_q2d(s->frame_rate)) + 0.5);
214 inlink->partial_buf_size =
215 inlink->min_samples =
216 inlink->max_samples = nb_samples;
221 static int config_output(AVFilterLink *outlink)
223 AudioVectorScopeContext *s = outlink->src->priv;
227 outlink->sample_aspect_ratio = (AVRational){1,1};
228 outlink->frame_rate = s->frame_rate;
230 s->prev_x = s->hw = s->w / 2;
231 s->prev_y = s->hh = s->mode == POLAR ? s->h - 1 : s->h / 2;
236 static int filter_frame(AVFilterLink *inlink, AVFrame *insamples)
238 AVFilterContext *ctx = inlink->dst;
239 AVFilterLink *outlink = ctx->outputs[0];
240 AudioVectorScopeContext *s = ctx->priv;
241 const int hw = s->hw;
242 const int hh = s->hh;
244 unsigned prev_x = s->prev_x, prev_y = s->prev_y;
245 double zoom = s->zoom;
248 if (!s->outpicref || s->outpicref->width != outlink->w ||
249 s->outpicref->height != outlink->h) {
250 av_frame_free(&s->outpicref);
251 s->outpicref = ff_get_video_buffer(outlink, outlink->w, outlink->h);
253 av_frame_free(&insamples);
254 return AVERROR(ENOMEM);
257 s->outpicref->sample_aspect_ratio = (AVRational){1,1};
258 for (i = 0; i < outlink->h; i++)
259 memset(s->outpicref->data[0] + i * s->outpicref->linesize[0], 0, outlink->w * 4);
261 s->outpicref->pts = insamples->pts;
268 switch (insamples->format) {
269 case AV_SAMPLE_FMT_S16: {
270 int16_t *samples = (int16_t *)insamples->data[0];
272 for (i = 0; i < insamples->nb_samples * 2; i++) {
273 float sample = samples[i] / (float)INT16_MAX;
274 max = FFMAX(FFABS(sample), max);
279 case AV_SAMPLE_FMT_FLT: {
280 float *samples = (float *)insamples->data[0];
282 for (i = 0; i < insamples->nb_samples * 2; i++) {
283 max = FFMAX(FFABS(samples[i]), max);
294 for (i = 0; i < insamples->nb_samples; i++) {
295 int16_t *samples = (int16_t *)insamples->data[0] + i * 2;
296 float *samplesf = (float *)insamples->data[0] + i * 2;
299 switch (insamples->format) {
300 case AV_SAMPLE_FMT_S16:
301 src[0] = samples[0] / (float)INT16_MAX;
302 src[1] = samples[1] / (float)INT16_MAX;
304 case AV_SAMPLE_FMT_FLT:
305 src[0] = samplesf[0];
306 src[1] = samplesf[1];
314 src[0] = FFSIGN(src[0]) * sqrtf(FFABS(src[0]));
315 src[1] = FFSIGN(src[1]) * sqrtf(FFABS(src[1]));
318 src[0] = FFSIGN(src[0]) * cbrtf(FFABS(src[0]));
319 src[1] = FFSIGN(src[1]) * cbrtf(FFABS(src[1]));
322 src[0] = FFSIGN(src[0]) * logf(1 + FFABS(src[0])) / logf(2);
323 src[1] = FFSIGN(src[1]) * logf(1 + FFABS(src[1])) / logf(2);
334 FFSWAP(float, src[0], src[1]);
336 if (s->mode == LISSAJOUS) {
337 x = ((src[1] - src[0]) * zoom / 2 + 1) * hw;
338 y = (1.0 - (src[0] + src[1]) * zoom / 2) * hh;
339 } else if (s->mode == LISSAJOUS_XY) {
340 x = (src[1] * zoom + 1) * hw;
341 y = (src[0] * zoom + 1) * hh;
343 float sx, sy, cx, cy;
347 cx = sx * sqrtf(1 - 0.5 * sy * sy);
348 cy = sy * sqrtf(1 - 0.5 * sx * sx);
349 x = hw + hw * FFSIGN(cx + cy) * (cx - cy) * .7;
350 y = s->h - s->h * fabsf(cx + cy) * .7;
353 if (s->draw == DOT) {
356 draw_line(s, x, y, prev_x, prev_y);
362 s->prev_x = x, s->prev_y = y;
363 av_frame_free(&insamples);
365 return ff_filter_frame(outlink, av_frame_clone(s->outpicref));
368 static av_cold void uninit(AVFilterContext *ctx)
370 AudioVectorScopeContext *s = ctx->priv;
372 av_frame_free(&s->outpicref);
375 static const AVFilterPad audiovectorscope_inputs[] = {
378 .type = AVMEDIA_TYPE_AUDIO,
379 .config_props = config_input,
380 .filter_frame = filter_frame,
385 static const AVFilterPad audiovectorscope_outputs[] = {
388 .type = AVMEDIA_TYPE_VIDEO,
389 .config_props = config_output,
394 AVFilter ff_avf_avectorscope = {
395 .name = "avectorscope",
396 .description = NULL_IF_CONFIG_SMALL("Convert input audio to vectorscope video output."),
398 .query_formats = query_formats,
399 .priv_size = sizeof(AudioVectorScopeContext),
400 .inputs = audiovectorscope_inputs,
401 .outputs = audiovectorscope_outputs,
402 .priv_class = &avectorscope_class,