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