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 AudioPanel::AudioPanel (ContentPanel* p)
61 : ContentSubPanel (p, _("Audio"))
70 _reference = new CheckBox (this, _("Use this DCP's audio as OV and make VF"));
71 _reference_note = new StaticText (this, wxT(""));
72 _reference_note->Wrap (200);
73 auto font = _reference_note->GetFont();
74 font.SetStyle(wxFONTSTYLE_ITALIC);
75 font.SetPointSize(font.GetPointSize() - 1);
76 _reference_note->SetFont(font);
78 _show = new Button (this, _("Show graph of audio levels..."));
79 _peak = new StaticText (this, wxT (""));
81 _gain_label = create_label (this, _("Gain"), true);
82 _gain = new ContentSpinCtrlDouble<AudioContent> (
84 new wxSpinCtrlDouble (this),
85 AudioContentProperty::GAIN,
87 boost::mem_fn (&AudioContent::gain),
88 boost::mem_fn (&AudioContent::set_gain)
91 _gain_db_label = create_label (this, _("dB"), false);
92 _gain_calculate_button = new Button (this, _("Calculate..."));
94 _delay_label = create_label (this, _("Delay"), true);
95 _delay = new ContentSpinCtrl<AudioContent> (
97 new wxSpinCtrl (this),
98 AudioContentProperty::DELAY,
100 boost::mem_fn (&AudioContent::delay),
101 boost::mem_fn (&AudioContent::set_delay)
104 /// TRANSLATORS: this is an abbreviation for milliseconds, the unit of time
105 _delay_ms_label = create_label (this, _("ms"), false);
107 _fade_in_label = create_label (this, _("Fade in"), true);
108 _fade_in = new Timecode<ContentTime> (this);
110 _fade_out_label = create_label (this, _("Fade out"), true);
111 _fade_out = new Timecode<ContentTime> (this);
113 _use_same_fades_as_video = new wxCheckBox (this, wxID_ANY, _("Use same fades as video"));
115 _mapping = new AudioMappingView (this, _("Content"), _("content"), _("DCP"), _("DCP"));
116 _sizer->Add (_mapping, 1, wxEXPAND | wxALL, 6);
118 _description = new StaticText (this, wxT(" \n"), wxDefaultPosition, wxDefaultSize);
119 _sizer->Add (_description, 0, wxALL, 12);
120 _description->SetFont (font);
122 _gain->wrapped()->SetRange (-60, 60);
123 _gain->wrapped()->SetDigits (1);
124 _gain->wrapped()->SetIncrement (0.5);
125 _delay->wrapped()->SetRange (-1000, 1000);
127 content_selection_changed ();
128 film_changed (Film::Property::AUDIO_CHANNELS);
129 film_changed (Film::Property::VIDEO_FRAME_RATE);
130 film_changed (Film::Property::REEL_TYPE);
132 _reference->Bind (wxEVT_CHECKBOX, boost::bind (&AudioPanel::reference_clicked, this));
133 _show->Bind (wxEVT_BUTTON, boost::bind (&AudioPanel::show_clicked, this));
134 _gain_calculate_button->Bind (wxEVT_BUTTON, boost::bind (&AudioPanel::gain_calculate_button_clicked, this));
136 _fade_in->Changed.connect (boost::bind(&AudioPanel::fade_in_changed, this));
137 _fade_out->Changed.connect (boost::bind(&AudioPanel::fade_out_changed, this));
138 _use_same_fades_as_video->Bind (wxEVT_CHECKBOX, boost::bind(&AudioPanel::use_same_fades_as_video_changed, this));
140 _mapping_connection = _mapping->Changed.connect (boost::bind (&AudioPanel::mapping_changed, this, _1));
141 _active_jobs_connection = JobManager::instance()->ActiveJobsChanged.connect (boost::bind (&AudioPanel::active_jobs_changed, this, _1, _2));
150 AudioPanel::add_to_grid ()
154 auto reference_sizer = new wxBoxSizer (wxVERTICAL);
155 reference_sizer->Add (_reference, 0);
156 reference_sizer->Add (_reference_note, 0);
157 _grid->Add (reference_sizer, wxGBPosition(r, 0), wxGBSpan(1, 4));
160 _grid->Add (_show, wxGBPosition (r, 0), wxGBSpan (1, 2));
161 _grid->Add (_peak, wxGBPosition (r, 2), wxGBSpan (1, 2), wxALIGN_CENTER_VERTICAL);
164 add_label_to_sizer (_grid, _gain_label, true, wxGBPosition(r, 0));
166 auto s = new wxBoxSizer (wxHORIZONTAL);
167 s->Add (_gain->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_GAP);
168 s->Add (_gain_db_label, 0, wxALIGN_CENTER_VERTICAL);
169 _grid->Add (s, wxGBPosition(r, 1));
172 _grid->Add (_gain_calculate_button, wxGBPosition(r, 2), wxDefaultSpan, wxALIGN_CENTER_VERTICAL);
175 add_label_to_sizer (_grid, _delay_label, true, wxGBPosition(r, 0));
176 auto s = new wxBoxSizer (wxHORIZONTAL);
177 s->Add (_delay->wrapped(), 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_GAP);
178 s->Add (_delay_ms_label, 0, wxALIGN_CENTER_VERTICAL);
179 _grid->Add (s, wxGBPosition(r, 1));
182 add_label_to_sizer (_grid, _fade_in_label, true, wxGBPosition(r, 0));
183 _grid->Add (_fade_in, wxGBPosition(r, 1), wxGBSpan(1, 3));
186 add_label_to_sizer (_grid, _fade_out_label, true, wxGBPosition(r, 0));
187 _grid->Add (_fade_out, wxGBPosition(r, 1), wxGBSpan(1, 3));
190 _grid->Add (_use_same_fades_as_video, wxGBPosition(r, 0), wxGBSpan(1, 4));
195 AudioPanel::~AudioPanel ()
198 _audio_dialog->Destroy ();
199 _audio_dialog = nullptr;
204 AudioPanel::film_changed (Film::Property property)
206 if (!_parent->film()) {
211 case Film::Property::AUDIO_CHANNELS:
212 case Film::Property::AUDIO_PROCESSOR:
213 _mapping->set_output_channels (_parent->film()->audio_output_names ());
216 case Film::Property::VIDEO_FRAME_RATE:
217 setup_description ();
219 case Film::Property::REEL_TYPE:
220 case Film::Property::INTEROP:
221 setup_sensitivity ();
230 AudioPanel::film_content_changed (int property)
232 auto ac = _parent->selected_audio ();
233 if (property == AudioContentProperty::STREAMS) {
234 if (ac.size() == 1) {
235 _mapping->set (ac.front()->audio->mapping());
236 _mapping->set_input_channels (ac.front()->audio->channel_names ());
238 vector<AudioMappingView::Group> groups;
240 for (auto i: ac.front()->audio->streams()) {
241 auto f = dynamic_pointer_cast<const FFmpegAudioStream> (i);
246 name += " (" + f->codec_name.get() + ")";
249 groups.push_back (AudioMappingView::Group (c, c + i->channels() - 1, name));
252 _mapping->set_input_groups (groups);
255 _mapping->set (AudioMapping ());
257 setup_description ();
260 } else if (property == AudioContentProperty::GAIN) {
262 } else if (property == DCPContentProperty::REFERENCE_AUDIO) {
263 if (ac.size() == 1) {
264 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (ac.front ());
265 checked_set (_reference, dcp ? dcp->reference_audio () : false);
267 checked_set (_reference, false);
270 setup_sensitivity ();
271 } else if (property == ContentProperty::VIDEO_FRAME_RATE) {
272 setup_description ();
273 } else if (property == AudioContentProperty::FADE_IN) {
276 check.insert (i->audio->fade_in().get());
279 if (check.size() == 1) {
281 ac.front()->audio->fade_in(),
282 ac.front()->active_video_frame_rate(_parent->film())
287 } else if (property == AudioContentProperty::FADE_OUT) {
290 check.insert (i->audio->fade_out().get());
293 if (check.size() == 1) {
295 ac.front()->audio->fade_out(),
296 ac.front()->active_video_frame_rate(_parent->film())
301 } else if (property == AudioContentProperty::USE_SAME_FADES_AS_VIDEO) {
302 setup_sensitivity ();
308 AudioPanel::gain_calculate_button_clicked ()
310 auto d = new GainCalculatorDialog (this);
311 auto const r = d->ShowModal ();
312 auto c = d->db_change();
314 if (r == wxID_CANCEL || !c) {
319 auto old_peak_dB = peak ();
320 auto old_value = _gain->wrapped()->GetValue();
321 _gain->wrapped()->SetValue(old_value + *c);
323 /* This appears to be necessary, as the change is not signalled,
326 _gain->view_changed ();
328 auto peak_dB = peak ();
329 if (old_peak_dB && *old_peak_dB < -0.5 && peak_dB && *peak_dB > -0.5) {
330 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."));
331 _gain->wrapped()->SetValue (old_value);
332 _gain->view_changed ();
340 AudioPanel::setup_description ()
342 auto ac = _parent->selected_audio ();
343 if (ac.size () != 1) {
344 checked_set (_description, wxT (""));
348 checked_set (_description, ac.front()->audio->processing_description(_parent->film()));
353 AudioPanel::mapping_changed (AudioMapping m)
355 auto c = _parent->selected_audio ();
357 c.front()->audio->set_mapping (m);
363 AudioPanel::content_selection_changed ()
365 auto sel = _parent->selected_audio ();
367 _gain->set_content (sel);
368 _delay->set_content (sel);
370 film_content_changed (AudioContentProperty::STREAMS);
371 film_content_changed (AudioContentProperty::GAIN);
372 film_content_changed (AudioContentProperty::FADE_IN);
373 film_content_changed (AudioContentProperty::FADE_OUT);
374 film_content_changed (AudioContentProperty::USE_SAME_FADES_AS_VIDEO);
375 film_content_changed (DCPContentProperty::REFERENCE_AUDIO);
377 setup_sensitivity ();
382 AudioPanel::setup_sensitivity ()
384 auto sel = _parent->selected_audio ();
386 shared_ptr<DCPContent> dcp;
387 if (sel.size() == 1) {
388 dcp = dynamic_pointer_cast<DCPContent> (sel.front ());
392 bool const can_reference = dcp && dcp->can_reference_audio (_parent->film(), why_not);
394 if (why_not.empty()) {
395 cannot = _("Cannot reference this DCP's audio.");
397 cannot = _("Cannot reference this DCP's audio: ") + std_to_wx(why_not);
399 setup_refer_button (_reference, _reference_note, dcp, can_reference, cannot);
401 auto const ref = _reference->GetValue();
402 auto const single = sel.size() == 1;
404 auto const all_have_video = std::all_of(sel.begin(), sel.end(), [](shared_ptr<const Content> c) { return static_cast<bool>(c->video); });
406 _gain->wrapped()->Enable (!ref);
407 _gain_calculate_button->Enable (!ref && single);
408 _show->Enable (single);
409 _peak->Enable (!ref && single);
410 _delay->wrapped()->Enable (!ref);
411 _mapping->Enable (!ref && single);
412 _description->Enable (!ref && single);
413 _fade_in->Enable (!_use_same_fades_as_video->GetValue());
414 _fade_out->Enable (!_use_same_fades_as_video->GetValue());
415 _use_same_fades_as_video->Enable (!ref && all_have_video);
420 AudioPanel::show_clicked ()
423 _audio_dialog->Destroy ();
424 _audio_dialog = nullptr;
427 auto ac = _parent->selected_audio ();
428 if (ac.size() != 1) {
432 _audio_dialog = new AudioDialog (this, _parent->film(), _parent->film_viewer(), ac.front());
433 _audio_dialog->Show ();
437 /** @return If there is one selected piece of audio content, return its peak value in dB (if known) */
439 AudioPanel::peak () const
441 optional<float> peak_dB;
443 auto sel = _parent->selected_audio ();
444 if (sel.size() == 1) {
445 auto playlist = make_shared<Playlist>();
446 playlist->add (_parent->film(), sel.front());
448 auto analysis = make_shared<AudioAnalysis>(_parent->film()->audio_analysis_path(playlist));
449 peak_dB = linear_to_db(analysis->overall_sample_peak().first.peak) + analysis->gain_correction(playlist);
460 AudioPanel::setup_peak ()
462 auto sel = _parent->selected_audio ();
464 auto peak_dB = peak ();
465 if (sel.size() != 1) {
466 _peak->SetLabel (wxT(""));
470 _peak->SetLabel (wxString::Format(_("Peak: %.2fdB"), *peak_dB));
472 _peak->SetLabel (_("Peak: unknown"));
476 static auto normal = _peak->GetForegroundColour ();
478 if (peak_dB && *peak_dB > -0.5) {
479 _peak->SetForegroundColour (wxColour (255, 0, 0));
480 } else if (peak_dB && *peak_dB > -3) {
481 _peak->SetForegroundColour (wxColour (186, 120, 0));
483 _peak->SetForegroundColour (normal);
489 AudioPanel::active_jobs_changed (optional<string> old_active, optional<string> new_active)
491 if (old_active && *old_active == "analyse_audio") {
493 _mapping->Enable (true);
494 } else if (new_active && *new_active == "analyse_audio") {
495 _mapping->Enable (false);
501 AudioPanel::reference_clicked ()
503 auto c = _parent->selected ();
508 auto d = dynamic_pointer_cast<DCPContent>(c.front());
513 d->set_reference_audio (_reference->GetValue ());
518 AudioPanel::set_film (shared_ptr<Film>)
520 /* We are changing film, so destroy any audio dialog for the old one */
522 _audio_dialog->Destroy ();
523 _audio_dialog = nullptr;
529 AudioPanel::fade_in_changed ()
531 auto const hmsf = _fade_in->get();
532 for (auto i: _parent->selected_audio()) {
533 auto const vfr = i->active_video_frame_rate(_parent->film());
534 i->audio->set_fade_in (dcpomatic::ContentTime(hmsf, vfr));
540 AudioPanel::fade_out_changed ()
542 auto const hmsf = _fade_out->get();
543 for (auto i: _parent->selected_audio()) {
544 auto const vfr = i->active_video_frame_rate (_parent->film());
545 i->audio->set_fade_out (dcpomatic::ContentTime(hmsf, vfr));
551 AudioPanel::use_same_fades_as_video_changed ()
553 for (auto content: _parent->selected_audio()) {
554 content->audio->set_use_same_fades_as_video(_use_same_fades_as_video->GetValue());