Cleanup: use layout() wrapper.
[dcpomatic.git] / src / wx / audio_panel.cc
index 5523d25393088196d88655581121b43f740c6522..50831ec4076607e5833a64d7cc5f983a02ae44c3 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
-#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 "audio_mapping_view.h"
+#include "audio_panel.h"
 #include "check_box.h"
+#include "content_panel.h"
 #include "dcpomatic_button.h"
+#include "gain_calculator_dialog.h"
+#include "static_text.h"
+#include "wx_util.h"
+#include "lib/audio_content.h"
+#include "lib/cinema_sound_processor.h"
 #include "lib/config.h"
+#include "lib/dcp_content.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 "lib/maths_util.h"
+#include <dcp/warnings.h>
+LIBDCP_DISABLE_WARNINGS
 #include <wx/spinctrl.h>
-#include <boost/foreach.hpp>
-#include <iostream>
+LIBDCP_ENABLE_WARNINGS
 
-using std::vector;
-using std::cout;
-using std::string;
+
+using std::dynamic_pointer_cast;
 using std::list;
+using std::make_shared;
 using std::pair;
-using boost::dynamic_pointer_cast;
-using boost::shared_ptr;
+using std::set;
+using std::shared_ptr;
+using std::string;
+using std::vector;
 using boost::optional;
+#if BOOST_VERSION >= 106100
+using namespace boost::placeholders;
+#endif
+using namespace dcpomatic;
+
+
+std::map<boost::filesystem::path, float> AudioPanel::_peak_cache;
+
 
 AudioPanel::AudioPanel (ContentPanel* p)
        : ContentSubPanel (p, _("Audio"))
-       , _audio_dialog (0)
+{
+
+}
+
+
+void
+AudioPanel::create ()
 {
        _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();
+       auto font = _reference_note->GetFont();
        font.SetStyle(wxFONTSTYLE_ITALIC);
        font.SetPointSize(font.GetPointSize() - 1);
        _reference_note->SetFont(font);
@@ -88,6 +107,14 @@ AudioPanel::AudioPanel (ContentPanel* p)
        /// TRANSLATORS: this is an abbreviation for milliseconds, the unit of time
        _delay_ms_label = create_label (this, _("ms"), false);
 
+       _fade_in_label = create_label (this, _("Fade in"), true);
+       _fade_in = new Timecode<ContentTime> (this);
+
+       _fade_out_label = create_label (this, _("Fade out"), true);
+       _fade_out = new Timecode<ContentTime> (this);
+
+       _use_same_fades_as_video = new CheckBox(this, _("Use same fades as video"));
+
        _mapping = new AudioMappingView (this, _("Content"), _("content"), _("DCP"), _("DCP"));
        _sizer->Add (_mapping, 1, wxEXPAND | wxALL, 6);
 
@@ -101,37 +128,37 @@ AudioPanel::AudioPanel (ContentPanel* p)
        _delay->wrapped()->SetRange (-1000, 1000);
 
        content_selection_changed ();
-       film_changed (Film::AUDIO_CHANNELS);
-       film_changed (Film::VIDEO_FRAME_RATE);
-       film_changed (Film::REEL_TYPE);
+       film_changed (Film::Property::AUDIO_CHANNELS);
+       film_changed (Film::Property::VIDEO_FRAME_RATE);
+       film_changed (Film::Property::REEL_TYPE);
 
-       _reference->Bind             (wxEVT_CHECKBOX, boost::bind (&AudioPanel::reference_clicked, this));
+       _reference->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));
 
+       _fade_in->Changed.connect (boost::bind(&AudioPanel::fade_in_changed, this));
+       _fade_out->Changed.connect (boost::bind(&AudioPanel::fade_out_changed, this));
+       _use_same_fades_as_video->bind(&AudioPanel::use_same_fades_as_video_changed, this);
+
        _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 ();
+
+       layout();
 }
 
+
 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;
-       }
+       auto 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);
@@ -139,41 +166,35 @@ AudioPanel::add_to_grid ()
 
        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);
+               auto s = new wxBoxSizer (wxHORIZONTAL);
+               s->Add (_gain->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_GAP);
                s->Add (_gain_db_label, 0, wxALIGN_CENTER_VERTICAL);
                _grid->Add (s, wxGBPosition(r, 1));
        }
 
