avfilter: add (a)graphmonitor filter(s)

Changelog

@@ -41,6 +41,7 @@ version <next>:
 - decoding S12M timecode in h264
 - xstack filter
 - pcm vidc decoder and encoder
+- (a)graphmonitor filter
 
 
 version 4.0:

doc/filters.texi

@@ -10300,6 +10300,63 @@ gradfun=radius=8
 
 @end itemize
 
+@section graphmonitor, agraphmonitor
+Show various filtergraph stats.
+
+With this filter one can debug complete filtergraph.
+Especially issues with links filling with queued frames.
+
+The filter accepts the following options:
+
+@table @option
+@item size, s
+Set video output size. Default is @var{hd720}.
+
+@item opacity, o
+Set video opacity. Default is @var{0.9}. Allowed range is from @var{0} to @var{1}.
+
+@item mode, m
+Set output mode, can be @var{fulll} or @var{compact}.
+In @var{compact} mode only filters with some queued frames have displayed stats.
+
+@item flags, f
+Set flags which enable which stats are shown in video.
+
+Available values for flags are:
+@table @samp
+@item queue
+Display number of queued frames in each link.
+
+@item frame_count_in
+Display number of frames taken from filter.
+
+@item frame_count_out
+Display number of frames given out from filter.
+
+@item pts
+Display current filtered frame pts.
+
+@item time
+Display current filtered frame time.
+
+@item timebase
+Display time base for filter link.
+
+@item format
+Display used format for filter link.
+
+@item size
+Display video size or number of audio channels in case of audio used by filter link.
+
+@item rate
+Display video frame rate or sample rate in case of audio used by filter link.
+@end table
+
+@item rate, r
+Set upper limit for video rate of output stream, Default value is @var{25}.
+This guarantee that output video frame rate will not be higher than this value.
+@end table
+
 @section greyedge
 A color constancy variation filter which estimates scene illumination via grey edge algorithm
 and corrects the scene colors accordingly.

libavfilter/Makefile

@@ -240,6 +240,7 @@ OBJS-$(CONFIG_FSPP_FILTER)                   += vf_fspp.o
 OBJS-$(CONFIG_GBLUR_FILTER)                  += vf_gblur.o
 OBJS-$(CONFIG_GEQ_FILTER)                    += vf_geq.o
 OBJS-$(CONFIG_GRADFUN_FILTER)                += vf_gradfun.o
+OBJS-$(CONFIG_GRAPHMONITOR_FILTER)           += f_graphmonitor.o
 OBJS-$(CONFIG_GREYEDGE_FILTER)               += vf_colorconstancy.o
 OBJS-$(CONFIG_HALDCLUT_FILTER)               += vf_lut3d.o framesync.o
 OBJS-$(CONFIG_HFLIP_FILTER)                  += vf_hflip.o
@@ -437,6 +438,7 @@ OBJS-$(CONFIG_NULLSINK_FILTER)               += vsink_nullsink.o
 # multimedia filters
 OBJS-$(CONFIG_ABITSCOPE_FILTER)              += avf_abitscope.o
 OBJS-$(CONFIG_ADRAWGRAPH_FILTER)             += f_drawgraph.o
+OBJS-$(CONFIG_AGRAPHMONITOR_FILTER)          += f_graphmonitor.o
 OBJS-$(CONFIG_AHISTOGRAM_FILTER)             += avf_ahistogram.o
 OBJS-$(CONFIG_APHASEMETER_FILTER)            += avf_aphasemeter.o
 OBJS-$(CONFIG_AVECTORSCOPE_FILTER)           += avf_avectorscope.o

libavfilter/allfilters.c

@@ -227,6 +227,7 @@ extern AVFilter ff_vf_fspp;
 extern AVFilter ff_vf_gblur;
 extern AVFilter ff_vf_geq;
 extern AVFilter ff_vf_gradfun;
+extern AVFilter ff_vf_graphmonitor;
 extern AVFilter ff_vf_greyedge;
 extern AVFilter ff_vf_haldclut;
 extern AVFilter ff_vf_hflip;
@@ -418,6 +419,7 @@ extern AVFilter ff_vsink_nullsink;
 /* multimedia filters */
 extern AVFilter ff_avf_abitscope;
 extern AVFilter ff_avf_adrawgraph;
