src/wx/audio_panel.cc

   1 /*
   2     Copyright (C) 2012-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_panel.h"
  22 #include "audio_mapping_view.h"
  23 #include "wx_util.h"
  24 #include "gain_calculator_dialog.h"
  25 #include "content_panel.h"
  26 #include "audio_dialog.h"
  27 #include "static_text.h"
  28 #include "check_box.h"
  29 #include "dcpomatic_button.h"
  30 #include "lib/config.h"
  31 #include "lib/ffmpeg_audio_stream.h"
  32 #include "lib/ffmpeg_content.h"
  33 #include "lib/cinema_sound_processor.h"
  34 #include "lib/job_manager.h"
  35 #include "lib/dcp_content.h"
  36 #include "lib/audio_content.h"
  37 #include <wx/spinctrl.h>
  38 #include <boost/foreach.hpp>
  39 #include <iostream>
  40
  41 using std::vector;
  42 using std::cout;
  43 using std::string;
  44 using std::list;
  45 using std::pair;
  46 using boost::dynamic_pointer_cast;
  47 using boost::shared_ptr;
  48 using boost::optional;
  49
  50 AudioPanel::AudioPanel (ContentPanel* p)
  51         : ContentSubPanel (p, _("Audio"))
  52         , _audio_dialog (0)
  53 {
  54         _reference = new CheckBox (this, _("Use this DCP's audio as OV and make VF"));
  55         _reference_note = new StaticText (this, wxT(""));
  56         _reference_note->Wrap (200);
  57         wxFont font = _reference_note->GetFont();
  58         font.SetStyle(wxFONTSTYLE_ITALIC);
  59         font.SetPointSize(font.GetPointSize() - 1);
  60         _reference_note->SetFont(font);
  61
  62         _show = new Button (this, _("Show graph of audio levels..."));
  63         _peak = new StaticText (this, wxT (""));
  64
  65         _gain_label = create_label (this, _("Gain"), true);
  66         _gain = new ContentSpinCtrlDouble<AudioContent> (
  67                 this,
  68                 new wxSpinCtrlDouble (this),
  69                 AudioContentProperty::GAIN,
  70                 &Content::audio,
  71                 boost::mem_fn (&AudioContent::gain),
  72                 boost::mem_fn (&AudioContent::set_gain)
  73                 );
  74
  75         _gain_db_label = create_label (this, _("dB"), false);
  76         _gain_calculate_button = new Button (this, _("Calculate..."));
  77
  78         _delay_label = create_label (this, _("Delay"), true);
  79         _delay = new ContentSpinCtrl<AudioContent> (
  80                 this,
  81                 new wxSpinCtrl (this),
  82                 AudioContentProperty::DELAY,
  83                 &Content::audio,
  84                 boost::mem_fn (&AudioContent::delay),
  85                 boost::mem_fn (&AudioContent::set_delay)
  86                 );
  87
  88         /// TRANSLATORS: this is an abbreviation for milliseconds, the unit of time
  89         _delay_ms_label = create_label (this, _("ms"), false);
  90
  91         _mapping = new AudioMappingView (this);
  92         _sizer->Add (_mapping, 1, wxEXPAND | wxALL, 6);
  93
  94         _description = new StaticText (this, wxT(" \n"), wxDefaultPosition, wxDefaultSize);
  95         _sizer->Add (_description, 0, wxALL, 12);
  96         _description->SetFont (font);
  97
  98         _gain->wrapped()->SetRange (-60, 60);
  99         _gain->wrapped()->SetDigits (1);
 100         _gain->wrapped()->SetIncrement (0.5);
 101         _delay->wrapped()->SetRange (-1000, 1000);
 102
 103         content_selection_changed ();
 104         film_changed (Film::AUDIO_CHANNELS);
 105         film_changed (Film::VIDEO_FRAME_RATE);
 106         film_changed (Film::REEL_TYPE);
 107
 108         _reference->Bind             (wxEVT_CHECKBOX, boost::bind (&AudioPanel::reference_clicked, this));
 109         _show->Bind                  (wxEVT_BUTTON,   boost::bind (&AudioPanel::show_clicked, this));
 110         _gain_calculate_button->Bind (wxEVT_BUTTON,   boost::bind (&AudioPanel::gain_calculate_button_clicked, this));
 111
 112         _mapping_connection = _mapping->Changed.connect (boost::bind (&AudioPanel::mapping_changed, this, _1));
 113         _active_jobs_connection = JobManager::instance()->ActiveJobsChanged.connect (boost::bind (&AudioPanel::active_jobs_changed, this, _1, _2));
 114
 115         add_to_grid ();
 116 }
 117
 118 void
 119 AudioPanel::add_to_grid ()
 120 {
 121         Config::Interface const interface = Config::instance()->interface_complexity();
 122
 123         int r = 0;
 124
 125         _reference->Show (interface == Config::INTERFACE_FULL);
 126         _reference_note->Show (interface == Config::INTERFACE_FULL);
 127
 128         if (interface == Config::INTERFACE_FULL) {
 129                 wxBoxSizer* reference_sizer = new wxBoxSizer (wxVERTICAL);
 130                 reference_sizer->Add (_reference, 0);
 131                 reference_sizer->Add (_reference_note, 0);
 132                 _grid->Add (reference_sizer, wxGBPosition(r, 0), wxGBSpan(1, 4));
 133                 ++r;
 134         }
 135
 136         _grid->Add (_show, wxGBPosition (r, 0), wxGBSpan (1, 2));
 137         _grid->Add (_peak, wxGBPosition (r, 2), wxGBSpan (1, 2), wxALIGN_CENTER_VERTICAL);
 138         ++r;
 139
 140         add_label_to_sizer (_grid, _gain_label, true, wxGBPosition(r, 0));
 141         {
 142                 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
 143                 s->Add (_gain->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM | wxRIGHT, 6);
 144                 s->Add (_gain_db_label, 0, wxALIGN_CENTER_VERTICAL);
 145                 _grid->Add (s, wxGBPosition(r, 1));
 146         }
 147         _grid->Add (_gain_calculate_button, wxGBPosition(r, 2), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
 148
 149         ++r;
 150
 151         add_label_to_sizer (_grid, _delay_label, true, wxGBPosition(r, 0));
 152         {
 153                 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
 154                 s->Add (_delay->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM | wxRIGHT, 6);
 155                 s->Add (_delay_ms_label, 0, wxALIGN_CENTER_VERTICAL);
 156                 _grid->Add (s, wxGBPosition(r, 1));
 157         }
 158         ++r;
 159 }
 160
 161 AudioPanel::~AudioPanel ()
 162 {
 163         if (_audio_dialog) {
 164                 _audio_dialog->Destroy ();
 165                 _audio_dialog = 0;
 166         }
 167 }
 168
 169 void
 170 AudioPanel::film_changed (Film::Property property)
 171 {
 172         switch (property) {
 173         case Film::AUDIO_CHANNELS:
 174         case Film::AUDIO_PROCESSOR:
 175                 _mapping->set_output_channels (_parent->film()->audio_output_names ());
 176                 setup_peak ();
 177                 break;
 178         case Film::VIDEO_FRAME_RATE:
 179                 setup_description ();
 180                 break;
 181         case Film::REEL_TYPE:
 182         case Film::INTEROP:
 183                 setup_sensitivity ();
 184                 break;
 185         default:
 186                 break;
 187         }
 188 }
 189
 190 void
 191 AudioPanel::film_content_changed (int property)
 192 {
 193         ContentList ac = _parent->selected_audio ();
 194         if (property == AudioContentProperty::STREAMS) {
 195                 if (ac.size() == 1) {
 196                         _mapping->set (ac.front()->audio->mapping());
 197                         _mapping->set_input_channels (ac.front()->audio->channel_names ());
 198
 199                         vector<AudioMappingView::Group> groups;
 200                         int c = 0;
 201                         BOOST_FOREACH (shared_ptr<const AudioStream> i, ac.front()->audio->streams()) {
 202                                 shared_ptr<const FFmpegAudioStream> f = dynamic_pointer_cast<const FFmpegAudioStream> (i);
 203                                 string name = "";
 204                                 if (f) {
 205                                         name = f->name;
 206                                         if (f->codec_name) {
 207                                                 name += " (" + f->codec_name.get() + ")";
 208                                         }
 209                                 }
 210                                 groups.push_back (AudioMappingView::Group (c, c + i->channels() - 1, name));
 211                                 c += i->channels ();
 212                         }
 213                         _mapping->set_input_groups (groups);
 214
 215                 } else {
 216                         _mapping->set (AudioMapping ());
 217                 }
 218                 setup_description ();
 219                 setup_peak ();
 220                 _sizer->Layout ();
 221         } else if (property == AudioContentProperty::GAIN) {
 222                 setup_peak ();
 223         } else if (property == DCPContentProperty::REFERENCE_AUDIO) {
 224                 if (ac.size() == 1) {
 225                         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (ac.front ());
 226                         checked_set (_reference, dcp ? dcp->reference_audio () : false);
 227                 } else {
 228                         checked_set (_reference, false);
 229                 }
 230
 231                 setup_sensitivity ();
 232         } else if (property == ContentProperty::VIDEO_FRAME_RATE) {
 233                 setup_description ();
 234         }
 235 }
 236
 237 void
 238 AudioPanel::gain_calculate_button_clicked ()
 239 {
 240         GainCalculatorDialog* d = new GainCalculatorDialog (this);
 241         int const r = d->ShowModal ();
 242
 243         if (r == wxID_CANCEL || d->wanted_fader() == 0 || d->actual_fader() == 0) {
 244                 d->Destroy ();
 245                 return;
 246         }
 247
 248         _gain->wrapped()->SetValue (
 249                 Config::instance()->cinema_sound_processor()->db_for_fader_change (
 250                         d->wanted_fader (),
 251                         d->actual_fader ()
 252                         )
 253                 );
 254
 255         /* This appears to be necessary, as the change is not signalled,
 256            I think.
 257         */
 258         _gain->view_changed ();
 259
 260         d->Destroy ();
 261 }
 262
 263 void
 264 AudioPanel::setup_description ()
 265 {
 266         ContentList ac = _parent->selected_audio ();
 267         if (ac.size () != 1) {
 268                 checked_set (_description, wxT (""));
 269                 return;
 270         }
 271
 272         checked_set (_description, ac.front()->audio->processing_description(_parent->film()));
 273 }
 274
 275 void
 276 AudioPanel::mapping_changed (AudioMapping m)
 277 {
 278         ContentList c = _parent->selected_audio ();
 279         if (c.size() == 1) {
 280                 c.front()->audio->set_mapping (m);
 281         }
 282 }
 283
 284 void
 285 AudioPanel::content_selection_changed ()
 286 {
 287         ContentList sel = _parent->selected_audio ();
 288
 289         _gain->set_content (sel);
 290         _delay->set_content (sel);
 291
 292         film_content_changed (AudioContentProperty::STREAMS);
 293         film_content_changed (AudioContentProperty::GAIN);
 294         film_content_changed (DCPContentProperty::REFERENCE_AUDIO);
 295
 296         setup_sensitivity ();
 297 }
 298
 299 void
 300 AudioPanel::setup_sensitivity ()
 301 {
 302         ContentList sel = _parent->selected_audio ();
 303
 304         shared_ptr<DCPContent> dcp;
 305         if (sel.size() == 1) {
 306                 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
 307         }
 308
 309         string why_not;
 310         bool const can_reference = dcp && dcp->can_reference_audio (_parent->film(), why_not);
 311         setup_refer_button (_reference, _reference_note, dcp, can_reference, why_not);
 312
 313         if (_reference->GetValue ()) {
 314                 _gain->wrapped()->Enable (false);
 315                 _gain_calculate_button->Enable (false);
 316                 _show->Enable (true);
 317                 _peak->Enable (false);
 318                 _delay->wrapped()->Enable (false);
 319                 _mapping->Enable (false);
 320                 _description->Enable (false);
 321         } else {
 322                 _gain->wrapped()->Enable (sel.size() == 1);
 323                 _gain_calculate_button->Enable (sel.size() == 1);
 324                 _show->Enable (sel.size() == 1);
 325                 _peak->Enable (sel.size() == 1);
 326                 _delay->wrapped()->Enable (sel.size() == 1);
 327                 _mapping->Enable (sel.size() == 1);
 328                 _description->Enable (sel.size() == 1);
 329         }
 330 }
 331
 332 void
 333 AudioPanel::show_clicked ()
 334 {
 335         if (_audio_dialog) {
 336                 _audio_dialog->Destroy ();
 337                 _audio_dialog = 0;
 338         }
 339
 340         ContentList ac = _parent->selected_audio ();
 341         if (ac.size() != 1) {
 342                 return;
 343         }
 344
 345         _audio_dialog = new AudioDialog (this, _parent->film (), ac.front ());
 346         _audio_dialog->Show ();
 347 }
 348
 349 void
 350 AudioPanel::setup_peak ()
 351 {
 352         ContentList sel = _parent->selected_audio ();
 353         optional<float> peak_dB;
 354
 355         if (sel.size() != 1) {
 356                 _peak->SetLabel (wxT (""));
 357         } else {
 358                 shared_ptr<Playlist> playlist (new Playlist);
 359                 playlist->add (_parent->film(), sel.front());
 360                 try {
 361                         shared_ptr<AudioAnalysis> analysis (new AudioAnalysis (_parent->film()->audio_analysis_path (playlist)));
 362                         peak_dB = 20 * log10 (analysis->overall_sample_peak().first.peak) + analysis->gain_correction (playlist);
 363                         _peak->SetLabel (wxString::Format (_("Peak: %.2fdB"), *peak_dB));
 364                 } catch (...) {
 365                         _peak->SetLabel (_("Peak: unknown"));
 366                 }
 367         }
 368
 369         static wxColour normal = _peak->GetForegroundColour ();
 370
 371         if (peak_dB && *peak_dB > -0.5) {
 372                 _peak->SetForegroundColour (wxColour (255, 0, 0));
 373         } else if (peak_dB && *peak_dB > -3) {
 374                 _peak->SetForegroundColour (wxColour (186, 120, 0));
 375         } else {
 376                 _peak->SetForegroundColour (normal);
 377         }
 378 }
 379
 380 void
 381 AudioPanel::active_jobs_changed (optional<string> old_active, optional<string> new_active)
 382 {
 383         if (old_active && *old_active == "analyse_audio") {
 384                 setup_peak ();
 385                 _mapping->Enable (true);
 386         } else if (new_active && *new_active == "analyse_audio") {
 387                 _mapping->Enable (false);
 388         }
 389 }
 390
 391 void
 392 AudioPanel::reference_clicked ()
 393 {
 394         ContentList c = _parent->selected ();
 395         if (c.size() != 1) {
 396                 return;
 397         }
 398
 399         shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (c.front ());
 400         if (!d) {
 401                 return;
 402         }
 403
 404         d->set_reference_audio (_reference->GetValue ());
 405 }
 406
 407 void
 408 AudioPanel::set_film (shared_ptr<Film>)
 409 {
 410         /* We are changing film, so destroy any audio dialog for the old one */
 411         if (_audio_dialog) {
 412                 _audio_dialog->Destroy ();
 413                 _audio_dialog = 0;
 414         }
 415 }