Apply fader-based gain calculations to the current gain, not 0dB.
[dcpomatic.git] / src / wx / audio_panel.cc
index 82604763c8e690b8e3c884703617794b2e475b6f..5523d25393088196d88655581121b43f740c6522 100644 (file)
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
-#include <boost/lexical_cast.hpp>
-#include <wx/spinctrl.h>
-#include "lib/config.h"
-#include "lib/ffmpeg_content.h"
-#include "lib/ffmpeg_audio_stream.h"
-#include "lib/audio_processor.h"
-#include "lib/cinema_sound_processor.h"
-#include "audio_dialog.h"
 #include "audio_panel.h"
 #include "audio_mapping_view.h"
 #include "wx_util.h"
 #include "gain_calculator_dialog.h"
 #include "content_panel.h"
+#include "audio_dialog.h"
+#include "static_text.h"
+#include "check_box.h"
+#include "dcpomatic_button.h"
+#include "lib/config.h"
+#include "lib/ffmpeg_audio_stream.h"
+#include "lib/ffmpeg_content.h"
+#include "lib/cinema_sound_processor.h"
+#include "lib/job_manager.h"
+#include "lib/dcp_content.h"
+#include "lib/audio_content.h"
+#include <wx/spinctrl.h>
+#include <boost/foreach.hpp>
+#include <iostream>
 
 using std::vector;
 using std::cout;
 using std::string;
 using std::list;
+using std::pair;
 using boost::dynamic_pointer_cast;
-using boost::lexical_cast;
 using boost::shared_ptr;
