Fix uninitialised variables causing random audio analysis peak values.
[dcpomatic.git] / src / lib / analyse_audio_job.cc
1 /*
2     Copyright (C) 2012-2015 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 AnalyseAudioJob::AnalyseAudioJob (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist)
54         : Job (film)
55         , _playlist (playlist)
56         , _done (0)
57         , _samples_per_point (1)
58         , _current (0)
59         , _sample_peak (new float[film->audio_channels()])
60         , _sample_peak_frame (new Frame[film->audio_channels()])
61 #ifdef DCPOMATIC_HAVE_EBUR128_PATCHED_FFMPEG
62         , _ebur128 (new AudioFilterGraph (film->audio_frame_rate(), film->audio_channels()))
63 #endif
64 {
65 #ifdef DCPOMATIC_HAVE_EBUR128_PATCHED_FFMPEG
66         _filters.push_back (new Filter ("ebur128", "ebur128", "audio", "ebur128=peak=true"));
67         _ebur128->setup (_filters);
68 #endif
69
70         for (int i = 0; i < film->audio_channels(); ++i) {
71                 _sample_peak[i] = 0;
72                 _sample_peak_frame[i] = 0;
73         }
74 }
75
76 AnalyseAudioJob::~AnalyseAudioJob ()
77 {
78         BOOST_FOREACH (Filter const * i, _filters) {
79                 delete const_cast<Filter*> (i);
80         }
81         delete[] _current;
82         delete[] _sample_peak;
83         delete[] _sample_peak_frame;
84 }
85
86 string
87 AnalyseAudioJob::name () const
88 {
89         return _("Analyse audio");
90 }
91
92 string
93 AnalyseAudioJob::json_name () const
94 {
95         return N_("analyse_audio");
96 }
97
98 void
99 AnalyseAudioJob::run ()
100 {
101         shared_ptr<Player> player (new Player (_film, _playlist));
102         player->set_ignore_video ();
103         player->set_fast ();
104         player->set_play_referenced ();
105
106         DCPTime const start = _playlist->start().get_value_or (DCPTime ());
107         DCPTime const length = _playlist->length ();
108
109         Frame const len = DCPTime (length - start).frames_round (_film->audio_frame_rate());
110         _samples_per_point = max (int64_t (1), len / _num_points);
111
112         delete[] _current;
113         _current = new AudioPoint[_film->audio_channels ()];
114         _analysis.reset (new AudioAnalysis (_film->audio_channels ()));
115
116         bool has_any_audio = false;
117         BOOST_FOREACH (shared_ptr<Content> c, _playlist->content ()) {
118                 if (c->audio) {
119                         has_any_audio = true;
120                 }
121         }
122
123         if (has_any_audio) {
124                 _done = 0;
125                 DCPTime const block = DCPTime::from_seconds (1.0 / 8);
126                 for (DCPTime t = start; t < length; t += block) {
127                         shared_ptr<const AudioBuffers> audio = player->get_audio (t, block, false);
128 #ifdef DCPOMATIC_HAVE_EBUR128_PATCHED_FFMPEG
129                         if (Config::instance()->analyse_ebur128 ()) {
130                                 _ebur128->process (audio);
131                         }
132 #endif
133                         analyse (audio);
134                         set_progress ((t.seconds() - start.seconds()) / (length.seconds() - start.seconds()));
135                 }
136         }
137
138         vector<AudioAnalysis::PeakTime> sample_peak;
139         for (int i = 0; i < _film->audio_channels(); ++i) {
140                 sample_peak.push_back (
141                         AudioAnalysis::PeakTime (_sample_peak[i], DCPTime::from_frames (_sample_peak_frame[i], _film->audio_frame_rate ()))
142                         );
143         }
144         _analysis->set_sample_peak (sample_peak);
145
146 #ifdef DCPOMATIC_HAVE_EBUR128_PATCHED_FFMPEG
147         if (Config::instance()->analyse_ebur128 ()) {
148                 void* eb = _ebur128->get("Parsed_ebur128_0")->priv;
149                 vector<float> true_peak;
150                 for (int i = 0; i < _film->audio_channels(); ++i) {
151                         true_peak.push_back (av_ebur128_get_true_peaks(eb)[i]);
152                 }
153                 _analysis->set_true_peak (true_peak);
154                 _analysis->set_integrated_loudness (av_ebur128_get_integrated_loudness(eb));
155                 _analysis->set_loudness_range (av_ebur128_get_loudness_range(eb));
156         }
157 #endif
158
159         if (_playlist->content().size() == 1) {
160                 /* If there was only one piece of content in this analysis we may later need to know what its
161                    gain was when we analysed it.
162                 */
163                 shared_ptr<const AudioContent> ac = _playlist->content().front()->audio;
164                 DCPOMATIC_ASSERT (ac);
165                 _analysis->set_analysis_gain (ac->gain ());
166         }
167
168         _analysis->write (_film->audio_analysis_path (_playlist));
169
170         set_progress (1);
171         set_state (FINISHED_OK);
172 }
173
174 void
175 AnalyseAudioJob::analyse (shared_ptr<const AudioBuffers> b)
176 {
177         int const frames = b->frames ();
178         int const channels = b->channels ();
179
180         for (int j = 0; j < channels; ++j) {
181                 float* data = b->data(j);
182                 for (int i = 0; i < frames; ++i) {
183                         float s = data[i];
184                         float as = fabsf (s);
185                         if (as < 10e-7) {
186                                 /* We may struggle to serialise and recover inf or -inf, so prevent such
187                                    values by replacing with this (140dB down) */
188                                 s = as = 10e-7;
189                         }
190                         _current[j][AudioPoint::RMS] += pow (s, 2);
191                         _current[j][AudioPoint::PEAK] = max (_current[j][AudioPoint::PEAK], as);
192
193                         if (as > _sample_peak[j]) {
194                                 _sample_peak[j] = as;
195                                 _sample_peak_frame[j] = _done + i;
196                         }
197
198                         if (((_done + i) % _samples_per_point) == 0) {
199                                 _current[j][AudioPoint::RMS] = sqrt (_current[j][AudioPoint::RMS] / _samples_per_point);
200                                 _analysis->add_point (j, _current[j]);
201                                 _current[j] = AudioPoint ();
202                         }
203                 }
204         }
205
206         _done += frames;
207 }