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 CheckBox(this, _("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(&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(&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         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 void
 199 AudioPanel::film_changed (Film::Property property)
 200 {
 201         if (!_parent->film()) {
 202                 return;
 203         }
 204
 205         switch (property) {
 206         case Film::Property::AUDIO_CHANNELS:
 207         case Film::Property::AUDIO_PROCESSOR:
 208                 _mapping->set_output_channels (_parent->film()->audio_output_names ());
 209                 setup_peak ();
 210                 break;
 211         case Film::Property::VIDEO_FRAME_RATE:
 212                 setup_description ();
 213                 break;
 214         case Film::Property::REEL_TYPE:
 215         case Film::Property::INTEROP:
 216                 setup_sensitivity ();
 217                 break;
 218         default:
 219                 break;
 220         }
 221 }
 222
 223
 224 void
 225 AudioPanel::film_content_changed (int property)
 226 {
 227         auto ac = _parent->selected_audio ();
 228         if (property == AudioContentProperty::STREAMS) {
 229                 if (ac.size() == 1) {
 230                         _mapping->set (ac.front()->audio->mapping());
 231                         _mapping->set_input_channels (ac.front()->audio->channel_names ());
 232
 233                         vector<AudioMappingView::Group> groups;
 234                         int c = 0;
 235                         for (auto i: ac.front()->audio->streams()) {
 236                                 auto f = dynamic_pointer_cast<const FFmpegAudioStream> (i);
 237                                 string name = "";
 238                                 if (f) {
 239                                         name = f->name;
 240                                         if (f->codec_name) {
 241                                                 name += " (" + f->codec_name.get() + ")";
 242                                         }
 243                                 }
 244                                 groups.push_back (AudioMappingView::Group (c, c + i->channels() - 1, name));
 245                                 c += i->channels ();
 246                         }
 247                         _mapping->set_input_groups (groups);
 248
 249                 } else {
 250                         _mapping->set (AudioMapping ());
 251                 }
 252                 setup_description ();
 253                 setup_peak ();
 254                 layout ();
 255         } else if (property == AudioContentProperty::GAIN) {
 256                 /* This is a bit aggressive but probably not so bad */
 257                 _peak_cache.clear();
 258                 setup_peak ();
 259         } else if (property == DCPContentProperty::REFERENCE_AUDIO) {
 260                 if (ac.size() == 1) {
 261                         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (ac.front ());
 262                         checked_set (_reference, dcp ? dcp->reference_audio () : false);
 263                 } else {
 264                         checked_set (_reference, false);
 265                 }
 266
 267                 setup_sensitivity ();
 268         } else if (property == ContentProperty::VIDEO_FRAME_RATE) {
 269                 setup_description ();
 270         } else if (property == AudioContentProperty::FADE_IN) {
 271                 set<Frame> check;
 272                 for (auto i: ac) {
 273                         check.insert (i->audio->fade_in().get());
 274                 }
 275
 276                 if (check.size() == 1) {
 277                         _fade_in->set (
 278                                 ac.front()->audio->fade_in(),
 279                                 ac.front()->active_video_frame_rate(_parent->film())
 280                                 );
 281                 } else {
 282                         _fade_in->clear ();
 283                 }
 284         } else if (property == AudioContentProperty::FADE_OUT) {
 285                 set<Frame> check;
 286                 for (auto i: ac) {
 287                         check.insert (i->audio->fade_out().get());
 288                 }
 289
 290                 if (check.size() == 1) {
 291                         _fade_out->set (
 292                                 ac.front()->audio->fade_out(),
 293                                 ac.front()->active_video_frame_rate(_parent->film())
 294                                 );
 295                 } else {
 296                         _fade_out->clear ();
 297                 }
 298         } else if (property == AudioContentProperty::USE_SAME_FADES_AS_VIDEO) {
 299                 setup_sensitivity ();
 300         }
 301 }
 302
 303
 304 void
 305 AudioPanel::gain_calculate_button_clicked ()
 306 {
 307         GainCalculatorDialog dialog(this);
 308         auto const r = dialog.ShowModal();
 309         auto change = dialog.db_change();
 310
 311         if (r == wxID_CANCEL || !change) {
 312                 return;
 313         }
 314
 315         auto old_peak_dB = peak ();
 316         auto old_value = _gain->wrapped()->GetValue();
 317         _gain->wrapped()->SetValue(old_value + *change);
 318
 319         /* This appears to be necessary, as the change is not signalled,
 320            I think.
 321         */
 322         _gain->view_changed ();
 323
 324         auto peak_dB = peak ();
 325         if (old_peak_dB && *old_peak_dB < -0.5 && peak_dB && *peak_dB > -0.5) {
 326                 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."));
 327                 _gain->wrapped()->SetValue (old_value);
 328                 _gain->view_changed ();
 329         }
 330 }
 331
 332
 333 void
 334 AudioPanel::setup_description ()
 335 {
 336         auto ac = _parent->selected_audio ();
 337         if (ac.size () != 1) {
 338                 checked_set (_description, wxT (""));
 339                 return;
 340         }
 341
 342         checked_set (_description, ac.front()->audio->processing_description(_parent->film()));
 343 }
 344
 345
 346 void
 347 AudioPanel::mapping_changed (AudioMapping m)
 348 {
 349         auto c = _parent->selected_audio ();
 350         if (c.size() == 1) {
 351                 c.front()->audio->set_mapping (m);
 352         }
 353 }
 354
 355
 356 void
 357 AudioPanel::content_selection_changed ()
 358 {
 359         auto sel = _parent->selected_audio ();
 360
 361         _gain->set_content (sel);
 362         _delay->set_content (sel);
 363
 364         film_content_changed (AudioContentProperty::STREAMS);
 365         film_content_changed (AudioContentProperty::GAIN);
 366         film_content_changed (AudioContentProperty::FADE_IN);
 367         film_content_changed (AudioContentProperty::FADE_OUT);
 368         film_content_changed (AudioContentProperty::USE_SAME_FADES_AS_VIDEO);
 369         film_content_changed (DCPContentProperty::REFERENCE_AUDIO);
 370
 371         setup_sensitivity ();
 372 }
 373
 374
 375 void
 376 AudioPanel::setup_sensitivity ()
 377 {
 378         auto sel = _parent->selected_audio ();
 379
 380         shared_ptr<DCPContent> dcp;
 381         if (sel.size() == 1) {
 382                 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
 383         }
 384
 385         string why_not;
 386         bool const can_reference = dcp && dcp->can_reference_audio (_parent->film(), why_not);
 387         wxString cannot;
 388         if (why_not.empty()) {
 389                 cannot = _("Cannot reference this DCP's audio.");
 390         } else {
 391                 cannot = _("Cannot reference this DCP's audio: ") + std_to_wx(why_not);
 392         }
 393         setup_refer_button (_reference, _reference_note, dcp, can_reference, cannot);
 394
 395         auto const ref = _reference->GetValue();
 396         auto const single = sel.size() == 1;
 397
 398         auto const all_have_video = std::all_of(sel.begin(), sel.end(), [](shared_ptr<const Content> c) { return static_cast<bool>(c->video); });
 399
 400         _gain->wrapped()->Enable (!ref);
 401         _gain_calculate_button->Enable (!ref && single);
 402         _show->Enable (single);
 403         _peak->Enable (!ref && single);
 404         _delay->wrapped()->Enable (!ref);
 405         _mapping->Enable (!ref && single);
 406         _description->Enable (!ref && single);
 407         _fade_in->Enable (!_use_same_fades_as_video->GetValue());
 408         _fade_out->Enable (!_use_same_fades_as_video->GetValue());
 409         _use_same_fades_as_video->Enable (!ref && all_have_video);
 410 }
 411
 412
 413 void
 414 AudioPanel::show_clicked ()
 415 {
 416         _audio_dialog.reset();
 417
 418         auto ac = _parent->selected_audio ();
 419         if (ac.size() != 1) {
 420                 return;
 421         }
 422
 423         _audio_dialog.reset(this, _parent->film(), _parent->film_viewer(), ac.front());
 424         _audio_dialog->Show ();
 425 }
 426
 427
 428 /** @return If there is one selected piece of audio content, return its peak value in dB (if known) */
 429 optional<float>
 430 AudioPanel::peak () const
 431 {
 432         optional<float> peak_dB;
 433
 434         auto sel = _parent->selected_audio ();
 435         if (sel.size() == 1) {
 436                 auto playlist = make_shared<Playlist>();
 437                 playlist->add (_parent->film(), sel.front());
 438                 try {
 439                         /* Loading the audio analysis file is slow, and this ::peak() is called a few times when
 440                          * the content selection is changed, so cache it.
 441                          */
 442                         auto const path = _parent->film()->audio_analysis_path(playlist);
 443                         auto cached = _peak_cache.find(path);
 444                         if (cached != _peak_cache.end()) {
 445                                 peak_dB = cached->second;
 446                         } else {
 447                                 auto analysis = make_shared<AudioAnalysis>(path);
 448                                 peak_dB = linear_to_db(analysis->overall_sample_peak().first.peak) + analysis->gain_correction(playlist);
 449                                 _peak_cache[path] = *peak_dB;
 450                         }
 451                 } catch (...) {
 452
 453                 }
 454         }
 455
 456         return peak_dB;
 457 }
 458
 459
 460 void
 461 AudioPanel::setup_peak ()
 462 {
 463         auto sel = _parent->selected_audio ();
 464
 465         auto peak_dB = peak ();
 466         if (sel.size() != 1) {
 467                 _peak->SetLabel (wxT(""));
 468         } else {
 469                 peak_dB = peak ();
 470                 if (peak_dB) {
 471                         _peak->SetLabel (wxString::Format(_("Peak: %.2fdB"), *peak_dB));
 472                 } else {
 473                         _peak->SetLabel (_("Peak: unknown"));
 474                 }
 475         }
 476
 477         static auto normal = _peak->GetForegroundColour ();
 478
 479         if (peak_dB && *peak_dB > -0.5) {
 480                 _peak->SetForegroundColour (wxColour (255, 0, 0));
 481         } else if (peak_dB && *peak_dB > -3) {
 482                 _peak->SetForegroundColour (wxColour (186, 120, 0));
 483         } else {
 484                 _peak->SetForegroundColour (normal);
 485         }
 486 }
 487
 488
 489 void
 490 AudioPanel::active_jobs_changed (optional<string> old_active, optional<string> new_active)
 491 {
 492         if (old_active && *old_active == "analyse_audio") {
 493                 setup_peak ();
 494                 _mapping->Enable (true);
 495         } else if (new_active && *new_active == "analyse_audio") {
 496                 _mapping->Enable (false);
 497         }
 498 }
 499
 500
 501 void
 502 AudioPanel::reference_clicked ()
 503 {
 504         auto c = _parent->selected ();
 505         if (c.size() != 1) {
 506                 return;
 507         }
 508
 509         auto d = dynamic_pointer_cast<DCPContent>(c.front());
 510         if (!d) {
 511                 return;
 512         }
 513
 514         d->set_reference_audio (_reference->GetValue ());
 515 }
 516
 517
 518 void
 519 AudioPanel::set_film (shared_ptr<Film>)
 520 {
 521         /* We are changing film, so destroy any audio dialog for the old one */
 522         _audio_dialog.reset();
 523 }
 524
 525
 526 void
 527 AudioPanel::fade_in_changed ()
 528 {
 529         auto const hmsf = _fade_in->get();
 530         for (auto i: _parent->selected_audio()) {
 531                 auto const vfr = i->active_video_frame_rate(_parent->film());
 532                 i->audio->set_fade_in (dcpomatic::ContentTime(hmsf, vfr));
 533         }
 534 }
 535
 536
 537 void
 538 AudioPanel::fade_out_changed ()
 539 {
 540         auto const hmsf = _fade_out->get();
 541         for (auto i: _parent->selected_audio()) {
 542                 auto const vfr = i->active_video_frame_rate (_parent->film());
 543                 i->audio->set_fade_out (dcpomatic::ContentTime(hmsf, vfr));
 544         }
 545 }
 546
 547
 548 void
 549 AudioPanel::use_same_fades_as_video_changed ()
 550 {
 551         for (auto content: _parent->selected_audio()) {
 552                 content->audio->set_use_same_fades_as_video(_use_same_fades_as_video->GetValue());
 553         }
 554 }
 555