2 Copyright (C) 2013-2016 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 content Content to analyse, or 0 to analyse all of the film's audio */
45 AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Content> content)
53 /* I can't get wxFRAME_FLOAT_ON_PARENT to work on OS X, and although wxSTAY_ON_TOP keeps
54 the window above all others (and not just our own) it's better than nothing for now.
56 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxSTAY_ON_TOP
58 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxFRAME_FLOAT_ON_PARENT
63 , _channels (film->audio_channels ())
66 wxFont subheading_font (*wxNORMAL_FONT);
67 subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
69 wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
70 wxBoxSizer* lr_sizer = new wxBoxSizer (wxHORIZONTAL);
72 wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
74 _plot = new AudioPlot (this);
75 left->Add (_plot, 1, wxTOP | wxEXPAND, 12);
76 _sample_peak = new wxStaticText (this, wxID_ANY, wxT (""));
77 left->Add (_sample_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
78 _true_peak = new wxStaticText (this, wxID_ANY, wxT (""));
79 left->Add (_true_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
80 _integrated_loudness = new wxStaticText (this, wxID_ANY, wxT (""));
81 left->Add (_integrated_loudness, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
82 _loudness_range = new wxStaticText (this, wxID_ANY, wxT (""));
83 left->Add (_loudness_range, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
85 lr_sizer->Add (left, 1, wxALL, 12);
87 wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
90 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Channels"));
91 m->SetFont (subheading_font);
92 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM, 16);
95 for (int i = 0; i < _channels; ++i) {
96 _channel_checkbox[i] = new wxCheckBox (this, wxID_ANY, std_to_wx (audio_channel_name (i)));
97 right->Add (_channel_checkbox[i], 0, wxEXPAND | wxALL, 3);
98 _channel_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::channel_clicked, this, _1));
101 for (int i = _channels; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
102 _channel_checkbox[i] = 0;
106 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Type"));
107 m->SetFont (subheading_font);
108 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
111 wxString const types[] = {
116 for (int i = 0; i < AudioPoint::COUNT; ++i) {
117 _type_checkbox[i] = new wxCheckBox (this, wxID_ANY, types[i]);
118 right->Add (_type_checkbox[i], 0, wxEXPAND | wxALL, 3);
119 _type_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::type_clicked, this, _1));
123 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Smoothing"));
124 m->SetFont (subheading_font);
125 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
128 _smoothing = new wxSlider (this, wxID_ANY, AudioPlot::max_smoothing / 2, 1, AudioPlot::max_smoothing);
129 _smoothing->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&AudioDialog::smoothing_changed, this));
130 right->Add (_smoothing, 0, wxEXPAND);
132 lr_sizer->Add (right, 0, wxALL, 12);
134 overall_sizer->Add (lr_sizer);
136 #ifdef DCPOMATIC_LINUX
137 wxSizer* buttons = CreateSeparatedButtonSizer (wxCLOSE);
139 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
143 SetSizer (overall_sizer);
144 overall_sizer->Layout ();
145 overall_sizer->SetSizeHints (this);
147 _film_connection = film->ContentChanged.connect (boost::bind (&AudioDialog::content_changed, this, _2));
148 SetTitle (_("DCP-o-matic audio"));
151 _playlist.reset (new Playlist ());
152 const_pointer_cast<Playlist> (_playlist)->add (content);
154 _playlist = film->playlist ();
159 AudioDialog::try_to_load_analysis ()
165 shared_ptr<const Film> film = _film.lock ();
166 DCPOMATIC_ASSERT (film);
168 boost::filesystem::path const path = film->audio_analysis_path (_playlist);
169 if (!boost::filesystem::exists (path)) {
170 _plot->set_analysis (shared_ptr<AudioAnalysis> ());
172 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
177 _analysis.reset (new AudioAnalysis (path));
178 } catch (OldFormatError& e) {
179 /* An old analysis file: recreate it */
180 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
182 } catch (xmlpp::exception& e) {
183 /* Probably a (very) old-style analysis file: recreate it */
184 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
188 _plot->set_analysis (_analysis);
189 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
192 /* Set up some defaults if no check boxes are checked */
195 while (i < _channels && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
199 if (i == _channels) {
200 /* Nothing checked; check mapped ones */
203 shared_ptr<Content> content = _content.lock ();
206 mapped = content->audio->mapping().mapped_output_channels ();
208 mapped = film->mapped_audio_channels ();
211 BOOST_FOREACH (int i, mapped) {
212 if (_channel_checkbox[i]) {
213 _channel_checkbox[i]->SetValue (true);
214 _plot->set_channel_visible (i, true);
220 while (i < AudioPoint::COUNT && !_type_checkbox[i]->GetValue ()) {
224 if (i == AudioPoint::COUNT) {
225 for (int i = 0; i < AudioPoint::COUNT; ++i) {
226 _type_checkbox[i]->SetValue (true);
227 _plot->set_type_visible (i, true);
235 AudioDialog::analysis_finished ()
237 shared_ptr<const Film> film = _film.lock ();
239 /* This should not happen, but if it does we should just give up quietly */
243 if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
244 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
247 _plot->set_message (_("Could not analyse audio."));
251 try_to_load_analysis ();
255 AudioDialog::channel_clicked (wxCommandEvent& ev)
258 while (c < _channels && ev.GetEventObject() != _channel_checkbox[c]) {
262 DCPOMATIC_ASSERT (c < _channels);
264 _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
268 AudioDialog::content_changed (int p)
270 if (p == AudioContentProperty::STREAMS) {
271 try_to_load_analysis ();
272 } else if (p == AudioContentProperty::GAIN) {
273 if (_playlist->content().size() == 1 && _analysis) {
274 /* We can use a short-cut to render the effect of this
275 change, rather than recalculating everything.
277 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
280 try_to_load_analysis ();
286 AudioDialog::type_clicked (wxCommandEvent& ev)
289 while (t < AudioPoint::COUNT && ev.GetEventObject() != _type_checkbox[t]) {
293 DCPOMATIC_ASSERT (t < AudioPoint::COUNT);
295 _plot->set_type_visible (t, _type_checkbox[t]->GetValue ());
299 AudioDialog::smoothing_changed ()
301 _plot->set_smoothing (_smoothing->GetValue ());
305 AudioDialog::setup_statistics ()
311 shared_ptr<Film> film = _film.lock ();
316 pair<AudioAnalysis::PeakTime, int> const peak = _analysis->overall_sample_peak ();
317 float const peak_dB = 20 * log10 (peak.first.peak) + _analysis->gain_correction (_playlist);
318 _sample_peak->SetLabel (
320 _("Sample peak is %.2fdB at %s on %s"),
322 time_to_timecode (peak.first.time, film->video_frame_rate ()).data (),
323 std_to_wx (short_audio_channel_name (peak.second)).data ()
328 _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
330 _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
333 if (_analysis->overall_true_peak()) {
334 float const peak = _analysis->overall_true_peak().get();
335 float const peak_dB = 20 * log10 (peak) + _analysis->gain_correction (_playlist);
337 _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
340 _true_peak->SetForegroundColour (wxColour (255, 0, 0));
342 _true_peak->SetForegroundColour (wxColour (0, 0, 0));
346 /* XXX: check whether it's ok to add dB gain to these quantities */
348 if (static_cast<bool>(_analysis->integrated_loudness ())) {
349 _integrated_loudness->SetLabel (
351 _("Integrated loudness %.2f LUFS"),
352 _analysis->integrated_loudness().get() + _analysis->gain_correction (_playlist)
357 if (static_cast<bool>(_analysis->loudness_range ())) {
358 _loudness_range->SetLabel (
360 _("Loudness range %.2f LU"),
361 _analysis->loudness_range().get() + _analysis->gain_correction (_playlist)
368 AudioDialog::Show (bool show)
370 bool const r = wxDialog::Show (show);
371 try_to_load_analysis ();