2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 #include "audio_dialog.h"
23 #include "audio_mapping_view.h"
24 #include "audio_panel.h"
25 #include "check_box.h"
26 #include "content_panel.h"
27 #include "dcpomatic_button.h"
28 #include "gain_calculator_dialog.h"
29 #include "static_text.h"
31 #include "lib/audio_content.h"
32 #include "lib/cinema_sound_processor.h"
33 #include "lib/config.h"
34 #include "lib/dcp_content.h"
35 #include "lib/ffmpeg_audio_stream.h"
36 #include "lib/ffmpeg_content.h"
37 #include "lib/job_manager.h"
38 #include "lib/maths_util.h"
39 #include <dcp/warnings.h>
40 LIBDCP_DISABLE_WARNINGS
41 #include <wx/spinctrl.h>
42 LIBDCP_ENABLE_WARNINGS
45 using std::dynamic_pointer_cast;
47 using std::make_shared;
50 using std::shared_ptr;
53 using boost::optional;
54 #if BOOST_VERSION >= 106100
55 using namespace boost::placeholders;
57 using namespace dcpomatic;
60 std::map<boost::filesystem::path, float> AudioPanel::_peak_cache;
63 AudioPanel::AudioPanel (ContentPanel* p)
64 : ContentSubPanel (p, _("Audio"))
73 _reference = new CheckBox (this, _("Use this DCP's audio as OV and make VF"));
74 _reference_note = new StaticText (this, wxT(""));
75 _reference_note->Wrap (200);
76 auto font = _reference_note->GetFont();
77 font.SetStyle(wxFONTSTYLE_ITALIC);
78 font.SetPointSize(font.GetPointSize() - 1);
79 _reference_note->SetFont(font);
81 _show = new Button (this, _("Show graph of audio levels..."));
82 _peak = new StaticText (this, wxT (""));
84 _gain_label = create_label (this, _("Gain"), true);
85 _gain = new ContentSpinCtrlDouble<AudioContent> (
87 new wxSpinCtrlDouble (this),
88 AudioContentProperty::GAIN,
90 boost::mem_fn (&AudioContent::gain),
91 boost::mem_fn (&AudioContent::set_gain)
94 _gain_db_label = create_label (this, _("dB"), false);
95 _gain_calculate_button = new Button (this, _("Calculate..."));
97 _delay_label = create_label (this, _("Delay"), true);
98 _delay = new ContentSpinCtrl<AudioContent> (
100 new wxSpinCtrl (this),
101 AudioContentProperty::DELAY,
103 boost::mem_fn (&AudioContent::delay),
104 boost::mem_fn (&AudioContent::set_delay)
107 /// TRANSLATORS: this is an abbreviation for milliseconds, the unit of time
108 _delay_ms_label = create_label (this, _("ms"), false);
110 _fade_in_label = create_label (this, _("Fade in"), true);
111 _fade_in = new Timecode<ContentTime> (this);
113 _fade_out_label = create_label (this, _("Fade out"), true);
114 _fade_out = new Timecode<ContentTime> (this);
116 _use_same_fades_as_video = new CheckBox(this, _("Use same fades as video"));
118 _mapping = new AudioMappingView (this, _("Content"), _("content"), _("DCP"), _("DCP"));
119 _sizer->Add (_mapping, 1, wxEXPAND | wxALL, 6);
121 _description = new StaticText (this, wxT(" \n"), wxDefaultPosition, wxDefaultSize);
122 _sizer->Add (_description, 0, wxALL, 12);
123 _description->SetFont (font);
125 _gain->wrapped()->SetRange (-60, 60);
126 _gain->wrapped()->SetDigits (1);
127 _gain->wrapped()->SetIncrement (0.5);
128 _delay->wrapped()->SetRange (-1000, 1000);
130 content_selection_changed ();
131 film_changed (Film::Property::AUDIO_CHANNELS);
132 film_changed (Film::Property::VIDEO_FRAME_RATE);
133 film_changed (Film::Property::REEL_TYPE);
135 _reference->bind(&AudioPanel::reference_clicked, this);
136 _show->Bind (wxEVT_BUTTON, boost::bind (&AudioPanel::show_clicked, this));
137 _gain_calculate_button->Bind (wxEVT_BUTTON, boost::bind (&AudioPanel::gain_calculate_button_clicked, this));
139 _fade_in->Changed.connect (boost::bind(&AudioPanel::fade_in_changed, this));
140 _fade_out->Changed.connect (boost::bind(&AudioPanel::fade_out_changed, this));
141 _use_same_fades_as_video->bind(&AudioPanel::use_same_fades_as_video_changed, this);
143 _mapping_connection = _mapping->Changed.connect (boost::bind (&AudioPanel::mapping_changed, this, _1));
144 _active_jobs_connection = JobManager::instance()->ActiveJobsChanged.connect (boost::bind (&AudioPanel::active_jobs_changed, this, _1, _2));
153 AudioPanel::add_to_grid ()
157 auto reference_sizer = new wxBoxSizer (wxVERTICAL);
158 reference_sizer->Add (_reference, 0);
159 reference_sizer->Add (_reference_note, 0);
160 _grid->Add (reference_sizer, wxGBPosition(r, 0), wxGBSpan(1, 4));
163 _grid->Add (_show, wxGBPosition (r, 0), wxGBSpan (1, 2));
164 _grid->Add (_peak, wxGBPosition (r, 2), wxGBSpan (1, 2), wxALIGN_CENTER_VERTICAL);
167 add_label_to_sizer (_grid, _gain_label, true, wxGBPosition(r, 0));
169 auto s = new wxBoxSizer (wxHORIZONTAL);
170 s->Add (_gain->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_GAP);
171 s->Add (_gain_db_label, 0, wxALIGN_CENTER_VERTICAL);
172 _grid->Add (s, wxGBPosition(r, 1));
175 _grid->Add (_gain_calculate_button, wxGBPosition(r, 2), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
178 add_label_to_sizer (_grid, _delay_label, true, wxGBPosition(r, 0));
179 auto s = new wxBoxSizer (wxHORIZONTAL);
180 s->Add (_delay->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_GAP);
181 s->Add (_delay_ms_label, 0, wxALIGN_CENTER_VERTICAL);
182 _grid->Add (s, wxGBPosition(r, 1));
185 add_label_to_sizer (_grid, _fade_in_label, true, wxGBPosition(r, 0));
186 _grid->Add (_fade_in, wxGBPosition(r, 1), wxGBSpan(1, 3));
189 add_label_to_sizer (_grid, _fade_out_label, true, wxGBPosition(r, 0));
190 _grid->Add (_fade_out, wxGBPosition(r, 1), wxGBSpan(1, 3));
193 _grid->Add (_use_same_fades_as_video, wxGBPosition(r, 0), wxGBSpan(1, 4));
199 AudioPanel::film_changed (Film::Property property)
201 if (!_parent->film()) {
206 case Film::Property::AUDIO_CHANNELS:
207 case Film::Property::AUDIO_PROCESSOR:
208 _mapping->set_output_channels (_parent->film()->audio_output_names ());
211 case Film::Property::VIDEO_FRAME_RATE:
212 setup_description ();
214 case Film::Property::REEL_TYPE:
215 case Film::Property::INTEROP:
216 setup_sensitivity ();
225 AudioPanel::film_content_changed (int property)
227 auto ac = _parent->selected_audio ();
228 if (property == AudioContentProperty::STREAMS) {
229 if (ac.size() == 1) {
230 _mapping->set (ac.front()->audio->mapping());
231 _mapping->set_input_channels (ac.front()->audio->channel_names ());
233 vector<AudioMappingView::Group> groups;
235 for (auto i: ac.front()->audio->streams()) {
236 auto f = dynamic_pointer_cast<const FFmpegAudioStream> (i);
241 name += " (" + f->codec_name.get() + ")";
244 groups.push_back (AudioMappingView::Group (c, c + i->channels() - 1, name));
247 _mapping->set_input_groups (groups);
250 _mapping->set (AudioMapping ());
252 setup_description ();
255 } else if (property == AudioContentProperty::GAIN) {
256 /* This is a bit aggressive but probably not so bad */
259 } else if (property == DCPContentProperty::REFERENCE_AUDIO) {
260 if (ac.size() == 1) {
261 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (ac.front ());
262 checked_set (_reference, dcp ? dcp->reference_audio () : false);
264 checked_set (_reference, false);
267 setup_sensitivity ();
268 } else if (property == ContentProperty::VIDEO_FRAME_RATE) {
269 setup_description ();
270 } else if (property == AudioContentProperty::FADE_IN) {
273 check.insert (i->audio->fade_in().get());
276 if (check.size() == 1) {
278 ac.front()->audio->fade_in(),
279 ac.front()->active_video_frame_rate(_parent->film())
284 } else if (property == AudioContentProperty::FADE_OUT) {
287 check.insert (i->audio->fade_out().get());
290 if (check.size() == 1) {
292 ac.front()->audio->fade_out(),
293 ac.front()->active_video_frame_rate(_parent->film())
298 } else if (property == AudioContentProperty::USE_SAME_FADES_AS_VIDEO) {
299 setup_sensitivity ();
305 AudioPanel::gain_calculate_button_clicked ()
307 GainCalculatorDialog dialog(this);
308 auto const r = dialog.ShowModal();
309 auto change = dialog.db_change();
311 if (r == wxID_CANCEL || !change) {
315 auto old_peak_dB = peak ();
316 auto old_value = _gain->wrapped()->GetValue();
317 _gain->wrapped()->SetValue(old_value + *change);
319 /* This appears to be necessary, as the change is not signalled,
322 _gain->view_changed ();
324 auto peak_dB = peak ();
325 if (old_peak_dB && *old_peak_dB < -0.5 && peak_dB && *peak_dB > -0.5) {
326 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."));
327 _gain->wrapped()->SetValue (old_value);
328 _gain->view_changed ();
334 AudioPanel::setup_description ()
336 auto ac = _parent->selected_audio ();
337 if (ac.size () != 1) {
338 checked_set (_description, wxT (""));
342 checked_set (_description, ac.front()->audio->processing_description(_parent->film()));
347 AudioPanel::mapping_changed (AudioMapping m)
349 auto c = _parent->selected_audio ();
351 c.front()->audio->set_mapping (m);
357 AudioPanel::content_selection_changed ()
359 auto sel = _parent->selected_audio ();
361 _gain->set_content (sel);
362 _delay->set_content (sel);
364 film_content_changed (AudioContentProperty::STREAMS);
365 film_content_changed (AudioContentProperty::GAIN);
366 film_content_changed (AudioContentProperty::FADE_IN);
367 film_content_changed (AudioContentProperty::FADE_OUT);
368 film_content_changed (AudioContentProperty::USE_SAME_FADES_AS_VIDEO);
369 film_content_changed (DCPContentProperty::REFERENCE_AUDIO);
371 setup_sensitivity ();
376 AudioPanel::setup_sensitivity ()
378 auto sel = _parent->selected_audio ();
380 shared_ptr<DCPContent> dcp;
381 if (sel.size() == 1) {
382 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
386 bool const can_reference = dcp && dcp->can_reference_audio (_parent->film(), why_not);
388 if (why_not.empty()) {
389 cannot = _("Cannot reference this DCP's audio.");
391 cannot = _("Cannot reference this DCP's audio: ") + std_to_wx(why_not);
393 setup_refer_button (_reference, _reference_note, dcp, can_reference, cannot);
395 auto const ref = _reference->GetValue();
396 auto const single = sel.size() == 1;
398 auto const all_have_video = std::all_of(sel.begin(), sel.end(), [](shared_ptr<const Content> c) { return static_cast<bool>(c->video); });
400 _gain->wrapped()->Enable (!ref);
401 _gain_calculate_button->Enable (!ref && single);
402 _show->Enable (single);
403 _peak->Enable (!ref && single);
404 _delay->wrapped()->Enable (!ref);
405 _mapping->Enable (!ref && single);
406 _description->Enable (!ref && single);
407 _fade_in->Enable (!_use_same_fades_as_video->GetValue());
408 _fade_out->Enable (!_use_same_fades_as_video->GetValue());
409 _use_same_fades_as_video->Enable (!ref && all_have_video);
414 AudioPanel::show_clicked ()
416 _audio_dialog.reset();
418 auto ac = _parent->selected_audio ();
419 if (ac.size() != 1) {
423 _audio_dialog.reset(this, _parent->film(), _parent->film_viewer(), ac.front());
424 _audio_dialog->Show ();
428 /** @return If there is one selected piece of audio content, return its peak value in dB (if known) */
430 AudioPanel::peak () const
432 optional<float> peak_dB;
434 auto sel = _parent->selected_audio ();
435 if (sel.size() == 1) {
436 auto playlist = make_shared<Playlist>();
437 playlist->add (_parent->film(), sel.front());
439 /* Loading the audio analysis file is slow, and this ::peak() is called a few times when
440 * the content selection is changed, so cache it.
442 auto const path = _parent->film()->audio_analysis_path(playlist);
443 auto cached = _peak_cache.find(path);
444 if (cached != _peak_cache.end()) {
445 peak_dB = cached->second;
447 auto analysis = make_shared<AudioAnalysis>(path);
448 peak_dB = linear_to_db(analysis->overall_sample_peak().first.peak) + analysis->gain_correction(playlist);
449 _peak_cache[path] = *peak_dB;
461 AudioPanel::setup_peak ()
463 auto sel = _parent->selected_audio ();
465 auto peak_dB = peak ();
466 if (sel.size() != 1) {
467 _peak->SetLabel (wxT(""));
471 _peak->SetLabel (wxString::Format(_("Peak: %.2fdB"), *peak_dB));
473 _peak->SetLabel (_("Peak: unknown"));
477 static auto normal = _peak->GetForegroundColour ();
479 if (peak_dB && *peak_dB > -0.5) {
480 _peak->SetForegroundColour (wxColour (255, 0, 0));
481 } else if (peak_dB && *peak_dB > -3) {
482 _peak->SetForegroundColour (wxColour (186, 120, 0));
484 _peak->SetForegroundColour (normal);
490 AudioPanel::active_jobs_changed (optional<string> old_active, optional<string> new_active)
492 if (old_active && *old_active == "analyse_audio") {
494 _mapping->Enable (true);
495 } else if (new_active && *new_active == "analyse_audio") {
496 _mapping->Enable (false);
502 AudioPanel::reference_clicked ()
504 auto c = _parent->selected ();
509 auto d = dynamic_pointer_cast<DCPContent>(c.front());
514 d->set_reference_audio (_reference->GetValue ());
519 AudioPanel::set_film (shared_ptr<Film>)
521 /* We are changing film, so destroy any audio dialog for the old one */
522 _audio_dialog.reset();
527 AudioPanel::fade_in_changed ()
529 auto const hmsf = _fade_in->get();
530 for (auto i: _parent->selected_audio()) {
531 auto const vfr = i->active_video_frame_rate(_parent->film());
532 i->audio->set_fade_in (dcpomatic::ContentTime(hmsf, vfr));
538 AudioPanel::fade_out_changed ()
540 auto const hmsf = _fade_out->get();
541 for (auto i: _parent->selected_audio()) {
542 auto const vfr = i->active_video_frame_rate (_parent->film());
543 i->audio->set_fade_out (dcpomatic::ContentTime(hmsf, vfr));
549 AudioPanel::use_same_fades_as_video_changed ()
551 for (auto content: _parent->selected_audio()) {
552 content->audio->set_use_same_fades_as_video(_use_same_fades_as_video->GetValue());