src/wx/audio_dialog.cc

   1 /*
   2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #include "audio_dialog.h"
  21 #include "audio_plot.h"
  22 #include "wx_util.h"
  23 #include "lib/audio_analysis.h"
  24 #include "lib/film.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>
  30 #include <iostream>
  31
  32 using std::cout;
  33 using boost::shared_ptr;
  34 using boost::bind;
  35 using boost::optional;
  36 using boost::const_pointer_cast;
  37 using boost::dynamic_pointer_cast;
  38
  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)
  42         , _film (film)
  43         , _plot (0)
  44 {
  45         wxFont subheading_font (*wxNORMAL_FONT);
  46         subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
  47
  48         wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
  49         wxBoxSizer* lr_sizer = new wxBoxSizer (wxHORIZONTAL);
  50
  51         wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
  52
  53         _plot = new AudioPlot (this);
  54         left->Add (_plot, 1, wxALL | wxEXPAND, 12);
  55         _peak_time = new wxStaticText (this, wxID_ANY, wxT (""));
  56         left->Add (_peak_time, 0, wxALL, 12);
  57
  58         lr_sizer->Add (left, 1, wxALL, 12);
  59
  60         wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
  61
  62         {
  63                 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Channels"));
  64                 m->SetFont (subheading_font);
  65                 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM, 16);
  66         }
  67
  68         for (int i = 0; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
  69                 _channel_checkbox[i] = new wxCheckBox (this, wxID_ANY, std_to_wx (audio_channel_name (i)));
  70                 right->Add (_channel_checkbox[i], 0, wxEXPAND | wxALL, 3);
  71                 _channel_checkbox[i]->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&AudioDialog::channel_clicked, this, _1));
  72         }
  73
  74         {
  75                 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Type"));
  76                 m->SetFont (subheading_font);
  77                 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
  78         }
  79
  80         wxString const types[] = {
  81                 _("Peak"),
  82                 _("RMS")
  83         };
  84
  85         for (int i = 0; i < AudioPoint::COUNT; ++i) {
  86                 _type_checkbox[i] = new wxCheckBox (this, wxID_ANY, types[i]);
  87                 right->Add (_type_checkbox[i], 0, wxEXPAND | wxALL, 3);
  88                 _type_checkbox[i]->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&AudioDialog::type_clicked, this, _1));
  89         }
  90
  91         {
  92                 wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Smoothing"));
  93                 m->SetFont (subheading_font);
  94                 right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
  95         }
  96
  97         _smoothing = new wxSlider (this, wxID_ANY, AudioPlot::max_smoothing / 2, 1, AudioPlot::max_smoothing);
  98         _smoothing->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&AudioDialog::smoothing_changed, this));
  99         right->Add (_smoothing, 0, wxEXPAND);
 100
 101         lr_sizer->Add (right, 0, wxALL, 12);
 102
 103         overall_sizer->Add (lr_sizer);
 104
 105 #ifdef DCPOMATIC_LINUX
 106         wxSizer* buttons = CreateSeparatedButtonSizer (wxCLOSE);
 107         if (buttons) {
 108                 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
 109         }
 110 #endif
 111
 112         SetSizer (overall_sizer);
 113         overall_sizer->Layout ();
 114         overall_sizer->SetSizeHints (this);
 115
 116         _film_connection = film->ContentChanged.connect (boost::bind (&AudioDialog::content_changed, this, _2));
 117         SetTitle (_("DCP-o-matic audio"));
 118
 119         if (content) {
 120                 _playlist.reset (new Playlist ());
 121                 const_pointer_cast<Playlist> (_playlist)->add (content);
 122         } else {
 123                 _playlist = film->playlist ();
 124         }
 125 }
 126
 127 void
 128 AudioDialog::try_to_load_analysis ()
 129 {
 130         if (!IsShown ()) {
 131                 return;
 132         }
 133
 134         shared_ptr<const Film> film = _film.lock ();
 135         DCPOMATIC_ASSERT (film);
 136
 137         boost::filesystem::path const path = film->audio_analysis_path (_playlist);
 138         if (!boost::filesystem::exists (path)) {
 139                 _plot->set_analysis (shared_ptr<AudioAnalysis> ());
 140                 _analysis.reset ();
 141                 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
 142                 return;
 143         }
 144
 145         try {
 146                 _analysis.reset (new AudioAnalysis (path));
 147         } catch (xmlpp::exception& e) {
 148                 /* Probably an old-style analysis file: recreate it */
 149                 JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
 150                 return;
 151         }
 152
 153         _plot->set_analysis (_analysis);
 154         _plot->set_gain_correction (_analysis->gain_correction (_playlist));
 155         setup_peak_time ();
 156
 157         /* Set up some defaults if no check boxes are checked */
 158
 159         int i = 0;
 160         while (i < MAX_DCP_AUDIO_CHANNELS && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
 161                 ++i;
 162         }
 163
 164         if (i == MAX_DCP_AUDIO_CHANNELS && _channel_checkbox[0]) {
 165                 _channel_checkbox[0]->SetValue (true);
 166                 _plot->set_channel_visible (0, true);
 167         }
 168
 169         i = 0;
 170         while (i < AudioPoint::COUNT && !_type_checkbox[i]->GetValue ()) {
 171                 i++;
 172         }
 173
 174         if (i == AudioPoint::COUNT) {
 175                 for (int i = 0; i < AudioPoint::COUNT; ++i) {
 176                         _type_checkbox[i]->SetValue (true);
 177                         _plot->set_type_visible (i, true);
 178                 }
 179         }
 180
 181         Refresh ();
 182 }
 183
 184 void
 185 AudioDialog::analysis_finished ()
 186 {
 187         shared_ptr<const Film> film = _film.lock ();
 188         DCPOMATIC_ASSERT (film);
 189
 190         if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
 191                 /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
 192                    Give up.
 193                 */
 194                 _plot->set_message (_("Could not analyse audio."));
 195                 return;
 196         }
 197
 198         try_to_load_analysis ();
 199 }
 200
 201 void
 202 AudioDialog::channel_clicked (wxCommandEvent& ev)
 203 {
 204         int c = 0;
 205         while (c < MAX_DCP_AUDIO_CHANNELS && ev.GetEventObject() != _channel_checkbox[c]) {
 206                 ++c;
 207         }
 208
 209         DCPOMATIC_ASSERT (c < MAX_DCP_AUDIO_CHANNELS);
 210
 211         _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
 212 }
 213
 214 void
 215 AudioDialog::content_changed (int p)
 216 {
 217         if (p == AudioContentProperty::AUDIO_STREAMS) {
 218                 try_to_load_analysis ();
 219         } else if (p == AudioContentProperty::AUDIO_GAIN) {
 220                 if (_playlist->content().size() == 1 && _analysis) {
 221                         /* We can use a short-cut to render the effect of this
 222                            change, rather than recalculating everything.
 223                         */
 224                         _plot->set_gain_correction (_analysis->gain_correction (_playlist));
 225                         setup_peak_time ();
 226                 } else {
 227                         try_to_load_analysis ();
 228                 }
 229         }
 230 }
 231
 232 void
 233 AudioDialog::type_clicked (wxCommandEvent& ev)
 234 {
 235         int t = 0;
 236         while (t < AudioPoint::COUNT && ev.GetEventObject() != _type_checkbox[t]) {
 237                 ++t;
 238         }
 239
 240         DCPOMATIC_ASSERT (t < AudioPoint::COUNT);
 241
 242         _plot->set_type_visible (t, _type_checkbox[t]->GetValue ());
 243 }
 244
 245 void
 246 AudioDialog::smoothing_changed ()
 247 {
 248         _plot->set_smoothing (_smoothing->GetValue ());
 249 }
 250
 251 void
 252 AudioDialog::setup_peak_time ()
 253 {
 254         if (!_analysis || !_analysis->peak ()) {
 255                 return;
 256         }
 257
 258         shared_ptr<Film> film = _film.lock ();
 259         if (!film) {
 260                 return;
 261         }
 262
 263         float const peak_dB = 20 * log10 (_analysis->peak().get()) + _analysis->gain_correction (_playlist);
 264
 265         _peak_time->SetLabel (
 266                 wxString::Format (
 267                         _("Peak is %.2fdB at %s"),
 268                         peak_dB,
 269                         time_to_timecode (_analysis->peak_time().get(), film->video_frame_rate ()).data ()
 270                         )
 271                 );
 272
 273         if (peak_dB > -3) {
 274                 _peak_time->SetForegroundColour (wxColour (255, 0, 0));
 275         } else {
 276                 _peak_time->SetForegroundColour (wxColour (0, 0, 0));
 277         }
 278 }
 279
 280 bool
 281 AudioDialog::Show (bool show)
 282 {
 283         bool const r = wxDialog::Show (show);
 284         try_to_load_analysis ();
 285         return r;
 286 }