2 * Copyright (c) 2015 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
21 #include "libavutil/avstring.h"
22 #include "libavutil/channel_layout.h"
23 #include "libavutil/eval.h"
24 #include "libavutil/intreadwrite.h"
25 #include "libavutil/opt.h"
26 #include "libavutil/parseutils.h"
27 #include "libavutil/xga_font_data.h"
35 static const char *const var_names[] = { "VOLUME", "CHANNEL", "PEAK", NULL };
36 enum { VAR_VOLUME, VAR_CHANNEL, VAR_PEAK, VAR_VARS_NB };
37 enum DisplayScale { LINEAR, LOG, NB_DISPLAY_SCALE };
39 typedef struct ShowVolumeContext {
44 AVRational frame_rate;
62 double draw_persistent_duration; /* in second */
63 uint8_t persistant_max_rgba[4];
64 int persistent_max_frames; /* number of frames to check max value */
65 float *max_persistent; /* max value for draw_persistent_max for each channel */
66 int *nb_frames_max_display; /* number of frame for each channel, for displaying the max value */
68 void (*meter)(float *src, int nb_samples, float *max, float factor);
71 #define OFFSET(x) offsetof(ShowVolumeContext, x)
72 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
74 static const AVOption showvolume_options[] = {
75 { "rate", "set video rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str="25"}, 0, INT_MAX, FLAGS },
76 { "r", "set video rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str="25"}, 0, INT_MAX, FLAGS },
77 { "b", "set border width", OFFSET(b), AV_OPT_TYPE_INT, {.i64=1}, 0, 5, FLAGS },
78 { "w", "set channel width", OFFSET(w), AV_OPT_TYPE_INT, {.i64=400}, 80, 8192, FLAGS },
79 { "h", "set channel height", OFFSET(h), AV_OPT_TYPE_INT, {.i64=20}, 1, 900, FLAGS },
80 { "f", "set fade", OFFSET(f), AV_OPT_TYPE_DOUBLE, {.dbl=0.95}, 0, 1, FLAGS },
81 { "c", "set volume color expression", OFFSET(color), AV_OPT_TYPE_STRING, {.str="PEAK*255+floor((1-PEAK)*255)*256+0xff000000"}, 0, 0, FLAGS },
82 { "t", "display channel names", OFFSET(draw_text), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
83 { "v", "display volume value", OFFSET(draw_volume), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
84 { "dm", "duration for max value display", OFFSET(draw_persistent_duration), AV_OPT_TYPE_DOUBLE, {.dbl=0.}, 0, 9000, FLAGS},
85 { "dmc","set color of the max value line", OFFSET(persistant_max_rgba), AV_OPT_TYPE_COLOR, {.str = "orange"}, 0, 0, FLAGS },
86 { "o", "set orientation", OFFSET(orientation), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "orientation" },
87 { "h", "horizontal", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "orientation" },
88 { "v", "vertical", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "orientation" },
89 { "s", "set step size", OFFSET(step), AV_OPT_TYPE_INT, {.i64=0}, 0, 5, FLAGS },
90 { "p", "set background opacity", OFFSET(bgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0}, 0, 1, FLAGS },
91 { "m", "set mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "mode" },
92 { "p", "peak", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "mode" },
93 { "r", "rms", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "mode" },
94 { "ds", "set display scale", OFFSET(display_scale), AV_OPT_TYPE_INT, {.i64=LINEAR}, LINEAR, NB_DISPLAY_SCALE - 1, FLAGS, "display_scale" },
95 { "lin", "linear", 0, AV_OPT_TYPE_CONST, {.i64=LINEAR}, 0, 0, FLAGS, "display_scale" },
96 { "log", "log", 0, AV_OPT_TYPE_CONST, {.i64=LOG}, 0, 0, FLAGS, "display_scale" },
100 AVFILTER_DEFINE_CLASS(showvolume);
102 static av_cold int init(AVFilterContext *ctx)
104 ShowVolumeContext *s = ctx->priv;
108 ret = av_expr_parse(&s->c_expr, s->color, var_names,
109 NULL, NULL, NULL, NULL, 0, ctx);
117 static int query_formats(AVFilterContext *ctx)
119 AVFilterFormats *formats = NULL;
120 AVFilterChannelLayouts *layouts = NULL;
121 AVFilterLink *inlink = ctx->inputs[0];
122 AVFilterLink *outlink = ctx->outputs[0];
123 static const enum AVSampleFormat sample_fmts[] = { AV_SAMPLE_FMT_FLTP, AV_SAMPLE_FMT_NONE };
124 static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_RGBA, AV_PIX_FMT_NONE };
127 formats = ff_make_format_list(sample_fmts);
128 if ((ret = ff_formats_ref(formats, &inlink->outcfg.formats)) < 0)
131 layouts = ff_all_channel_counts();
132 if ((ret = ff_channel_layouts_ref(layouts, &inlink->outcfg.channel_layouts)) < 0)
135 formats = ff_all_samplerates();
136 if ((ret = ff_formats_ref(formats, &inlink->outcfg.samplerates)) < 0)
139 formats = ff_make_format_list(pix_fmts);
140 if ((ret = ff_formats_ref(formats, &outlink->incfg.formats)) < 0)
146 static void find_peak(float *src, int nb_samples, float *peak, float factor)
151 for (i = 0; i < nb_samples; i++)
152 *peak = FFMAX(*peak, FFABS(src[i]));
155 static void find_rms(float *src, int nb_samples, float *rms, float factor)
159 for (i = 0; i < nb_samples; i++)
160 *rms += factor * (src[i] * src[i] - *rms);
163 static int config_input(AVFilterLink *inlink)
165 AVFilterContext *ctx = inlink->dst;
166 ShowVolumeContext *s = ctx->priv;
168 s->nb_samples = FFMAX(1, av_rescale(inlink->sample_rate, s->frame_rate.den, s->frame_rate.num));
169 s->values = av_calloc(inlink->channels * VAR_VARS_NB, sizeof(double));
171 return AVERROR(ENOMEM);
173 s->color_lut = av_calloc(s->w, sizeof(*s->color_lut) * inlink->channels);
175 return AVERROR(ENOMEM);
177 s->max = av_calloc(inlink->channels, sizeof(*s->max));
179 return AVERROR(ENOMEM);
181 s->rms_factor = 10000. / inlink->sample_rate;
184 case 0: s->meter = find_peak; break;
185 case 1: s->meter = find_rms; break;
186 default: return AVERROR_BUG;
189 if (s->draw_persistent_duration > 0.) {
190 s->persistent_max_frames = (int) FFMAX(av_q2d(s->frame_rate) * s->draw_persistent_duration, 1.);
191 s->max_persistent = av_calloc(inlink->channels * s->persistent_max_frames, sizeof(*s->max_persistent));
192 s->nb_frames_max_display = av_calloc(inlink->channels * s->persistent_max_frames, sizeof(*s->nb_frames_max_display));
197 static int config_output(AVFilterLink *outlink)
199 ShowVolumeContext *s = outlink->src->priv;
200 AVFilterLink *inlink = outlink->src->inputs[0];
203 if (s->orientation) {
205 outlink->w = s->h * inlink->channels + (inlink->channels - 1) * s->b;
208 outlink->h = s->h * inlink->channels + (inlink->channels - 1) * s->b;
211 outlink->sample_aspect_ratio = (AVRational){1,1};
212 outlink->frame_rate = s->frame_rate;
214 for (ch = 0; ch < inlink->channels; ch++) {
217 for (i = 0; i < s->w; i++) {
218 float max = i / (float)(s->w - 1);
220 s->values[ch * VAR_VARS_NB + VAR_PEAK] = max;
221 s->values[ch * VAR_VARS_NB + VAR_VOLUME] = 20.0 * log10(max);
222 s->values[ch * VAR_VARS_NB + VAR_CHANNEL] = ch;
223 s->color_lut[ch * s->w + i] = av_expr_eval(s->c_expr, &s->values[ch * VAR_VARS_NB], NULL);
230 static void drawtext(AVFrame *pic, int x, int y, const char *txt, int o)
236 font = avpriv_cga_font, font_height = 8;
238 for (i = 0; txt[i]; i++) {
241 if (o) { /* vertical orientation */
242 for (char_y = font_height - 1; char_y >= 0; char_y--) {
243 uint8_t *p = pic->data[0] + (y + i * 10) * pic->linesize[0] + x * 4;
244 for (mask = 0x80; mask; mask >>= 1) {
245 if (font[txt[i] * font_height + font_height - 1 - char_y] & mask)
246 AV_WN32(&p[char_y * 4], ~AV_RN32(&p[char_y * 4]));
247 p += pic->linesize[0];
250 } else { /* horizontal orientation */
251 uint8_t *p = pic->data[0] + y * pic->linesize[0] + (x + i * 8) * 4;
252 for (char_y = 0; char_y < font_height; char_y++) {
253 for (mask = 0x80; mask; mask >>= 1) {
254 if (font[txt[i] * font_height + char_y] & mask)
255 AV_WN32(p, ~AV_RN32(p));
258 p += pic->linesize[0] - 8 * 4;
264 static void clear_picture(ShowVolumeContext *s, AVFilterLink *outlink)
267 const uint32_t bg = (uint32_t)(s->bgopacity * 255) << 24;
269 for (i = 0; i < outlink->h; i++) {
270 uint32_t *dst = (uint32_t *)(s->out->data[0] + i * s->out->linesize[0]);
271 for (j = 0; j < outlink->w; j++)
272 AV_WN32A(dst + j, bg);
276 static inline int calc_max_draw(ShowVolumeContext *s, AVFilterLink *outlink, float max)
279 if (s->display_scale == LINEAR) {
282 max_val = av_clipf(0.21 * log10(max) + 1, 0, 1);
284 if (s->orientation) { /* vertical */
285 return outlink->h - outlink->h * max_val;
286 } else { /* horizontal */
287 return s->w * max_val;
291 static inline void calc_persistent_max(ShowVolumeContext *s, float max, int channel)
293 /* update max value for persistent max display */
294 if ((max >= s->max_persistent[channel]) || (s->nb_frames_max_display[channel] >= s->persistent_max_frames)) { /* update max value for display */
295 s->max_persistent[channel] = max;
296 s->nb_frames_max_display[channel] = 0;
298 s->nb_frames_max_display[channel] += 1; /* incremente display frame count */
302 static inline void draw_max_line(ShowVolumeContext *s, int max_draw, int channel)
305 if (s->orientation) { /* vertical */
306 uint8_t *dst = s->out->data[0] + max_draw * s->out->linesize[0] + channel * (s->b + s->h) * 4;
307 for (k = 0; k < s->h; k++) {
308 memcpy(dst + k * 4, s->persistant_max_rgba, sizeof(s->persistant_max_rgba));
310 } else { /* horizontal */
311 for (k = 0; k < s->h; k++) {
312 uint8_t *dst = s->out->data[0] + (channel * s->h + channel * s->b + k) * s->out->linesize[0];
313 memcpy(dst + max_draw * 4, s->persistant_max_rgba, sizeof(s->persistant_max_rgba));
318 static int filter_frame(AVFilterLink *inlink, AVFrame *insamples)
320 AVFilterContext *ctx = inlink->dst;
321 AVFilterLink *outlink = ctx->outputs[0];
322 ShowVolumeContext *s = ctx->priv;
323 const int step = s->step;
324 int c, j, k, max_draw;
327 if (!s->out || s->out->width != outlink->w ||
328 s->out->height != outlink->h) {
329 av_frame_free(&s->out);
330 s->out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
332 av_frame_free(&insamples);
333 return AVERROR(ENOMEM);
335 clear_picture(s, outlink);
337 s->out->pts = insamples->pts;
339 if ((s->f < 1.) && (s->f > 0.)) {
340 for (j = 0; j < outlink->h; j++) {
341 uint8_t *dst = s->out->data[0] + j * s->out->linesize[0];
342 const uint32_t alpha = s->bgopacity * 255;
344 for (k = 0; k < outlink->w; k++) {
345 dst[k * 4 + 0] = FFMAX(dst[k * 4 + 0] * s->f, 0);
346 dst[k * 4 + 1] = FFMAX(dst[k * 4 + 1] * s->f, 0);
347 dst[k * 4 + 2] = FFMAX(dst[k * 4 + 2] * s->f, 0);
348 dst[k * 4 + 3] = FFMAX(dst[k * 4 + 3] * s->f, alpha);
351 } else if (s->f == 0.) {
352 clear_picture(s, outlink);
355 if (s->orientation) { /* vertical */
356 for (c = 0; c < inlink->channels; c++) {
357 float *src = (float *)insamples->extended_data[c];
358 uint32_t *lut = s->color_lut + s->w * c;
361 s->meter(src, insamples->nb_samples, &s->max[c], s->rms_factor);
364 s->values[c * VAR_VARS_NB + VAR_VOLUME] = 20.0 * log10(max);
365 max = av_clipf(max, 0, 1);
366 max_draw = calc_max_draw(s, outlink, max);
368 for (j = max_draw; j < s->w; j++) {
369 uint8_t *dst = s->out->data[0] + j * s->out->linesize[0] + c * (s->b + s->h) * 4;
370 for (k = 0; k < s->h; k++) {
371 AV_WN32A(&dst[k * 4], lut[s->w - j - 1]);
377 if (s->h >= 8 && s->draw_text) {
378 const char *channel_name = av_get_channel_name(av_channel_layout_extract_channel(insamples->channel_layout, c));
381 drawtext(s->out, c * (s->h + s->b) + (s->h - 10) / 2, outlink->h - 35, channel_name, 1);
384 if (s->draw_persistent_duration > 0.) {
385 calc_persistent_max(s, max, c);
386 max_draw = FFMAX(0, calc_max_draw(s, outlink, s->max_persistent[c]) - 1);
387 draw_max_line(s, max_draw, c);
390 } else { /* horizontal */
391 for (c = 0; c < inlink->channels; c++) {
392 float *src = (float *)insamples->extended_data[c];
393 uint32_t *lut = s->color_lut + s->w * c;
396 s->meter(src, insamples->nb_samples, &s->max[c], s->rms_factor);
399 s->values[c * VAR_VARS_NB + VAR_VOLUME] = 20.0 * log10(max);
400 max = av_clipf(max, 0, 1);
401 max_draw = calc_max_draw(s, outlink, max);
403 for (j = 0; j < s->h; j++) {
404 uint8_t *dst = s->out->data[0] + (c * s->h + c * s->b + j) * s->out->linesize[0];
406 for (k = 0; k < max_draw; k++) {
407 AV_WN32A(dst + k * 4, lut[k]);
413 if (s->h >= 8 && s->draw_text) {
414 const char *channel_name = av_get_channel_name(av_channel_layout_extract_channel(insamples->channel_layout, c));
417 drawtext(s->out, 2, c * (s->h + s->b) + (s->h - 8) / 2, channel_name, 0);
420 if (s->draw_persistent_duration > 0.) {
421 calc_persistent_max(s, max, c);
422 max_draw = FFMAX(0, calc_max_draw(s, outlink, s->max_persistent[c]) - 1);
423 draw_max_line(s, max_draw, c);
428 av_frame_free(&insamples);
429 out = av_frame_clone(s->out);
431 return AVERROR(ENOMEM);
432 av_frame_make_writable(out);
434 /* draw volume level */
435 for (c = 0; c < inlink->channels && s->h >= 8 && s->draw_volume; c++) {
438 if (s->orientation) { /* vertical */
439 snprintf(buf, sizeof(buf), "%.2f", s->values[c * VAR_VARS_NB + VAR_VOLUME]);
440 drawtext(out, c * (s->h + s->b) + (s->h - 8) / 2, 2, buf, 1);
441 } else { /* horizontal */
442 snprintf(buf, sizeof(buf), "%.2f", s->values[c * VAR_VARS_NB + VAR_VOLUME]);
443 drawtext(out, FFMAX(0, s->w - 8 * (int)strlen(buf)), c * (s->h + s->b) + (s->h - 8) / 2, buf, 0);
447 return ff_filter_frame(outlink, out);
450 static int activate(AVFilterContext *ctx)
452 AVFilterLink *inlink = ctx->inputs[0];
453 AVFilterLink *outlink = ctx->outputs[0];
454 ShowVolumeContext *s = ctx->priv;
458 FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink);
460 ret = ff_inlink_consume_samples(inlink, s->nb_samples, s->nb_samples, &in);
464 return filter_frame(inlink, in);
466 FF_FILTER_FORWARD_STATUS(inlink, outlink);
467 FF_FILTER_FORWARD_WANTED(outlink, inlink);
469 return FFERROR_NOT_READY;
472 static av_cold void uninit(AVFilterContext *ctx)
474 ShowVolumeContext *s = ctx->priv;
476 av_frame_free(&s->out);
477 av_expr_free(s->c_expr);
478 av_freep(&s->values);
479 av_freep(&s->color_lut);
483 static const AVFilterPad showvolume_inputs[] = {
486 .type = AVMEDIA_TYPE_AUDIO,
487 .config_props = config_input,
492 static const AVFilterPad showvolume_outputs[] = {
495 .type = AVMEDIA_TYPE_VIDEO,
496 .config_props = config_output,
501 AVFilter ff_avf_showvolume = {
502 .name = "showvolume",
503 .description = NULL_IF_CONFIG_SMALL("Convert input audio volume to video output."),
505 .activate = activate,
507 .query_formats = query_formats,
508 .priv_size = sizeof(ShowVolumeContext),
509 .inputs = showvolume_inputs,
510 .outputs = showvolume_outputs,
511 .priv_class = &showvolume_class,