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>
36 using boost::shared_ptr;
38 using boost::optional;
39 using boost::const_pointer_cast;
40 using boost::dynamic_pointer_cast;
42 /** @param content Content to analyse, or 0 to analyse all of the film's audio */
43 AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Content> content)
50 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxFRAME_FLOAT_ON_PARENT
54 , _channels (film->audio_channels ())
57 wxFont subheading_font (*wxNORMAL_FONT);
58 subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
60 wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
61 wxBoxSizer* lr_sizer = new wxBoxSizer (wxHORIZONTAL);
63 wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
65 _plot = new AudioPlot (this);
66 left->Add (_plot, 1, wxTOP | wxEXPAND, 12);
67 _sample_peak = new wxStaticText (this, wxID_ANY, wxT (""));
68 left->Add (_sample_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
69 _true_peak = new wxStaticText (this, wxID_ANY, wxT (""));
70 left->Add (_true_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
71 _integrated_loudness = new wxStaticText (this, wxID_ANY, wxT (""));
72 left->Add (_integrated_loudness, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
73 _loudness_range = new wxStaticText (this, wxID_ANY, wxT (""));
74 left->Add (_loudness_range, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
76 lr_sizer->Add (left, 1, wxALL, 12);
78 wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
81 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Channels"));
82 m->SetFont (subheading_font);
83 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM, 16);
86 for (int i = 0; i < _channels; ++i) {
87 _channel_checkbox[i] = new wxCheckBox (this, wxID_ANY, std_to_wx (audio_channel_name (i)));
88 right->Add (_channel_checkbox[i], 0, wxEXPAND | wxALL, 3);
89 _channel_checkbox[i]->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&AudioDialog::channel_clicked, this, _1));
92 for (int i = _channels; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
93 _channel_checkbox[i] = 0;
97 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Type"));
98 m->SetFont (subheading_font);
99 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
102 wxString const types[] = {
107 for (int i = 0; i < AudioPoint::COUNT; ++i) {
108 _type_checkbox[i] = new wxCheckBox (this, wxID_ANY, types[i]);
109 right->Add (_type_checkbox[i], 0, wxEXPAND | wxALL, 3);
110 _type_checkbox[i]->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&AudioDialog::type_clicked, this, _1));
114 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Smoothing"));
115 m->SetFont (subheading_font);
116 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
119 _smoothing = new wxSlider (this, wxID_ANY, AudioPlot::max_smoothing / 2, 1, AudioPlot::max_smoothing);
120 _smoothing->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&AudioDialog::smoothing_changed, this));
121 right->Add (_smoothing, 0, wxEXPAND);
123 lr_sizer->Add (right, 0, wxALL, 12);
125 overall_sizer->Add (lr_sizer);
127 #ifdef DCPOMATIC_LINUX
128 wxSizer* buttons = CreateSeparatedButtonSizer (wxCLOSE);
130 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
134 SetSizer (overall_sizer);
135 overall_sizer->Layout ();
136 overall_sizer->SetSizeHints (this);
138 _film_connection = film->ContentChanged.connect (boost::bind (&AudioDialog::content_changed, this, _2));
139 SetTitle (_("DCP-o-matic audio"));
142 _playlist.reset (new Playlist ());
143 const_pointer_cast<Playlist> (_playlist)->add (content);
145 _playlist = film->playlist ();
150 AudioDialog::try_to_load_analysis ()
156 shared_ptr<const Film> film = _film.lock ();
157 DCPOMATIC_ASSERT (film);
159 boost::filesystem::path const path = film->audio_analysis_path (_playlist);
160 if (!boost::filesystem::exists (path)) {
161 _plot->set_analysis (shared_ptr<AudioAnalysis> ());
163 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
168 _analysis.reset (new AudioAnalysis (path));
169 } catch (xmlpp::exception& e) {
170 /* Probably an old-style analysis file: recreate it */
171 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
175 _plot->set_analysis (_analysis);
176 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
179 /* Set up some defaults if no check boxes are checked */
182 while (i < _channels && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
186 if (i == _channels) {
187 /* Nothing checked; check mapped ones */
190 shared_ptr<Content> content = _content.lock ();
193 mapped = content->audio->mapping().mapped_output_channels ();
195 mapped = film->mapped_audio_channels ();
198 BOOST_FOREACH (int i, mapped) {
199 if (_channel_checkbox[i]) {
200 _channel_checkbox[i]->SetValue (true);
201 _plot->set_channel_visible (i, true);
207 while (i < AudioPoint::COUNT && !_type_checkbox[i]->GetValue ()) {
211 if (i == AudioPoint::COUNT) {
212 for (int i = 0; i < AudioPoint::COUNT; ++i) {
213 _type_checkbox[i]->SetValue (true);
214 _plot->set_type_visible (i, true);
222 AudioDialog::analysis_finished ()
224 shared_ptr<const Film> film = _film.lock ();
226 /* This should not happen, but if it does we should just give up quietly */
230 if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
231 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
234 _plot->set_message (_("Could not analyse audio."));
238 try_to_load_analysis ();
242 AudioDialog::channel_clicked (wxCommandEvent& ev)
245 while (c < _channels && ev.GetEventObject() != _channel_checkbox[c]) {
249 DCPOMATIC_ASSERT (c < _channels);
251 _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
255 AudioDialog::content_changed (int p)
257 if (p == AudioContentProperty::STREAMS) {
258 try_to_load_analysis ();
259 } else if (p == AudioContentProperty::GAIN) {
260 if (_playlist->content().size() == 1 && _analysis) {
261 /* We can use a short-cut to render the effect of this
262 change, rather than recalculating everything.
264 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
267 try_to_load_analysis ();
273 AudioDialog::type_clicked (wxCommandEvent& ev)
276 while (t < AudioPoint::COUNT && ev.GetEventObject() != _type_checkbox[t]) {
280 DCPOMATIC_ASSERT (t < AudioPoint::COUNT);
282 _plot->set_type_visible (t, _type_checkbox[t]->GetValue ());
286 AudioDialog::smoothing_changed ()
288 _plot->set_smoothing (_smoothing->GetValue ());
292 AudioDialog::setup_statistics ()
298 shared_ptr<Film> film = _film.lock ();
303 if (static_cast<bool>(_analysis->sample_peak ())) {
305 float const peak_dB = 20 * log10 (_analysis->sample_peak().get()) + _analysis->gain_correction (_playlist);
307 _sample_peak->SetLabel (
309 _("Sample peak is %.2fdB at %s"),
311 time_to_timecode (_analysis->sample_peak_time().get(), film->video_frame_rate ()).data ()
316 _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
318 _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
322 if (static_cast<bool>(_analysis->true_peak ())) {
323 float const peak_dB = 20 * log10 (_analysis->true_peak().get()) + _analysis->gain_correction (_playlist);
325 _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
328 _true_peak->SetForegroundColour (wxColour (255, 0, 0));
330 _true_peak->SetForegroundColour (wxColour (0, 0, 0));
334 /* XXX: check whether it's ok to add dB gain to these quantities */
336 if (static_cast<bool>(_analysis->integrated_loudness ())) {
337 _integrated_loudness->SetLabel (
339 _("Integrated loudness %.2f LUFS"),
340 _analysis->integrated_loudness().get() + _analysis->gain_correction (_playlist)
345 if (static_cast<bool>(_analysis->loudness_range ())) {
346 _loudness_range->SetLabel (
348 _("Loudness range %.2f LU"),
349 _analysis->loudness_range().get() + _analysis->gain_correction (_playlist)
356 AudioDialog::Show (bool show)
358 bool const r = wxDialog::Show (show);
359 try_to_load_analysis ();