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