src/wx/audio_panel.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "audio_panel.h"
  21 #include "audio_mapping_view.h"
  22 #include "wx_util.h"
  23 #include "gain_calculator_dialog.h"
  24 #include "content_panel.h"
  25 #include "audio_dialog.h"
  26 #include "lib/config.h"
  27 #include "lib/ffmpeg_content.h"
  28 #include "lib/cinema_sound_processor.h"
  29 #include "lib/job_manager.h"
  30 #include "lib/dcp_content.h"
  31 #include <wx/spinctrl.h>
  32 #include <boost/lexical_cast.hpp>
  33 #include <boost/foreach.hpp>
  34 #include <iostream>
  35
  36 using std::vector;
  37 using std::cout;
  38 using std::string;
  39 using std::list;
  40 using std::pair;
  41 using boost::dynamic_pointer_cast;
  42 using boost::lexical_cast;
  43 using boost::shared_ptr;
  44 using boost::optional;
  45
  46 AudioPanel::AudioPanel (ContentPanel* p)
  47         : ContentSubPanel (p, _("Audio"))
  48         , _audio_dialog (0)
  49 {
  50         wxGridBagSizer* grid = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
  51         _sizer->Add (grid, 0, wxALL, 8);
  52
  53         int r = 0;
  54
  55         _reference = new wxCheckBox (this, wxID_ANY, _("Refer to existing DCP"));
  56         grid->Add (_reference, wxGBPosition (r, 0), wxGBSpan (1, 2));
  57         ++r;
  58
  59         {
  60                 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
  61                 _show = new wxButton (this, wxID_ANY, _("Show graph of audio levels..."));
  62                 s->Add (_show);
  63                 _peak = new wxStaticText (this, wxID_ANY, wxT (""));
  64                 s->Add (_peak, 0, wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT, DCPOMATIC_SIZER_X_GAP);
  65                 grid->Add (s, wxGBPosition (r, 0), wxGBSpan (1, 2));
  66                 ++r;
  67         }
  68
  69         add_label_to_grid_bag_sizer (grid, this, _("Gain"), true, wxGBPosition (r, 0));
  70         _gain = new ContentSpinCtrlDouble<AudioContent> (
  71                 this,
  72                 new wxSpinCtrlDouble (this),
  73                 AudioContentProperty::AUDIO_GAIN,
  74                 boost::mem_fn (&AudioContent::audio_gain),
  75                 boost::mem_fn (&AudioContent::set_audio_gain)
  76                 );
  77
  78         _gain->add (grid, wxGBPosition (r, 1));
  79         add_label_to_grid_bag_sizer (grid, this, _("dB"), false, wxGBPosition (r, 2));
  80         _gain_calculate_button = new wxButton (this, wxID_ANY, _("Calculate..."));
  81         grid->Add (_gain_calculate_button, wxGBPosition (r, 3));
  82         ++r;
  83
  84         add_label_to_grid_bag_sizer (grid, this, _("Delay"), true, wxGBPosition (r, 0));
  85         _delay = new ContentSpinCtrl<AudioContent> (
  86                 this,
  87                 new wxSpinCtrl (this),
  88                 AudioContentProperty::AUDIO_DELAY,
  89                 boost::mem_fn (&AudioContent::audio_delay),
  90                 boost::mem_fn (&AudioContent::set_audio_delay)
  91                 );
  92
  93         _delay->add (grid, wxGBPosition (r, 1));
  94         /// TRANSLATORS: this is an abbreviation for milliseconds, the unit of time
  95         add_label_to_grid_bag_sizer (grid, this, _("ms"), false, wxGBPosition (r, 2));
  96         ++r;
  97
  98         _mapping = new AudioMappingView (this);
  99         _sizer->Add (_mapping, 1, wxEXPAND | wxALL, 6);
 100         ++r;
 101
 102         _description = new wxStaticText (this, wxID_ANY, wxT (" \n"), wxDefaultPosition, wxDefaultSize);
 103         _sizer->Add (_description, 0, wxALL, 12);
 104         wxFont font = _description->GetFont();
 105         font.SetStyle (wxFONTSTYLE_ITALIC);
 106         font.SetPointSize (font.GetPointSize() - 1);
 107         _description->SetFont (font);
 108         ++r;
 109
 110         _gain->wrapped()->SetRange (-60, 60);
 111         _gain->wrapped()->SetDigits (1);
 112         _gain->wrapped()->SetIncrement (0.5);
 113         _delay->wrapped()->SetRange (-1000, 1000);
 114
 115         _reference->Bind             (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&AudioPanel::reference_clicked, this));
 116         _show->Bind                  (wxEVT_COMMAND_BUTTON_CLICKED,   boost::bind (&AudioPanel::show_clicked, this));
 117         _gain_calculate_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED,   boost::bind (&AudioPanel::gain_calculate_button_clicked, this));
 118
 119         _mapping_connection = _mapping->Changed.connect (boost::bind (&AudioPanel::mapping_changed, this, _1));
 120
 121         JobManager::instance()->ActiveJobsChanged.connect (boost::bind (&AudioPanel::active_jobs_changed, this, _1));
 122 }
 123
 124 AudioPanel::~AudioPanel ()
 125 {
 126         if (_audio_dialog) {
 127                 _audio_dialog->Destroy ();
 128                 _audio_dialog = 0;
 129         }
 130 }
 131
 132 void
 133 AudioPanel::film_changed (Film::Property property)
 134 {
 135         switch (property) {
 136         case Film::AUDIO_CHANNELS:
 137         case Film::AUDIO_PROCESSOR:
 138                 _mapping->set_output_channels (_parent->film()->audio_output_names ());
 139                 setup_peak ();
 140                 break;
 141         case Film::VIDEO_FRAME_RATE:
 142                 setup_description ();
 143                 break;
 144         case Film::REEL_TYPE:
 145                 setup_sensitivity ();
 146         default:
 147                 break;
 148         }
 149 }
 150
 151 void
 152 AudioPanel::film_content_changed (int property)
 153 {
 154         AudioContentList ac = _parent->selected_audio ();
 155         if (property == AudioContentProperty::AUDIO_STREAMS) {
 156                 if (ac.size() == 1) {
 157                         _mapping->set (ac.front()->audio_mapping());
 158                         _mapping->set_input_channels (ac.front()->audio_channel_names ());
 159                 } else {
 160                         _mapping->set (AudioMapping ());
 161                 }
 162                 setup_description ();
 163                 setup_peak ();
 164                 _sizer->Layout ();
 165         } else if (property == AudioContentProperty::AUDIO_GAIN) {
 166                 setup_peak ();
 167         } else if (property == DCPContentProperty::REFERENCE_AUDIO) {
 168                 if (ac.size() == 1) {
 169                         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (ac.front ());
 170                         checked_set (_reference, dcp ? dcp->reference_audio () : false);
 171                 } else {
 172                         checked_set (_reference, false);
 173                 }
 174
 175                 setup_sensitivity ();
 176         }
 177 }
 178
 179 void
 180 AudioPanel::gain_calculate_button_clicked ()
 181 {
 182         GainCalculatorDialog* d = new GainCalculatorDialog (this);
 183         int const r = d->ShowModal ();
 184
 185         if (r == wxID_CANCEL || d->wanted_fader() == 0 || d->actual_fader() == 0) {
 186                 d->Destroy ();
 187                 return;
 188         }
 189
 190         _gain->wrapped()->SetValue (
 191                 Config::instance()->cinema_sound_processor()->db_for_fader_change (
 192                         d->wanted_fader (),
 193                         d->actual_fader ()
 194                         )
 195                 );
 196
 197         /* This appears to be necessary, as the change is not signalled,
 198            I think.
 199         */
 200         _gain->view_changed ();
 201
 202         d->Destroy ();
 203 }
 204
 205 void
 206 AudioPanel::setup_description ()
 207 {
 208         AudioContentList ac = _parent->selected_audio ();
 209         if (ac.size () != 1) {
 210                 checked_set (_description, wxT (""));
 211                 return;
 212         }
 213
 214         checked_set (_description, ac.front()->processing_description ());
 215 }
 216
 217 void
 218 AudioPanel::mapping_changed (AudioMapping m)
 219 {
 220         AudioContentList c = _parent->selected_audio ();
 221         if (c.size() == 1) {
 222                 c.front()->set_audio_mapping (m);
 223         }
 224 }
 225
 226 void
 227 AudioPanel::content_selection_changed ()
 228 {
 229         AudioContentList sel = _parent->selected_audio ();
 230
 231         _gain->set_content (sel);
 232         _delay->set_content (sel);
 233
 234         film_content_changed (AudioContentProperty::AUDIO_STREAMS);
 235         film_content_changed (DCPContentProperty::REFERENCE_AUDIO);
 236
 237         setup_sensitivity ();
 238 }
 239
 240 void
 241 AudioPanel::setup_sensitivity ()
 242 {
 243         AudioContentList sel = _parent->selected_audio ();
 244
 245         shared_ptr<DCPContent> dcp;
 246         if (sel.size() == 1) {
 247                 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
 248         }
 249
 250         list<string> why_not;
 251         bool const can_reference = dcp && dcp->can_reference_audio (why_not);
 252         _reference->Enable (can_reference);
 253
 254         wxString s;
 255         if (!can_reference) {
 256                 s = _("Cannot reference this DCP.  ");
 257                 BOOST_FOREACH (string i, why_not) {
 258                         s += std_to_wx(i) + wxT("  ");
 259                 }
 260         }
 261         _reference->SetToolTip (s);
 262
 263         if (_reference->GetValue ()) {
 264                 _gain->wrapped()->Enable (false);
 265                 _gain_calculate_button->Enable (false);
 266                 _peak->Enable (false);
 267                 _delay->wrapped()->Enable (false);
 268                 _mapping->Enable (false);
 269                 _description->Enable (false);
 270         } else {
 271                 _gain->wrapped()->Enable (true);
 272                 _gain_calculate_button->Enable (sel.size() == 1);
 273                 _peak->Enable (true);
 274                 _delay->wrapped()->Enable (true);
 275                 _mapping->Enable (sel.size() == 1);
 276                 _description->Enable (true);
 277         }
 278 }
 279
 280 void
 281 AudioPanel::show_clicked ()
 282 {
 283         if (_audio_dialog) {
 284                 _audio_dialog->Destroy ();
 285                 _audio_dialog = 0;
 286         }
 287
 288         AudioContentList ac = _parent->selected_audio ();
 289         if (ac.size() != 1) {
 290                 return;
 291         }
 292
 293         _audio_dialog = new AudioDialog (this, _parent->film (), ac.front ());
 294         _audio_dialog->Show ();
 295 }
 296
 297 void
 298 AudioPanel::setup_peak ()
 299 {
 300         AudioContentList sel = _parent->selected_audio ();
 301         bool alert = false;
 302
 303         if (sel.size() != 1) {
 304                 _peak->SetLabel (wxT (""));
 305         } else {
 306                 shared_ptr<Playlist> playlist (new Playlist);
 307                 playlist->add (sel.front ());
 308                 try {
 309                         shared_ptr<AudioAnalysis> analysis (new AudioAnalysis (_parent->film()->audio_analysis_path (playlist)));
 310                         if (analysis->peak ()) {
 311                                 float const peak_dB = 20 * log10 (analysis->peak().get()) + analysis->gain_correction (playlist);
 312                                 if (peak_dB > -3) {
 313                                         alert = true;
 314                                 }
 315                                 _peak->SetLabel (wxString::Format (_("Peak: %.2fdB"), peak_dB));
 316                         } else {
 317                                 _peak->SetLabel (_("Peak: unknown"));
 318                         }
 319                 } catch (...) {
 320                         _peak->SetLabel (_("Peak: unknown"));
 321                 }
 322         }
 323
 324         static wxColour normal = _peak->GetForegroundColour ();
 325
 326         if (alert) {
 327                 _peak->SetForegroundColour (wxColour (255, 0, 0));
 328         } else {
 329                 _peak->SetForegroundColour (normal);
 330         }
 331 }
 332
 333 void
 334 AudioPanel::active_jobs_changed (optional<string> j)
 335 {
 336         if (j && *j == "analyse_audio") {
 337                 setup_peak ();
 338         }
 339 }
 340
 341 void
 342 AudioPanel::reference_clicked ()
 343 {
 344         ContentList c = _parent->selected ();
 345         if (c.size() != 1) {
 346                 return;
 347         }
 348
 349         shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (c.front ());
 350         if (!d) {
 351                 return;
 352         }
 353
 354         d->set_reference_audio (_reference->GetValue ());
 355 }