+using boost::optional;
 
 AudioPanel::AudioPanel (ContentPanel* p)
        : ContentSubPanel (p, _("Audio"))
        , _audio_dialog (0)
 {
-       wxGridBagSizer* grid = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
-       _sizer->Add (grid, 0, wxALL, 8);
-
-       int r = 0;
-
-       _show = new wxButton (this, wxID_ANY, _("Show Audio..."));
-       grid->Add (_show, wxGBPosition (r, 0));
-       ++r;
-
-       add_label_to_grid_bag_sizer (grid, this, _("Gain"), true, wxGBPosition (r, 0));
+       _reference = new CheckBox (this, _("Use this DCP's audio as OV and make VF"));
+       _reference_note = new StaticText (this, wxT(""));
+       _reference_note->Wrap (200);
+       wxFont font = _reference_note->GetFont();
+       font.SetStyle(wxFONTSTYLE_ITALIC);
+       font.SetPointSize(font.GetPointSize() - 1);
+       _reference_note->SetFont(font);
+
+       _show = new Button (this, _("Show graph of audio levels..."));
+       _peak = new StaticText (this, wxT (""));
+
+       _gain_label = create_label (this, _("Gain"), true);
        _gain = new ContentSpinCtrlDouble<AudioContent> (
                this,
                new wxSpinCtrlDouble (this),
-               AudioContentProperty::AUDIO_GAIN,
-               boost::mem_fn (&AudioContent::audio_gain),
-               boost::mem_fn (&AudioContent::set_audio_gain)
+               AudioContentProperty::GAIN,
+               &Content::audio,
+               boost::mem_fn (&AudioContent::gain),
+               boost::mem_fn (&AudioContent::set_gain)
                );
-       
-       _gain->add (grid, wxGBPosition (r, 1));
-       add_label_to_grid_bag_sizer (grid, this, _("dB"), false, wxGBPosition (r, 2));
-       _gain_calculate_button = new wxButton (this, wxID_ANY, _("Calculate..."));
-       grid->Add (_gain_calculate_button, wxGBPosition (r, 3));
-       ++r;
 
-       add_label_to_grid_bag_sizer (grid, this, _("Delay"), true, wxGBPosition (r, 0));
+       _gain_db_label = create_label (this, _("dB"), false);
+       _gain_calculate_button = new Button (this, _("Calculate..."));
+
+       _delay_label = create_label (this, _("Delay"), true);
        _delay = new ContentSpinCtrl<AudioContent> (
                this,
                new wxSpinCtrl (this),
-               AudioContentProperty::AUDIO_DELAY,
-               boost::mem_fn (&AudioContent::audio_delay),
-               boost::mem_fn (&AudioContent::set_audio_delay)
+               AudioContentProperty::DELAY,
+               &Content::audio,
+               boost::mem_fn (&AudioContent::delay),
+               boost::mem_fn (&AudioContent::set_delay)
                );
-       
-       _delay->add (grid, wxGBPosition (r, 1));
-       /// TRANSLATORS: this is an abbreviation for milliseconds, the unit of time
-       add_label_to_grid_bag_sizer (grid, this, _("ms"), false, wxGBPosition (r, 2));
-       ++r;
 
-       add_label_to_grid_bag_sizer (grid, this, _("Stream"), true, wxGBPosition (r, 0));
-       _stream = new wxChoice (this, wxID_ANY);
-       grid->Add (_stream, wxGBPosition (r, 1), wxGBSpan (1, 3), wxEXPAND);
-       ++r;
+       /// TRANSLATORS: this is an abbreviation for milliseconds, the unit of time
+       _delay_ms_label = create_label (this, _("ms"), false);
 
-       add_label_to_grid_bag_sizer (grid, this, _("Process with"), true, wxGBPosition (r, 0));
-       _processor = new wxChoice (this, wxID_ANY);
-       setup_processors ();
-       grid->Add (_processor, wxGBPosition (r, 1), wxGBSpan (1, 3), wxEXPAND);
-       ++r;
-       
-       _mapping = new AudioMappingView (this);
+       _mapping = new AudioMappingView (this, _("Content"), _("content"), _("DCP"), _("DCP"));
        _sizer->Add (_mapping, 1, wxEXPAND | wxALL, 6);
 
+       _description = new StaticText (this, wxT(" \n"), wxDefaultPosition, wxDefaultSize);
+       _sizer->Add (_description, 0, wxALL, 12);
+       _description->SetFont (font);
+
        _gain->wrapped()->SetRange (-60, 60);
        _gain->wrapped()->SetDigits (1);
        _gain->wrapped()->SetIncrement (0.5);
        _delay->wrapped()->SetRange (-1000, 1000);
 
-       _stream->Bind                (wxEVT_COMMAND_CHOICE_SELECTED, boost::bind (&AudioPanel::stream_changed, this));
-       _show->Bind                  (wxEVT_COMMAND_BUTTON_CLICKED,  boost::bind (&AudioPanel::show_clicked, this));
-       _gain_calculate_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED,  boost::bind (&AudioPanel::gain_calculate_button_clicked, this));
-       _processor->Bind             (wxEVT_COMMAND_CHOICE_SELECTED, boost::bind (&AudioPanel::processor_changed, this));
+       content_selection_changed ();
+       film_changed (Film::AUDIO_CHANNELS);
+       film_changed (Film::VIDEO_FRAME_RATE);
+       film_changed (Film::REEL_TYPE);
+
+       _reference->Bind             (wxEVT_CHECKBOX, boost::bind (&AudioPanel::reference_clicked, this));
+       _show->Bind                  (wxEVT_BUTTON,   boost::bind (&AudioPanel::show_clicked, this));
+       _gain_calculate_button->Bind (wxEVT_BUTTON,   boost::bind (&AudioPanel::gain_calculate_button_clicked, this));
 
-       _mapping->Changed.connect (boost::bind (&AudioPanel::mapping_changed, this, _1));
+       _mapping_connection = _mapping->Changed.connect (boost::bind (&AudioPanel::mapping_changed, this, _1));
+       _active_jobs_connection = JobManager::instance()->ActiveJobsChanged.connect (boost::bind (&AudioPanel::active_jobs_changed, this, _1, _2));
+
+       add_to_grid ();
 }
 