-       _gain_calculate_button->Show (full);
+       _grid->Add (_gain_calculate_button, wxGBPosition(r, 2), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
+       ++r;
 
-       if (full) {
-               _grid->Add (_gain_calculate_button, wxGBPosition(r, 2), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
-               ++r;
-       }
+       add_label_to_sizer (_grid, _delay_label, true, wxGBPosition(r, 0));
+       auto s = new wxBoxSizer (wxHORIZONTAL);
+       s->Add (_delay->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_GAP);
+       s->Add (_delay_ms_label, 0, wxALIGN_CENTER_VERTICAL);
+       _grid->Add (s, wxGBPosition(r, 1));
+       ++r;
 
-       _delay_label->Show (full);
-       _delay->show (full);
-       _delay_ms_label->Show (full);
+       add_label_to_sizer (_grid, _fade_in_label, true, wxGBPosition(r, 0));
+       _grid->Add (_fade_in, wxGBPosition(r, 1), wxGBSpan(1, 3));
+       ++r;
 
-       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;
-       }
-}
+       add_label_to_sizer (_grid, _fade_out_label, true, wxGBPosition(r, 0));
+       _grid->Add (_fade_out, wxGBPosition(r, 1), wxGBSpan(1, 3));
+       ++r;
 
-AudioPanel::~AudioPanel ()
-{
-       if (_audio_dialog) {
-               _audio_dialog->Destroy ();
-               _audio_dialog = 0;
-       }
+       _grid->Add (_use_same_fades_as_video, wxGBPosition(r, 0), wxGBSpan(1, 4));
+       ++r;
 }
 
+
 void
 AudioPanel::film_changed (Film::Property property)
 {
@@ -182,16 +203,16 @@ AudioPanel::film_changed (Film::Property property)
        }
 
        switch (property) {
-       case Film::AUDIO_CHANNELS:
-       case Film::AUDIO_PROCESSOR:
+       case Film::Property::AUDIO_CHANNELS:
+       case Film::Property::AUDIO_PROCESSOR:
                _mapping->set_output_channels (_parent->film()->audio_output_names ());
                setup_peak ();
                break;
-       case Film::VIDEO_FRAME_RATE:
+       case Film::Property::VIDEO_FRAME_RATE:
                setup_description ();
                break;
-       case Film::REEL_TYPE:
-       case Film::INTEROP:
+       case Film::Property::REEL_TYPE:
+       case Film::Property::INTEROP:
                setup_sensitivity ();
                break;
        default:
@@ -199,10 +220,11 @@ AudioPanel::film_changed (Film::Property property)
        }
 }
 
