2 Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 #include "audio_dialog.h"
22 #include "audio_plot.h"
24 #include "static_text.h"
25 #include "check_box.h"
26 #include "lib/audio_analysis.h"
28 #include "lib/analyse_audio_job.h"
29 #include "lib/audio_content.h"
30 #include "lib/job_manager.h"
31 #include <libxml++/libxml++.h>
32 #include <boost/filesystem.hpp>
33 #include <boost/foreach.hpp>
40 using boost::shared_ptr;
41 using boost::weak_ptr;
43 using boost::optional;
44 using boost::const_pointer_cast;
45 using boost::dynamic_pointer_cast;
46 using namespace dcpomatic;
48 /** @param parent Parent window.
49 * @param film Film we are using.
50 * @param content Content to analyse, or 0 to analyse all of the film's audio.
52 AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer, shared_ptr<Content> content)
60 /* I can't get wxFRAME_FLOAT_ON_PARENT to work on OS X, and although wxSTAY_ON_TOP keeps
61 the window above all others (and not just our own) it's better than nothing for now.
63 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxSTAY_ON_TOP
65 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxFRAME_FLOAT_ON_PARENT
71 , _channels (film->audio_channels ())
74 wxFont subheading_font (*wxNORMAL_FONT);
75 subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
77 wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
78 wxBoxSizer* lr_sizer = new wxBoxSizer (wxHORIZONTAL);
80 wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
82 _cursor = new StaticText (this, wxT("Cursor: none"));
83 left->Add (_cursor, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
84 _plot = new AudioPlot (this, viewer);
85 left->Add (_plot, 1, wxTOP | wxEXPAND, 12);
86 _sample_peak = new StaticText (this, wxT (""));
87 left->Add (_sample_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
88 _true_peak = new StaticText (this, wxT (""));
89 left->Add (_true_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
90 _integrated_loudness = new StaticText (this, wxT (""));
91 left->Add (_integrated_loudness, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
92 _loudness_range = new StaticText (this, wxT (""));
93 left->Add (_loudness_range, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
94 _leqm = new StaticText (this, wxT(""));
95 left->Add (_leqm, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
97 lr_sizer->Add (left, 1, wxALL | wxEXPAND, 12);
99 wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
102 wxStaticText* m = new StaticText (this, _("Channels"));
103 m->SetFont (subheading_font);
104 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM, 16);
107 for (int i = 0; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
108 _channel_checkbox[i] = new CheckBox (this, std_to_wx(audio_channel_name(i)));
109 _channel_checkbox[i]->SetForegroundColour(wxColour(_plot->colour(i)));
110 right->Add (_channel_checkbox[i], 0, wxEXPAND | wxALL, 3);
111 _channel_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::channel_clicked, this, _1));
115 wxStaticText* m = new StaticText (this, _("Type"));
116 m->SetFont (subheading_font);
117 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
120 wxString const types[] = {
125 for (int i = 0; i < AudioPoint::COUNT; ++i) {
126 _type_checkbox[i] = new CheckBox (this, types[i]);
127 right->Add (_type_checkbox[i], 0, wxEXPAND | wxALL, 3);
128 _type_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::type_clicked, this, _1));
132 wxStaticText* m = new StaticText (this, _("Smoothing"));
133 m->SetFont (subheading_font);
134 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
137 _smoothing = new wxSlider (this, wxID_ANY, AudioPlot::max_smoothing / 2, 1, AudioPlot::max_smoothing);
138 _smoothing->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&AudioDialog::smoothing_changed, this));
139 right->Add (_smoothing, 0, wxEXPAND);
141 lr_sizer->Add (right, 0, wxALL, 12);
143 overall_sizer->Add (lr_sizer, 0, wxEXPAND);
145 #ifdef DCPOMATIC_LINUX
146 wxSizer* buttons = CreateSeparatedButtonSizer (wxCLOSE);
148 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
152 SetSizer (overall_sizer);
153 overall_sizer->Layout ();
154 overall_sizer->SetSizeHints (this);
156 _film_connection = film->Change.connect (boost::bind(&AudioDialog::film_change, this, _1, _2));
157 _film_content_connection = film->ContentChange.connect (boost::bind (&AudioDialog::content_change, this, _1, _3));
158 DCPOMATIC_ASSERT (film->directory());
159 SetTitle(wxString::Format(_("DCP-o-matic audio - %s"), std_to_wx(film->directory().get().string())));
162 _playlist.reset (new Playlist ());
163 const_pointer_cast<Playlist>(_playlist)->add(film, content);
165 _playlist = film->playlist ();
168 _plot->Cursor.connect (bind (&AudioDialog::set_cursor, this, _1, _2));
172 AudioDialog::try_to_load_analysis ()
178 shared_ptr<const Film> film = _film.lock ();
179 DCPOMATIC_ASSERT (film);
181 shared_ptr<Content> check = _content.lock();
183 boost::filesystem::path const path = film->audio_analysis_path (_playlist);
184 if (!boost::filesystem::exists (path)) {
185 _plot->set_analysis (shared_ptr<AudioAnalysis> ());
188 BOOST_FOREACH (shared_ptr<Job> i, JobManager::instance()->get()) {
189 if (dynamic_pointer_cast<AnalyseAudioJob>(i)) {
194 JobManager::instance()->analyse_audio (
195 film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
201 _analysis.reset (new AudioAnalysis (path));
202 } catch (OldFormatError& e) {
203 /* An old analysis file: recreate it */
204 JobManager::instance()->analyse_audio (
205 film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
208 } catch (xmlpp::exception& e) {
209 /* Probably a (very) old-style analysis file: recreate it */
210 JobManager::instance()->analyse_audio (
211 film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
216 _plot->set_analysis (_analysis);
217 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
220 for (int i = 0; i < _channels; ++i) {
221 _channel_checkbox[i]->Show ();
224 for (int i = _channels; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
225 _channel_checkbox[i]->Hide ();
228 /* Set up some defaults if no check boxes are checked */
231 while (i < _channels && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
235 if (i == _channels) {
236 /* Nothing checked; check mapped ones */
239 shared_ptr<Content> content = _content.lock ();
242 mapped = content->audio->mapping().mapped_output_channels ();
244 mapped = film->mapped_audio_channels ();
247 BOOST_FOREACH (int i, mapped) {
248 if (_channel_checkbox[i]) {
249 _channel_checkbox[i]->SetValue (true);
250 _plot->set_channel_visible (i, true);
256 while (i < AudioPoint::COUNT && !_type_checkbox[i]->GetValue ()) {
260 if (i == AudioPoint::COUNT) {
261 for (int i = 0; i < AudioPoint::COUNT; ++i) {
262 _type_checkbox[i]->SetValue (true);
263 _plot->set_type_visible (i, true);
271 AudioDialog::analysis_finished ()
273 shared_ptr<const Film> film = _film.lock ();
275 /* This should not happen, but if it does we should just give up quietly */
279 if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
280 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
283 _plot->set_message (_("Could not analyse audio."));
287 try_to_load_analysis ();
291 AudioDialog::channel_clicked (wxCommandEvent& ev)
294 while (c < _channels && ev.GetEventObject() != _channel_checkbox[c]) {
298 DCPOMATIC_ASSERT (c < _channels);
300 _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
304 AudioDialog::film_change (ChangeType type, int p)
306 if (type != CHANGE_TYPE_DONE) {
310 if (p == Film::AUDIO_CHANNELS) {
311 shared_ptr<Film> film = _film.lock ();
313 _channels = film->audio_channels ();
314 try_to_load_analysis ();
320 AudioDialog::content_change (ChangeType type, int p)
322 if (type != CHANGE_TYPE_DONE) {
326 if (p == AudioContentProperty::STREAMS) {
327 try_to_load_analysis ();
328 } else if (p == AudioContentProperty::GAIN) {
329 if (_playlist->content().size() == 1 && _analysis) {
330 /* We can use a short-cut to render the effect of this
331 change, rather than recalculating everything.
333 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
336 try_to_load_analysis ();
342 AudioDialog::type_clicked (wxCommandEvent& ev)
345 while (t < AudioPoint::COUNT && ev.GetEventObject() != _type_checkbox[t]) {
349 DCPOMATIC_ASSERT (t < AudioPoint::COUNT);
351 _plot->set_type_visible (t, _type_checkbox[t]->GetValue ());
355 AudioDialog::smoothing_changed ()
357 _plot->set_smoothing (_smoothing->GetValue ());
361 AudioDialog::setup_statistics ()
367 shared_ptr<Film> film = _film.lock ();
372 pair<AudioAnalysis::PeakTime, int> const peak = _analysis->overall_sample_peak ();
373 float const peak_dB = linear_to_db(peak.first.peak) + _analysis->gain_correction(_playlist);
374 _sample_peak->SetLabel (
376 _("Sample peak is %.2fdB at %s on %s"),
378 time_to_timecode (peak.first.time, film->video_frame_rate ()).data (),
379 std_to_wx (short_audio_channel_name (peak.second)).data ()
384 _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
386 _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
389 if (_analysis->overall_true_peak()) {
390 float const peak = _analysis->overall_true_peak().get();
391 float const peak_dB = linear_to_db(peak) + _analysis->gain_correction(_playlist);
393 _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
396 _true_peak->SetForegroundColour (wxColour (255, 0, 0));
398 _true_peak->SetForegroundColour (wxColour (0, 0, 0));
402 /* XXX: check whether it's ok to add dB gain to these quantities */
404 if (static_cast<bool>(_analysis->integrated_loudness ())) {
405 _integrated_loudness->SetLabel (
407 _("Integrated loudness %.2f LUFS"),
408 _analysis->integrated_loudness().get() + _analysis->gain_correction (_playlist)
413 if (static_cast<bool>(_analysis->loudness_range ())) {
414 _loudness_range->SetLabel (
416 _("Loudness range %.2f LU"),
417 _analysis->loudness_range().get() + _analysis->gain_correction (_playlist)
422 if (static_cast<bool>(_analysis->leqm())) {
425 _("LEQ(m) %.2fdB"), _analysis->leqm().get() + _analysis->gain_correction(_playlist)
432 AudioDialog::Show (bool show)
434 bool const r = wxDialog::Show (show);
435 try_to_load_analysis ();
440 AudioDialog::set_cursor (optional<DCPTime> time, optional<float> db)
443 _cursor->SetLabel (_("Cursor: none"));
447 shared_ptr<Film> film = _film.lock();
448 DCPOMATIC_ASSERT (film);
449 _cursor->SetLabel (wxString::Format (_("Cursor: %.1fdB at %s"), *db, time->timecode(film->video_frame_rate())));