2 Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include "audio_dialog.h"
21 #include "audio_plot.h"
23 #include "lib/audio_analysis.h"
25 #include "lib/analyse_audio_job.h"
26 #include "lib/audio_content.h"
27 #include "lib/job_manager.h"
28 #include <libxml++/libxml++.h>
29 #include <boost/filesystem.hpp>
33 using boost::shared_ptr;
35 using boost::optional;
36 using boost::const_pointer_cast;
37 using boost::dynamic_pointer_cast;
39 /** @param content Content to analyse, or 0 to analyse all of the film's audio */
40 AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<AudioContent> content)
41 : wxDialog (parent, wxID_ANY, _("Audio"), wxDefaultPosition, wxSize (640, 512), wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE)
43 , _channels (film->audio_channels ())
46 wxFont subheading_font (*wxNORMAL_FONT);
47 subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
49 wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
50 wxBoxSizer* lr_sizer = new wxBoxSizer (wxHORIZONTAL);
52 wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
54 _plot = new AudioPlot (this);
55 left->Add (_plot, 1, wxTOP | wxEXPAND, 12);
56 _sample_peak = new wxStaticText (this, wxID_ANY, wxT (""));
57 left->Add (_sample_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
58 _true_peak = new wxStaticText (this, wxID_ANY, wxT (""));
59 left->Add (_true_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
60 _integrated_loudness = new wxStaticText (this, wxID_ANY, wxT (""));
61 left->Add (_integrated_loudness, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
62 _loudness_range = new wxStaticText (this, wxID_ANY, wxT (""));
63 left->Add (_loudness_range, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
65 lr_sizer->Add (left, 1, wxALL, 12);
67 wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
70 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Channels"));
71 m->SetFont (subheading_font);
72 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM, 16);
75 for (int i = 0; i < _channels; ++i) {
76 _channel_checkbox[i] = new wxCheckBox (this, wxID_ANY, std_to_wx (audio_channel_name (i)));
77 right->Add (_channel_checkbox[i], 0, wxEXPAND | wxALL, 3);
78 _channel_checkbox[i]->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&AudioDialog::channel_clicked, this, _1));
82 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Type"));
83 m->SetFont (subheading_font);
84 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
87 wxString const types[] = {
92 for (int i = 0; i < AudioPoint::COUNT; ++i) {
93 _type_checkbox[i] = new wxCheckBox (this, wxID_ANY, types[i]);
94 right->Add (_type_checkbox[i], 0, wxEXPAND | wxALL, 3);
95 _type_checkbox[i]->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&AudioDialog::type_clicked, this, _1));
99 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Smoothing"));
100 m->SetFont (subheading_font);
101 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
104 _smoothing = new wxSlider (this, wxID_ANY, AudioPlot::max_smoothing / 2, 1, AudioPlot::max_smoothing);
105 _smoothing->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&AudioDialog::smoothing_changed, this));
106 right->Add (_smoothing, 0, wxEXPAND);
108 lr_sizer->Add (right, 0, wxALL, 12);
110 overall_sizer->Add (lr_sizer);
112 #ifdef DCPOMATIC_LINUX
113 wxSizer* buttons = CreateSeparatedButtonSizer (wxCLOSE);
115 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
119 SetSizer (overall_sizer);
120 overall_sizer->Layout ();
121 overall_sizer->SetSizeHints (this);
123 _film_connection = film->ContentChanged.connect (boost::bind (&AudioDialog::content_changed, this, _2));
124 SetTitle (_("DCP-o-matic audio"));
127 _playlist.reset (new Playlist ());
128 const_pointer_cast<Playlist> (_playlist)->add (content);
130 _playlist = film->playlist ();
135 AudioDialog::try_to_load_analysis ()
141 shared_ptr<const Film> film = _film.lock ();
142 DCPOMATIC_ASSERT (film);
144 boost::filesystem::path const path = film->audio_analysis_path (_playlist);
145 if (!boost::filesystem::exists (path)) {
146 _plot->set_analysis (shared_ptr<AudioAnalysis> ());
148 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
153 _analysis.reset (new AudioAnalysis (path));
154 } catch (xmlpp::exception& e) {
155 /* Probably an old-style analysis file: recreate it */
156 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
160 _plot->set_analysis (_analysis);
161 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
164 /* Set up some defaults if no check boxes are checked */
167 while (i < _channels && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
171 if (i == _channels && _channel_checkbox[0]) {
172 _channel_checkbox[0]->SetValue (true);
173 _plot->set_channel_visible (0, true);
177 while (i < AudioPoint::COUNT && !_type_checkbox[i]->GetValue ()) {
181 if (i == AudioPoint::COUNT) {
182 for (int i = 0; i < AudioPoint::COUNT; ++i) {
183 _type_checkbox[i]->SetValue (true);
184 _plot->set_type_visible (i, true);
192 AudioDialog::analysis_finished ()
194 shared_ptr<const Film> film = _film.lock ();
195 DCPOMATIC_ASSERT (film);
197 if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
198 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
201 _plot->set_message (_("Could not analyse audio."));
205 try_to_load_analysis ();
209 AudioDialog::channel_clicked (wxCommandEvent& ev)
212 while (c < _channels && ev.GetEventObject() != _channel_checkbox[c]) {
216 DCPOMATIC_ASSERT (c < _channels);
218 _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
222 AudioDialog::content_changed (int p)
224 if (p == AudioContentProperty::AUDIO_STREAMS) {
225 try_to_load_analysis ();
226 } else if (p == AudioContentProperty::AUDIO_GAIN) {
227 if (_playlist->content().size() == 1 && _analysis) {
228 /* We can use a short-cut to render the effect of this
229 change, rather than recalculating everything.
231 _plot->set_gain_correction (_analysis->gain_correction (_playlist));
234 try_to_load_analysis ();
240 AudioDialog::type_clicked (wxCommandEvent& ev)
243 while (t < AudioPoint::COUNT && ev.GetEventObject() != _type_checkbox[t]) {
247 DCPOMATIC_ASSERT (t < AudioPoint::COUNT);
249 _plot->set_type_visible (t, _type_checkbox[t]->GetValue ());
253 AudioDialog::smoothing_changed ()
255 _plot->set_smoothing (_smoothing->GetValue ());
259 AudioDialog::setup_statistics ()
265 shared_ptr<Film> film = _film.lock ();
270 if (static_cast<bool>(_analysis->sample_peak ())) {
272 float const peak_dB = 20 * log10 (_analysis->sample_peak().get()) + _analysis->gain_correction (_playlist);
274 _sample_peak->SetLabel (
276 _("Sample peak is %.2fdB at %s"),
278 time_to_timecode (_analysis->sample_peak_time().get(), film->video_frame_rate ()).data ()
283 _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
285 _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
289 if (static_cast<bool>(_analysis->true_peak ())) {
290 float const peak_dB = 20 * log10 (_analysis->true_peak().get()) + _analysis->gain_correction (_playlist);
292 _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
295 _true_peak->SetForegroundColour (wxColour (255, 0, 0));
297 _true_peak->SetForegroundColour (wxColour (0, 0, 0));
301 /* XXX: check whether it's ok to add dB gain to these quantities */
303 if (static_cast<bool>(_analysis->integrated_loudness ())) {
304 _integrated_loudness->SetLabel (
306 _("Integrated loudness %.2f LUFS"),
307 _analysis->integrated_loudness().get() + _analysis->gain_correction (_playlist)
312 if (static_cast<bool>(_analysis->loudness_range ())) {
313 _loudness_range->SetLabel (
315 _("Loudness range %.2f LU"),
316 _analysis->loudness_range().get() + _analysis->gain_correction (_playlist)
323 AudioDialog::Show (bool show)
325 bool const r = wxDialog::Show (show);
326 try_to_load_analysis ();