git.sesse.net Git - ffmpeg/blob - libavfilter/af_resample.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 /**
  20  * @file
  21  * sample format and channel layout conversion audio filter
  22  */
  23
  24 #include "libavutil/avassert.h"
  25 #include "libavutil/avstring.h"
  26 #include "libavutil/common.h"
  27 #include "libavutil/dict.h"
  28 #include "libavutil/mathematics.h"
  29 #include "libavutil/opt.h"
  30
  31 #include "libavresample/avresample.h"
  32
  33 #include "audio.h"
  34 #include "avfilter.h"
  35 #include "formats.h"
  36 #include "internal.h"
  37
  38 typedef struct ResampleContext {
  39     const AVClass *class;
  40     AVAudioResampleContext *avr;
  41     AVDictionary *options;
  42
  43     int resampling;
  44     int64_t next_pts;
  45     int64_t next_in_pts;
  46
  47     /* set by filter_frame() to signal an output frame to request_frame() */
  48     int got_output;
  49 } ResampleContext;
  50
  51 static av_cold int init(AVFilterContext *ctx, AVDictionary **opts)
  52 {
  53     ResampleContext *s = ctx->priv;
  54     const AVClass *avr_class = avresample_get_class();
  55     AVDictionaryEntry *e = NULL;
  56
  57     while ((e = av_dict_get(*opts, "", e, AV_DICT_IGNORE_SUFFIX))) {
  58         if (av_opt_find(&avr_class, e->key, NULL, 0,
  59                         AV_OPT_SEARCH_FAKE_OBJ | AV_OPT_SEARCH_CHILDREN))
  60             av_dict_set(&s->options, e->key, e->value, 0);
  61     }
  62
  63     e = NULL;
  64     while ((e = av_dict_get(s->options, "", e, AV_DICT_IGNORE_SUFFIX)))
  65         av_dict_set(opts, e->key, NULL, 0);
  66
  67     /* do not allow the user to override basic format options */
  68     av_dict_set(&s->options,  "in_channel_layout", NULL, 0);
  69     av_dict_set(&s->options, "out_channel_layout", NULL, 0);
  70     av_dict_set(&s->options,  "in_sample_fmt",     NULL, 0);
  71     av_dict_set(&s->options, "out_sample_fmt",     NULL, 0);
  72     av_dict_set(&s->options,  "in_sample_rate",    NULL, 0);
  73     av_dict_set(&s->options, "out_sample_rate",    NULL, 0);
  74
  75     return 0;
  76 }
  77
  78 static av_cold void uninit(AVFilterContext *ctx)
  79 {
  80     ResampleContext *s = ctx->priv;
  81
  82     if (s->avr) {
  83         avresample_close(s->avr);
  84         avresample_free(&s->avr);
  85     }
  86     av_dict_free(&s->options);
  87 }
  88
  89 static int query_formats(AVFilterContext *ctx)
  90 {
  91     AVFilterLink *inlink  = ctx->inputs[0];
  92     AVFilterLink *outlink = ctx->outputs[0];
  93
  94     AVFilterFormats        *in_formats      = ff_all_formats(AVMEDIA_TYPE_AUDIO);
  95     AVFilterFormats        *out_formats     = ff_all_formats(AVMEDIA_TYPE_AUDIO);
  96     AVFilterFormats        *in_samplerates  = ff_all_samplerates();
  97     AVFilterFormats        *out_samplerates = ff_all_samplerates();
  98     AVFilterChannelLayouts *in_layouts      = ff_all_channel_layouts();
  99     AVFilterChannelLayouts *out_layouts     = ff_all_channel_layouts();
 100
 101     ff_formats_ref(in_formats,  &inlink->out_formats);
 102     ff_formats_ref(out_formats, &outlink->in_formats);
 103
 104     ff_formats_ref(in_samplerates,  &inlink->out_samplerates);
 105     ff_formats_ref(out_samplerates, &outlink->in_samplerates);
 106
 107     ff_channel_layouts_ref(in_layouts,  &inlink->out_channel_layouts);
 108     ff_channel_layouts_ref(out_layouts, &outlink->in_channel_layouts);
 109
 110     return 0;
 111 }
 112
 113 static int config_output(AVFilterLink *outlink)
 114 {
 115     AVFilterContext *ctx = outlink->src;
 116     AVFilterLink *inlink = ctx->inputs[0];
 117     ResampleContext   *s = ctx->priv;
 118     char buf1[64], buf2[64];
 119     int ret;
 120
 121     int64_t resampling_forced;
 122
 123     if (s->avr) {
 124         avresample_close(s->avr);
 125         avresample_free(&s->avr);
 126     }
 127
 128     if (inlink->channel_layout == outlink->channel_layout &&
 129         inlink->sample_rate    == outlink->sample_rate    &&
 130         (inlink->format        == outlink->format ||
 131         (av_get_channel_layout_nb_channels(inlink->channel_layout)  == 1 &&
 132          av_get_channel_layout_nb_channels(outlink->channel_layout) == 1 &&
 133          av_get_planar_sample_fmt(inlink->format) ==
 134          av_get_planar_sample_fmt(outlink->format))))
 135         return 0;
 136
 137     if (!(s->avr = avresample_alloc_context()))
 138         return AVERROR(ENOMEM);
 139
 140     if (s->options) {
 141         int ret;
 142         AVDictionaryEntry *e = NULL;
 143         while ((e = av_dict_get(s->options, "", e, AV_DICT_IGNORE_SUFFIX)))
 144             av_log(ctx, AV_LOG_VERBOSE, "lavr option: %s=%s\n", e->key, e->value);
 145
 146         ret = av_opt_set_dict(s->avr, &s->options);
 147         if (ret < 0)
 148             return ret;
 149     }
 150
 151     av_opt_set_int(s->avr,  "in_channel_layout", inlink ->channel_layout, 0);
 152     av_opt_set_int(s->avr, "out_channel_layout", outlink->channel_layout, 0);
 153     av_opt_set_int(s->avr,  "in_sample_fmt",     inlink ->format,         0);
 154     av_opt_set_int(s->avr, "out_sample_fmt",     outlink->format,         0);
 155     av_opt_set_int(s->avr,  "in_sample_rate",    inlink ->sample_rate,    0);
 156     av_opt_set_int(s->avr, "out_sample_rate",    outlink->sample_rate,    0);
 157
 158     if ((ret = avresample_open(s->avr)) < 0)
 159         return ret;
 160
 161     av_opt_get_int(s->avr, "force_resampling", 0, &resampling_forced);
 162     s->resampling = resampling_forced || (inlink->sample_rate != outlink->sample_rate);
 163
 164     if (s->resampling) {
 165         outlink->time_base = (AVRational){ 1, outlink->sample_rate };
 166         s->next_pts        = AV_NOPTS_VALUE;
 167         s->next_in_pts     = AV_NOPTS_VALUE;
 168     } else
 169         outlink->time_base = inlink->time_base;
 170
 171     av_get_channel_layout_string(buf1, sizeof(buf1),
 172                                  -1, inlink ->channel_layout);
 173     av_get_channel_layout_string(buf2, sizeof(buf2),
 174                                  -1, outlink->channel_layout);
 175     av_log(ctx, AV_LOG_VERBOSE,
 176            "fmt:%s srate:%d cl:%s -> fmt:%s srate:%d cl:%s\n",
 177            av_get_sample_fmt_name(inlink ->format), inlink ->sample_rate, buf1,
 178            av_get_sample_fmt_name(outlink->format), outlink->sample_rate, buf2);
 179
 180     return 0;
 181 }
 182
 183 static int request_frame(AVFilterLink *outlink)
 184 {
 185     AVFilterContext *ctx = outlink->src;
 186     ResampleContext   *s = ctx->priv;
 187     int ret = 0;
 188
 189     s->got_output = 0;
 190     while (ret >= 0 && !s->got_output)
 191         ret = ff_request_frame(ctx->inputs[0]);
 192
 193     /* flush the lavr delay buffer */
 194     if (ret == AVERROR_EOF && s->avr) {
 195         AVFrame *frame;
 196         int nb_samples = avresample_get_out_samples(s->avr, 0);
 197
 198         if (!nb_samples)
 199             return ret;
 200
 201         frame = ff_get_audio_buffer(outlink, nb_samples);
 202         if (!frame)
 203             return AVERROR(ENOMEM);
 204
 205         ret = avresample_convert(s->avr, frame->extended_data,
 206                                  frame->linesize[0], nb_samples,
 207                                  NULL, 0, 0);
 208         if (ret <= 0) {
 209             av_frame_free(&frame);
 210             return (ret == 0) ? AVERROR_EOF : ret;
 211         }
 212
 213         frame->nb_samples = ret;
 214         frame->pts = s->next_pts;
 215         return ff_filter_frame(outlink, frame);
 216     }
 217     return ret;
 218 }
 219
 220 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 221 {
 222     AVFilterContext  *ctx = inlink->dst;
 223     ResampleContext    *s = ctx->priv;
 224     AVFilterLink *outlink = ctx->outputs[0];
 225     int ret;
 226
 227     if (s->avr) {
 228         AVFrame *out;
 229         int delay, nb_samples;
 230
 231         /* maximum possible samples lavr can output */
 232         delay      = avresample_get_delay(s->avr);
 233         nb_samples = avresample_get_out_samples(s->avr, in->nb_samples);
 234
 235         out = ff_get_audio_buffer(outlink, nb_samples);
 236         if (!out) {
 237             ret = AVERROR(ENOMEM);
 238             goto fail;
 239         }
 240
 241         ret = avresample_convert(s->avr, out->extended_data, out->linesize[0],
 242                                  nb_samples, in->extended_data, in->linesize[0],
 243                                  in->nb_samples);
 244         if (ret <= 0) {
 245             av_frame_free(&out);
 246             if (ret < 0)
 247                 goto fail;
 248         }
 249
 250         av_assert0(!avresample_available(s->avr));
 251
 252         if (s->resampling && s->next_pts == AV_NOPTS_VALUE) {
 253             if (in->pts == AV_NOPTS_VALUE) {
 254                 av_log(ctx, AV_LOG_WARNING, "First timestamp is missing, "
 255                        "assuming 0.\n");
 256                 s->next_pts = 0;
 257             } else
 258                 s->next_pts = av_rescale_q(in->pts, inlink->time_base,
 259                                            outlink->time_base);
 260         }
 261
 262         if (ret > 0) {
 263             out->nb_samples = ret;
 264
 265             ret = av_frame_copy_props(out, in);
 266             if (ret < 0) {
 267                 av_frame_free(&out);
 268                 goto fail;
 269             }
 270
 271             if (s->resampling) {
 272                 out->sample_rate = outlink->sample_rate;
 273                 /* Only convert in->pts if there is a discontinuous jump.
 274                    This ensures that out->pts tracks the number of samples actually
 275                    output by the resampler in the absence of such a jump.
 276                    Otherwise, the rounding in av_rescale_q() and av_rescale()
 277                    causes off-by-1 errors. */
 278                 if (in->pts != AV_NOPTS_VALUE && in->pts != s->next_in_pts) {
 279                     out->pts = av_rescale_q(in->pts, inlink->time_base,
 280                                                 outlink->time_base) -
 281                                    av_rescale(delay, outlink->sample_rate,
 282                                               inlink->sample_rate);
 283                 } else
 284                     out->pts = s->next_pts;
 285
 286                 s->next_pts = out->pts + out->nb_samples;
 287                 s->next_in_pts = in->pts + in->nb_samples;
 288             } else
 289                 out->pts = in->pts;
 290
 291             ret = ff_filter_frame(outlink, out);
 292             s->got_output = 1;
 293         }
 294
 295 fail:
 296         av_frame_free(&in);
 297     } else {
 298         in->format = outlink->format;
 299         ret = ff_filter_frame(outlink, in);
 300         s->got_output = 1;
 301     }
 302
 303     return ret;
 304 }
 305
 306 static const AVClass *resample_child_class_next(const AVClass *prev)
 307 {
 308     return prev ? NULL : avresample_get_class();
 309 }
 310
 311 static void *resample_child_next(void *obj, void *prev)
 312 {
 313     ResampleContext *s = obj;
 314     return prev ? NULL : s->avr;
 315 }
 316
 317 static const AVClass resample_class = {
 318     .class_name       = "resample",
 319     .item_name        = av_default_item_name,
 320     .version          = LIBAVUTIL_VERSION_INT,
 321     .child_class_next = resample_child_class_next,
 322     .child_next       = resample_child_next,
 323 };
 324
 325 static const AVFilterPad avfilter_af_resample_inputs[] = {
 326     {
 327         .name          = "default",
 328         .type          = AVMEDIA_TYPE_AUDIO,
 329         .filter_frame  = filter_frame,
 330     },
 331     { NULL }
 332 };
 333
 334 static const AVFilterPad avfilter_af_resample_outputs[] = {
 335     {
 336         .name          = "default",
 337         .type          = AVMEDIA_TYPE_AUDIO,
 338         .config_props  = config_output,
 339         .request_frame = request_frame
 340     },
 341     { NULL }
 342 };
 343
 344 AVFilter ff_af_resample = {
 345     .name          = "resample",
 346     .description   = NULL_IF_CONFIG_SMALL("Audio resampling and conversion."),
 347     .priv_size     = sizeof(ResampleContext),
 348     .priv_class    = &resample_class,
 349     .init_dict     = init,
 350     .uninit        = uninit,
 351     .query_formats = query_formats,
 352     .inputs        = avfilter_af_resample_inputs,
 353     .outputs       = avfilter_af_resample_outputs,
 354 };