git.sesse.net Git - nageru/blob - nageru/resampling_queue.h

   1 #ifndef _RESAMPLING_QUEUE_H
   2 #define _RESAMPLING_QUEUE_H 1
   3
   4 // Takes in samples from an input source, possibly with jitter, and outputs a fixed number
   5 // of samples every iteration. Used to a) change sample rates if needed, and b) deal with
   6 // input sources that don't have audio locked to video. For every input video
   7 // frame, you call add_input_samples() with the received time point of the video frame,
   8 // taken to be the _end_ point of the frame's audio. When you want to _output_ a finished
   9 // frame with audio, you get_output_samples() with the number of samples you want, and will
  10 // get exactly that number of samples back. If the input and output clocks are not in sync,
  11 // the audio will be stretched for you. (If they are _very_ out of sync, this will come through
  12 // as a pitch shift.) Of course, the process introduces some delay; you specify a target delay
  13 // (typically measured in milliseconds, although more is fine) and the algorithm works to
  14 // provide exactly that.
  15 //
  16 // A/V sync is a much harder problem than one would intuitively assume. This implementation
  17 // is based on a 2012 paper by Fons Adriaensen, “Controlling adaptive resampling”
  18 // (http://kokkinizita.linuxaudio.org/papers/adapt-resamp.pdf). The paper gives an algorithm
  19 // that converges to jitter of <100 ns; the basic idea is to measure the _rate_ the input
  20 // queue fills and is drained (as opposed to the length of the queue itself), and smoothly
  21 // adjust the resampling rate so that it reaches steady state at the desired delay.
  22 //
  23 // Parts of the code is adapted from Adriaensen's project Zita-ajbridge (based on the same
  24 // algorithm), although it has been heavily reworked for this use case. Original copyright follows:
  25 //
  26 //  Copyright (C) 2012-2015 Fons Adriaensen <fons@linuxaudio.org>
  27 //
  28 //  This program is free software; you can redistribute it and/or modify
  29 //  it under the terms of the GNU General Public License as published by
  30 //  the Free Software Foundation; either version 3 of the License, or
  31 //  (at your option) any later version.
  32 //
  33 //  This program is distributed in the hope that it will be useful,
  34 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  35 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  36 //  GNU General Public License for more details.
  37 //
  38 //  You should have received a copy of the GNU General Public License
  39 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  40
  41 #include <sys/types.h>
  42 #include <zita-resampler/vresampler.h>
  43 #include <chrono>
  44 #include <deque>
  45 #include <memory>
  46
  47 #include "defs.h"
  48 #include "input_mapping.h"
  49
  50 class ResamplingQueue {
  51 public:
  52         // device_spec is for debugging outputs only.
  53         ResamplingQueue(DeviceSpec device_spec, unsigned freq_in, unsigned freq_out, unsigned num_channels, double expected_delay_seconds);
  54
  55         // If policy is DO_NOT_ADJUST_RATE, the resampling rate will not be changed.
  56         // This is primarily useful if you have an extraordinary situation, such as
  57         // dropped frames.
  58         enum RateAdjustmentPolicy {
  59                 DO_NOT_ADJUST_RATE,
  60                 ADJUST_RATE
  61         };
  62
  63         void add_input_samples(std::chrono::steady_clock::time_point ts, const float *samples, ssize_t num_samples, RateAdjustmentPolicy rate_adjustment_policy);
  64         // Returns false if underrun.
  65         bool get_output_samples(std::chrono::steady_clock::time_point ts, float *samples, ssize_t num_samples, RateAdjustmentPolicy rate_adjustment_policy);
  66
  67 private:
  68         void init_loop_filter(double bandwidth_hz);
  69
  70         VResampler vresampler;
  71
  72         DeviceSpec device_spec;
  73         unsigned freq_in, freq_out, num_channels;
  74
  75         bool first_output = true;
  76
  77         struct InputPoint {
  78                 // Equivalent to t_a0 or t_a1 in the paper.
  79                 std::chrono::steady_clock::time_point ts;
  80
  81                 // Number of samples that have been written to the queue (in total)
  82                 // at this time point. Equivalent to k_a0 or k_a1 in the paper.
  83                 size_t input_samples_received = 0;
  84
  85                 // Set to false if we should not use the timestamp from this sample
  86                 // (e.g. if it is from a dropped frame and thus bad). In particular,
  87                 // we will not use it for updateing current_estimated_freq_in.
  88                 bool good_sample = false;
  89         };
  90         InputPoint a0, a1;
  91
  92         // The current rate at which we seem to get input samples, in Hz.
  93         // For an ideal input, identical to freq_in.
  94         double current_estimated_freq_in;
  95
  96         ssize_t total_consumed_samples = 0;
  97
  98         // Filter state for the loop filter.
  99         double z1 = 0.0, z2 = 0.0, z3 = 0.0;
 100
 101         // Ratio between the two frequencies.
 102         const double ratio;
 103
 104         // Current correction ratio. ratio * rcorr gives the true ratio,
 105         // so values above 1.0 means to pitch down (consume input samples slower).
 106         double rcorr = 1.0;
 107
 108         // How much delay we are expected to have, in input samples.
 109         // If actual delay drifts too much away from this, we will start
 110         // changing the resampling ratio to compensate.
 111         const double expected_delay;
 112
 113         // Input samples not yet fed into the resampler.
 114         // TODO: Use a circular buffer instead, for efficiency.
 115         std::deque<float> buffer;
 116 };
 117
 118 #endif  // !defined(_RESAMPLING_QUEUE_H)