src/wx/audio_dialog.cc

   1 /*
   2     Copyright (C) 2013-2016 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         _plot = new AudioPlot (this);
  78         left->Add (_plot, 1, wxTOP | wxEXPAND, 12);
  79         _sample_peak = new wxStaticText (this, wxID_ANY, wxT (""));
  80         left->Add (_sample_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
  81         _true_peak = new wxStaticText (this, wxID_ANY, wxT (""));
  82         left->Add (_true_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
  83         _integrated_loudness = new wxStaticText (this, wxID_ANY, wxT (""));
  84         left->Add (_integrated_loudness, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
  85         _loudness_range = new wxStaticText (this, wxID_ANY, wxT (""));
  86         left->Add (_loudness_range, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
  87
  88         lr_sizer->Add (left, 1, wxALL, 12);
  89
  90         wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
  91
  92         {
  93                 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Channels"));
  94                 m->SetFont (subheading_font);
  95                 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM, 16);
  96         }
  97
  98         for (int i = 0; i < _channels; ++i) {
  99                 _channel_checkbox[i] = new wxCheckBox (this, wxID_ANY, std_to_wx (audio_channel_name (i)));
 100                 _channel_checkbox[i]->SetForegroundColour(wxColour(_plot->colour(i)));
 101                 right->Add (_channel_checkbox[i], 0, wxEXPAND | wxALL, 3);
 102                 _channel_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::channel_clicked, this, _1));
 103         }
 104
 105         for (int i = _channels; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
 106                 _channel_checkbox[i] = 0;
 107         }
 108
 109         {
 110                 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Type"));
 111                 m->SetFont (subheading_font);
 112                 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
 113         }
 114
 115         wxString const types[] = {
 116                 _("Peak"),
 117                 _("RMS")
 118         };
 119
 120         for (int i = 0; i < AudioPoint::COUNT; ++i) {
 121                 _type_checkbox[i] = new wxCheckBox (this, wxID_ANY, types[i]);
 122                 right->Add (_type_checkbox[i], 0, wxEXPAND | wxALL, 3);
 123                 _type_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::type_clicked, this, _1));
 124         }
 125
 126         {
 127                 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Smoothing"));
 128                 m->SetFont (subheading_font);
 129                 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
 130         }
 131
 132         _smoothing = new wxSlider (this, wxID_ANY, AudioPlot::max_smoothing / 2, 1, AudioPlot::max_smoothing);
 133         _smoothing->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&AudioDialog::smoothing_changed, this));
 134         right->Add (_smoothing, 0, wxEXPAND);
 135
 136         lr_sizer->Add (right, 0, wxALL, 12);
 137
 138         overall_sizer->Add (lr_sizer);
 139
 140 #ifdef DCPOMATIC_LINUX
 141         wxSizer* buttons = CreateSeparatedButtonSizer (wxCLOSE);
 142         if (buttons) {
 143                 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
 144         }
 145 #endif
 146
 147         SetSizer (overall_sizer);
 148         overall_sizer->Layout ();
 149         overall_sizer->SetSizeHints (this);
 150
 151         _film_connection = film->ContentChanged.connect (boost::bind (&AudioDialog::content_changed, this, _2));
 152         SetTitle (_("DCP-o-matic audio"));
 153
 154         if (content) {
 155                 _playlist.reset (new Playlist ());
 156                 const_pointer_cast<Playlist> (_playlist)->add (content);
 157         } else {
 158                 _playlist = film->playlist ();
 159         }
 160 }
 161
 162 void
 163 AudioDialog::try_to_load_analysis ()
 164 {
 165         if (!IsShown ()) {
 166                 return;
 167         }
 168
 169         shared_ptr<const Film> film = _film.lock ();
 170         DCPOMATIC_ASSERT (film);
 171
 172         shared_ptr<Content> check = _content.lock();
 173
 174         boost::filesystem::path const path = film->audio_analysis_path (_playlist);
 175         if (!boost::filesystem::exists (path)) {
 176                 _plot->set_analysis (shared_ptr<AudioAnalysis> ());
 177                 _analysis.reset ();
 178                 JobManager::instance()->analyse_audio (
 179                         film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
 180                         );
 181                 return;
 182         }
 183
 184         try {
 185                 _analysis.reset (new AudioAnalysis (path));
 186         } catch (OldFormatError& e) {
 187                 /* An old analysis file: recreate it */
 188                 JobManager::instance()->analyse_audio (
 189                         film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
 190                         );
 191                 return;
 192         } catch (xmlpp::exception& e) {
 193                 /* Probably a (very) old-style analysis file: recreate it */
 194                 JobManager::instance()->analyse_audio (
 195                         film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
 196                         );
 197                 return;
 198         }
 199
 200         _plot->set_analysis (_analysis);
 201         _plot->set_gain_correction (_analysis->gain_correction (_playlist));
 202         setup_statistics ();
 203
 204         /* Set up some defaults if no check boxes are checked */
 205
 206         int i = 0;
 207         while (i < _channels && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
 208                 ++i;
 209         }
 210
 211         if (i == _channels) {
 212                 /* Nothing checked; check mapped ones */
 213
 214                 list<int> mapped;
 215                 shared_ptr<Content> content = _content.lock ();
 216
 217                 if (content) {
 218                         mapped = content->audio->mapping().mapped_output_channels ();
 219                 } else {
 220                         mapped = film->mapped_audio_channels ();
 221                 }
 222
 223                 BOOST_FOREACH (int i, mapped) {
 224                         if (_channel_checkbox[i]) {
 225                                 _channel_checkbox[i]->SetValue (true);
 226                                 _plot->set_channel_visible (i, true);
 227                         }
 228                 }
 229         }
 230
 231         i = 0;
 232         while (i < AudioPoint::COUNT && !_type_checkbox[i]->GetValue ()) {
 233                 i++;
 234         }
 235
 236         if (i == AudioPoint::COUNT) {
 237                 for (int i = 0; i < AudioPoint::COUNT; ++i) {
 238                         _type_checkbox[i]->SetValue (true);
 239                         _plot->set_type_visible (i, true);
 240                 }
 241         }
 242
 243         Refresh ();
 244 }
 245
 246 void
 247 AudioDialog::analysis_finished ()
 248 {
 249         shared_ptr<const Film> film = _film.lock ();
 250         if (!film) {
 251                 /* This should not happen, but if it does we should just give up quietly */
 252                 return;
 253         }
 254
 255         if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
 256                 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
 257                    Give up.
 258                 */
 259                 _plot->set_message (_("Could not analyse audio."));
 260                 return;
 261         }
 262
 263         try_to_load_analysis ();
 264 }
 265
 266 void
 267 AudioDialog::channel_clicked (wxCommandEvent& ev)
 268 {
 269         int c = 0;
 270         while (c < _channels && ev.GetEventObject() != _channel_checkbox[c]) {
 271                 ++c;
 272         }
 273
 274         DCPOMATIC_ASSERT (c < _channels);
 275
 276         _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
 277 }
 278
 279 void
 280 AudioDialog::content_changed (int p)
 281 {
 282         if (p == AudioContentProperty::STREAMS) {
 283                 try_to_load_analysis ();
 284         } else if (p == AudioContentProperty::GAIN) {
 285                 if (_playlist->content().size() == 1 && _analysis) {
 286                         /* We can use a short-cut to render the effect of this
 287                            change, rather than recalculating everything.
 288                         */
 289                         _plot->set_gain_correction (_analysis->gain_correction (_playlist));
 290                         setup_statistics ();
 291                 } else {
 292                         try_to_load_analysis ();
 293                 }
 294         }
 295 }
 296
 297 void
 298 AudioDialog::type_clicked (wxCommandEvent& ev)
 299 {
 300         int t = 0;
 301         while (t < AudioPoint::COUNT && ev.GetEventObject() != _type_checkbox[t]) {
 302                 ++t;
 303         }
 304
 305         DCPOMATIC_ASSERT (t < AudioPoint::COUNT);
 306
 307         _plot->set_type_visible (t, _type_checkbox[t]->GetValue ());
 308 }
 309
 310 void
 311 AudioDialog::smoothing_changed ()
 312 {
 313         _plot->set_smoothing (_smoothing->GetValue ());
 314 }
 315
 316 void
 317 AudioDialog::setup_statistics ()
 318 {
 319         if (!_analysis) {
 320                 return;
 321         }
 322
 323         shared_ptr<Film> film = _film.lock ();
 324         if (!film) {
 325                 return;
 326         }
 327
 328         pair<AudioAnalysis::PeakTime, int> const peak = _analysis->overall_sample_peak ();
 329         float const peak_dB = 20 * log10 (peak.first.peak) + _analysis->gain_correction (_playlist);
 330         _sample_peak->SetLabel (
 331                 wxString::Format (
 332                         _("Sample peak is %.2fdB at %s on %s"),
 333                         peak_dB,
 334                         time_to_timecode (peak.first.time, film->video_frame_rate ()).data (),
 335                         std_to_wx (short_audio_channel_name (peak.second)).data ()
 336                         )
 337                 );
 338
 339         if (peak_dB > -3) {
 340                 _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
 341         } else {
 342                 _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
 343         }
 344
 345         if (_analysis->overall_true_peak()) {
 346                 float const peak = _analysis->overall_true_peak().get();
 347                 float const peak_dB = 20 * log10 (peak) + _analysis->gain_correction (_playlist);
 348
 349                 _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
 350
 351                 if (peak_dB > -3) {
 352                         _true_peak->SetForegroundColour (wxColour (255, 0, 0));
 353                 } else {
 354                         _true_peak->SetForegroundColour (wxColour (0, 0, 0));
 355                 }
 356         }
 357
 358         /* XXX: check whether it's ok to add dB gain to these quantities */
 359
 360         if (static_cast<bool>(_analysis->integrated_loudness ())) {
 361                 _integrated_loudness->SetLabel (
 362                         wxString::Format (
 363                                 _("Integrated loudness %.2f LUFS"),
 364                                 _analysis->integrated_loudness().get() + _analysis->gain_correction (_playlist)
 365                                 )
 366                         );
 367         }
 368
 369         if (static_cast<bool>(_analysis->loudness_range ())) {
 370                 _loudness_range->SetLabel (
 371                         wxString::Format (
 372                                 _("Loudness range %.2f LU"),
 373                                 _analysis->loudness_range().get() + _analysis->gain_correction (_playlist)
 374                                 )
 375                         );
 376         }
 377 }
 378
 379 bool
 380 AudioDialog::Show (bool show)
 381 {
 382         bool const r = wxDialog::Show (show);
 383         try_to_load_analysis ();
 384         return r;
 385 }