avfilter: add 3D scope multimedia filter

6 files changed, 417 insertions, 2 deletions

diff --git a/Changelog b/Changelog
index fa83786a20..c98f18f97a 100644
--- a/Changelog
+++ b/Changelog
@@ -10,6 +10,7 @@ version <next>:
 - Add new mode to cropdetect filter to detect crop-area based on motion vectors and edges
 - VAAPI decoding and encoding for 8bit 444 HEVC and VP9
 - WBMP (Wireless Application Protocol Bitmap) image format
+- a3dscope filter
 
 
 version 5.1:
diff --git a/doc/filters.texi b/doc/filters.texi
index 01a359f20f..1e7e98c350 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -27232,6 +27232,61 @@ tools.
 
 Below is a description of the currently available multimedia filters.
 
+@section a3dscope
+
+Convert input audio to 3d scope video output.
+
+The filter accepts the following options:
+
+@table @option
+@item rate, r
+Set frame rate, expressed as number of frames per second. Default
+value is "25".
+
+@item size, s
+Specify the video size for the output. For the syntax of this option, check the
+@ref{video size syntax,,"Video size" section in the ffmpeg-utils manual,ffmpeg-utils}.
+Default value is @code{hd720}.
+
+@item fov
+Set the camera field of view. Default is 90 degrees.
+Allowed range is from 40 to 150.
+
+@item roll
+Set the camera roll.
+
+@item pitch
+Set the camera pitch.
+
+@item yaw
+Set the camera yaw.
+
+@item xzoom
+Set the camera zoom on X-axis.
+
+@item yzoom
+Set the camera zoom on Y-axis.
+
+@item zzoom
+Set the camera zoom on Z-axis.
+
+@item xpos
+Set the camera position on X-axis.
+
+@item ypos
+Set the camera position on Y-axis.
+
+@item zpos
+Set the camera position on Z-axis.
+
+@item length
+Set the length of displayed audio waves in number of frames.
+@end table
+
+@subsection Commands
+
+Filter supports the some above options as @ref{commands}.
+
 @section abitscope
 
 Convert input audio to a video output, displaying the audio bit scope.
diff --git a/libavfilter/Makefile b/libavfilter/Makefile
index 3187f99a50..c5c44db440 100644
--- a/libavfilter/Makefile
+++ b/libavfilter/Makefile
@@ -579,6 +579,7 @@ OBJS-$(CONFIG_YUVTESTSRC_FILTER)             += vsrc_testsrc.o
 OBJS-$(CONFIG_NULLSINK_FILTER)               += vsink_nullsink.o
 
 # multimedia filters
+OBJS-$(CONFIG_A3DSCOPE_FILTER)               += avf_a3dscope.o
 OBJS-$(CONFIG_ABITSCOPE_FILTER)              += avf_abitscope.o
 OBJS-$(CONFIG_ADRAWGRAPH_FILTER)             += f_drawgraph.o
 OBJS-$(CONFIG_AGRAPHMONITOR_FILTER)          += f_graphmonitor.o
diff --git a/libavfilter/allfilters.c b/libavfilter/allfilters.c
index 8372c4c003..0285889e70 100644
--- a/libavfilter/allfilters.c
+++ b/libavfilter/allfilters.c
@@ -546,6 +546,7 @@ extern const AVFilter ff_vsrc_yuvtestsrc;
 extern const AVFilter ff_vsink_nullsink;
 
 /* multimedia filters */
+extern const AVFilter ff_avf_a3dscope;
 extern const AVFilter ff_avf_abitscope;
 extern const AVFilter ff_avf_adrawgraph;
 extern const AVFilter ff_avf_agraphmonitor;
