Add normalization gain factor to Export Analysis
[ardour.git] / libs / audiographer / src / general / analyser.cc
1 /*
2  * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program 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
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17  */
18
19 #include "audiographer/general/analyser.h"
20 #include "pbd/fastlog.h"
21
22 using namespace AudioGrapher;
23
24 const float Analyser::fft_range_db (80); // dB
25
26 Analyser::Analyser (float sample_rate, unsigned int channels, framecnt_t bufsize, framecnt_t n_samples)
27         : _ebur128_plugin (0)
28         , _dbtp_plugin (0)
29         , _sample_rate (sample_rate)
30         , _channels (channels)
31         , _bufsize (bufsize / channels)
32         , _n_samples (n_samples)
33         , _pos (0)
34 {
35         assert (bufsize % channels == 0);
36         assert (bufsize > 1);
37         //printf ("NEW ANALYSER %p r:%.1f c:%d f:%ld l%ld\n", this, sample_rate, channels, bufsize, n_samples);
38         if (channels > 0 && channels <= 2) {
39                 using namespace Vamp::HostExt;
40                 PluginLoader* loader (PluginLoader::getInstance ());
41                 _ebur128_plugin = loader->loadPlugin ("libardourvampplugins:ebur128", sample_rate, PluginLoader::ADAPT_ALL_SAFE);
42                 assert (_ebur128_plugin);
43                 _ebur128_plugin->reset ();
44                 if (!_ebur128_plugin->initialise (channels, _bufsize, _bufsize)) {
45                         printf ("FAILED TO INITIALIZE EBUR128\n");
46                         delete _ebur128_plugin;
47                         _ebur128_plugin = 0;
48                 }
49         }
50
51         _dbtp_plugin = (Vamp::Plugin**) malloc (sizeof(Vamp::Plugin*) * channels);
52         for (unsigned int c = 0; c < _channels; ++c) {
53                 using namespace Vamp::HostExt;
54                 PluginLoader* loader (PluginLoader::getInstance ());
55                 _dbtp_plugin[c] = loader->loadPlugin ("libardourvampplugins:dBTP", sample_rate, PluginLoader::ADAPT_ALL_SAFE);
56                 assert (_dbtp_plugin[c]);
57                 _dbtp_plugin[c]->reset ();
58                 if (!_dbtp_plugin[c]->initialise (1, _bufsize, _bufsize)) {
59                         printf ("FAILED TO INITIALIZE DBTP %d\n", c);
60                         delete _dbtp_plugin[c];
61                         _dbtp_plugin[c] = 0;
62                 }
63         }
64
65         _bufs[0] = (float*) malloc (sizeof (float) * _bufsize);
66         _bufs[1] = (float*) malloc (sizeof (float) * _bufsize);
67
68         const size_t peaks = sizeof (_result.peaks) / sizeof (ARDOUR::PeakData::PeakDatum) / 4;
69         _spp = ceil ((_n_samples + 1.f) / (float) peaks);
70
71         const size_t swh = sizeof (_result.spectrum) / sizeof (float);
72         const size_t height = sizeof (_result.spectrum[0]) / sizeof (float);
73         const size_t width = swh / height;
74         _fpp = ceil ((_n_samples + 1.f) / (float) width);
75
76         _fft_data_size   = _bufsize / 2;
77         _fft_freq_per_bin = sample_rate / _fft_data_size / 2.f;
78
79         _fft_data_in  = (float *) fftwf_malloc (sizeof (float) * _bufsize);
80         _fft_data_out = (float *) fftwf_malloc (sizeof (float) * _bufsize);
81         _fft_power    = (float *) malloc (sizeof (float) * _fft_data_size);
82
83         for (uint32_t i = 0; i < _fft_data_size; ++i) {
84                 _fft_power[i] = 0;
85         }
86         for (uint32_t i = 0; i < _bufsize; ++i) {
87                 _fft_data_out[i] = 0;
88         }
89
90         const float nyquist = (sample_rate * .5);
91 #if 0 // linear
92 #define YPOS(FREQ) rint (height * (1.0 - FREQ / nyquist))
93 #else
94 #define YPOS(FREQ) rint (height * (1 - logf (1.f + .1f * _fft_data_size * FREQ / nyquist) / logf (1.f + .1f * _fft_data_size)))
95 #endif
96
97         _result.freq[0] = YPOS (50);
98         _result.freq[1] = YPOS (100);
99         _result.freq[2] = YPOS (500);
100         _result.freq[3] = YPOS (1000);
101         _result.freq[4] = YPOS (5000);
102         _result.freq[5] = YPOS (10000);
103
104         _fft_plan = fftwf_plan_r2r_1d (_bufsize, _fft_data_in, _fft_data_out, FFTW_R2HC, FFTW_MEASURE);
105
106         _hann_window = (float *) malloc (sizeof (float) * _bufsize);
107         double sum = 0.0;
108
109         for (uint32_t i = 0; i < _bufsize; ++i) {
110                 _hann_window[i] = 0.5f - (0.5f * (float) cos (2.0f * M_PI * (float)i / (float)(_bufsize)));
111                 sum += _hann_window[i];
112         }
113         const double isum = 2.0 / sum;
114         for (uint32_t i = 0; i < _bufsize; ++i) {
115                 _hann_window[i] *= isum;
116         }
117
118         if (channels == 2) {
119                 _result.n_channels = 2;
120         } else {
121                 _result.n_channels = 1;
122         }
123 }
124
125 Analyser::~Analyser ()
126 {
127         delete _ebur128_plugin;
128         for (unsigned int c = 0; c < _channels; ++c) {
129                 delete _dbtp_plugin[c];
130         }
131         free (_dbtp_plugin);
132         free (_bufs[0]);
133         free (_bufs[1]);
134         fftwf_destroy_plan (_fft_plan);
135         fftwf_free (_fft_data_in);
136         fftwf_free (_fft_data_out);
137         free (_fft_power);
138         free (_hann_window);
139 }
140
141 void
142 Analyser::process (ProcessContext<float> const & c)
143 {
144         framecnt_t n_samples = c.frames () / c.channels ();
145         assert (c.frames () % c.channels () == 0);
146         assert (n_samples <= _bufsize);
147         //printf ("PROC %p @%ld F: %ld, S: %ld C:%d\n", this, _pos, c.frames (), n_samples, c.channels ());
148         float const * d = c.data ();
149         framecnt_t s;
150         const unsigned cmask = _result.n_channels - 1; // [0, 1]
151         for (s = 0; s < n_samples; ++s) {
152                 _fft_data_in[s] = 0;
153                 const framecnt_t pk = (_pos + s) / _spp;
154                 for (unsigned int c = 0; c < _channels; ++c) {
155                         const float v = *d;
156                         if (fabsf(v) > _result.peak) { _result.peak = fabsf(v); }
157                         _bufs[c][s] = v;
158                         const unsigned int cc = c & cmask;
159                         if (_result.peaks[cc][pk].min > v) { _result.peaks[cc][pk].min = *d; }
160                         if (_result.peaks[cc][pk].max < v) { _result.peaks[cc][pk].max = *d; }
161                         _fft_data_in[s] += v * _hann_window[s] / (float) _channels;
162                         ++d;
163                 }
164         }
165
166         for (; s < _bufsize; ++s) {
167                 _fft_data_in[s] = 0;
168                 for (unsigned int c = 0; c < _channels; ++c) {
169                         _bufs[c][s] = 0.f;
170                 }
171         }
172
173         if (_ebur128_plugin) {
174                 _ebur128_plugin->process (_bufs, Vamp::RealTime::fromSeconds ((double) _pos / _sample_rate));
175         }
176
177         float const * const data = c.data ();
178         for (unsigned int c = 0; c < _channels; ++c) {
179                 if (!_dbtp_plugin[c]) { continue; }
180                 for (s = 0; s < n_samples; ++s) {
181                         _bufs[0][s] = data[s * _channels + c];
182                 }
183                 _dbtp_plugin[c]->process (_bufs, Vamp::RealTime::fromSeconds ((double) _pos / _sample_rate));
184         }
185
186         fftwf_execute (_fft_plan);
187
188         _fft_power[0] = _fft_data_out[0] * _fft_data_out[0];
189 #define FRe (_fft_data_out[i])
190 #define FIm (_fft_data_out[_bufsize - i])
191         for (uint32_t i = 1; i < _fft_data_size - 1; ++i) {
192                 _fft_power[i] = (FRe * FRe) + (FIm * FIm);
193         }
194 #undef FRe
195 #undef FIm
196
197         const size_t height = sizeof (_result.spectrum[0]) / sizeof (float);
198         const framecnt_t x0 = _pos / _fpp;
199         framecnt_t x1 = (_pos + n_samples) / _fpp;
200         if (x0 == x1) x1 = x0 + 1;
201
202         for (uint32_t i = 0; i < _fft_data_size - 1; ++i) {
203                 const float level = fft_power_at_bin (i, i);
204                 if (level < -fft_range_db) continue;
205                 const float pk = level > 0.0 ? 1.0 : (fft_range_db + level) / fft_range_db;
206 #if 0 // linear
207                 const uint32_t y0 = floor (i * (float) height / _fft_data_size);
208                 uint32_t y1 = ceil ((i + 1.0) * (float) height / _fft_data_size);
209 #else // logscale
210                 const uint32_t y0 = floor (height * logf (1.f + .1f * i) / logf (1.f + .1f * _fft_data_size));
211                 uint32_t y1 = ceilf (height * logf (1.f + .1f * (i + 1.f)) / logf (1.f + .1f * _fft_data_size));
212 #endif
213                 assert (y0 < height);
214                 assert (y1 > 0 && y1 <= height);
215                 if (y0 == y1) y1 = y0 + 1;
216                 for (int x = x0; x < x1; ++x) {
217                         for (uint32_t y = y0; y < y1 && y < height; ++y) {
218                                 uint32_t yy = height - 1 - y;
219                                 if (_result.spectrum[x][yy] < pk) { _result.spectrum[x][yy] = pk; }
220                         }
221                 }
222         }
223
224         _pos += n_samples;
225
226         /* pass audio audio through */
227         ListedSource<float>::output (c);
228 }
229
230 ARDOUR::ExportAnalysisPtr
231 Analyser::result ()
232 {
233         //printf ("PROCESSED %ld / %ld samples\n", _pos, _n_samples);
234         if (_pos == 0) {
235                 return ARDOUR::ExportAnalysisPtr ();
236         }
237         if (_ebur128_plugin) {
238                 Vamp::Plugin::FeatureSet features = _ebur128_plugin->getRemainingFeatures ();
239                 if (!features.empty () && features.size () == 3) {
240                         _result.loudness = features[0][0].values[0];
241                         _result.loudness_range = features[1][0].values[0];
242                         assert (features[2][0].values.size () == 540);
243                         for (int i = 0; i < 540; ++i) {
244                                 _result.loudness_hist[i] = features[2][0].values[i];
245                                 if (_result.loudness_hist[i] > _result.loudness_hist_max) {
246                                         _result.loudness_hist_max = _result.loudness_hist[i]; }
247                         }
248                         _result.have_loudness = true;
249                 }
250         }
251
252         const unsigned cmask = _result.n_channels - 1; // [0, 1]
253         for (unsigned int c = 0; c < _channels; ++c) {
254                 if (!_dbtp_plugin[c]) { continue; }
255                 Vamp::Plugin::FeatureSet features = _dbtp_plugin[c]->getRemainingFeatures ();
256                 if (!features.empty () && features.size () == 2) {
257                         _result.have_dbtp = true;
258                         float p = features[0][0].values[0];
259                         if (p > _result.truepeak) { _result.truepeak = p; }
260
261                         for (std::vector<float>::const_iterator i = features[1][0].values.begin();
262                                         i != features[1][0].values.end(); ++i) {
263                                 const framecnt_t pk = (*i) / _spp;
264                                 const unsigned int cc = c & cmask;
265                                 _result.truepeakpos[cc].insert (pk);
266                         }
267                 }
268         }
269
270         return ARDOUR::ExportAnalysisPtr (new ARDOUR::ExportAnalysis (_result));
271 }
272
273 float
274 Analyser::fft_power_at_bin (const uint32_t b, const float norm) const
275 {
276         const float a = _fft_power[b] * norm;
277         return a > 1e-12 ? 10.0 * fast_log10 (a) : -INFINITY;
278 }