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, _("Content"), _("content"), _("DCP"), _("DCP"));
  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         bool const full = Config::instance()->interface_complexity() == Config::INTERFACE_FULL;
 122
 123         int r = 0;
 124
 125         _reference->Show (full);
 126         _reference_note->Show (full);
 127
 128         if (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
 148         _gain_calculate_button->Show (full);
 149
 150         if (full) {
 151                 _grid->Add (_gain_calculate_button, wxGBPosition(r, 2), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
 152                 ++r;
 153         }
 154
 155         _delay_label->Show (full);
 156         _delay->show (full);
 157         _delay_ms_label->Show (full);
 158
 159         if (full) {
 160                 add_label_to_sizer (_grid, _delay_label, true, wxGBPosition(r, 0));
 161                 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
 162                 s->Add (_delay->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM | wxRIGHT, 6);
 163                 s->Add (_delay_ms_label, 0, wxALIGN_CENTER_VERTICAL);
 164                 _grid->Add (s, wxGBPosition(r, 1));
 165                 ++r;
 166         }
 167 }
 168
 169 AudioPanel::~AudioPanel ()
 170 {
 171         if (_audio_dialog) {
 172                 _audio_dialog->Destroy ();
 173                 _audio_dialog = 0;
 174         }
 175 }
 176
 177 void
 178 AudioPanel::film_changed (Film::Property property)
 179 {
 180         if (!_parent->film()) {
 181                 return;
 182         }
 183
 184         switch (property) {
 185         case Film::AUDIO_CHANNELS:
 186         case Film::AUDIO_PROCESSOR:
 187                 _mapping->set_output_channels (_parent->film()->audio_output_names ());
 188                 setup_peak ();
 189                 break;
 190         case Film::VIDEO_FRAME_RATE:
 191                 setup_description ();
 192                 break;
 193         case Film::REEL_TYPE:
 194         case Film::INTEROP:
 195                 setup_sensitivity ();
 196                 break;
 197         default:
 198                 break;
 199         }
 200 }
 201
 202 void
 203 AudioPanel::film_content_changed (int property)
 204 {
 205         ContentList ac = _parent->selected_audio ();
 206         if (property == AudioContentProperty::STREAMS) {
 207                 if (ac.size() == 1) {
 208                         _mapping->set (ac.front()->audio->mapping());
 209                         _mapping->set_input_channels (ac.front()->audio->channel_names ());
 210
 211                         vector<AudioMappingView::Group> groups;
 212                         int c = 0;
 213                         BOOST_FOREACH (shared_ptr<const AudioStream> i, ac.front()->audio->streams()) {
 214                                 shared_ptr<const FFmpegAudioStream> f = dynamic_pointer_cast<const FFmpegAudioStream> (i);
 215                                 string name = "";
 216                                 if (f) {
 217                                         name = f->name;
 218                                         if (f->codec_name) {
 219                                                 name += " (" + f->codec_name.get() + ")";
 220                                         }
 221                                 }
 222                                 groups.push_back (AudioMappingView::Group (c, c + i->channels() - 1, name));
 223                                 c += i->channels ();
 224                         }
 225                         _mapping->set_input_groups (groups);
 226
 227                 } else {
 228                         _mapping->set (AudioMapping ());
 229                 }
 230                 setup_description ();
 231                 setup_peak ();
 232                 _sizer->Layout ();
 233         } else if (property == AudioContentProperty::GAIN) {
 234                 setup_peak ();
 235         } else if (property == DCPContentProperty::REFERENCE_AUDIO) {
 236                 if (ac.size() == 1) {
 237                         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (ac.front ());
 238                         checked_set (_reference, dcp ? dcp->reference_audio () : false);
 239                 } else {
 240                         checked_set (_reference, false);
 241                 }
 242
 243                 setup_sensitivity ();
 244         } else if (property == ContentProperty::VIDEO_FRAME_RATE) {
 245                 setup_description ();
 246         }
 247 }
 248
 249 void
 250 AudioPanel::gain_calculate_button_clicked ()
 251 {
 252         GainCalculatorDialog* d = new GainCalculatorDialog (this);
 253         int const r = d->ShowModal ();
 254         optional<float> c = d->db_change();
 255
 256         if (r == wxID_CANCEL || !c) {
 257                 d->Destroy ();
 258                 return;
 259         }
 260
 261         _gain->wrapped()->SetValue (*c);
 262
 263         /* This appears to be necessary, as the change is not signalled,
 264            I think.
 265         */
 266         _gain->view_changed ();
 267
 268         d->Destroy ();
 269 }
 270
 271 void
 272 AudioPanel::setup_description ()
 273 {
 274         ContentList ac = _parent->selected_audio ();
 275         if (ac.size () != 1) {
 276                 checked_set (_description, wxT (""));
 277                 return;
 278         }
 279
 280         checked_set (_description, ac.front()->audio->processing_description(_parent->film()));
 281 }
 282
 283 void
 284 AudioPanel::mapping_changed (AudioMapping m)
 285 {
 286         ContentList c = _parent->selected_audio ();
 287         if (c.size() == 1) {
 288                 c.front()->audio->set_mapping (m);
 289         }
 290 }
 291
 292 void
 293 AudioPanel::content_selection_changed ()
 294 {
 295         ContentList sel = _parent->selected_audio ();
 296
 297         _gain->set_content (sel);
 298         _delay->set_content (sel);
 299
 300         film_content_changed (AudioContentProperty::STREAMS);
 301         film_content_changed (AudioContentProperty::GAIN);
 302         film_content_changed (DCPContentProperty::REFERENCE_AUDIO);
 303
 304         setup_sensitivity ();
 305 }
 306
 307 void
 308 AudioPanel::setup_sensitivity ()
 309 {
 310         ContentList sel = _parent->selected_audio ();
 311
 312         shared_ptr<DCPContent> dcp;
 313         if (sel.size() == 1) {
 314                 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
 315         }
 316
 317         string why_not;
 318         bool const can_reference = dcp && dcp->can_reference_audio (_parent->film(), why_not);
 319         setup_refer_button (_reference, _reference_note, dcp, can_reference, why_not);
 320
 321         if (_reference->GetValue ()) {
 322                 _gain->wrapped()->Enable (false);
 323                 _gain_calculate_button->Enable (false);
 324                 _show->Enable (true);
 325                 _peak->Enable (false);
 326                 _delay->wrapped()->Enable (false);
 327                 _mapping->Enable (false);
 328                 _description->Enable (false);
 329         } else {
 330                 _gain->wrapped()->Enable (sel.size() == 1);
 331                 _gain_calculate_button->Enable (sel.size() == 1);
 332                 _show->Enable (sel.size() == 1);
 333                 _peak->Enable (sel.size() == 1);
 334                 _delay->wrapped()->Enable (sel.size() == 1);
 335                 _mapping->Enable (sel.size() == 1);
 336                 _description->Enable (sel.size() == 1);
 337         }
 338 }
 339
 340 void
 341 AudioPanel::show_clicked ()
 342 {
 343         if (_audio_dialog) {
 344                 _audio_dialog->Destroy ();
 345                 _audio_dialog = 0;
 346         }
 347
 348         ContentList ac = _parent->selected_audio ();
 349         if (ac.size() != 1) {
 350                 return;
 351         }
 352
 353         _audio_dialog = new AudioDialog (this, _parent->film (), ac.front ());
 354         _audio_dialog->Show ();
 355 }
 356
 357 void
 358 AudioPanel::setup_peak ()
 359 {
 360         ContentList sel = _parent->selected_audio ();
 361         optional<float> peak_dB;
 362
 363         if (sel.size() != 1) {
 364                 _peak->SetLabel (wxT (""));
 365         } else {
 366                 shared_ptr<Playlist> playlist (new Playlist);
 367                 playlist->add (_parent->film(), sel.front());
 368                 try {
 369                         shared_ptr<AudioAnalysis> analysis (new AudioAnalysis (_parent->film()->audio_analysis_path (playlist)));
 370                         peak_dB = 20 * log10 (analysis->overall_sample_peak().first.peak) + analysis->gain_correction (playlist);
 371                         _peak->SetLabel (wxString::Format (_("Peak: %.2fdB"), *peak_dB));
 372                 } catch (...) {
 373                         _peak->SetLabel (_("Peak: unknown"));
 374                 }
 375         }
 376
 377         static wxColour normal = _peak->GetForegroundColour ();
 378
 379         if (peak_dB && *peak_dB > -0.5) {
 380                 _peak->SetForegroundColour (wxColour (255, 0, 0));
 381         } else if (peak_dB && *peak_dB > -3) {
 382                 _peak->SetForegroundColour (wxColour (186, 120, 0));
 383         } else {
 384                 _peak->SetForegroundColour (normal);
 385         }
 386 }
 387
 388 void
 389 AudioPanel::active_jobs_changed (optional<string> old_active, optional<string> new_active)
 390 {
 391         if (old_active && *old_active == "analyse_audio") {
 392                 setup_peak ();
 393                 _mapping->Enable (true);
 394         } else if (new_active && *new_active == "analyse_audio") {
 395                 _mapping->Enable (false);
 396         }
 397 }
 398
 399 void
 400 AudioPanel::reference_clicked ()
 401 {
 402         ContentList c = _parent->selected ();
 403         if (c.size() != 1) {
 404                 return;
 405         }
 406
 407         shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (c.front ());
 408         if (!d) {
 409                 return;
 410         }
 411
 412         d->set_reference_audio (_reference->GetValue ());
 413 }
 414
 415 void
 416 AudioPanel::set_film (shared_ptr<Film>)
 417 {
 418         /* We are changing film, so destroy any audio dialog for the old one */
 419         if (_audio_dialog) {
 420                 _audio_dialog->Destroy ();
 421                 _audio_dialog = 0;
 422         }
 423 }