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 "lib/audio_analysis.h"
26 #include "lib/analyse_audio_job.h"
27 #include "lib/audio_content.h"
28 #include "lib/job_manager.h"
29 #include <libxml++/libxml++.h>
30 #include <boost/filesystem.hpp>
31 #include <boost/foreach.hpp>
38 using boost::shared_ptr;
40 using boost::optional;
41 using boost::const_pointer_cast;
42 using boost::dynamic_pointer_cast;
44 /** @param parent Parent window.
45 * @param film Film we are using.
46 * @param content Content to analyse, or 0 to analyse all of the film's audio.
48 AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Content> content)
56 /* I can't get wxFRAME_FLOAT_ON_PARENT to work on OS X, and although wxSTAY_ON_TOP keeps
57 the window above all others (and not just our own) it's better than nothing for now.
59 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxSTAY_ON_TOP
61 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxFRAME_FLOAT_ON_PARENT
66 , _channels (film->audio_channels ())
69 wxFont subheading_font (*wxNORMAL_FONT);
70 subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
72 wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
73 wxBoxSizer* lr_sizer = new wxBoxSizer (wxHORIZONTAL);
75 wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
77 _cursor = new wxStaticText (this, wxID_ANY, wxT("Cursor: none"));
78 left->Add (_cursor, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
79 _plot = new AudioPlot (this);
80 left->Add (_plot, 1, wxTOP | wxEXPAND, 12);
81 _sample_peak = new wxStaticText (this, wxID_ANY, wxT (""));
82 left->Add (_sample_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
83 _true_peak = new wxStaticText (this, wxID_ANY, wxT (""));
84 left->Add (_true_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
85 _integrated_loudness = new wxStaticText (this, wxID_ANY, wxT (""));
86 left->Add (_integrated_loudness, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
87 _loudness_range = new wxStaticText (this, wxID_ANY, wxT (""));
88 left->Add (_loudness_range, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
90 lr_sizer->Add (left, 1, wxALL | wxEXPAND, 12);
92 wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
95 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Channels"));
96 m->SetFont (subheading_font);
97 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM, 16);
100 for (int i = 0; i < _channels; ++i) {
101 _channel_checkbox[i] = new wxCheckBox (this, wxID_ANY, std_to_wx (audio_channel_name (i)));
102 _channel_checkbox[i]->SetForegroundColour(wxColour(_plot->colour(i)));
103 right->Add (_channel_checkbox[i], 0, wxEXPAND | wxALL, 3);
104 _channel_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::channel_clicked, this, _1));
107 for (int i = _channels; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
108 _channel_checkbox[i] = 0;
112 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Type"));
113 m->SetFont (subheading_font);
114 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
117 wxString const types[] = {
122 for (int i = 0; i < AudioPoint::COUNT; ++i) {
123 _type_checkbox[i] = new wxCheckBox (this, wxID_ANY, types[i]);
124 right->Add (_type_checkbox[i], 0, wxEXPAND | wxALL, 3);
125 _type_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::type_clicked, this, _1));
129 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Smoothing"));
130 m->SetFont (subheading_font);
131 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
134 _smoothing = new wxSlider (this, wxID_ANY, AudioPlot::max_smoothing / 2, 1, AudioPlot::max_smoothing);
135 _smoothing->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&AudioDialog::smoothing_changed, this));
136 right->Add (_smoothing, 0, wxEXPAND);
138 lr_sizer->Add (right, 0, wxALL, 12);
140 overall_sizer->Add (lr_sizer, 0, wxEXPAND);
142 #ifdef DCPOMATIC_LINUX
143 wxSizer* buttons = CreateSeparatedButtonSizer (wxCLOSE);
145 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
149 SetSizer (overall_sizer);
150 overall_sizer->Layout ();
151 overall_sizer->SetSizeHints (this);
153 _film_connection = film->ContentChange.connect (boost::bind (&AudioDialog::content_change, this, _1, _3));
154 DCPOMATIC_ASSERT (film->directory());
155 SetTitle(wxString::Format(_("DCP-o-matic audio - %s"), std_to_wx(film->directory().get().string())));
158 _playlist.reset (new Playlist ());
159 const_pointer_cast<Playlist> (_playlist)->add (content);
161 _playlist = film->playlist ();
164 _plot->Cursor.connect (bind (&AudioDialog::set_cursor, this, _1, _2));
168 AudioDialog::try_to_load_analysis ()
174 shared_ptr<const Film> film = _film.lock ();
175 DCPOMATIC_ASSERT (film);
177 shared_ptr<Content> check = _content.lock();
179 boost::filesystem::path const path = film->audio_analysis_path (_playlist);
180 if (!boost::filesystem::exists (path)) {
181 _plot->set_analysis (shared_ptr<AudioAnalysis> ());
183 JobManager::instance()->analyse_audio (
184 film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
190 _analysis.reset (new AudioAnalysis (path));
191 } catch (OldFormatError& e) {
192 /* An old analysis file: recreate it */
193 JobManager::instance()->analyse_audio (
194 film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
197 } catch (xmlpp::exception& e) {
198 /* Probably a (very) old-style analysis file: recreate it */
199 JobManager::instance()->analyse_audio (
200 film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
205 _plot->set_analysis (_analysis);
206 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
209 /* Set up some defaults if no check boxes are checked */
212 while (i < _channels && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
216 if (i == _channels) {
217 /* Nothing checked; check mapped ones */
220 shared_ptr<Content> content = _content.lock ();
223 mapped = content->audio->mapping().mapped_output_channels ();
225 mapped = film->mapped_audio_channels ();
228 BOOST_FOREACH (int i, mapped) {
229 if (_channel_checkbox[i]) {
230 _channel_checkbox[i]->SetValue (true);
231 _plot->set_channel_visible (i, true);
237 while (i < AudioPoint::COUNT && !_type_checkbox[i]->GetValue ()) {
241 if (i == AudioPoint::COUNT) {
242 for (int i = 0; i < AudioPoint::COUNT; ++i) {
243 _type_checkbox[i]->SetValue (true);
244 _plot->set_type_visible (i, true);
252 AudioDialog::analysis_finished ()
254 shared_ptr<const Film> film = _film.lock ();
256 /* This should not happen, but if it does we should just give up quietly */
260 if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
261 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
264 _plot->set_message (_("Could not analyse audio."));
268 try_to_load_analysis ();
272 AudioDialog::channel_clicked (wxCommandEvent& ev)
275 while (c < _channels && ev.GetEventObject() != _channel_checkbox[c]) {
279 DCPOMATIC_ASSERT (c < _channels);
281 _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
285 AudioDialog::content_change (ChangeType type, int p)
287 if (type != CHANGE_TYPE_DONE) {
291 if (p == AudioContentProperty::STREAMS) {
292 try_to_load_analysis ();
293 } else if (p == AudioContentProperty::GAIN) {
294 if (_playlist->content().size() == 1 && _analysis) {
295 /* We can use a short-cut to render the effect of this
296 change, rather than recalculating everything.
298 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
301 try_to_load_analysis ();
307 AudioDialog::type_clicked (wxCommandEvent& ev)
310 while (t < AudioPoint::COUNT && ev.GetEventObject() != _type_checkbox[t]) {
314 DCPOMATIC_ASSERT (t < AudioPoint::COUNT);
316 _plot->set_type_visible (t, _type_checkbox[t]->GetValue ());
320 AudioDialog::smoothing_changed ()
322 _plot->set_smoothing (_smoothing->GetValue ());
326 AudioDialog::setup_statistics ()
332 shared_ptr<Film> film = _film.lock ();
337 pair<AudioAnalysis::PeakTime, int> const peak = _analysis->overall_sample_peak ();
338 float const peak_dB = 20 * log10 (peak.first.peak) + _analysis->gain_correction (_playlist);
339 _sample_peak->SetLabel (
341 _("Sample peak is %.2fdB at %s on %s"),
343 time_to_timecode (peak.first.time, film->video_frame_rate ()).data (),
344 std_to_wx (short_audio_channel_name (peak.second)).data ()
349 _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
351 _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
354 if (_analysis->overall_true_peak()) {
355 float const peak = _analysis->overall_true_peak().get();
356 float const peak_dB = 20 * log10 (peak) + _analysis->gain_correction (_playlist);
358 _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
361 _true_peak->SetForegroundColour (wxColour (255, 0, 0));
363 _true_peak->SetForegroundColour (wxColour (0, 0, 0));
367 /* XXX: check whether it's ok to add dB gain to these quantities */
369 if (static_cast<bool>(_analysis->integrated_loudness ())) {
370 _integrated_loudness->SetLabel (
372 _("Integrated loudness %.2f LUFS"),
373 _analysis->integrated_loudness().get() + _analysis->gain_correction (_playlist)
378 if (static_cast<bool>(_analysis->loudness_range ())) {
379 _loudness_range->SetLabel (
381 _("Loudness range %.2f LU"),
382 _analysis->loudness_range().get() + _analysis->gain_correction (_playlist)
389 AudioDialog::Show (bool show)
391 bool const r = wxDialog::Show (show);
392 try_to_load_analysis ();
397 AudioDialog::set_cursor (optional<DCPTime> time, optional<float> db)
400 _cursor->SetLabel (_("Cursor: none"));
404 shared_ptr<Film> film = _film.lock();
405 DCPOMATIC_ASSERT (film);
406 _cursor->SetLabel (wxString::Format (_("Cursor: %.1fdB at %s"), *db, time->timecode(film->video_frame_rate())));