src/wx/audio_panel.cc

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