diff --git a/libavfilter/avf_a3dscope.c b/libavfilter/avf_a3dscope.c
new file mode 100644
index 0000000000..f3bb39feaf
--- /dev/null
+++ b/libavfilter/avf_a3dscope.c
@@ -0,0 +1,357 @@
+/*
+ * Copyright (c) 2022 Paul B Mahol
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#include "libavutil/avassert.h"
+#include "libavutil/channel_layout.h"
+#include "libavutil/opt.h"
+#include "libavutil/parseutils.h"
+#include "avfilter.h"
+#include "filters.h"
+#include "formats.h"
+#include "audio.h"
+#include "video.h"
+#include "internal.h"
+
+typedef struct Audio3dScopeContext {
+    const AVClass *class;
+    int w, h;
+    int size;
+    float fov;
+    float roll;
+    float pitch;
+    float yaw;
+    float zoom[3];
+    float eye[3];
+
+    AVRational frame_rate;
+    int nb_samples;
+
+    float view_matrix[4][4];
+    float projection_matrix[4][4];
+
+    AVFrame *frames[60];
+} Audio3dScopeContext;
+
+#define OFFSET(x) offsetof(Audio3dScopeContext, x)
+#define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
+#define TFLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
+
+static const AVOption a3dscope_options[] = {
+    { "rate", "set video rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str="25"}, 0, INT_MAX, FLAGS },
+    { "r",    "set video rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str="25"}, 0, INT_MAX, FLAGS },
+    { "size", "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str="hd720"}, 0, 0, FLAGS },
+    { "s",    "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str="hd720"}, 0, 0, FLAGS },
+    { "fov",  "set camera FoV", OFFSET(fov),    AV_OPT_TYPE_FLOAT, {.dbl=90.f},  40, 150, TFLAGS },
+    { "roll", "set camera roll",OFFSET(roll),   AV_OPT_TYPE_FLOAT, {.dbl=0.f}, -180, 180, TFLAGS },
+    { "pitch","set camera pitch",OFFSET(pitch), AV_OPT_TYPE_FLOAT, {.dbl=0.f}, -180, 180, TFLAGS },
+    { "yaw",  "set camera yaw",  OFFSET(yaw),   AV_OPT_TYPE_FLOAT, {.dbl=0.f}, -180, 180, TFLAGS },
+    { "xzoom","set camera zoom", OFFSET(zoom[0]),AV_OPT_TYPE_FLOAT, {.dbl=1.f}, 0.01,  10, TFLAGS },
+    { "yzoom","set camera zoom", OFFSET(zoom[1]),AV_OPT_TYPE_FLOAT, {.dbl=1.f}, 0.01,  10, TFLAGS },
+    { "zzoom","set camera zoom", OFFSET(zoom[2]),AV_OPT_TYPE_FLOAT, {.dbl=1.f}, 0.01,  10, TFLAGS },
+    { "xpos", "set camera position", OFFSET(eye[0]), AV_OPT_TYPE_FLOAT, {.dbl=0.f},-60.f, 60.f, TFLAGS },
+    { "ypos", "set camera position", OFFSET(eye[1]), AV_OPT_TYPE_FLOAT, {.dbl=0.f},-60.f, 60.f, TFLAGS },
+    { "zpos", "set camera position", OFFSET(eye[2]), AV_OPT_TYPE_FLOAT, {.dbl=0.f},-60.f, 60.f, TFLAGS },
+    { "length","set length",    OFFSET(size),   AV_OPT_TYPE_INT,   {.i64=15},      1,  60,  FLAGS },
+    { NULL }
+};
+
+AVFILTER_DEFINE_CLASS(a3dscope);
+
+static int query_formats(AVFilterContext *ctx)
+{
+    AVFilterFormats *formats = NULL;
+    AVFilterChannelLayouts *layouts = NULL;
+    AVFilterLink *inlink = ctx->inputs[0];
+    AVFilterLink *outlink = ctx->outputs[0];
+    static const enum AVSampleFormat sample_fmts[] = { AV_SAMPLE_FMT_FLTP, AV_SAMPLE_FMT_NONE };
+    static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_RGBA, AV_PIX_FMT_NONE };
+    int ret;
+
+    formats = ff_make_format_list(sample_fmts);
+    if ((ret = ff_formats_ref         (formats, &inlink->outcfg.formats        )) < 0)
+        return ret;
+
+    formats = ff_all_samplerates();
+    if ((ret = ff_formats_ref(formats, &inlink->outcfg.samplerates)) < 0)
+        return ret;
+
+    formats = ff_make_format_list(pix_fmts);
+    if ((ret = ff_formats_ref(formats, &outlink->incfg.formats)) < 0)
+        return ret;
+
+    layouts = ff_all_channel_counts();
+    if ((ret = ff_channel_layouts_ref(layouts, &inlink->outcfg.channel_layouts)) < 0)
+        return ret;
+
+    return 0;
+}
+
+static int config_input(AVFilterLink *inlink)
+{
+    AVFilterContext *ctx = inlink->dst;
+    Audio3dScopeContext *s = ctx->priv;
+
+    s->nb_samples = FFMAX(1, av_rescale(inlink->sample_rate, s->frame_rate.den, s->frame_rate.num));
+
+    return 0;
+}
+
+static int config_output(AVFilterLink *outlink)
+{
+    Audio3dScopeContext *s = outlink->src->priv;
+
+    outlink->w = s->w;
+    outlink->h = s->h;
+    outlink->sample_aspect_ratio = (AVRational){1,1};
+    outlink->frame_rate = s->frame_rate;
+    outlink->time_base = av_inv_q(outlink->frame_rate);
+
+    return 0;
+}
+
+static void projection_matrix(float fov, float a, float near, float far,
+                              float matrix[4][4])
+{
+    float f;
+
+    memset(matrix, 0, sizeof(*matrix));
+
+    f = 1.0f / tanf(fov * 0.5f * M_PI / 180.f);
+    matrix[0][0] = f * a;
+    matrix[1][1] = f;
+    matrix[2][2] = -(far + near) / (far - near);
+    matrix[2][3] = -1.f;
+    matrix[3][2] = -(near * far) / (far - near);
+}
+
+static inline void vmultiply(const float v[4], const float m[4][4], float d[4])
+{
+    d[0] = v[0] * m[0][0] + v[1] * m[1][0] + v[2] * m[2][0] + v[3] * m[3][0];
+    d[1] = v[0] * m[0][1] + v[1] * m[1][1] + v[2] * m[2][1] + v[3] * m[3][1];
+    d[2] = v[0] * m[0][2] + v[1] * m[1][2] + v[2] * m[2][2] + v[3] * m[3][2];
+    d[3] = v[0] * m[0][3] + v[1] * m[1][3] + v[2] * m[2][3] + v[3] * m[3][3];
+}
+
+static void mmultiply(const float m2[4][4], const float m1[4][4], float m[4][4])
+{
+    vmultiply(m2[0], m1, m[0]);
+    vmultiply(m2[1], m1, m[1]);
+    vmultiply(m2[2], m1, m[2]);
+    vmultiply(m2[3], m1, m[3]);
+}
+
+static float vdot(const float x[3], const float y[3])
+{
+    return x[0] * y[0] + x[1] * y[1] + x[2] * y[2];
+}
+
+static void view_matrix(const float eye[3],
+                        const float z[3],
+                        const float roll,
+                        const float pitch,
+                        const float yaw, float m[4][4])
+{
+    float cr = cosf(roll * M_PI / 180.f);
+    float sr = sinf(roll * M_PI / 180.f);
+    float cp = cosf(pitch * M_PI / 180.f);
+    float sp = sinf(pitch * M_PI / 180.f);
+    float cy = cosf(yaw * M_PI / 180.f);
+    float sy = sinf(yaw * M_PI / 180.f);
+    float t[4][4];
+    float rx[4][4] = {
+        {z[0], 0.f, 0.f, 0.f },
+        { 0.f, cy,  -sy, 0.f },
+        { 0.f, sy,   cy, 0.f },
+        { 0.f, 0.f, 0.f, 1.f },
+    };
+
+    float ry[4][4] = {
+        { cp,  0.f, sp,  0.f },
+        { 0.f,z[1], 0.f, 0.f },
+        {-sp,  0.f, cp,  0.f },
+        { 0.f, 0.f, 0.f, 1.f },
+    };
+
+    float rz[4][4] = {
+        { cr, -sr,  0.f, 0.f },
+        { sr,  cr,  0.f, 0.f },
+        { 0.f, 0.f,z[2], 0.f },
+        { 0.f, 0.f, 0.f, 1.f },
+    };
+
+    memset(m, 0, sizeof(*m));
+
+    mmultiply(rx, ry, t);
+    mmultiply(rz,  t, m);
+
+    m[3][0] = -vdot(m[0], eye);
+    m[3][1] = -vdot(m[1], eye);
+    m[3][2] = -vdot(m[2], eye);
+}
+
+static void draw_dot(AVFrame *out, unsigned x, unsigned y, float z,
+                     int r, int g, int b)
+{
+    const int linesize = out->linesize[0];
+    uint8_t *dst;
+
+    dst = out->data[0] + y * linesize + x * 4;
+    dst[0] = r * z;
+    dst[1] = g * z;
+    dst[2] = b * z;
+    dst[3] = 255 * z;
+}
+
+static int filter_frame(AVFilterLink *inlink, AVFrame *in)
+{
+    AVFilterContext *ctx = inlink->dst;
+    AVFilterLink *outlink = ctx->outputs[0];
+    Audio3dScopeContext *s = ctx->priv;
+    const float half_height = (s->h - 1) * 0.5f;
+    const float half_width = (s->w - 1) * 0.5f;
+    float matrix[4][4];
+    const int w = s->w;
+    const int h = s->h;
+    AVFrame *out;
+
+    out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
+    if (!out) {
+        av_frame_free(&in);
+        return AVERROR(ENOMEM);
+    }
+
+    s->frames[0] = in;
+
+    out->sample_aspect_ratio = (AVRational){1,1};
+    for (int y = 0; y < outlink->h; y++)
+        memset(out->data[0] + y * out->linesize[0], 0, outlink->w * 4);
+    out->pts = av_rescale_q(in->pts, inlink->time_base, outlink->time_base);
+
+    projection_matrix(s->fov, half_width / half_height, 0.1f, 1000000.f, s->projection_matrix);
+    view_matrix(s->eye, s->zoom, s->roll, s->pitch, s->yaw, s->view_matrix);
+    mmultiply(s->projection_matrix, s->view_matrix, matrix);
+
+    for (int nb_frame = s->size - 1; nb_frame >= 0; nb_frame--) {
+        const float scale = 1.f / s->nb_samples;
+        AVFrame *frame = s->frames[nb_frame];
+        float channels;
+
+        if (!frame)
+            continue;
+
+        channels = frame->ch_layout.nb_channels;
+        for (int ch = 0; ch < channels; ch++) {
+            const float *src = (float *)frame->extended_data[ch];
+            const int r = 128.f + 127.f * sinf(ch / (channels - 1) * M_PI);
+            const int g = 128.f + 127.f * ch / (channels - 1);
+            const int b = 128.f + 127.f * cosf(ch / (channels - 1) * M_PI);
+
+            for (int n = frame->nb_samples - 1, nn = s->nb_samples * nb_frame; n >= 0; n--, nn++) {
+                float v[4] = { src[n], ch - (channels - 1) * 0.5f, -0.1f + -nn * scale, 1.f };
+                float d[4];
+                int x, y;
+
+                vmultiply(v, matrix, d);
+
+                d[0] /= d[3];
+                d[1] /= d[3];
+
+                x = d[0] * half_width  + half_width;
+                y = d[1] * half_height + half_height;
+
+                if (x >= w || y >= h || x < 0 || y < 0)
+                    continue;
+
+                draw_dot(out, x, y, av_clipf(1.f / d[3], 0.f, 1.f),
+                         r, g, b);
+            }
+        }
+    }
+
+    av_frame_free(&s->frames[59]);
+    memmove(&s->frames[1], &s->frames[0], 59 * sizeof(AVFrame *));
+    s->frames[0] = NULL;
+
+    return ff_filter_frame(outlink, out);
+}
+
+static int activate(AVFilterContext *ctx)
+{
+    AVFilterLink *inlink = ctx->inputs[0];
+    AVFilterLink *outlink = ctx->outputs[0];
+    Audio3dScopeContext *s = ctx->priv;
+    AVFrame *in;
+    int ret;
+
+    FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink);
+
+    ret = ff_inlink_consume_samples(inlink, s->nb_samples, s->nb_samples, &in);
+    if (ret < 0)
+        return ret;
+    if (ret > 0)
+        return filter_frame(inlink, in);
+
+    if (ff_inlink_queued_samples(inlink) >= s->nb_samples) {
+        ff_filter_set_ready(ctx, 10);
+        return 0;
+    }
+
+    FF_FILTER_FORWARD_STATUS(inlink, outlink);
+    FF_FILTER_FORWARD_WANTED(outlink, inlink);
+
+    return FFERROR_NOT_READY;
+}
+
+static av_cold void uninit(AVFilterContext *ctx)
+{
+    Audio3dScopeContext *s = ctx->priv;
+
+    for (int n = 0; n < 60; n++)
+        av_frame_free(&s->frames[n]);
+}
+
+static const AVFilterPad audio3dscope_inputs[] = {
+    {
+        .name         = "default",
+        .type         = AVMEDIA_TYPE_AUDIO,
+        .config_props = config_input,
+    },
+};
+
+static const AVFilterPad audio3dscope_outputs[] = {
+    {
+        .name         = "default",
+        .type         = AVMEDIA_TYPE_VIDEO,
+        .config_props = config_output,
+    },
+};
+
+const AVFilter ff_avf_a3dscope = {
+    .name          = "a3dscope",
+    .description   = NULL_IF_CONFIG_SMALL("Convert input audio to 3d scope video output."),
+    .uninit        = uninit,
+    .priv_size     = sizeof(Audio3dScopeContext),
+    .activate      = activate,
+    FILTER_INPUTS(audio3dscope_inputs),
+    FILTER_OUTPUTS(audio3dscope_outputs),
+    FILTER_QUERY_FUNC(query_formats),
+    .priv_class    = &a3dscope_class,
+    .process_command = ff_filter_process_command,
+};
diff --git a/libavfilter/version.h b/libavfilter/version.h
index f3c1964cac..fb21fad979 100644
--- a/libavfilter/version.h
+++ b/libavfilter/version.h
@@ -31,8 +31,8 @@
 
 #include "version_major.h"
 
-#define LIBAVFILTER_VERSION_MINOR  46
-#define LIBAVFILTER_VERSION_MICRO 103
+#define LIBAVFILTER_VERSION_MINOR  47
+#define LIBAVFILTER_VERSION_MICRO 100
 
 
 #define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \