libavfilter/aeval.c
36c06b09
 /*
  * Copyright (c) 2011 Stefano Sabatini
  *
  * 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
  */
 
 /**
  * @file
  * eval audio source
  */
 
 #include "libavutil/avassert.h"
 #include "libavutil/avstring.h"
1acd2f6b
 #include "libavutil/channel_layout.h"
36c06b09
 #include "libavutil/eval.h"
 #include "libavutil/opt.h"
6c26fe8b
 #include "libavutil/parseutils.h"
36c06b09
 #include "avfilter.h"
4522df52
 #include "audio.h"
36c06b09
 #include "internal.h"
 
d7847333
 static const char * const var_names[] = {
e424abc3
     "ch",           ///< the value of the current channel
36c06b09
     "n",            ///< number of frame
e424abc3
     "nb_in_channels",
     "nb_out_channels",
36c06b09
     "t",            ///< timestamp expressed in seconds
     "s",            ///< sample rate
     NULL
 };
 
 enum var_name {
e424abc3
     VAR_CH,
36c06b09
     VAR_N,
e424abc3
     VAR_NB_IN_CHANNELS,
     VAR_NB_OUT_CHANNELS,
36c06b09
     VAR_T,
     VAR_S,
     VAR_VARS_NB
 };
 
ed93ed5e
 typedef struct EvalContext {
36c06b09
     const AVClass *class;
     char *sample_rate_str;
     int sample_rate;
     int64_t chlayout;
e1a8df70
     char *chlayout_str;
e424abc3
     int nb_channels;            ///< number of output channels
     int nb_in_channels;         ///< number of input channels
     int same_chlayout;          ///< set output as input channel layout
36c06b09
     int64_t pts;
937cfebd
     AVExpr **expr;
64ce15b9
     char *exprs;
36c06b09
     int nb_samples;             ///< number of samples per requested frame
badbd241
     int64_t duration;
36c06b09
     uint64_t n;
     double var_values[VAR_VARS_NB];
e424abc3
     double *channel_values;
     int64_t out_channel_layout;
36c06b09
 } EvalContext;
 
e424abc3
 static double val(void *priv, double ch)
 {
     EvalContext *eval = priv;
     return eval->channel_values[FFMIN((int)ch, eval->nb_in_channels-1)];
 }
 
 static double (* const aeval_func1[])(void *, double) = { val, NULL };
 static const char * const aeval_func1_names[] = { "val", NULL };
 
36c06b09
 #define OFFSET(x) offsetof(EvalContext, x)
42d621d1
 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
36c06b09
 
c17808ce
 static const AVOption aevalsrc_options[]= {
64ce15b9
     { "exprs",       "set the '|'-separated list of channels expressions", OFFSET(exprs), AV_OPT_TYPE_STRING, {.str = NULL}, .flags = FLAGS },
d46c1c72
     { "nb_samples",  "set the number of samples per requested frame", OFFSET(nb_samples),      AV_OPT_TYPE_INT,    {.i64 = 1024},    0,        INT_MAX, FLAGS },
     { "n",           "set the number of samples per requested frame", OFFSET(nb_samples),      AV_OPT_TYPE_INT,    {.i64 = 1024},    0,        INT_MAX, FLAGS },
42d621d1
     { "sample_rate", "set the sample rate",                           OFFSET(sample_rate_str), AV_OPT_TYPE_STRING, {.str = "44100"}, CHAR_MIN, CHAR_MAX, FLAGS },
     { "s",           "set the sample rate",                           OFFSET(sample_rate_str), AV_OPT_TYPE_STRING, {.str = "44100"}, CHAR_MIN, CHAR_MAX, FLAGS },
badbd241
     { "duration",    "set audio duration", OFFSET(duration), AV_OPT_TYPE_DURATION, {.i64 = -1}, -1, INT64_MAX, FLAGS },
     { "d",           "set audio duration", OFFSET(duration), AV_OPT_TYPE_DURATION, {.i64 = -1}, -1, INT64_MAX, FLAGS },
42d621d1
     { "channel_layout", "set channel layout", OFFSET(chlayout_str), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, FLAGS },
     { "c",              "set channel layout", OFFSET(chlayout_str), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, FLAGS },
b211607b
     { NULL }
36c06b09
 };
 
