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 | wxSTAY_ON_TOP
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));
93 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Type"));
94 m->SetFont (subheading_font);
95 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
98 wxString const types[] = {
103 for (int i = 0; i < AudioPoint::COUNT; ++i) {
104 _type_checkbox[i] = new wxCheckBox (this, wxID_ANY, types[i]);
105 right->Add (_type_checkbox[i], 0, wxEXPAND | wxALL, 3);
106 _type_checkbox[i]->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&AudioDialog::type_clicked, this, _1));
110 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Smoothing"));
111 m->SetFont (subheading_font);
112 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
115 _smoothing = new wxSlider (this, wxID_ANY, AudioPlot::max_smoothing / 2, 1, AudioPlot::max_smoothing);
116 _smoothing->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&AudioDialog::smoothing_changed, this));
117 right->Add (_smoothing, 0, wxEXPAND);
119 lr_sizer->Add (right, 0, wxALL, 12);
121 overall_sizer->Add (lr_sizer);
123 #ifdef DCPOMATIC_LINUX
124 wxSizer* buttons = CreateSeparatedButtonSizer (wxCLOSE);
126 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
130 SetSizer (overall_sizer);
131 overall_sizer->Layout ();
132 overall_sizer->SetSizeHints (this);
134 _film_connection = film->ContentChanged.connect (boost::bind (&AudioDialog::content_changed, this, _2));
135 SetTitle (_("DCP-o-matic audio"));
138 _playlist.reset (new Playlist ());
139 const_pointer_cast<Playlist> (_playlist)->add (content);
141 _playlist = film->playlist ();
146 AudioDialog::try_to_load_analysis ()
152 shared_ptr<const Film> film = _film.lock ();
153 DCPOMATIC_ASSERT (film);
155 boost::filesystem::path const path = film->audio_analysis_path (_playlist);
156 if (!boost::filesystem::exists (path)) {
157 _plot->set_analysis (shared_ptr<AudioAnalysis> ());
159 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
164 _analysis.reset (new AudioAnalysis (path));
165 } catch (xmlpp::exception& e) {
166 /* Probably an old-style analysis file: recreate it */
167 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
171 _plot->set_analysis (_analysis);
172 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
175 /* Set up some defaults if no check boxes are checked */
178 while (i < _channels && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
182 if (i == _channels) {
183 /* Nothing checked; check mapped ones */
186 shared_ptr<Content> content = _content.lock ();
189 mapped = content->audio->mapping().mapped_output_channels ();
191 mapped = film->mapped_audio_channels ();
194 BOOST_FOREACH (int i, mapped) {
195 if (_channel_checkbox[i]) {
196 _channel_checkbox[i]->SetValue (true);
197 _plot->set_channel_visible (i, true);
203 while (i < AudioPoint::COUNT && !_type_checkbox[i]->GetValue ()) {
207 if (i == AudioPoint::COUNT) {
208 for (int i = 0; i < AudioPoint::COUNT; ++i) {
209 _type_checkbox[i]->SetValue (true);
210 _plot->set_type_visible (i, true);
218 AudioDialog::analysis_finished ()
220 shared_ptr<const Film> film = _film.lock ();
221 DCPOMATIC_ASSERT (film);
223 if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
224 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
227 _plot->set_message (_("Could not analyse audio."));
231 try_to_load_analysis ();
235 AudioDialog::channel_clicked (wxCommandEvent& ev)
238 while (c < _channels && ev.GetEventObject() != _channel_checkbox[c]) {
242 DCPOMATIC_ASSERT (c < _channels);
244 _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
248 AudioDialog::content_changed (int p)
250 if (p == AudioContentProperty::STREAMS) {
251 try_to_load_analysis ();
252 } else if (p == AudioContentProperty::GAIN) {
253 if (_playlist->content().size() == 1 && _analysis) {
254 /* We can use a short-cut to render the effect of this
255 change, rather than recalculating everything.
257 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
260 try_to_load_analysis ();
266 AudioDialog::type_clicked (wxCommandEvent& ev)
269 while (t < AudioPoint::COUNT && ev.GetEventObject() != _type_checkbox[t]) {
273 DCPOMATIC_ASSERT (t < AudioPoint::COUNT);
275 _plot->set_type_visible (t, _type_checkbox[t]->GetValue ());
279 AudioDialog::smoothing_changed ()
281 _plot->set_smoothing (_smoothing->GetValue ());
285 AudioDialog::setup_statistics ()
291 shared_ptr<Film> film = _film.lock ();
296 if (static_cast<bool>(_analysis->sample_peak ())) {
298 float const peak_dB = 20 * log10 (_analysis->sample_peak().get()) + _analysis->gain_correction (_playlist);
300 _sample_peak->SetLabel (
302 _("Sample peak is %.2fdB at %s"),
304 time_to_timecode (_analysis->sample_peak_time().get(), film->video_frame_rate ()).data ()
309 _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
311 _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
315 if (static_cast<bool>(_analysis->true_peak ())) {
316 float const peak_dB = 20 * log10 (_analysis->true_peak().get()) + _analysis->gain_correction (_playlist);
318 _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
321 _true_peak->SetForegroundColour (wxColour (255, 0, 0));
323 _true_peak->SetForegroundColour (wxColour (0, 0, 0));
327 /* XXX: check whether it's ok to add dB gain to these quantities */
329 if (static_cast<bool>(_analysis->integrated_loudness ())) {
330 _integrated_loudness->SetLabel (
332 _("Integrated loudness %.2f LUFS"),
333 _analysis->integrated_loudness().get() + _analysis->gain_correction (_playlist)
338 if (static_cast<bool>(_analysis->loudness_range ())) {
339 _loudness_range->SetLabel (
341 _("Loudness range %.2f LU"),
342 _analysis->loudness_range().get() + _analysis->gain_correction (_playlist)
349 AudioDialog::Show (bool show)
351 bool const r = wxDialog::Show (show);
352 try_to_load_analysis ();