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