c17808ce
 AVFILTER_DEFINE_CLASS(aevalsrc);
36c06b09
 
e424abc3
 static int parse_channel_expressions(AVFilterContext *ctx,
                                      int expected_nb_channels)
36c06b09
 {
     EvalContext *eval = ctx->priv;
64ce15b9
     char *args1 = av_strdup(eval->exprs);
efbf107f
     char *expr, *last_expr = NULL, *buf;
e424abc3
     double (* const *func1)(void *, double) = NULL;
     const char * const *func1_names = NULL;
     int i, ret = 0;
 
     if (!args1)
         return AVERROR(ENOMEM);
36c06b09
 
e424abc3
     if (!eval->exprs) {
64ce15b9
         av_log(ctx, AV_LOG_ERROR, "Channels expressions list is empty\n");
e424abc3
         return AVERROR(EINVAL);
     }
 
     if (!strcmp(ctx->filter->name, "aeval")) {
         func1 = aeval_func1;
         func1_names = aeval_func1_names;
989c91b5
     }
 
405b3eb5
 #define ADD_EXPRESSION(expr_) do {                                      \
         if (!av_dynarray2_add((void **)&eval->expr, &eval->nb_channels, \
                               sizeof(*eval->expr), NULL)) {             \
             ret = AVERROR(ENOMEM);                                      \
             goto end;                                                   \
         }                                                               \
         eval->expr[eval->nb_channels-1] = NULL;                         \
         ret = av_expr_parse(&eval->expr[eval->nb_channels - 1], expr_,  \
e424abc3
                             var_names, func1_names, func1,              \
405b3eb5
                             NULL, NULL, 0, ctx);                        \
         if (ret < 0)                                                    \
             goto end;                                                   \
     } while (0)
 
e424abc3
     /* reset expressions */
     for (i = 0; i < eval->nb_channels; i++) {
         av_expr_free(eval->expr[i]);
         eval->expr[i] = NULL;
     }
     av_freep(&eval->expr);
     eval->nb_channels = 0;
 
36c06b09
     buf = args1;
937cfebd
     while (expr = av_strtok(buf, "|", &buf)) {
405b3eb5
         ADD_EXPRESSION(expr);
         last_expr = expr;
36c06b09
     }
e1a8df70
 
e424abc3
     if (expected_nb_channels > eval->nb_channels)
         for (i = eval->nb_channels; i < expected_nb_channels; i++)
             ADD_EXPRESSION(last_expr);
 
     if (expected_nb_channels > 0 && eval->nb_channels != expected_nb_channels) {
         av_log(ctx, AV_LOG_ERROR,
                "Mismatch between the specified number of channel expressions '%d' "
                "and the number of expected output channels '%d' for the specified channel layout\n",
                eval->nb_channels, expected_nb_channels);
         ret = AVERROR(EINVAL);
         goto end;
     }
 
 end:
     av_free(args1);
     return ret;
 }
405b3eb5
 
e424abc3
 static av_cold int init(AVFilterContext *ctx)
 {
     EvalContext *eval = ctx->priv;
0fe6906d
     int ret = 0;
e424abc3
 
     if (eval->chlayout_str) {
         if (!strcmp(eval->chlayout_str, "same") && !strcmp(ctx->filter->name, "aeval")) {
             eval->same_chlayout = 1;
         } else {
             ret = ff_parse_channel_layout(&eval->chlayout, NULL, eval->chlayout_str, ctx);
             if (ret < 0)
                 return ret;
 
             ret = parse_channel_expressions(ctx, av_get_channel_layout_nb_channels(eval->chlayout));
             if (ret < 0)
                 return ret;
e1a8df70
         }
     } else {
17d4233c
         /* guess channel layout from nb expressions/channels */
e424abc3
         if ((ret = parse_channel_expressions(ctx, -1)) < 0)
             return ret;
 
17d4233c
         eval->chlayout = av_get_default_channel_layout(eval->nb_channels);
aac57c76
         if (!eval->chlayout && eval->nb_channels <= 0) {
17d4233c
             av_log(ctx, AV_LOG_ERROR, "Invalid number of channels '%d' provided\n",
                    eval->nb_channels);
e424abc3
             return AVERROR(EINVAL);
17d4233c
         }
e1a8df70
     }
36c06b09
 
e424abc3
     if (eval->sample_rate_str)
         if ((ret = ff_parse_sample_rate(&eval->sample_rate, eval->sample_rate_str, ctx)))
             return ret;
36c06b09
     eval->n = 0;
 
     return ret;
 }
 
