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 "static_text.h"
  25 #include "check_box.h"
  26 #include "lib/audio_analysis.h"
  27 #include "lib/film.h"
  28 #include "lib/analyse_audio_job.h"
  29 #include "lib/audio_content.h"
  30 #include "lib/job_manager.h"
  31 #include <libxml++/libxml++.h>
  32 #include <boost/filesystem.hpp>
  33 #include <boost/foreach.hpp>
  34 #include <iostream>
  35
  36 using std::cout;
  37 using std::list;
  38 using std::vector;
  39 using std::pair;
  40 using boost::shared_ptr;
  41 using boost::bind;
  42 using boost::optional;
  43 using boost::const_pointer_cast;
  44 using boost::dynamic_pointer_cast;
  45
  46 /** @param parent Parent window.
  47  *  @param film Film we are using.
  48  *  @param content Content to analyse, or 0 to analyse all of the film's audio.
  49  */
  50 AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Content> content)
  51         : wxDialog (
  52                 parent,
  53                 wxID_ANY,
  54                 _("Audio"),
  55                 wxDefaultPosition,
  56                 wxSize (640, 512),
  57 #ifdef DCPOMATIC_OSX
  58                 /* I can't get wxFRAME_FLOAT_ON_PARENT to work on OS X, and although wxSTAY_ON_TOP keeps
  59                    the window above all others (and not just our own) it's better than nothing for now.
  60                 */
  61                 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxSTAY_ON_TOP
  62 #else
  63                 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxFRAME_FLOAT_ON_PARENT
  64 #endif
  65                 )
  66         , _film (film)
  67         , _content (content)
  68         , _channels (film->audio_channels ())
  69         , _plot (0)
  70 {
  71         wxFont subheading_font (*wxNORMAL_FONT);
  72         subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
  73
  74         wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
  75         wxBoxSizer* lr_sizer = new wxBoxSizer (wxHORIZONTAL);
  76
  77         wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
  78
  79         _cursor = new StaticText (this, wxT("Cursor: none"));
  80         left->Add (_cursor, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
  81         _plot = new AudioPlot (this);
  82         left->Add (_plot, 1, wxTOP | wxEXPAND, 12);
  83         _sample_peak = new StaticText (this, wxT (""));
  84         left->Add (_sample_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
  85         _true_peak = new StaticText (this, wxT (""));
  86         left->Add (_true_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
  87         _integrated_loudness = new StaticText (this, wxT (""));
  88         left->Add (_integrated_loudness, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
  89         _loudness_range = new StaticText (this, wxT (""));
  90         left->Add (_loudness_range, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
  91
  92         lr_sizer->Add (left, 1, wxALL | wxEXPAND, 12);
  93
  94         wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
  95
  96         {
  97                 wxStaticText* m = new StaticText (this, _("Channels"));
  98                 m->SetFont (subheading_font);
  99                 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM, 16);
 100         }
 101
 102         for (int i = 0; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
 103                 _channel_checkbox[i] = new CheckBox (this, std_to_wx(audio_channel_name(i)));
 104                 _channel_checkbox[i]->SetForegroundColour(wxColour(_plot->colour(i)));
 105                 right->Add (_channel_checkbox[i], 0, wxEXPAND | wxALL, 3);
 106                 _channel_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::channel_clicked, this, _1));
 107         }
 108
 109         show_or_hide_channel_checkboxes ();
 110
 111         {
 112                 wxStaticText* m = new StaticText (this, _("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 CheckBox (this, 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 StaticText (this, _("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->Change.connect (boost::bind(&AudioDialog::film_change, this, _1, _2));
 154         _film_content_connection = film->ContentChange.connect (boost::bind (&AudioDialog::content_change, this, _1, _3));
 155         DCPOMATIC_ASSERT (film->directory());
 156         SetTitle(wxString::Format(_("DCP-o-matic audio - %s"), std_to_wx(film->directory().get().string())));
 157
 158         if (content) {
 159                 _playlist.reset (new Playlist ());
 160                 const_pointer_cast<Playlist>(_playlist)->add(film, content);
 161         } else {
 162                 _playlist = film->playlist ();
 163         }
 164
 165         _plot->Cursor.connect (bind (&AudioDialog::set_cursor, this, _1, _2));
 166 }
 167
 168
 169 void
 170 AudioDialog::show_or_hide_channel_checkboxes ()
 171 {
 172         for (int i = 0; i < _channels; ++i) {
 173                 _channel_checkbox[i]->Show ();
 174         }
 175
 176         for (int i = _channels; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
 177                 _channel_checkbox[i]->Hide ();
 178         }
 179 }
 180
 181
 182 void
 183 AudioDialog::try_to_load_analysis ()
 184 {
 185         if (!IsShown ()) {
 186                 return;
 187         }
 188
 189         shared_ptr<const Film> film = _film.lock ();
 190         DCPOMATIC_ASSERT (film);
 191
 192         shared_ptr<Content> check = _content.lock();
 193
 194         boost::filesystem::path const path = film->audio_analysis_path (_playlist);
 195         if (!boost::filesystem::exists (path)) {
 196                 _plot->set_analysis (shared_ptr<AudioAnalysis> ());
 197                 _analysis.reset ();
 198
 199                 BOOST_FOREACH (shared_ptr<Job> i, JobManager::instance()->get()) {
 200                         if (dynamic_pointer_cast<AnalyseAudioJob>(i)) {
 201                                 i->cancel ();
 202                         }
 203                 }
 204
 205                 JobManager::instance()->analyse_audio (
 206                         film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
 207                         );
 208                 return;
 209         }
 210
 211         try {
 212                 _analysis.reset (new AudioAnalysis (path));
 213         } catch (OldFormatError& e) {
 214                 /* An old analysis file: recreate it */
 215                 JobManager::instance()->analyse_audio (
 216                         film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
 217                         );
 218                 return;
 219         } catch (xmlpp::exception& e) {
 220                 /* Probably a (very) old-style analysis file: recreate it */
 221                 JobManager::instance()->analyse_audio (
 222                         film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
 223                         );
 224                 return;
 225         }
 226
 227         _plot->set_analysis (_analysis);
 228         _plot->set_gain_correction (_analysis->gain_correction (_playlist));
 229         setup_statistics ();
 230         show_or_hide_channel_checkboxes ();
 231
 232         /* Set up some defaults if no check boxes are checked */
 233
 234         int i = 0;
 235         while (i < _channels && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
 236                 ++i;
 237         }
 238
 239         if (i == _channels) {
 240                 /* Nothing checked; check mapped ones */
 241
 242                 list<int> mapped;
 243                 shared_ptr<Content> content = _content.lock ();
 244
 245                 if (content) {
 246                         mapped = content->audio->mapping().mapped_output_channels ();
 247                 } else {
 248                         mapped = film->mapped_audio_channels ();
 249                 }
 250
 251                 BOOST_FOREACH (int i, mapped) {
 252                         if (_channel_checkbox[i]) {
 253                                 _channel_checkbox[i]->SetValue (true);
 254                                 _plot->set_channel_visible (i, true);
 255                         }
 256                 }
 257         }
 258
 259         i = 0;
 260         while (i < AudioPoint::COUNT && !_type_checkbox[i]->GetValue ()) {
 261                 i++;
 262         }
 263
 264         if (i == AudioPoint::COUNT) {
 265                 for (int i = 0; i < AudioPoint::COUNT; ++i) {
 266                         _type_checkbox[i]->SetValue (true);
 267                         _plot->set_type_visible (i, true);
 268                 }
 269         }
 270
 271         Refresh ();
 272 }
 273
 274 void
 275 AudioDialog::analysis_finished ()
 276 {
 277         shared_ptr<const Film> film = _film.lock ();
 278         if (!film) {
 279                 /* This should not happen, but if it does we should just give up quietly */
 280                 return;
 281         }
 282
 283         if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
 284                 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
 285                    Give up.
 286                 */
 287                 _plot->set_message (_("Could not analyse audio."));
 288                 return;
 289         }
 290
 291         try_to_load_analysis ();
 292 }
 293
 294 void
 295 AudioDialog::channel_clicked (wxCommandEvent& ev)
 296 {
 297         int c = 0;
 298         while (c < _channels && ev.GetEventObject() != _channel_checkbox[c]) {
 299                 ++c;
 300         }
 301
 302         DCPOMATIC_ASSERT (c < _channels);
 303
 304         _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
 305 }
 306
 307 void
 308 AudioDialog::film_change (ChangeType type, int p)
 309 {
 310         if (type != CHANGE_TYPE_DONE) {
 311                 return;
 312         }
 313
 314         if (p == Film::AUDIO_CHANNELS) {
 315                 shared_ptr<Film> film = _film.lock ();
 316                 if (film) {
 317                         _channels = film->audio_channels ();
 318                         try_to_load_analysis ();
 319                 }
 320         }
 321 }
 322
 323 void
 324 AudioDialog::content_change (ChangeType type, int p)
 325 {
 326         if (type != CHANGE_TYPE_DONE) {
 327                 return;
 328         }
 329
 330         if (p == AudioContentProperty::STREAMS) {
 331                 try_to_load_analysis ();
 332         } else if (p == AudioContentProperty::GAIN) {
 333                 if (_playlist->content().size() == 1 && _analysis) {
 334                         /* We can use a short-cut to render the effect of this
 335                            change, rather than recalculating everything.
 336                         */
 337                         _plot->set_gain_correction (_analysis->gain_correction (_playlist));
 338                         setup_statistics ();
 339                 } else {
 340                         try_to_load_analysis ();
 341                 }
 342         }
 343 }
 344
 345 void
 346 AudioDialog::type_clicked (wxCommandEvent& ev)
 347 {
 348         int t = 0;
 349         while (t < AudioPoint::COUNT && ev.GetEventObject() != _type_checkbox[t]) {
 350                 ++t;
 351         }
 352
 353         DCPOMATIC_ASSERT (t < AudioPoint::COUNT);
 354
 355         _plot->set_type_visible (t, _type_checkbox[t]->GetValue ());
 356 }
 357
 358 void
 359 AudioDialog::smoothing_changed ()
 360 {
 361         _plot->set_smoothing (_smoothing->GetValue ());
 362 }
 363
 364 void
 365 AudioDialog::setup_statistics ()
 366 {
 367         if (!_analysis) {
 368                 return;
 369         }
 370
 371         shared_ptr<Film> film = _film.lock ();
 372         if (!film) {
 373                 return;
 374         }
 375
 376         pair<AudioAnalysis::PeakTime, int> const peak = _analysis->overall_sample_peak ();
 377         float const peak_dB = 20 * log10 (peak.first.peak) + _analysis->gain_correction (_playlist);
 378         _sample_peak->SetLabel (
 379                 wxString::Format (
 380                         _("Sample peak is %.2fdB at %s on %s"),
 381                         peak_dB,
 382                         time_to_timecode (peak.first.time, film->video_frame_rate ()).data (),
 383                         std_to_wx (short_audio_channel_name (peak.second)).data ()
 384                         )
 385                 );
 386
 387         if (peak_dB > -3) {
 388                 _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
 389         } else {
 390                 _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
 391         }
 392
 393         if (_analysis->overall_true_peak()) {
 394                 float const peak = _analysis->overall_true_peak().get();
 395                 float const peak_dB = 20 * log10 (peak) + _analysis->gain_correction (_playlist);
 396
 397                 _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
 398
 399                 if (peak_dB > -3) {
 400                         _true_peak->SetForegroundColour (wxColour (255, 0, 0));
 401                 } else {
 402                         _true_peak->SetForegroundColour (wxColour (0, 0, 0));
 403                 }
 404         }
 405
 406         /* XXX: check whether it's ok to add dB gain to these quantities */
 407
 408         if (static_cast<bool>(_analysis->integrated_loudness ())) {
 409                 _integrated_loudness->SetLabel (
 410                         wxString::Format (
 411                                 _("Integrated loudness %.2f LUFS"),
 412                                 _analysis->integrated_loudness().get() + _analysis->gain_correction (_playlist)
 413                                 )
 414                         );
 415         }
 416
 417         if (static_cast<bool>(_analysis->loudness_range ())) {
 418                 _loudness_range->SetLabel (
 419                         wxString::Format (
 420                                 _("Loudness range %.2f LU"),
 421                                 _analysis->loudness_range().get() + _analysis->gain_correction (_playlist)
 422                                 )
 423                         );
 424         }
 425 }
 426
 427 bool
 428 AudioDialog::Show (bool show)
 429 {
 430         bool const r = wxDialog::Show (show);
 431         try_to_load_analysis ();
 432         return r;
 433 }
 434
 435 void
 436 AudioDialog::set_cursor (optional<DCPTime> time, optional<float> db)
 437 {
 438         if (!time || !db) {
 439                 _cursor->SetLabel (_("Cursor: none"));
 440                 return;
 441         }
 442
 443         shared_ptr<Film> film = _film.lock();
 444         DCPOMATIC_ASSERT (film);
 445         _cursor->SetLabel (wxString::Format (_("Cursor: %.1fdB at %s"), *db, time->timecode(film->video_frame_rate())));
 446 }