+void
+AudioPanel::add_to_grid ()
+{
+       bool const full = Config::instance()->interface_complexity() == Config::INTERFACE_FULL;
+
+       int r = 0;
+
+       _reference->Show (full);
+       _reference_note->Show (full);
+
+       if (full) {
+               wxBoxSizer* reference_sizer = new wxBoxSizer (wxVERTICAL);
+               reference_sizer->Add (_reference, 0);
+               reference_sizer->Add (_reference_note, 0);
+               _grid->Add (reference_sizer, wxGBPosition(r, 0), wxGBSpan(1, 4));
+               ++r;
+       }
+
+       _grid->Add (_show, wxGBPosition (r, 0), wxGBSpan (1, 2));
+       _grid->Add (_peak, wxGBPosition (r, 2), wxGBSpan (1, 2), wxALIGN_CENTER_VERTICAL);
+       ++r;
+
+       add_label_to_sizer (_grid, _gain_label, true, wxGBPosition(r, 0));
+       {
+               wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
+               s->Add (_gain->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM | wxRIGHT, 6);
+               s->Add (_gain_db_label, 0, wxALIGN_CENTER_VERTICAL);
+               _grid->Add (s, wxGBPosition(r, 1));
+       }
+
+       _gain_calculate_button->Show (full);
+
+       if (full) {
+               _grid->Add (_gain_calculate_button, wxGBPosition(r, 2), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
+               ++r;
+       }
+
+       _delay_label->Show (full);
+       _delay->show (full);
+       _delay_ms_label->Show (full);
+
+       if (full) {
+               add_label_to_sizer (_grid, _delay_label, true, wxGBPosition(r, 0));
+               wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
+               s->Add (_delay->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM | wxRIGHT, 6);
+               s->Add (_delay_ms_label, 0, wxALIGN_CENTER_VERTICAL);
+               _grid->Add (s, wxGBPosition(r, 1));
+               ++r;
+       }
+}
+
+AudioPanel::~AudioPanel ()
+{
+       if (_audio_dialog) {
+               _audio_dialog->Destroy ();
+               _audio_dialog = 0;
+       }
+}
 
 void
 AudioPanel::film_changed (Film::Property property)
 {
+       if (!_parent->film()) {
+               return;
+       }
+
        switch (property) {
        case Film::AUDIO_CHANNELS:
-               _mapping->set_channels (_parent->film()->audio_channels ());
-               _sizer->Layout ();
+       case Film::AUDIO_PROCESSOR:
+               _mapping->set_output_channels (_parent->film()->audio_output_names ());
+               setup_peak ();
+               break;
+       case Film::VIDEO_FRAME_RATE:
+               setup_description ();
+               break;
+       case Film::REEL_TYPE:
+       case Film::INTEROP:
+               setup_sensitivity ();
                break;
        default:
                break;
@@ -125,38 +202,47 @@ AudioPanel::film_changed (Film::Property property)
 void
 AudioPanel::film_content_changed (int property)
 {
-       AudioContentList ac = _parent->selected_audio ();
-       shared_ptr<AudioContent> acs;
-       shared_ptr<FFmpegContent> fcs;
-       if (ac.size() == 1) {
-               acs = ac.front ();
-               fcs = dynamic_pointer_cast<FFmpegContent> (acs);
-       }
-       
-       if (property == AudioContentProperty::AUDIO_MAPPING) {
-               _mapping->set (acs ? acs->audio_mapping () : AudioMapping ());
-               _sizer->Layout ();
-       } else if (property == FFmpegContentProperty::AUDIO_STREAM) {
-               _mapping->set (acs ? acs->audio_mapping () : AudioMapping ());
-               _sizer->Layout ();
-       } else if (property == FFmpegContentProperty::AUDIO_STREAMS) {
-               _stream->Clear ();
-               if (fcs) {
-                       vector<shared_ptr<FFmpegAudioStream> > a = fcs->audio_streams ();
-                       for (vector<shared_ptr<FFmpegAudioStream> >::iterator i = a.begin(); i != a.end(); ++i) {
-                               _stream->Append (std_to_wx ((*i)->name), new wxStringClientData (std_to_wx ((*i)->identifier ())));
-                       }
-                       
-                       if (fcs->audio_stream()) {
-                               checked_set (_stream, fcs->audio_stream()->identifier ());
+       ContentList ac = _parent->selected_audio ();
+       if (property == AudioContentProperty::STREAMS) {
+               if (ac.size() == 1) {
+                       _mapping->set (ac.front()->audio->mapping());
+                       _mapping->set_input_channels (ac.front()->audio->channel_names ());
+
+                       vector<AudioMappingView::Group> groups;
+                       int c = 0;
+                       BOOST_FOREACH (shared_ptr<const AudioStream> i, ac.front()->audio->streams()) {
+                               shared_ptr<const FFmpegAudioStream> f = dynamic_pointer_cast<const FFmpegAudioStream> (i);
+                               string name = "";
+                               if (f) {
+                                       name = f->name;
+                                       if (f->codec_name) {
+                                               name += " (" + f->codec_name.get() + ")";
+                                       }
+                               }
+                               groups.push_back (AudioMappingView::Group (c, c + i->channels() - 1, name));
+                               c += i->channels ();
                        }
+                       _mapping->set_input_groups (groups);
+
+               } else {
+                       _mapping->set (AudioMapping ());
                }
-       } else if (property == AudioContentProperty::AUDIO_PROCESSOR) {
-               if (acs) {
-                       checked_set (_processor, acs->audio_processor() ? acs->audio_processor()->id() : N_("none"));
+               setup_description ();
+               setup_peak ();
+               _sizer->Layout ();
+       } else if (property == AudioContentProperty::GAIN) {
+               setup_peak ();
+       } else if (property == DCPContentProperty::REFERENCE_AUDIO) {
+               if (ac.size() == 1) {
+                       shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (ac.front ());
+                       checked_set (_reference, dcp ? dcp->reference_audio () : false);
                } else {
-                       checked_set (_processor, N_("none"));
+                       checked_set (_reference, false);
                }
+
+               setup_sensitivity ();
+       } else if (property == ContentProperty::VIDEO_FRAME_RATE) {
+               setup_description ();
        }
 }
 
@@ -164,139 +250,180 @@ void
 AudioPanel::gain_calculate_button_clicked ()
 {
        GainCalculatorDialog* d = new GainCalculatorDialog (this);
-       d->ShowModal ();
+       int const r = d->ShowModal ();
+       optional<float> c = d->db_change();
 
-       if (d->wanted_fader() == 0 || d->actual_fader() == 0) {
+       if (r == wxID_CANCEL || !c) {
                d->Destroy ();
                return;
        }
-       
-       _gain->wrapped()->SetValue (
-               Config::instance()->cinema_sound_processor()->db_for_fader_change (
-                       d->wanted_fader (),
-                       d->actual_fader ()
-                       )
-               );
+
+       _gain->wrapped()->SetValue(_gain->wrapped()->GetValue() + *c);
 
        /* This appears to be necessary, as the change is not signalled,
           I think.
        */
        _gain->view_changed ();
-       
+
        d->Destroy ();
 }
 
 void
-AudioPanel::show_clicked ()
+AudioPanel::setup_description ()
 {
-       if (_audio_dialog) {
-               _audio_dialog->Destroy ();
-               _audio_dialog = 0;
-       }
-
-       AudioContentList ac = _parent->selected_audio ();
-       if (ac.size() != 1) {
+       ContentList ac = _parent->selected_audio ();
+       if (ac.size () != 1) {
+               checked_set (_description, wxT (""));
                return;
        }
-       
-       _audio_dialog = new AudioDialog (this);
-       _audio_dialog->Show ();
-       _audio_dialog->set_content (ac.front ());
+
+       checked_set (_description, ac.front()->audio->processing_description(_parent->film()));
 }
 
 void
-AudioPanel::stream_changed ()
+AudioPanel::mapping_changed (AudioMapping m)
 {
-       FFmpegContentList fc = _parent->selected_ffmpeg ();
-       if (fc.size() != 1) {
-               return;
+       ContentList c = _parent->selected_audio ();
+       if (c.size() == 1) {
+               c.front()->audio->set_mapping (m);
        }
+}
 
-       shared_ptr<FFmpegContent> fcs = fc.front ();
-       
-       if (_stream->GetSelection() == -1) {
-               return;
-       }
-       
-       vector<shared_ptr<FFmpegAudioStream> > a = fcs->audio_streams ();
-       vector<shared_ptr<FFmpegAudioStream> >::iterator i = a.begin ();
-       string const s = string_client_data (_stream->GetClientObject (_stream->GetSelection ()));
-       while (i != a.end() && (*i)->identifier () != s) {
-               ++i;
-       }
+void
+AudioPanel::content_selection_changed ()
+{
+       ContentList sel = _parent->selected_audio ();
 
-       if (i != a.end ()) {
-               fcs->set_audio_stream (*i);
-       }
+       _gain->set_content (sel);
+       _delay->set_content (sel);
+
+       film_content_changed (AudioContentProperty::STREAMS);
+       film_content_changed (AudioContentProperty::GAIN);
+       film_content_changed (DCPContentProperty::REFERENCE_AUDIO);
+
+       setup_sensitivity ();
 }
 
 void
-AudioPanel::processor_changed ()
+AudioPanel::setup_sensitivity ()
 {
-       string const s = string_client_data (_processor->GetClientObject (_processor->GetSelection ()));
-       AudioProcessor const * p = 0;
-       if (s != wx_to_std (N_("none"))) {
-               p = AudioProcessor::from_id (s);
+       ContentList sel = _parent->selected_audio ();
+
+       shared_ptr<DCPContent> dcp;
+       if (sel.size() == 1) {
+               dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
        }
-               
-       AudioContentList c = _parent->selected_audio ();
-       for (AudioContentList::const_iterator i = c.begin(); i != c.end(); ++i) {
-               (*i)->set_audio_processor (p);
+
+       string why_not;
+       bool const can_reference = dcp && dcp->can_reference_audio (_parent->film(), why_not);
+       wxString cannot;
+       if (why_not.empty()) {
+               cannot = _("Cannot reference this DCP's audio.");
+       } else {
+               cannot = _("Cannot reference this DCP's audio: ") + std_to_wx(why_not);
+       }
+       setup_refer_button (_reference, _reference_note, dcp, can_reference, cannot);
+
+       if (_reference->GetValue ()) {
+               _gain->wrapped()->Enable (false);
+               _gain_calculate_button->Enable (false);
+               _show->Enable (true);
+               _peak->Enable (false);
+               _delay->wrapped()->Enable (false);
+               _mapping->Enable (false);
+               _description->Enable (false);
+       } else {
+               _gain->wrapped()->Enable (sel.size() == 1);
+               _gain_calculate_button->Enable (sel.size() == 1);
+               _show->Enable (sel.size() == 1);
+               _peak->Enable (sel.size() == 1);
+               _delay->wrapped()->Enable (sel.size() == 1);
+               _mapping->Enable (sel.size() == 1);
+               _description->Enable (sel.size() == 1);
        }
 }
 
 void
-AudioPanel::mapping_changed (AudioMapping m)
+AudioPanel::show_clicked ()
 {
-       AudioContentList c = _parent->selected_audio ();
-       if (c.size() == 1) {
-               c.front()->set_audio_mapping (m);
+       if (_audio_dialog) {
+               _audio_dialog->Destroy ();
+               _audio_dialog = 0;
+       }
+
+       ContentList ac = _parent->selected_audio ();
+       if (ac.size() != 1) {
+               return;
        }
+
+       _audio_dialog = new AudioDialog (this, _parent->film (), ac.front ());
+       _audio_dialog->Show ();
 }
 
 void
-AudioPanel::content_selection_changed ()
+AudioPanel::setup_peak ()
 {
-       AudioContentList sel = _parent->selected_audio ();
-
-       if (_audio_dialog && sel.size() == 1) {
-               _audio_dialog->set_content (sel.front ());
+       ContentList sel = _parent->selected_audio ();
+       optional<float> peak_dB;
+
+       if (sel.size() != 1) {
+               _peak->SetLabel (wxT (""));
+       } else {
+               shared_ptr<Playlist> playlist (new Playlist);
+               playlist->add (_parent->film(), sel.front());
+               try {
+                       shared_ptr<AudioAnalysis> analysis (new AudioAnalysis (_parent->film()->audio_analysis_path (playlist)));
+                       peak_dB = 20 * log10 (analysis->overall_sample_peak().first.peak) + analysis->gain_correction (playlist);
+                       _peak->SetLabel (wxString::Format (_("Peak: %.2fdB"), *peak_dB));
+               } catch (...) {
+                       _peak->SetLabel (_("Peak: unknown"));
+               }
        }
-       
-       _gain->set_content (sel);
-       _delay->set_content (sel);
 
-       _gain_calculate_button->Enable (sel.size() == 1);
-       _show->Enable (sel.size() == 1);
-       _stream->Enable (sel.size() == 1);
-       _processor->Enable (!sel.empty());
-       _mapping->Enable (sel.size() == 1);
+       static wxColour normal = _peak->GetForegroundColour ();
 
-       setup_processors ();
+       if (peak_dB && *peak_dB > -0.5) {
+               _peak->SetForegroundColour (wxColour (255, 0, 0));
+       } else if (peak_dB && *peak_dB > -3) {
+               _peak->SetForegroundColour (wxColour (186, 120, 0));
+       } else {
+               _peak->SetForegroundColour (normal);
+       }
+}
 
-       film_content_changed (AudioContentProperty::AUDIO_MAPPING);
-       film_content_changed (AudioContentProperty::AUDIO_PROCESSOR);
-       film_content_changed (FFmpegContentProperty::AUDIO_STREAM);
-       film_content_changed (FFmpegContentProperty::AUDIO_STREAMS);
+void
+AudioPanel::active_jobs_changed (optional<string> old_active, optional<string> new_active)
+{
+       if (old_active && *old_active == "analyse_audio") {
+               setup_peak ();
+               _mapping->Enable (true);
+       } else if (new_active && *new_active == "analyse_audio") {
+               _mapping->Enable (false);
+       }
 }
 
 void
-AudioPanel::setup_processors ()
+AudioPanel::reference_clicked ()
 {
-       AudioContentList sel = _parent->selected_audio ();
+       ContentList c = _parent->selected ();
+       if (c.size() != 1) {
+               return;
+       }
 
-       _processor->Clear ();
-       list<AudioProcessor const *> ap = AudioProcessor::all ();
-       _processor->Append (_("None"), new wxStringClientData (N_("none")));
-       for (list<AudioProcessor const *>::const_iterator i = ap.begin(); i != ap.end(); ++i) {
+       shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (c.front ());
+       if (!d) {
+               return;
+       }
 
-               AudioContentList::const_iterator j = sel.begin();
-               while (j != sel.end() && (*i)->in_channels().includes ((*j)->audio_channels ())) {
-                       ++j;
-               }
+       d->set_reference_audio (_reference->GetValue ());
+}
 
-               if (j == sel.end ()) {
-                       _processor->Append (std_to_wx ((*i)->name ()), new wxStringClientData (std_to_wx ((*i)->id ())));
-               }
+void
+AudioPanel::set_film (shared_ptr<Film>)
+{
+       /* We are changing film, so destroy any audio dialog for the old one */
+       if (_audio_dialog) {
+               _audio_dialog->Destroy ();
+               _audio_dialog = 0;
        }
 }