f4341c64
 static av_cold void uninit(AVFilterContext *ctx)
36c06b09
 {
     EvalContext *eval = ctx->priv;
     int i;
 
937cfebd
     for (i = 0; i < eval->nb_channels; i++) {
36c06b09
         av_expr_free(eval->expr[i]);
         eval->expr[i] = NULL;
     }
937cfebd
     av_freep(&eval->expr);
c8372f80
     av_freep(&eval->channel_values);
36c06b09
 }
 
 static int config_props(AVFilterLink *outlink)
 {
     EvalContext *eval = outlink->src->priv;
     char buf[128];
 
     outlink->time_base = (AVRational){1, eval->sample_rate};
     outlink->sample_rate = eval->sample_rate;
 
     eval->var_values[VAR_S] = eval->sample_rate;
e424abc3
     eval->var_values[VAR_NB_IN_CHANNELS] = NAN;
     eval->var_values[VAR_NB_OUT_CHANNELS] = outlink->channels;
36c06b09
 
     av_get_channel_layout_string(buf, sizeof(buf), 0, eval->chlayout);
 
fda968aa
     av_log(outlink->src, AV_LOG_VERBOSE,
badbd241
            "sample_rate:%d chlayout:%s duration:%"PRId64"\n",
6c26fe8b
            eval->sample_rate, buf, eval->duration);
36c06b09
 
     return 0;
 }
 
 static int query_formats(AVFilterContext *ctx)
 {
     EvalContext *eval = ctx->priv;
185d1f3b
     static const enum AVSampleFormat sample_fmts[] = { AV_SAMPLE_FMT_DBLP, AV_SAMPLE_FMT_NONE };
aac57c76
     int64_t chlayouts[] = { eval->chlayout ? eval->chlayout : FF_COUNT2LAYOUT(eval->nb_channels) , -1 };
986d2f6e
     int sample_rates[] = { eval->sample_rate, -1 };
a0854c08
     AVFilterFormats *formats;
     AVFilterChannelLayouts *layouts;
     int ret;
36c06b09
 
a0854c08
     formats = ff_make_format_list(sample_fmts);
     if (!formats)
         return AVERROR(ENOMEM);
     ret = ff_set_common_formats (ctx, formats);
     if (ret < 0)
         return ret;
36c06b09
 
a0854c08
     layouts = avfilter_make_format64_list(chlayouts);
     if (!layouts)
         return AVERROR(ENOMEM);
     ret = ff_set_common_channel_layouts(ctx, layouts);
     if (ret < 0)
         return ret;
 
     formats = ff_make_format_list(sample_rates);
     if (!formats)
         return AVERROR(ENOMEM);
     return ff_set_common_samplerates(ctx, formats);
36c06b09
 }
 
 static int request_frame(AVFilterLink *outlink)
 {
     EvalContext *eval = outlink->src->priv;
a05a44e2
     AVFrame *samplesref;
36c06b09
     int i, j;
badbd241
     int64_t t = av_rescale(eval->n, AV_TIME_BASE, eval->sample_rate);
dbc7f02a
     int nb_samples;
6c26fe8b
 
f9eed5d7
     if (eval->duration >= 0 && t >= eval->duration)
6c26fe8b
         return AVERROR_EOF;
36c06b09
 
dbc7f02a
     if (eval->duration >= 0) {
         nb_samples = FFMIN(eval->nb_samples, av_rescale(eval->duration, eval->sample_rate, AV_TIME_BASE) - eval->pts);
         if (!nb_samples)
             return AVERROR_EOF;
     } else {
         nb_samples = eval->nb_samples;
     }
     samplesref = ff_get_audio_buffer(outlink, nb_samples);
ed8373e7
     if (!samplesref)
         return AVERROR(ENOMEM);
36c06b09
 
     /* evaluate expression for each single sample and for each channel */
dbc7f02a
     for (i = 0; i < nb_samples; i++, eval->n++) {
36c06b09
         eval->var_values[VAR_N] = eval->n;
         eval->var_values[VAR_T] = eval->var_values[VAR_N] * (double)1/eval->sample_rate;
 
         for (j = 0; j < eval->nb_channels; j++) {
cfde7395
             *((double *) samplesref->extended_data[j] + i) =
36c06b09
                 av_expr_eval(eval->expr[j], eval->var_values, NULL);
         }
     }
 
     samplesref->pts = eval->pts;
a05a44e2
     samplesref->sample_rate = eval->sample_rate;
dbc7f02a
     eval->pts += nb_samples;
36c06b09
 
44f3d217
     return ff_filter_frame(outlink, samplesref);
36c06b09
 }
 