+
 void
 AudioPanel::film_content_changed (int property)
 {
-       ContentList ac = _parent->selected_audio ();
+       auto ac = _parent->selected_audio ();
        if (property == AudioContentProperty::STREAMS) {
                if (ac.size() == 1) {
                        _mapping->set (ac.front()->audio->mapping());
@@ -210,8 +232,8 @@ AudioPanel::film_content_changed (int property)
 
                        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);
+                       for (auto i: ac.front()->audio->streams()) {
+                               auto f = dynamic_pointer_cast<const FFmpegAudioStream> (i);
                                string name = "";
                                if (f) {
                                        name = f->name;
@@ -229,8 +251,10 @@ AudioPanel::film_content_changed (int property)
                }
                setup_description ();
                setup_peak ();
-               _sizer->Layout ();
+               layout ();
        } else if (property == AudioContentProperty::GAIN) {
+               /* This is a bit aggressive but probably not so bad */
+               _peak_cache.clear();
                setup_peak ();
        } else if (property == DCPContentProperty::REFERENCE_AUDIO) {
                if (ac.size() == 1) {
@@ -243,35 +267,73 @@ AudioPanel::film_content_changed (int property)
                setup_sensitivity ();
        } else if (property == ContentProperty::VIDEO_FRAME_RATE) {
                setup_description ();
+       } else if (property == AudioContentProperty::FADE_IN) {
+               set<Frame> check;
+               for (auto i: ac) {
+                       check.insert (i->audio->fade_in().get());
+               }
+
+               if (check.size() == 1) {
+                       _fade_in->set (
+                               ac.front()->audio->fade_in(),
+                               ac.front()->active_video_frame_rate(_parent->film())
+                               );
+               } else {
+                       _fade_in->clear ();
+               }
+       } else if (property == AudioContentProperty::FADE_OUT) {
+               set<Frame> check;
+               for (auto i: ac) {
+                       check.insert (i->audio->fade_out().get());
+               }
+
+               if (check.size() == 1) {
+                       _fade_out->set (
+                               ac.front()->audio->fade_out(),
+                               ac.front()->active_video_frame_rate(_parent->film())
+                               );
+               } else {
+                       _fade_out->clear ();
+               }
+       } else if (property == AudioContentProperty::USE_SAME_FADES_AS_VIDEO) {
+               setup_sensitivity ();
        }
 }
 
+
 void
 AudioPanel::gain_calculate_button_clicked ()
 {
-       GainCalculatorDialog* d = new GainCalculatorDialog (this);
-       int const r = d->ShowModal ();
-       optional<float> c = d->db_change();
+       GainCalculatorDialog dialog(this);
+       auto const r = dialog.ShowModal();
+       auto change = dialog.db_change();
 
-       if (r == wxID_CANCEL || !c) {
-               d->Destroy ();
+       if (r == wxID_CANCEL || !change) {
                return;
        }
 
-       _gain->wrapped()->SetValue(_gain->wrapped()->GetValue() + *c);
+       auto old_peak_dB = peak ();
+       auto old_value = _gain->wrapped()->GetValue();
+       _gain->wrapped()->SetValue(old_value + *change);
 
        /* This appears to be necessary, as the change is not signalled,
           I think.
        */
        _gain->view_changed ();
 
-       d->Destroy ();
+       auto peak_dB = peak ();
+       if (old_peak_dB && *old_peak_dB < -0.5 && peak_dB && *peak_dB > -0.5) {
+               error_dialog (this, _("It is not possible to adjust the content's gain for this fader change as it would cause the DCP's audio to clip.  The gain has not been changed."));
+               _gain->wrapped()->SetValue (old_value);
+               _gain->view_changed ();
+       }
 }
 
+
 void
 AudioPanel::setup_description ()
 {
-       ContentList ac = _parent->selected_audio ();
+       auto ac = _parent->selected_audio ();
        if (ac.size () != 1) {
                checked_set (_description, wxT (""));
                return;
@@ -280,34 +342,40 @@ AudioPanel::setup_description ()
        checked_set (_description, ac.front()->audio->processing_description(_parent->film()));
 }
 
+
 void
 AudioPanel::mapping_changed (AudioMapping m)
 {
-       ContentList c = _parent->selected_audio ();
+       auto c = _parent->selected_audio ();
        if (c.size() == 1) {
                c.front()->audio->set_mapping (m);
        }
 }
 
+
 void
 AudioPanel::content_selection_changed ()
 {
-       ContentList sel = _parent->selected_audio ();
+       auto sel = _parent->selected_audio ();
 
        _gain->set_content (sel);
        _delay->set_content (sel);
 
        film_content_changed (AudioContentProperty::STREAMS);
        film_content_changed (AudioContentProperty::GAIN);
+       film_content_changed (AudioContentProperty::FADE_IN);
+       film_content_changed (AudioContentProperty::FADE_OUT);
+       film_content_changed (AudioContentProperty::USE_SAME_FADES_AS_VIDEO);
        film_content_changed (DCPContentProperty::REFERENCE_AUDIO);
 
        setup_sensitivity ();
 }
 
+
 void
 AudioPanel::setup_sensitivity ()
 {
-       ContentList sel = _parent->selected_audio ();
+       auto sel = _parent->selected_audio ();
 
        shared_ptr<DCPContent> dcp;
        if (sel.size() == 1) {
@@ -324,63 +392,89 @@ AudioPanel::setup_sensitivity ()
        }
        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);
-       }
+       auto const ref = _reference->GetValue();
+       auto const single = sel.size() == 1;
+
+       auto const all_have_video = std::all_of(sel.begin(), sel.end(), [](shared_ptr<const Content> c) { return static_cast<bool>(c->video); });
+
+       _gain->wrapped()->Enable (!ref);
+       _gain_calculate_button->Enable (!ref && single);
+       _show->Enable (single);
+       _peak->Enable (!ref && single);
+       _delay->wrapped()->Enable (!ref);
+       _mapping->Enable (!ref && single);
+       _description->Enable (!ref && single);
+       _fade_in->Enable (!_use_same_fades_as_video->GetValue());
+       _fade_out->Enable (!_use_same_fades_as_video->GetValue());
+       _use_same_fades_as_video->Enable (!ref && all_have_video);
 }
 
+
 void
 AudioPanel::show_clicked ()
 {
-       if (_audio_dialog) {
-               _audio_dialog->Destroy ();
-               _audio_dialog = 0;
-       }
+       _audio_dialog.reset();
 
-       ContentList ac = _parent->selected_audio ();
+       auto ac = _parent->selected_audio ();
        if (ac.size() != 1) {
                return;
        }
 
-       _audio_dialog = new AudioDialog (this, _parent->film (), ac.front ());
+       _audio_dialog.reset(this, _parent->film(), _parent->film_viewer(), ac.front());
        _audio_dialog->Show ();
 }
 
-void
-AudioPanel::setup_peak ()
+
+/** @return If there is one selected piece of audio content, return its peak value in dB (if known) */
+optional<float>
+AudioPanel::peak () const
 {
-       ContentList sel = _parent->selected_audio ();
        optional<float> peak_dB;
 
-       if (sel.size() != 1) {
-               _peak->SetLabel (wxT (""));
-       } else {
-               shared_ptr<Playlist> playlist (new Playlist);
+       auto sel = _parent->selected_audio ();
+       if (sel.size() == 1) {
+               auto playlist = make_shared<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));
+                       /* Loading the audio analysis file is slow, and this ::peak() is called a few times when
+                        * the content selection is changed, so cache it.
+                        */
+                       auto const path = _parent->film()->audio_analysis_path(playlist);
+                       auto cached = _peak_cache.find(path);
+                       if (cached != _peak_cache.end()) {
+                               peak_dB = cached->second;
+                       } else {
+                               auto analysis = make_shared<AudioAnalysis>(path);
+                               peak_dB = linear_to_db(analysis->overall_sample_peak().first.peak) + analysis->gain_correction(playlist);
+                               _peak_cache[path] = *peak_dB;
+                       }
                } catch (...) {
+
+               }
+       }
+
+       return peak_dB;
+}
+
+
+void
+AudioPanel::setup_peak ()
+{
+       auto sel = _parent->selected_audio ();
+
+       auto peak_dB = peak ();
+       if (sel.size() != 1) {
+               _peak->SetLabel (wxT(""));
+       } else {
+               peak_dB = peak ();
+               if (peak_dB) {
+                       _peak->SetLabel (wxString::Format(_("Peak: %.2fdB"), *peak_dB));
+               } else {
                        _peak->SetLabel (_("Peak: unknown"));
                }
        }
 
-       static wxColour normal = _peak->GetForegroundColour ();
+       static auto normal = _peak->GetForegroundColour ();
 
        if (peak_dB && *peak_dB > -0.5) {
                _peak->SetForegroundColour (wxColour (255, 0, 0));
@@ -391,6 +485,7 @@ AudioPanel::setup_peak ()
        }
 }
 
