src/lib/analyse_audio_job.cc

   1 /*
   2     Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "audio_analysis.h"
  22 #include "audio_buffers.h"
  23 #include "analyse_audio_job.h"
  24 #include "audio_content.h"
  25 #include "compose.hpp"
  26 #include "film.h"
  27 #include "player.h"
  28 #include "playlist.h"
  29 #include "filter.h"
  30 #include "audio_filter_graph.h"
  31 #include "config.h"
  32 extern "C" {
  33 #include <libavutil/channel_layout.h>
  34 #ifdef DCPOMATIC_HAVE_EBUR128_PATCHED_FFMPEG
  35 #include <libavfilter/f_ebur128.h>
  36 #endif
  37 }
  38 #include <boost/foreach.hpp>
  39 #include <iostream>
  40
  41 #include "i18n.h"
  42
  43 using std::string;
  44 using std::vector;
  45 using std::max;
  46 using std::min;
  47 using std::cout;
  48 using boost::shared_ptr;
  49 using boost::dynamic_pointer_cast;
  50
  51 int const AnalyseAudioJob::_num_points = 1024;
  52
  53 /** @param from_zero true to analyse audio from time 0 in the playlist, otherwise begin at Playlist::start */
  54 AnalyseAudioJob::AnalyseAudioJob (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist, bool from_zero)
  55         : Job (film)
  56         , _playlist (playlist)
  57         , _from_zero (from_zero)
  58         , _done (0)
  59         , _samples_per_point (1)
  60         , _current (0)
  61         , _sample_peak (new float[film->audio_channels()])
  62         , _sample_peak_frame (new Frame[film->audio_channels()])
  63 #ifdef DCPOMATIC_HAVE_EBUR128_PATCHED_FFMPEG
  64         , _ebur128 (new AudioFilterGraph (film->audio_frame_rate(), film->audio_channels()))
  65 #endif
  66 {
  67 #ifdef DCPOMATIC_HAVE_EBUR128_PATCHED_FFMPEG
  68         _filters.push_back (new Filter ("ebur128", "ebur128", "audio", "ebur128=peak=true"));
  69         _ebur128->setup (_filters);
  70 #endif
  71
  72         for (int i = 0; i < film->audio_channels(); ++i) {
  73                 _sample_peak[i] = 0;
  74                 _sample_peak_frame[i] = 0;
  75         }
  76
  77         if (!_from_zero) {
  78                 _start = _playlist->start().get_value_or(DCPTime());
  79         }
  80 }
  81
  82 AnalyseAudioJob::~AnalyseAudioJob ()
  83 {
  84         BOOST_FOREACH (Filter const * i, _filters) {
  85                 delete const_cast<Filter*> (i);
  86         }
  87         delete[] _current;
  88         delete[] _sample_peak;
  89         delete[] _sample_peak_frame;
  90 }
  91
  92 string
  93 AnalyseAudioJob::name () const
  94 {
  95         return _("Analyse audio");
  96 }
  97
  98 string
  99 AnalyseAudioJob::json_name () const
 100 {
 101         return N_("analyse_audio");
 102 }
 103
 104 void
 105 AnalyseAudioJob::run ()
 106 {
 107         shared_ptr<Player> player (new Player (_film, _playlist));
 108         player->set_ignore_video ();
 109         player->set_ignore_text ();
 110         player->set_fast ();
 111         player->set_play_referenced ();
 112         player->Audio.connect (bind (&AnalyseAudioJob::analyse, this, _1, _2));
 113
 114         DCPTime const length = _playlist->length ();
 115
 116         Frame const len = DCPTime (length - _start).frames_round (_film->audio_frame_rate());
 117         _samples_per_point = max (int64_t (1), len / _num_points);
 118
 119         delete[] _current;
 120         _current = new AudioPoint[_film->audio_channels ()];
 121         _analysis.reset (new AudioAnalysis (_film->audio_channels ()));
 122
 123         bool has_any_audio = false;
 124         BOOST_FOREACH (shared_ptr<Content> c, _playlist->content ()) {
 125                 if (c->audio) {
 126                         has_any_audio = true;
 127                 }
 128         }
 129
 130         if (has_any_audio) {
 131                 player->seek (_start, true);
 132                 _done = 0;
 133                 while (!player->pass ()) {}
 134         }
 135
 136         vector<AudioAnalysis::PeakTime> sample_peak;
 137         for (int i = 0; i < _film->audio_channels(); ++i) {
 138                 sample_peak.push_back (
 139                         AudioAnalysis::PeakTime (_sample_peak[i], DCPTime::from_frames (_sample_peak_frame[i], _film->audio_frame_rate ()))
 140                         );
 141         }
 142         _analysis->set_sample_peak (sample_peak);
 143
 144 #ifdef DCPOMATIC_HAVE_EBUR128_PATCHED_FFMPEG
 145         if (Config::instance()->analyse_ebur128 ()) {
 146                 void* eb = _ebur128->get("Parsed_ebur128_0")->priv;
 147                 vector<float> true_peak;
 148                 for (int i = 0; i < _film->audio_channels(); ++i) {
 149                         true_peak.push_back (av_ebur128_get_true_peaks(eb)[i]);
 150                 }
 151                 _analysis->set_true_peak (true_peak);
 152                 _analysis->set_integrated_loudness (av_ebur128_get_integrated_loudness(eb));
 153                 _analysis->set_loudness_range (av_ebur128_get_loudness_range(eb));
 154         }
 155 #endif
 156
 157         if (_playlist->content().size() == 1) {
 158                 /* If there was only one piece of content in this analysis we may later need to know what its
 159                    gain was when we analysed it.
 160                 */
 161                 shared_ptr<const AudioContent> ac = _playlist->content().front()->audio;
 162                 if (ac) {
 163                         _analysis->set_analysis_gain (ac->gain());
 164                 }
 165         }
 166
 167         _analysis->set_samples_per_point (_samples_per_point);
 168         _analysis->set_sample_rate (_film->audio_frame_rate ());
 169         _analysis->write (_film->audio_analysis_path (_playlist));
 170
 171         set_progress (1);
 172         set_state (FINISHED_OK);
 173 }
 174
 175 void
 176 AnalyseAudioJob::analyse (shared_ptr<const AudioBuffers> b, DCPTime time)
 177 {
 178         DCPOMATIC_ASSERT (time >= _start);
 179
 180 #ifdef DCPOMATIC_HAVE_EBUR128_PATCHED_FFMPEG
 181         if (Config::instance()->analyse_ebur128 ()) {
 182                 _ebur128->process (b);
 183         }
 184 #endif
 185
 186         int const frames = b->frames ();
 187         int const channels = b->channels ();
 188
 189         for (int j = 0; j < channels; ++j) {
 190                 float* data = b->data(j);
 191                 for (int i = 0; i < frames; ++i) {
 192                         float s = data[i];
 193                         float as = fabsf (s);
 194                         if (as < 10e-7) {
 195                                 /* We may struggle to serialise and recover inf or -inf, so prevent such
 196                                    values by replacing with this (140dB down) */
 197                                 s = as = 10e-7;
 198                         }
 199                         _current[j][AudioPoint::RMS] += pow (s, 2);
 200                         _current[j][AudioPoint::PEAK] = max (_current[j][AudioPoint::PEAK], as);
 201
 202                         if (as > _sample_peak[j]) {
 203                                 _sample_peak[j] = as;
 204                                 _sample_peak_frame[j] = _done + i;
 205                         }
 206
 207                         if (((_done + i) % _samples_per_point) == 0) {
 208                                 _current[j][AudioPoint::RMS] = sqrt (_current[j][AudioPoint::RMS] / _samples_per_point);
 209                                 _analysis->add_point (j, _current[j]);
 210                                 _current[j] = AudioPoint ();
 211                         }
 212                 }
 213         }
 214
 215         _done += frames;
 216
 217         DCPTime const length = _playlist->length ();
 218         set_progress ((time.seconds() - _start.seconds()) / (length.seconds() - _start.seconds()));
 219 }