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