e424abc3
 #if CONFIG_AEVALSRC_FILTER
2d9d4440
 static const AVFilterPad aevalsrc_outputs[] = {
     {
         .name          = "default",
         .type          = AVMEDIA_TYPE_AUDIO,
         .config_props  = config_props,
         .request_frame = request_frame,
     },
     { NULL }
 };
 
325f6e0a
 AVFilter ff_asrc_aevalsrc = {
b211607b
     .name          = "aevalsrc",
     .description   = NULL_IF_CONFIG_SMALL("Generate an audio signal generated by an expression."),
36c06b09
     .query_formats = query_formats,
b211607b
     .init          = init,
     .uninit        = uninit,
     .priv_size     = sizeof(EvalContext),
     .inputs        = NULL,
     .outputs       = aevalsrc_outputs,
     .priv_class    = &aevalsrc_class,
36c06b09
 };
e424abc3
 
 #endif /* CONFIG_AEVALSRC_FILTER */
 
 #define OFFSET(x) offsetof(EvalContext, x)
 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
 
 static const AVOption aeval_options[]= {
     { "exprs", "set the '|'-separated list of channels expressions", OFFSET(exprs), AV_OPT_TYPE_STRING, {.str = NULL}, .flags = FLAGS },
     { "channel_layout", "set channel layout", OFFSET(chlayout_str), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, FLAGS },
     { "c",              "set channel layout", OFFSET(chlayout_str), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, FLAGS },
     { NULL }
 };
 
 AVFILTER_DEFINE_CLASS(aeval);
 
 static int aeval_query_formats(AVFilterContext *ctx)
 {
     AVFilterFormats *formats = NULL;
     AVFilterChannelLayouts *layouts;
     AVFilterLink *inlink  = ctx->inputs[0];
     AVFilterLink *outlink  = ctx->outputs[0];
     EvalContext *eval = ctx->priv;
     static const enum AVSampleFormat sample_fmts[] = {
         AV_SAMPLE_FMT_DBLP, AV_SAMPLE_FMT_NONE
     };
6aaac24d
     int ret;
e424abc3
 
     // inlink supports any channel layout
     layouts = ff_all_channel_counts();
6aaac24d
     if ((ret = ff_channel_layouts_ref(layouts, &inlink->out_channel_layouts)) < 0)
         return ret;
e424abc3
 
     if (eval->same_chlayout) {
         layouts = ff_all_channel_counts();
6aaac24d
         if ((ret = ff_set_common_channel_layouts(ctx, layouts)) < 0)
             return ret;
e424abc3
     } else {
         // outlink supports only requested output channel layout
         layouts = NULL;
6aaac24d
         if ((ret = ff_add_channel_layout(&layouts,
e424abc3
                               eval->out_channel_layout ? eval->out_channel_layout :
6aaac24d
                               FF_COUNT2LAYOUT(eval->nb_channels))) < 0)
             return ret;
         if ((ret = ff_channel_layouts_ref(layouts, &outlink->in_channel_layouts)) < 0)
             return ret;
e424abc3
     }
 
     formats = ff_make_format_list(sample_fmts);
6aaac24d
     if ((ret = ff_set_common_formats(ctx, formats)) < 0)
         return ret;
e424abc3
 
     formats = ff_all_samplerates();
6aaac24d
     return ff_set_common_samplerates(ctx, formats);
e424abc3
 }
 
 static int aeval_config_output(AVFilterLink *outlink)
 {
     AVFilterContext *ctx = outlink->src;
     EvalContext *eval = ctx->priv;
     AVFilterLink *inlink = ctx->inputs[0];
     int ret;
 
     if (eval->same_chlayout) {
         eval->chlayout = inlink->channel_layout;
 
         if ((ret = parse_channel_expressions(ctx, inlink->channels)) < 0)
             return ret;
     }
 
     eval->n = 0;
     eval->nb_in_channels = eval->var_values[VAR_NB_IN_CHANNELS] = inlink->channels;
     eval->var_values[VAR_NB_OUT_CHANNELS] = outlink->channels;
     eval->var_values[VAR_S] = inlink->sample_rate;
     eval->var_values[VAR_T] = NAN;
 
     eval->channel_values = av_realloc_f(eval->channel_values,
                                         inlink->channels, sizeof(*eval->channel_values));
     if (!eval->channel_values)
         return AVERROR(ENOMEM);
 
     return 0;
 }
 
 #define TS2T(ts, tb) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts)*av_q2d(tb))
 
 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 {
     EvalContext *eval     = inlink->dst->priv;
     AVFilterLink *outlink = inlink->dst->outputs[0];
     int nb_samples        = in->nb_samples;
     AVFrame *out;
     double t0;
     int i, j;
 
     out = ff_get_audio_buffer(outlink, nb_samples);
c0292141
     if (!out) {
         av_frame_free(&in);
e424abc3
         return AVERROR(ENOMEM);
c0292141
     }
e424abc3
     av_frame_copy_props(out, in);
 
     t0 = TS2T(in->pts, inlink->time_base);
 
     /* evaluate expression for each single sample and for each channel */
     for (i = 0; i < nb_samples; i++, eval->n++) {
         eval->var_values[VAR_N] = eval->n;
         eval->var_values[VAR_T] = t0 + i * (double)1/inlink->sample_rate;
 
         for (j = 0; j < inlink->channels; j++)
             eval->channel_values[j] = *((double *) in->extended_data[j] + i);
 
         for (j = 0; j < outlink->channels; j++) {
             eval->var_values[VAR_CH] = j;
             *((double *) out->extended_data[j] + i) =
                 av_expr_eval(eval->expr[j], eval->var_values, eval);
         }
     }
 
     av_frame_free(&in);
     return ff_filter_frame(outlink, out);
 }
 
 #if CONFIG_AEVAL_FILTER
 
 static const AVFilterPad aeval_inputs[] = {
     {
         .name           = "default",
         .type           = AVMEDIA_TYPE_AUDIO,
         .filter_frame   = filter_frame,
     },
     { NULL }
 };
 
 static const AVFilterPad aeval_outputs[] = {
     {
         .name          = "default",
         .type          = AVMEDIA_TYPE_AUDIO,
         .config_props  = aeval_config_output,
     },
     { NULL }
 };
 
 AVFilter ff_af_aeval = {
     .name          = "aeval",
     .description   = NULL_IF_CONFIG_SMALL("Filter audio signal according to a specified expression."),
     .query_formats = aeval_query_formats,
     .init          = init,
     .uninit        = uninit,
     .priv_size     = sizeof(EvalContext),
     .inputs        = aeval_inputs,
     .outputs       = aeval_outputs,
     .priv_class    = &aeval_class,
 };
 
 #endif /* CONFIG_AEVAL_FILTER */