+extern AVFilter ff_avf_agraphmonitor;
 extern AVFilter ff_avf_ahistogram;
 extern AVFilter ff_avf_aphasemeter;
 extern AVFilter ff_avf_avectorscope;

libavfilter/f_graphmonitor.c

+/*
+ * Copyright (c) 2018 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 "float.h"
+
+#include "libavutil/pixdesc.h"
+#include "libavutil/eval.h"
+#include "libavutil/intreadwrite.h"
+#include "libavutil/opt.h"
+#include "libavutil/timestamp.h"
+#include "libavutil/xga_font_data.h"
+#include "avfilter.h"
+#include "filters.h"
+#include "formats.h"
+#include "internal.h"
+#include "video.h"
+
+typedef struct GraphMonitorContext {
+    const AVClass *class;
+
+    int w, h;
+    float opacity;
+    int mode;
+    int flags;
+    AVRational frame_rate;
+
+    int64_t pts;
+    uint8_t white[4];
+    uint8_t yellow[4];
+    uint8_t red[4];
+    uint8_t green[4];
+    uint8_t bg[4];
+} GraphMonitorContext;
+
+enum {
+    MODE_QUEUE = 1 << 0,
+    MODE_FCIN  = 1 << 1,
+    MODE_FCOUT = 1 << 2,
+    MODE_PTS   = 1 << 3,
+    MODE_TIME  = 1 << 4,
+    MODE_TB    = 1 << 5,
+    MODE_FMT   = 1 << 6,
+    MODE_SIZE  = 1 << 7,
+    MODE_RATE  = 1 << 8,
+};
+
+#define OFFSET(x) offsetof(GraphMonitorContext, x)
+#define VF AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
+
+static const AVOption graphmonitor_options[] = {
+    { "size", "set monitor size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str="hd720"}, 0, 0, VF },
+    { "s",    "set monitor size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str="hd720"}, 0, 0, VF },
+    { "opacity", "set video opacity", OFFSET(opacity), AV_OPT_TYPE_FLOAT, {.dbl=.9}, 0, 1, VF },
+    { "o",       "set video opacity", OFFSET(opacity), AV_OPT_TYPE_FLOAT, {.dbl=.9}, 0, 1, VF },
+    { "mode", "set mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, VF, "mode" },
+    { "m",    "set mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, VF, "mode" },
+        { "full",     NULL, 0, AV_OPT_TYPE_CONST, {.i64=0},   0, 0, VF, "mode" },
+        { "compact",  NULL, 0, AV_OPT_TYPE_CONST, {.i64=1},   0, 0, VF, "mode" },
+    { "flags", "set flags", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64=MODE_QUEUE}, 0, INT_MAX, VF, "flags" },
+    { "f",     "set flags", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64=MODE_QUEUE}, 0, INT_MAX, VF, "flags" },
+        { "queue",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_QUEUE},   0, 0, VF, "flags" },
+        { "frame_count_in",   NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_FCOUT},   0, 0, VF, "flags" },
+        { "frame_count_out",  NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_FCIN},    0, 0, VF, "flags" },
+        { "pts",              NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_PTS},     0, 0, VF, "flags" },
+        { "time",             NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_TIME},    0, 0, VF, "flags" },
+        { "timebase",         NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_TB},      0, 0, VF, "flags" },
+        { "format",           NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_FMT},     0, 0, VF, "flags" },
+        { "size",             NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_SIZE},    0, 0, VF, "flags" },
+        { "rate",             NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_RATE},    0, 0, VF, "flags" },
+    { "rate", "set video rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str = "25"}, 0, INT_MAX, VF },
+    { "r",    "set video rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str = "25"}, 0, INT_MAX, VF },
+    { NULL }
+};
+
+static int query_formats(AVFilterContext *ctx)
+{
+    AVFilterLink *outlink = ctx->outputs[0];
+    static const enum AVPixelFormat pix_fmts[] = {
+        AV_PIX_FMT_RGBA,
+        AV_PIX_FMT_NONE
+    };
+    int ret;
+
+    AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
+    if ((ret = ff_formats_ref(fmts_list, &outlink->in_formats)) < 0)
+        return ret;
+
+    return 0;
+}
+
+static void clear_image(GraphMonitorContext *s, AVFrame *out, AVFilterLink *outlink)
+{
+    int bg = AV_RN32(s->bg);
+
+    for (int i = 0; i < out->height; i++)
+        for (int j = 0; j < out->width; j++)
+            AV_WN32(out->data[0] + i * out->linesize[0] + j * 4, bg);
+}
+
+static void drawtext(AVFrame *pic, int x, int y, const char *txt, uint8_t *color)
+{
+    const uint8_t *font;
+    int font_height;
+    int i;
+
+    font = avpriv_cga_font,   font_height =  8;
+
+    if (y + 8 >= pic->height ||
+        x + strlen(txt) * 8 >= pic->width)
+        return;
+
+    for (i = 0; txt[i]; i++) {
+        int char_y, mask;
+
+        uint8_t *p = pic->data[0] + y*pic->linesize[0] + (x + i*8)*4;
+        for (char_y = 0; char_y < font_height; char_y++) {
+            for (mask = 0x80; mask; mask >>= 1) {
+                if (font[txt[i] * font_height + char_y] & mask) {
+                    p[0] = color[0];
+                    p[1] = color[1];
+                    p[2] = color[2];
+                }
+                p += 4;
+            }
+            p += pic->linesize[0] - 8 * 4;
+        }
+    }
+}
+
+static int filter_have_queued(AVFilterContext *filter)
+{
+    for (int j = 0; j < filter->nb_inputs; j++) {
+        AVFilterLink *l = filter->inputs[j];
+        size_t frames = ff_inlink_queued_frames(l);
+
+        if (frames)
+            return 1;
+    }
+
+    for (int j = 0; j < filter->nb_outputs; j++) {
+        AVFilterLink *l = filter->outputs[j];
+        size_t frames = ff_inlink_queued_frames(l);
+
+        if (frames)
+            return 1;
+    }
+
+    return 0;
+}
+
+static void draw_items(AVFilterContext *ctx, AVFrame *out,
+                       int xpos, int ypos,
+                       AVFilterLink *l,
+                       size_t frames)
+{
+    GraphMonitorContext *s = ctx->priv;
+    char buffer[1024] = { 0 };
+
+    if (s->flags & MODE_FMT) {
+        if (l->type == AVMEDIA_TYPE_VIDEO) {
+            snprintf(buffer, sizeof(buffer)-1, " | format: %s",
+                     av_get_pix_fmt_name(l->format));
+        } else if (l->type == AVMEDIA_TYPE_AUDIO) {
+            snprintf(buffer, sizeof(buffer)-1, " | format: %s",
+                     av_get_sample_fmt_name(l->format));
+        }
+        drawtext(out, xpos, ypos, buffer, s->white);
+        xpos += strlen(buffer) * 8;
+    }
+    if (s->flags & MODE_SIZE) {
+        if (l->type == AVMEDIA_TYPE_VIDEO) {
+            snprintf(buffer, sizeof(buffer)-1, " | size: %dx%d", l->w, l->h);
+        } else if (l->type == AVMEDIA_TYPE_AUDIO) {
+            snprintf(buffer, sizeof(buffer)-1, " | channels: %d", l->channels);
+        }
+        drawtext(out, xpos, ypos, buffer, s->white);
+        xpos += strlen(buffer) * 8;
+    }
+    if (s->flags & MODE_RATE) {
+        if (l->type == AVMEDIA_TYPE_VIDEO) {
+            snprintf(buffer, sizeof(buffer)-1, " | fps: %d/%d", l->frame_rate.num, l->frame_rate.den);
+        } else if (l->type == AVMEDIA_TYPE_AUDIO) {
+            snprintf(buffer, sizeof(buffer)-1, " | samplerate: %d", l->sample_rate);
+        }
+        drawtext(out, xpos, ypos, buffer, s->white);
+        xpos += strlen(buffer) * 8;
+    }
+    if (s->flags & MODE_TB) {
+        snprintf(buffer, sizeof(buffer)-1, " | tb: %d/%d", l->time_base.num, l->time_base.den);
+        drawtext(out, xpos, ypos, buffer, s->white);
+        xpos += strlen(buffer) * 8;
+    }
+    if (s->flags & MODE_QUEUE) {
+        snprintf(buffer, sizeof(buffer)-1, " | queue: ");
+        drawtext(out, xpos, ypos, buffer, s->white);
+        xpos += strlen(buffer) * 8;
+        snprintf(buffer, sizeof(buffer)-1, "%"PRId64, frames);
+        drawtext(out, xpos, ypos, buffer, frames > 0 ? frames >= 10 ? frames >= 50 ? s->red : s->yellow : s->green : s->white);
+        xpos += strlen(buffer) * 8;
+    }
+    if (s->flags & MODE_FCIN) {
+        snprintf(buffer, sizeof(buffer)-1, " | in: %"PRId64, l->frame_count_in);
+        drawtext(out, xpos, ypos, buffer, s->white);
+        xpos += strlen(buffer) * 8;
+    }
+    if (s->flags & MODE_FCOUT) {
+        snprintf(buffer, sizeof(buffer)-1, " | out: %"PRId64, l->frame_count_out);
+        drawtext(out, xpos, ypos, buffer, s->white);
+        xpos += strlen(buffer) * 8;
+    }
+    if (s->flags & MODE_PTS) {
+        snprintf(buffer, sizeof(buffer)-1, " | pts: %s", av_ts2str(l->current_pts_us));
+        drawtext(out, xpos, ypos, buffer, s->white);
+        xpos += strlen(buffer) * 8;
+    }
+    if (s->flags & MODE_TIME) {
+        snprintf(buffer, sizeof(buffer)-1, " | time: %s", av_ts2timestr(l->current_pts_us, &AV_TIME_BASE_Q));
+        drawtext(out, xpos, ypos, buffer, s->white);
+        xpos += strlen(buffer) * 8;
+    }
+}
+
+static int create_frame(AVFilterContext *ctx, int64_t pts)
+{
+    GraphMonitorContext *s = ctx->priv;
+    AVFilterLink *outlink = ctx->outputs[0];
+    AVFrame *out;
+    int xpos, ypos = 0;
+
+    out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
+    if (!out)
+        return AVERROR(ENOMEM);
+
+    clear_image(s, out, outlink);
+
+    for (int i = 0; i < ctx->graph->nb_filters; i++) {
+        AVFilterContext *filter = ctx->graph->filters[i];
+        char buffer[1024] = { 0 };
+
+        if (s->mode && !filter_have_queued(filter))
+            continue;
+
+        xpos = 0;
+        drawtext(out, xpos, ypos, filter->name, s->white);
+        xpos += strlen(filter->name) * 8 + 10;
+        drawtext(out, xpos, ypos, filter->filter->name, s->white);
+        ypos += 10;
+        for (int j = 0; j < filter->nb_inputs; j++) {
+            AVFilterLink *l = filter->inputs[j];
+            size_t frames = ff_inlink_queued_frames(l);
+
+            if (s->mode && !frames)
+                continue;
+
+            xpos = 10;
+            snprintf(buffer, sizeof(buffer)-1, "in%d: ", j);
+            drawtext(out, xpos, ypos, buffer, s->white);
+            xpos += strlen(buffer) * 8;
+            drawtext(out, xpos, ypos, l->src->name, s->white);
+            xpos += strlen(l->src->name) * 8 + 10;
+            draw_items(ctx, out, xpos, ypos, l, frames);
+            ypos += 10;
+        }
+
+        ypos += 2;
+        for (int j = 0; j < filter->nb_outputs; j++) {
+            AVFilterLink *l = filter->outputs[j];
+            size_t frames = ff_inlink_queued_frames(l);
+
+            if (s->mode && !frames)
+                continue;
+
+            xpos = 10;
+            snprintf(buffer, sizeof(buffer)-1, "out%d: ", j);
+            drawtext(out, xpos, ypos, buffer, s->white);
+            xpos += strlen(buffer) * 8;
+            drawtext(out, xpos, ypos, l->dst->name, s->white);
+            xpos += strlen(l->dst->name) * 8 + 10;
+            draw_items(ctx, out, xpos, ypos, l, frames);
+            ypos += 10;
+        }
+        ypos += 5;
+    }
+
+    out->pts = pts;
+    s->pts = pts;
+    return ff_filter_frame(outlink, out);
+}
+
+static int activate(AVFilterContext *ctx)
+{
+    GraphMonitorContext *s = ctx->priv;
+    AVFilterLink *inlink = ctx->inputs[0];
+    AVFilterLink *outlink = ctx->outputs[0];
+    int64_t pts = AV_NOPTS_VALUE;
+
+    FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink);
+
+    if (ff_inlink_queued_frames(inlink)) {
+        AVFrame *frame = NULL;
+        int ret;
+
+        ret = ff_inlink_consume_frame(inlink, &frame);
+        if (ret < 0)
+            return ret;
+        if (ret > 0) {
+            pts = frame->pts;
+            av_frame_free(&frame);
+        }
+    }
+
+    if (pts != AV_NOPTS_VALUE) {
+        pts = av_rescale_q(pts, inlink->time_base, outlink->time_base);
+        if (s->pts < pts && ff_outlink_frame_wanted(outlink))
+            return create_frame(ctx, pts);
+    }
+
+    FF_FILTER_FORWARD_STATUS(inlink, outlink);
+    FF_FILTER_FORWARD_WANTED(outlink, inlink);
+
+    return FFERROR_NOT_READY;
+}
+
+static int config_output(AVFilterLink *outlink)
+{
+    GraphMonitorContext *s = outlink->src->priv;
+
+    s->bg[3] = 255 * s->opacity;
+    s->white[0] = s->white[1] = s->white[2] = 255;
+    s->yellow[0] = s->yellow[1] = 255;
+    s->red[0] = 255;
+    s->green[1] = 255;
+    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(s->frame_rate);
+
+    return 0;
+}
+
+#if CONFIG_GRAPHMONITOR_FILTER
+
+AVFILTER_DEFINE_CLASS(graphmonitor);
+
+static const AVFilterPad graphmonitor_inputs[] = {
+    {
+        .name = "default",
+        .type = AVMEDIA_TYPE_VIDEO,
+    },
+    { NULL }
+};
+
+static const AVFilterPad graphmonitor_outputs[] = {
+    {
+        .name         = "default",
+        .type         = AVMEDIA_TYPE_VIDEO,
+        .config_props = config_output,
+    },
+    { NULL }
+};
+
+AVFilter ff_vf_graphmonitor = {
+    .name          = "graphmonitor",
+    .description   = NULL_IF_CONFIG_SMALL("Show various filtergraph stats."),
+    .priv_size     = sizeof(GraphMonitorContext),
+    .priv_class    = &graphmonitor_class,
+    .query_formats = query_formats,
+    .activate      = activate,
+    .inputs        = graphmonitor_inputs,
+    .outputs       = graphmonitor_outputs,
+};
+
+#endif // CONFIG_GRAPHMONITOR_FILTER
+
+#if CONFIG_AGRAPHMONITOR_FILTER
+
+#define agraphmonitor_options graphmonitor_options
+AVFILTER_DEFINE_CLASS(agraphmonitor);
+
+static const AVFilterPad agraphmonitor_inputs[] = {
+    {
+        .name = "default",
+        .type = AVMEDIA_TYPE_AUDIO,
+    },
+    { NULL }
+};
+
+static const AVFilterPad agraphmonitor_outputs[] = {
+    {
+        .name         = "default",
+        .type         = AVMEDIA_TYPE_VIDEO,
+        .config_props = config_output,
+    },
+    { NULL }
+};
+
+AVFilter ff_avf_agraphmonitor = {
+    .name          = "agraphmonitor",
+    .description   = NULL_IF_CONFIG_SMALL("Show various filtergraph stats."),
+    .priv_size     = sizeof(GraphMonitorContext),
+    .priv_class    = &agraphmonitor_class,
+    .query_formats = query_formats,
+    .activate      = activate,
+    .inputs        = agraphmonitor_inputs,
+    .outputs       = agraphmonitor_outputs,
+};
+#endif // CONFIG_AGRAPHMONITOR_FILTER

libavfilter/version.h

@@ -30,7 +30,7 @@
 #include "libavutil/version.h"
 
 #define LIBAVFILTER_VERSION_MAJOR   7
-#define LIBAVFILTER_VERSION_MINOR  38
+#define LIBAVFILTER_VERSION_MINOR  39
 #define LIBAVFILTER_VERSION_MICRO 100
 
 #define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \