src/wx/audio_panel.cc

   1 /*
   2     Copyright (C) 2012-2021 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
  22 #include "audio_dialog.h"
  23 #include "audio_mapping_view.h"
  24 #include "audio_panel.h"
  25 #include "check_box.h"
  26 #include "content_panel.h"
  27 #include "dcpomatic_button.h"
  28 #include "gain_calculator_dialog.h"
  29 #include "static_text.h"
  30 #include "wx_util.h"
  31 #include "lib/audio_content.h"
  32 #include "lib/cinema_sound_processor.h"
  33 #include "lib/config.h"
  34 #include "lib/dcp_content.h"
  35 #include "lib/ffmpeg_audio_stream.h"
  36 #include "lib/ffmpeg_content.h"
  37 #include "lib/job_manager.h"
  38 #include "lib/maths_util.h"
  39 #include <dcp/warnings.h>
  40 LIBDCP_DISABLE_WARNINGS
  41 #include <wx/spinctrl.h>
  42 LIBDCP_ENABLE_WARNINGS
  43
  44
  45 using std::dynamic_pointer_cast;
  46 using std::list;
  47 using std::make_shared;
  48 using std::pair;
  49 using std::set;
  50 using std::shared_ptr;
  51 using std::string;
  52 using std::vector;
  53 using boost::optional;
  54 #if BOOST_VERSION >= 106100
  55 using namespace boost::placeholders;
  56 #endif
  57 using namespace dcpomatic;
  58
  59
  60 std::map<boost::filesystem::path, float> AudioPanel::_peak_cache;
  61
  62
  63 AudioPanel::AudioPanel (ContentPanel* p)
  64         : ContentSubPanel (p, _("Audio"))
  65 {
  66
  67 }
  68
  69
  70 void
  71 AudioPanel::create ()
  72 {
  73         _reference = new CheckBox (this, _("Use this DCP's audio as OV and make VF"));
  74         _reference_note = new StaticText (this, wxT(""));
  75         _reference_note->Wrap (200);
  76         auto font = _reference_note->GetFont();
  77         font.SetStyle(wxFONTSTYLE_ITALIC);
  78         font.SetPointSize(font.GetPointSize() - 1);
  79         _reference_note->SetFont(font);
  80
  81         _show = new Button (this, _("Show graph of audio levels..."));
  82         _peak = new StaticText (this, wxT (""));
  83
  84         _gain_label = create_label (this, _("Gain"), true);
  85         _gain = new ContentSpinCtrlDouble<AudioContent> (
  86                 this,
  87                 new wxSpinCtrlDouble (this),
  88                 AudioContentProperty::GAIN,
  89                 &Content::audio,
  90                 boost::mem_fn (&AudioContent::gain),
  91                 boost::mem_fn (&AudioContent::set_gain)
  92                 );
  93
  94         _gain_db_label = create_label (this, _("dB"), false);
  95         _gain_calculate_button = new Button (this, _("Calculate..."));
  96
  97         _delay_label = create_label (this, _("Delay"), true);
  98         _delay = new ContentSpinCtrl<AudioContent> (
  99                 this,
 100                 new wxSpinCtrl (this),
 101                 AudioContentProperty::DELAY,
 102                 &Content::audio,
 103                 boost::mem_fn (&AudioContent::delay),
 104                 boost::mem_fn (&AudioContent::set_delay)
 105                 );
 106
 107         /// TRANSLATORS: this is an abbreviation for milliseconds, the unit of time
 108         _delay_ms_label = create_label (this, _("ms"), false);
 109
 110         _fade_in_label = create_label (this, _("Fade in"), true);
 111         _fade_in = new Timecode<ContentTime> (this);
 112
 113         _fade_out_label = create_label (this, _("Fade out"), true);
 114         _fade_out = new Timecode<ContentTime> (this);
 115
 116         _use_same_fades_as_video = new wxCheckBox (this, wxID_ANY, _("Use same fades as video"));
 117
 118         _mapping = new AudioMappingView (this, _("Content"), _("content"), _("DCP"), _("DCP"));
 119         _sizer->Add (_mapping, 1, wxEXPAND | wxALL, 6);
 120
 121         _description = new StaticText (this, wxT(" \n"), wxDefaultPosition, wxDefaultSize);
 122         _sizer->Add (_description, 0, wxALL, 12);
 123         _description->SetFont (font);
 124
 125         _gain->wrapped()->SetRange (-60, 60);
 126         _gain->wrapped()->SetDigits (1);
 127         _gain->wrapped()->SetIncrement (0.5);
 128         _delay->wrapped()->SetRange (-1000, 1000);
 129
 130         content_selection_changed ();
 131         film_changed (Film::Property::AUDIO_CHANNELS);
 132         film_changed (Film::Property::VIDEO_FRAME_RATE);
 133         film_changed (Film::Property::REEL_TYPE);
 134
 135         _reference->Bind             (wxEVT_CHECKBOX, boost::bind (&AudioPanel::reference_clicked, this));
 136         _show->Bind                  (wxEVT_BUTTON,   boost::bind (&AudioPanel::show_clicked, this));
 137         _gain_calculate_button->Bind (wxEVT_BUTTON,   boost::bind (&AudioPanel::gain_calculate_button_clicked, this));
 138
 139         _fade_in->Changed.connect (boost::bind(&AudioPanel::fade_in_changed, this));
 140         _fade_out->Changed.connect (boost::bind(&AudioPanel::fade_out_changed, this));
 141         _use_same_fades_as_video->Bind (wxEVT_CHECKBOX, boost::bind(&AudioPanel::use_same_fades_as_video_changed, this));
 142
 143         _mapping_connection = _mapping->Changed.connect (boost::bind (&AudioPanel::mapping_changed, this, _1));
 144         _active_jobs_connection = JobManager::instance()->ActiveJobsChanged.connect (boost::bind (&AudioPanel::active_jobs_changed, this, _1, _2));
 145
 146         add_to_grid ();
 147
 148         _sizer->Layout ();
 149 }
 150
 151
 152 void
 153 AudioPanel::add_to_grid ()
 154 {
 155         int r = 0;
 156
 157         auto reference_sizer = new wxBoxSizer (wxVERTICAL);
 158         reference_sizer->Add (_reference, 0);
 159         reference_sizer->Add (_reference_note, 0);
 160         _grid->Add (reference_sizer, wxGBPosition(r, 0), wxGBSpan(1, 4));
 161         ++r;
 162
 163         _grid->Add (_show, wxGBPosition (r, 0), wxGBSpan (1, 2));
 164         _grid->Add (_peak, wxGBPosition (r, 2), wxGBSpan (1, 2), wxALIGN_CENTER_VERTICAL);
 165         ++r;
 166
 167         add_label_to_sizer (_grid, _gain_label, true, wxGBPosition(r, 0));
 168         {
 169                 auto s = new wxBoxSizer (wxHORIZONTAL);
 170                 s->Add (_gain->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_GAP);
 171                 s->Add (_gain_db_label, 0, wxALIGN_CENTER_VERTICAL);
 172                 _grid->Add (s, wxGBPosition(r, 1));
 173         }
 174
 175         _grid->Add (_gain_calculate_button, wxGBPosition(r, 2), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
 176         ++r;
 177
 178         add_label_to_sizer (_grid, _delay_label, true, wxGBPosition(r, 0));
 179         auto s = new wxBoxSizer (wxHORIZONTAL);
 180         s->Add (_delay->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_GAP);
 181         s->Add (_delay_ms_label, 0, wxALIGN_CENTER_VERTICAL);
 182         _grid->Add (s, wxGBPosition(r, 1));
 183         ++r;
 184
 185         add_label_to_sizer (_grid, _fade_in_label, true, wxGBPosition(r, 0));
 186         _grid->Add (_fade_in, wxGBPosition(r, 1), wxGBSpan(1, 3));
 187         ++r;
 188
 189         add_label_to_sizer (_grid, _fade_out_label, true, wxGBPosition(r, 0));
 190         _grid->Add (_fade_out, wxGBPosition(r, 1), wxGBSpan(1, 3));
 191         ++r;
 192
 193         _grid->Add (_use_same_fades_as_video, wxGBPosition(r, 0), wxGBSpan(1, 4));
 194         ++r;
 195 }
 196
 197
 198 AudioPanel::~AudioPanel ()
 199 {
 200         if (_audio_dialog) {
 201                 _audio_dialog->Destroy ();
 202                 _audio_dialog = nullptr;
 203         }
 204 }
 205
 206 void
 207 AudioPanel::film_changed (Film::Property property)
 208 {
 209         if (!_parent->film()) {
 210                 return;
 211         }
 212
 213         switch (property) {
 214         case Film::Property::AUDIO_CHANNELS:
 215         case Film::Property::AUDIO_PROCESSOR:
 216                 _mapping->set_output_channels (_parent->film()->audio_output_names ());
 217                 setup_peak ();
 218                 break;
 219         case Film::Property::VIDEO_FRAME_RATE:
 220                 setup_description ();
 221                 break;
 222         case Film::Property::REEL_TYPE:
 223         case Film::Property::INTEROP:
 224                 setup_sensitivity ();
 225                 break;
 226         default:
 227                 break;
 228         }
 229 }
 230
 231
 232 void
 233 AudioPanel::film_content_changed (int property)
 234 {
 235         auto ac = _parent->selected_audio ();
 236         if (property == AudioContentProperty::STREAMS) {
 237                 if (ac.size() == 1) {
 238                         _mapping->set (ac.front()->audio->mapping());
 239                         _mapping->set_input_channels (ac.front()->audio->channel_names ());
 240
 241                         vector<AudioMappingView::Group> groups;
 242                         int c = 0;
 243                         for (auto i: ac.front()->audio->streams()) {
 244                                 auto f = dynamic_pointer_cast<const FFmpegAudioStream> (i);
 245                                 string name = "";
 246                                 if (f) {
 247                                         name = f->name;
 248                                         if (f->codec_name) {
 249                                                 name += " (" + f->codec_name.get() + ")";
 250                                         }
 251                                 }
 252                                 groups.push_back (AudioMappingView::Group (c, c + i->channels() - 1, name));
 253                                 c += i->channels ();
 254                         }
 255                         _mapping->set_input_groups (groups);
 256
 257                 } else {
 258                         _mapping->set (AudioMapping ());
 259                 }
 260                 setup_description ();
 261                 setup_peak ();
 262                 layout ();
 263         } else if (property == AudioContentProperty::GAIN) {
 264                 setup_peak ();
 265         } else if (property == DCPContentProperty::REFERENCE_AUDIO) {
 266                 if (ac.size() == 1) {
 267                         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (ac.front ());
 268                         checked_set (_reference, dcp ? dcp->reference_audio () : false);
 269                 } else {
 270                         checked_set (_reference, false);
 271                 }
 272
 273                 setup_sensitivity ();
 274         } else if (property == ContentProperty::VIDEO_FRAME_RATE) {
 275                 setup_description ();
 276         } else if (property == AudioContentProperty::FADE_IN) {
 277                 set<Frame> check;
 278                 for (auto i: ac) {
 279                         check.insert (i->audio->fade_in().get());
 280                 }
 281
 282                 if (check.size() == 1) {
 283                         _fade_in->set (
 284                                 ac.front()->audio->fade_in(),
 285                                 ac.front()->active_video_frame_rate(_parent->film())
 286                                 );
 287                 } else {
 288                         _fade_in->clear ();
 289                 }
 290         } else if (property == AudioContentProperty::FADE_OUT) {
 291                 set<Frame> check;
 292                 for (auto i: ac) {
 293                         check.insert (i->audio->fade_out().get());
 294                 }
 295
 296                 if (check.size() == 1) {
 297                         _fade_out->set (
 298                                 ac.front()->audio->fade_out(),
 299                                 ac.front()->active_video_frame_rate(_parent->film())
 300                                 );
 301                 } else {
 302                         _fade_out->clear ();
 303                 }
 304         } else if (property == AudioContentProperty::USE_SAME_FADES_AS_VIDEO) {
 305                 setup_sensitivity ();
 306         }
 307 }
 308
 309
 310 void
 311 AudioPanel::gain_calculate_button_clicked ()
 312 {
 313         auto d = new GainCalculatorDialog (this);
 314         auto const r = d->ShowModal ();
 315         auto c = d->db_change();
 316
 317         if (r == wxID_CANCEL || !c) {
 318                 d->Destroy ();
 319                 return;
 320         }
 321
 322         auto old_peak_dB = peak ();
 323         auto old_value = _gain->wrapped()->GetValue();
 324         _gain->wrapped()->SetValue(old_value + *c);
 325
 326         /* This appears to be necessary, as the change is not signalled,
 327            I think.
 328         */
 329         _gain->view_changed ();
 330
 331         auto peak_dB = peak ();
 332         if (old_peak_dB && *old_peak_dB < -0.5 && peak_dB && *peak_dB > -0.5) {
 333                 error_dialog (this, _("It is not possible to adjust the content's gain for this fader change as it would cause the DCP's audio to clip.  The gain has not been changed."));
 334                 _gain->wrapped()->SetValue (old_value);
 335                 _gain->view_changed ();
 336         }
 337
 338         d->Destroy ();
 339 }
 340
 341
 342 void
 343 AudioPanel::setup_description ()
 344 {
 345         auto ac = _parent->selected_audio ();
 346         if (ac.size () != 1) {
 347                 checked_set (_description, wxT (""));
 348                 return;
 349         }
 350
 351         checked_set (_description, ac.front()->audio->processing_description(_parent->film()));
 352 }
 353
 354
 355 void
 356 AudioPanel::mapping_changed (AudioMapping m)
 357 {
 358         auto c = _parent->selected_audio ();
 359         if (c.size() == 1) {
 360                 c.front()->audio->set_mapping (m);
 361         }
 362 }
 363
 364
 365 void
 366 AudioPanel::content_selection_changed ()
 367 {
 368         auto sel = _parent->selected_audio ();
 369
 370         _gain->set_content (sel);
 371         _delay->set_content (sel);
 372
 373         film_content_changed (AudioContentProperty::STREAMS);
 374         film_content_changed (AudioContentProperty::GAIN);
 375         film_content_changed (AudioContentProperty::FADE_IN);
 376         film_content_changed (AudioContentProperty::FADE_OUT);
 377         film_content_changed (AudioContentProperty::USE_SAME_FADES_AS_VIDEO);
 378         film_content_changed (DCPContentProperty::REFERENCE_AUDIO);
 379
 380         setup_sensitivity ();
 381 }
 382
 383
 384 void
 385 AudioPanel::setup_sensitivity ()
 386 {
 387         auto sel = _parent->selected_audio ();
 388
 389         shared_ptr<DCPContent> dcp;
 390         if (sel.size() == 1) {
 391                 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
 392         }
 393
 394         string why_not;
 395         bool const can_reference = dcp && dcp->can_reference_audio (_parent->film(), why_not);
 396         wxString cannot;
 397         if (why_not.empty()) {
 398                 cannot = _("Cannot reference this DCP's audio.");
 399         } else {
 400                 cannot = _("Cannot reference this DCP's audio: ") + std_to_wx(why_not);
 401         }
 402         setup_refer_button (_reference, _reference_note, dcp, can_reference, cannot);
 403
 404         auto const ref = _reference->GetValue();
 405         auto const single = sel.size() == 1;
 406
 407         auto const all_have_video = std::all_of(sel.begin(), sel.end(), [](shared_ptr<const Content> c) { return static_cast<bool>(c->video); });
 408
 409         _gain->wrapped()->Enable (!ref);
 410         _gain_calculate_button->Enable (!ref && single);
 411         _show->Enable (single);
 412         _peak->Enable (!ref && single);
 413         _delay->wrapped()->Enable (!ref);
 414         _mapping->Enable (!ref && single);
 415         _description->Enable (!ref && single);
 416         _fade_in->Enable (!_use_same_fades_as_video->GetValue());
 417         _fade_out->Enable (!_use_same_fades_as_video->GetValue());
 418         _use_same_fades_as_video->Enable (!ref && all_have_video);
 419 }
 420
 421
 422 void
 423 AudioPanel::show_clicked ()
 424 {
 425         if (_audio_dialog) {
 426                 _audio_dialog->Destroy ();
 427                 _audio_dialog = nullptr;
 428         }
 429
 430         auto ac = _parent->selected_audio ();
 431         if (ac.size() != 1) {
 432                 return;
 433         }
 434
 435         _audio_dialog = new AudioDialog (this, _parent->film(), _parent->film_viewer(), ac.front());
 436         _audio_dialog->Show ();
 437 }
 438
 439
 440 /** @return If there is one selected piece of audio content, return its peak value in dB (if known) */
 441 optional<float>
 442 AudioPanel::peak () const
 443 {
 444         optional<float> peak_dB;
 445
 446         auto sel = _parent->selected_audio ();
 447         if (sel.size() == 1) {
 448                 auto playlist = make_shared<Playlist>();
 449                 playlist->add (_parent->film(), sel.front());
 450                 try {
 451                         /* Loading the audio analysis file is slow, and this ::peak() is called a few times when
 452                          * the content selection is changed, so cache it.
 453                          */
 454                         auto const path = _parent->film()->audio_analysis_path(playlist);
 455                         auto cached = _peak_cache.find(path);
 456                         if (cached != _peak_cache.end()) {
 457                                 peak_dB = cached->second;
 458                         } else {
 459                                 auto analysis = make_shared<AudioAnalysis>(path);
 460                                 peak_dB = linear_to_db(analysis->overall_sample_peak().first.peak) + analysis->gain_correction(playlist);
 461                                 _peak_cache[path] = *peak_dB;
 462                         }
 463                 } catch (...) {
 464
 465                 }
 466         }
 467
 468         return peak_dB;
 469 }
 470
 471
 472 void
 473 AudioPanel::setup_peak ()
 474 {
 475         auto sel = _parent->selected_audio ();
 476
 477         auto peak_dB = peak ();
 478         if (sel.size() != 1) {
 479                 _peak->SetLabel (wxT(""));
 480         } else {
 481                 peak_dB = peak ();
 482                 if (peak_dB) {
 483                         _peak->SetLabel (wxString::Format(_("Peak: %.2fdB"), *peak_dB));
 484                 } else {
 485                         _peak->SetLabel (_("Peak: unknown"));
 486                 }
 487         }
 488
 489         static auto normal = _peak->GetForegroundColour ();
 490
 491         if (peak_dB && *peak_dB > -0.5) {
 492                 _peak->SetForegroundColour (wxColour (255, 0, 0));
 493         } else if (peak_dB && *peak_dB > -3) {
 494                 _peak->SetForegroundColour (wxColour (186, 120, 0));
 495         } else {
 496                 _peak->SetForegroundColour (normal);
 497         }
 498 }
 499
 500
 501 void
 502 AudioPanel::active_jobs_changed (optional<string> old_active, optional<string> new_active)
 503 {
 504         if (old_active && *old_active == "analyse_audio") {
 505                 setup_peak ();
 506                 _mapping->Enable (true);
 507         } else if (new_active && *new_active == "analyse_audio") {
 508                 _mapping->Enable (false);
 509         }
 510 }
 511
 512
 513 void
 514 AudioPanel::reference_clicked ()
 515 {
 516         auto c = _parent->selected ();
 517         if (c.size() != 1) {
 518                 return;
 519         }
 520
 521         auto d = dynamic_pointer_cast<DCPContent>(c.front());
 522         if (!d) {
 523                 return;
 524         }
 525
 526         d->set_reference_audio (_reference->GetValue ());
 527 }
 528
 529
 530 void
 531 AudioPanel::set_film (shared_ptr<Film>)
 532 {
 533         /* We are changing film, so destroy any audio dialog for the old one */
 534         if (_audio_dialog) {
 535                 _audio_dialog->Destroy ();
 536                 _audio_dialog = nullptr;
 537         }
 538 }
 539
 540
 541 void
 542 AudioPanel::fade_in_changed ()
 543 {
 544         auto const hmsf = _fade_in->get();
 545         for (auto i: _parent->selected_audio()) {
 546                 auto const vfr = i->active_video_frame_rate(_parent->film());
 547                 i->audio->set_fade_in (dcpomatic::ContentTime(hmsf, vfr));
 548         }
 549 }
 550
 551
 552 void
 553 AudioPanel::fade_out_changed ()
 554 {
 555         auto const hmsf = _fade_out->get();
 556         for (auto i: _parent->selected_audio()) {
 557                 auto const vfr = i->active_video_frame_rate (_parent->film());
 558                 i->audio->set_fade_out (dcpomatic::ContentTime(hmsf, vfr));
 559         }
 560 }
 561
 562
 563 void
 564 AudioPanel::use_same_fades_as_video_changed ()
 565 {
 566         for (auto content: _parent->selected_audio()) {
 567                 content->audio->set_use_same_fades_as_video(_use_same_fades_as_video->GetValue());
 568         }
 569 }
 570