+
 void
 AudioPanel::active_jobs_changed (optional<string> old_active, optional<string> new_active)
 {
@@ -402,15 +497,16 @@ AudioPanel::active_jobs_changed (optional<string> old_active, optional<string> n
        }
 }
 
+
 void
 AudioPanel::reference_clicked ()
 {
-       ContentList c = _parent->selected ();
+       auto c = _parent->selected ();
        if (c.size() != 1) {
                return;
        }
 
-       shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (c.front ());
+       auto d = dynamic_pointer_cast<DCPContent>(c.front());
        if (!d) {
                return;
        }
@@ -418,12 +514,42 @@ AudioPanel::reference_clicked ()
        d->set_reference_audio (_reference->GetValue ());
 }
 
+
 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;
+       _audio_dialog.reset();
+}
+
+
+void
+AudioPanel::fade_in_changed ()
+{
+       auto const hmsf = _fade_in->get();
+       for (auto i: _parent->selected_audio()) {
+               auto const vfr = i->active_video_frame_rate(_parent->film());
+               i->audio->set_fade_in (dcpomatic::ContentTime(hmsf, vfr));
+       }
+}
+
+
+void
+AudioPanel::fade_out_changed ()
+{
+       auto const hmsf = _fade_out->get();
+       for (auto i: _parent->selected_audio()) {
+               auto const vfr = i->active_video_frame_rate (_parent->film());
+               i->audio->set_fade_out (dcpomatic::ContentTime(hmsf, vfr));
        }
 }
+
+
+void
+AudioPanel::use_same_fades_as_video_changed ()
+{
+       for (auto content: _parent->selected_audio()) {
+               content->audio->set_use_same_fades_as_video(_use_same_fades_as_video->GetValue());
+       }
+}
+