git.sesse.net Git - ffmpeg/blob - libavfilter/af_rubberband.c

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * FFmpeg is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with FFmpeg; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #include <rubberband/rubberband-c.h>
  20
  21 #include "libavutil/channel_layout.h"
  22 #include "libavutil/common.h"
  23 #include "libavutil/opt.h"
  24
  25 #include "audio.h"
  26 #include "avfilter.h"
  27 #include "filters.h"
  28 #include "formats.h"
  29 #include "internal.h"
  30
  31 typedef struct RubberBandContext {
  32     const AVClass *class;
  33     RubberBandState rbs;
  34
  35     double tempo, pitch;
  36     int transients, detector, phase, window,
  37         smoothing, formant, opitch, channels;
  38     int64_t nb_samples_out;
  39     int64_t nb_samples_in;
  40     int64_t first_pts;
  41     int nb_samples;
  42 } RubberBandContext;
  43
  44 #define OFFSET(x) offsetof(RubberBandContext, x)
  45 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  46 #define AT AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
  47
  48 static const AVOption rubberband_options[] = {
  49     { "tempo",      "set tempo scale factor", OFFSET(tempo), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.01, 100, AT },
  50     { "pitch",      "set pitch scale factor", OFFSET(pitch), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.01, 100, AT },
  51     { "transients", "set transients", OFFSET(transients), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, A, "transients" },
  52         { "crisp",  0,                0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionTransientsCrisp},  0, 0, A, "transients" },
  53         { "mixed",  0,                0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionTransientsMixed},  0, 0, A, "transients" },
  54         { "smooth", 0,                0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionTransientsSmooth}, 0, 0, A, "transients" },
  55     { "detector",   "set detector",   OFFSET(detector),   AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, A, "detector" },
  56         { "compound",   0,            0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionDetectorCompound},   0, 0, A, "detector" },
  57         { "percussive", 0,            0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionDetectorPercussive}, 0, 0, A, "detector" },
  58         { "soft",       0,            0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionDetectorSoft},       0, 0, A, "detector" },
  59     { "phase",      "set phase",      OFFSET(phase),      AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, A, "phase" },
  60         { "laminar",     0,           0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionPhaseLaminar},     0, 0, A, "phase" },
  61         { "independent", 0,           0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionPhaseIndependent}, 0, 0, A, "phase" },
  62     { "window",     "set window",     OFFSET(window),     AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, A, "window" },
  63         { "standard", 0,              0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionWindowStandard}, 0, 0, A, "window" },
  64         { "short",    0,              0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionWindowShort},    0, 0, A, "window" },
  65         { "long",     0,              0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionWindowLong},     0, 0, A, "window" },
  66     { "smoothing",  "set smoothing",  OFFSET(smoothing),  AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, A, "smoothing" },
  67         { "off",    0,                0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionSmoothingOff}, 0, 0, A, "smoothing" },
  68         { "on",     0,                0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionSmoothingOn},  0, 0, A, "smoothing" },
  69     { "formant",    "set formant",    OFFSET(formant),    AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, A, "formant" },
  70         { "shifted",    0,            0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionFormantShifted},   0, 0, A, "formant" },
  71         { "preserved",  0,            0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionFormantPreserved}, 0, 0, A, "formant" },
  72     { "pitchq",     "set pitch quality", OFFSET(opitch),  AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, A, "pitch" },
  73         { "quality",     0,           0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionPitchHighQuality},     0, 0, A, "pitch" },
  74         { "speed",       0,           0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionPitchHighSpeed},       0, 0, A, "pitch" },
  75         { "consistency", 0,           0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionPitchHighConsistency}, 0, 0, A, "pitch" },
  76     { "channels",   "set channels",   OFFSET(channels),   AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, A, "channels" },
  77         { "apart",    0,              0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionChannelsApart},    0, 0, A, "channels" },
  78         { "together", 0,              0,                  AV_OPT_TYPE_CONST, {.i64=RubberBandOptionChannelsTogether}, 0, 0, A, "channels" },
  79     { NULL },
  80 };
  81
  82 AVFILTER_DEFINE_CLASS(rubberband);
  83
  84 static av_cold void uninit(AVFilterContext *ctx)
  85 {
  86     RubberBandContext *s = ctx->priv;
  87
  88     if (s->rbs)
  89         rubberband_delete(s->rbs);
  90 }
  91
  92 static int query_formats(AVFilterContext *ctx)
  93 {
  94     AVFilterFormats *formats = NULL;
  95     AVFilterChannelLayouts *layouts = NULL;
  96     static const enum AVSampleFormat sample_fmts[] = {
  97         AV_SAMPLE_FMT_FLTP,
  98         AV_SAMPLE_FMT_NONE,
  99     };
 100     int ret;
 101
 102     layouts = ff_all_channel_counts();
 103     if (!layouts)
 104         return AVERROR(ENOMEM);
 105     ret = ff_set_common_channel_layouts(ctx, layouts);
 106     if (ret < 0)
 107         return ret;
 108
 109     formats = ff_make_format_list(sample_fmts);
 110     if (!formats)
 111         return AVERROR(ENOMEM);
 112     ret = ff_set_common_formats(ctx, formats);
 113     if (ret < 0)
 114         return ret;
 115
 116     formats = ff_all_samplerates();
 117     if (!formats)
 118         return AVERROR(ENOMEM);
 119     return ff_set_common_samplerates(ctx, formats);
 120 }
 121
 122 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 123 {
 124     RubberBandContext *s = inlink->dst->priv;
 125     AVFilterLink *outlink = inlink->dst->outputs[0];
 126     AVFrame *out;
 127     int ret = 0, nb_samples;
 128
 129     if (s->first_pts == AV_NOPTS_VALUE)
 130         s->first_pts = in->pts;
 131
 132     rubberband_process(s->rbs, (const float *const *)in->data, in->nb_samples, ff_outlink_get_status(inlink));
 133     s->nb_samples_in += in->nb_samples;
 134
 135     nb_samples = rubberband_available(s->rbs);
 136     if (nb_samples > 0) {
 137         out = ff_get_audio_buffer(outlink, nb_samples);
 138         if (!out) {
 139             av_frame_free(&in);
 140             return AVERROR(ENOMEM);
 141         }
 142         out->pts = s->first_pts + av_rescale_q(s->nb_samples_out,
 143                      (AVRational){ 1, outlink->sample_rate },
 144                      outlink->time_base);
 145         nb_samples = rubberband_retrieve(s->rbs, (float *const *)out->data, nb_samples);
 146         out->nb_samples = nb_samples;
 147         ret = ff_filter_frame(outlink, out);
 148         s->nb_samples_out += nb_samples;
 149     }
 150
 151     av_frame_free(&in);
 152     return ret  < 0 ? ret : nb_samples;
 153 }
 154
 155 static int config_input(AVFilterLink *inlink)
 156 {
 157     AVFilterContext *ctx = inlink->dst;
 158     RubberBandContext *s = ctx->priv;
 159     int opts = s->transients|s->detector|s->phase|s->window|
 160                s->smoothing|s->formant|s->opitch|s->channels|
 161                RubberBandOptionProcessRealTime;
 162
 163     if (s->rbs)
 164         rubberband_delete(s->rbs);
 165     s->rbs = rubberband_new(inlink->sample_rate, inlink->channels, opts, 1. / s->tempo, s->pitch);
 166     if (!s->rbs)
 167         return AVERROR(ENOMEM);
 168
 169     s->nb_samples = rubberband_get_samples_required(s->rbs);
 170     s->first_pts = AV_NOPTS_VALUE;
 171
 172     return 0;
 173 }
 174
 175 static int activate(AVFilterContext *ctx)
 176 {
 177     AVFilterLink *inlink = ctx->inputs[0];
 178     AVFilterLink *outlink = ctx->outputs[0];
 179     RubberBandContext *s = ctx->priv;
 180     AVFrame *in = NULL;
 181     int ret;
 182
 183     FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink);
 184
 185     ret = ff_inlink_consume_samples(inlink, s->nb_samples, s->nb_samples, &in);
 186     if (ret < 0)
 187         return ret;
 188     if (ret > 0) {
 189         ret = filter_frame(inlink, in);
 190         if (ret != 0)
 191             return ret;
 192     }
 193
 194     FF_FILTER_FORWARD_STATUS(inlink, outlink);
 195     FF_FILTER_FORWARD_WANTED(outlink, inlink);
 196
 197     return FFERROR_NOT_READY;
 198 }
 199
 200 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
 201                            char *res, int res_len, int flags)
 202 {
 203     RubberBandContext *s = ctx->priv;
 204     int ret;
 205
 206     ret = ff_filter_process_command(ctx, cmd, args, res, res_len, flags);
 207     if (ret < 0)
 208         return ret;
 209
 210     rubberband_set_time_ratio(s->rbs, 1. / s->tempo);
 211     rubberband_set_pitch_scale(s->rbs, s->pitch);
 212
 213     return 0;
 214 }
 215
 216 static const AVFilterPad rubberband_inputs[] = {
 217     {
 218         .name          = "default",
 219         .type          = AVMEDIA_TYPE_AUDIO,
 220         .config_props  = config_input,
 221     },
 222     { NULL }
 223 };
 224
 225 static const AVFilterPad rubberband_outputs[] = {
 226     {
 227         .name          = "default",
 228         .type          = AVMEDIA_TYPE_AUDIO,
 229     },
 230     { NULL }
 231 };
 232
 233 AVFilter ff_af_rubberband = {
 234     .name          = "rubberband",
 235     .description   = NULL_IF_CONFIG_SMALL("Apply time-stretching and pitch-shifting."),
 236     .query_formats = query_formats,
 237     .priv_size     = sizeof(RubberBandContext),
 238     .priv_class    = &rubberband_class,
 239     .uninit        = uninit,
 240     .activate      = activate,
 241     .inputs        = rubberband_inputs,
 242     .outputs       = rubberband_outputs,
 243     .process_command = process_command,
 244 };