src/wx/audio_dialog.cc

   1 /*
   2     Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 #include "audio_dialog.h"
  22 #include "audio_plot.h"
  23 #include "wx_util.h"
  24 #include "lib/audio_analysis.h"
  25 #include "lib/film.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>
  32 #include <iostream>
  33
  34 using std::cout;
  35 using std::list;
  36 using std::vector;
  37 using std::pair;
  38 using boost::shared_ptr;
  39 using boost::bind;
  40 using boost::optional;
  41 using boost::const_pointer_cast;
  42 using boost::dynamic_pointer_cast;
  43
  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.
  47  */
  48 AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Content> content)
  49         : wxDialog (
  50                 parent,
  51                 wxID_ANY,
  52                 _("Audio"),
  53                 wxDefaultPosition,
  54                 wxSize (640, 512),
  55 #ifdef DCPOMATIC_OSX
  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.
  58                 */
  59                 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxSTAY_ON_TOP
  60 #else
  61                 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxFRAME_FLOAT_ON_PARENT
  62 #endif
  63                 )
  64         , _film (film)
  65         , _content (content)
  66         , _channels (film->audio_channels ())
  67         , _plot (0)
  68 {
  69         wxFont subheading_font (*wxNORMAL_FONT);
  70         subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
  71
  72         wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
  73         wxBoxSizer* lr_sizer = new wxBoxSizer (wxHORIZONTAL);
  74
  75         wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
  76
  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);
  89
  90         lr_sizer->Add (left, 1, wxALL | wxEXPAND, 12);
  91
  92         wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
  93
  94         {
  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);
  98         }
  99
 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));
 105         }
 106
 107         for (int i = _channels; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
 108                 _channel_checkbox[i] = 0;
 109         }
 110
 111         {
 112                 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Type"));
 113                 m->SetFont (subheading_font);
 114                 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
 115         }
 116
 117         wxString const types[] = {
 118                 _("Peak"),
 119                 _("RMS")
 120         };
 121
 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));
 126         }
 127
 128         {
 129                 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Smoothing"));
 130                 m->SetFont (subheading_font);
 131                 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
 132         }
 133
 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);
 137
 138         lr_sizer->Add (right, 0, wxALL, 12);
 139
 140         overall_sizer->Add (lr_sizer, 0, wxEXPAND);
 141
 142 #ifdef DCPOMATIC_LINUX
 143         wxSizer* buttons = CreateSeparatedButtonSizer (wxCLOSE);
 144         if (buttons) {
 145                 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
 146         }
 147 #endif
 148
 149         SetSizer (overall_sizer);
 150         overall_sizer->Layout ();
 151         overall_sizer->SetSizeHints (this);
 152
 153         _film_connection = film->ContentChanged.connect (boost::bind (&AudioDialog::content_changed, this, _2));
 154         SetTitle (_("DCP-o-matic audio"));
 155
 156         if (content) {
 157                 _playlist.reset (new Playlist ());
 158                 const_pointer_cast<Playlist> (_playlist)->add (content);
 159         } else {
 160                 _playlist = film->playlist ();
 161         }
 162
 163         _plot->Cursor.connect (bind (&AudioDialog::set_cursor, this, _1, _2));
 164 }
 165
 166 void
 167 AudioDialog::try_to_load_analysis ()
 168 {
 169         if (!IsShown ()) {
 170                 return;
 171         }
 172
 173         shared_ptr<const Film> film = _film.lock ();
 174         DCPOMATIC_ASSERT (film);
 175
 176         shared_ptr<Content> check = _content.lock();
 177
 178         boost::filesystem::path const path = film->audio_analysis_path (_playlist);
 179         if (!boost::filesystem::exists (path)) {
 180                 _plot->set_analysis (shared_ptr<AudioAnalysis> ());
 181                 _analysis.reset ();
 182                 JobManager::instance()->analyse_audio (
 183                         film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
 184                         );
 185                 return;
 186         }
 187
 188         try {
 189                 _analysis.reset (new AudioAnalysis (path));
 190         } catch (OldFormatError& e) {
 191                 /* An old analysis file: recreate it */
 192                 JobManager::instance()->analyse_audio (
 193                         film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
 194                         );
 195                 return;
 196         } catch (xmlpp::exception& e) {
 197                 /* Probably a (very) old-style analysis file: recreate it */
 198                 JobManager::instance()->analyse_audio (
 199                         film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
 200                         );
 201                 return;
 202         }
 203
 204         _plot->set_analysis (_analysis);
 205         _plot->set_gain_correction (_analysis->gain_correction (_playlist));
 206         setup_statistics ();
 207
 208         /* Set up some defaults if no check boxes are checked */
 209
 210         int i = 0;
 211         while (i < _channels && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
 212                 ++i;
 213         }
 214
 215         if (i == _channels) {
 216                 /* Nothing checked; check mapped ones */
 217
 218                 list<int> mapped;
 219                 shared_ptr<Content> content = _content.lock ();
 220
 221                 if (content) {
 222                         mapped = content->audio->mapping().mapped_output_channels ();
 223                 } else {
 224                         mapped = film->mapped_audio_channels ();
 225                 }
 226
 227                 BOOST_FOREACH (int i, mapped) {
 228                         if (_channel_checkbox[i]) {
 229                                 _channel_checkbox[i]->SetValue (true);
 230                                 _plot->set_channel_visible (i, true);
 231                         }
 232                 }
 233         }
 234
 235         i = 0;
 236         while (i < AudioPoint::COUNT && !_type_checkbox[i]->GetValue ()) {
 237                 i++;
 238         }
 239
 240         if (i == AudioPoint::COUNT) {
 241                 for (int i = 0; i < AudioPoint::COUNT; ++i) {
 242                         _type_checkbox[i]->SetValue (true);
 243                         _plot->set_type_visible (i, true);
 244                 }
 245         }
 246
 247         Refresh ();
 248 }
 249
 250 void
 251 AudioDialog::analysis_finished ()
 252 {
 253         shared_ptr<const Film> film = _film.lock ();
 254         if (!film) {
 255                 /* This should not happen, but if it does we should just give up quietly */
 256                 return;
 257         }
 258
 259         if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
 260                 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
 261                    Give up.
 262                 */
 263                 _plot->set_message (_("Could not analyse audio."));
 264                 return;
 265         }
 266
 267         try_to_load_analysis ();
 268 }
 269
 270 void
 271 AudioDialog::channel_clicked (wxCommandEvent& ev)
 272 {
 273         int c = 0;
 274         while (c < _channels && ev.GetEventObject() != _channel_checkbox[c]) {
 275                 ++c;
 276         }
 277
 278         DCPOMATIC_ASSERT (c < _channels);
 279
 280         _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
 281 }
 282
 283 void
 284 AudioDialog::content_changed (int p)
 285 {
 286         if (p == AudioContentProperty::STREAMS) {
 287                 try_to_load_analysis ();
 288         } else if (p == AudioContentProperty::GAIN) {
 289                 if (_playlist->content().size() == 1 && _analysis) {
 290                         /* We can use a short-cut to render the effect of this
 291                            change, rather than recalculating everything.
 292                         */
 293                         _plot->set_gain_correction (_analysis->gain_correction (_playlist));
 294                         setup_statistics ();
 295                 } else {
 296                         try_to_load_analysis ();
 297                 }
 298         }
 299 }
 300
 301 void
 302 AudioDialog::type_clicked (wxCommandEvent& ev)
 303 {
 304         int t = 0;
 305         while (t < AudioPoint::COUNT && ev.GetEventObject() != _type_checkbox[t]) {
 306                 ++t;
 307         }
 308
 309         DCPOMATIC_ASSERT (t < AudioPoint::COUNT);
 310
 311         _plot->set_type_visible (t, _type_checkbox[t]->GetValue ());
 312 }
 313
 314 void
 315 AudioDialog::smoothing_changed ()
 316 {
 317         _plot->set_smoothing (_smoothing->GetValue ());
 318 }
 319
 320 void
 321 AudioDialog::setup_statistics ()
 322 {
 323         if (!_analysis) {
 324                 return;
 325         }
 326
 327         shared_ptr<Film> film = _film.lock ();
 328         if (!film) {
 329                 return;
 330         }
 331
 332         pair<AudioAnalysis::PeakTime, int> const peak = _analysis->overall_sample_peak ();
 333         float const peak_dB = 20 * log10 (peak.first.peak) + _analysis->gain_correction (_playlist);
 334         _sample_peak->SetLabel (
 335                 wxString::Format (
 336                         _("Sample peak is %.2fdB at %s on %s"),
 337                         peak_dB,
 338                         time_to_timecode (peak.first.time, film->video_frame_rate ()).data (),
 339                         std_to_wx (short_audio_channel_name (peak.second)).data ()
 340                         )
 341                 );
 342
 343         if (peak_dB > -3) {
 344                 _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
 345         } else {
 346                 _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
 347         }
 348
 349         if (_analysis->overall_true_peak()) {
 350                 float const peak = _analysis->overall_true_peak().get();
 351                 float const peak_dB = 20 * log10 (peak) + _analysis->gain_correction (_playlist);
 352
 353                 _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
 354
 355                 if (peak_dB > -3) {
 356                         _true_peak->SetForegroundColour (wxColour (255, 0, 0));
 357                 } else {
 358                         _true_peak->SetForegroundColour (wxColour (0, 0, 0));
 359                 }
 360         }
 361
 362         /* XXX: check whether it's ok to add dB gain to these quantities */
 363
 364         if (static_cast<bool>(_analysis->integrated_loudness ())) {
 365                 _integrated_loudness->SetLabel (
 366                         wxString::Format (
 367                                 _("Integrated loudness %.2f LUFS"),
 368                                 _analysis->integrated_loudness().get() + _analysis->gain_correction (_playlist)
 369                                 )
 370                         );
 371         }
 372
 373         if (static_cast<bool>(_analysis->loudness_range ())) {
 374                 _loudness_range->SetLabel (
 375                         wxString::Format (
 376                                 _("Loudness range %.2f LU"),
 377                                 _analysis->loudness_range().get() + _analysis->gain_correction (_playlist)
 378                                 )
 379                         );
 380         }
 381 }
 382
 383 bool
 384 AudioDialog::Show (bool show)
 385 {
 386         bool const r = wxDialog::Show (show);
 387         try_to_load_analysis ();
 388         return r;
 389 }
 390
 391 void
 392 AudioDialog::set_cursor (optional<DCPTime> time, optional<float> db)
 393 {
 394         if (!time || !db) {
 395                 _cursor->SetLabel (_("Cursor: none"));
 396                 return;
 397         }
 398
 399         shared_ptr<Film> film = _film.lock();
 400         DCPOMATIC_ASSERT (film);
 401         _cursor->SetLabel (wxString::Format (_("Cursor: %.1fdB at %s"), *db, time->timecode(film->video_frame_rate())));
 402 }