2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/film_editor.cc
21 * @brief A wx widget to edit a film's metadata, and perform various functions.
27 #include <boost/thread.hpp>
28 #include <boost/filesystem.hpp>
29 #include <boost/lexical_cast.hpp>
30 #include "lib/format.h"
32 #include "lib/transcode_job.h"
33 #include "lib/exceptions.h"
34 #include "lib/ab_transcode_job.h"
35 #include "lib/thumbs_job.h"
36 #include "lib/job_manager.h"
37 #include "lib/filter.h"
38 #include "lib/screen.h"
39 #include "lib/config.h"
40 #include "filter_dialog.h"
42 #include "film_editor.h"
43 #include "dcp_range_dialog.h"
44 #include "gain_calculator_dialog.h"
45 #include "sound_processor.h"
48 using namespace boost;
50 /** @param f Film to edit */
51 FilmEditor::FilmEditor (Film* f, wxWindow* parent)
53 , _ignore_changes (Film::NONE)
56 _sizer = new wxFlexGridSizer (2, 4, 4);
59 add_label_to_sizer (_sizer, this, "Name");
60 _name = new wxTextCtrl (this, wxID_ANY);
61 _sizer->Add (_name, 1, wxEXPAND);
63 add_label_to_sizer (_sizer, this, "Content");
64 _content = new wxFilePickerCtrl (this, wxID_ANY, wxT (""), wxT ("Select Content File"), wxT("*.*"));
65 _sizer->Add (_content, 1, wxEXPAND);
67 add_label_to_sizer (_sizer, this, "Content Type");
68 _dcp_content_type = new wxComboBox (this, wxID_ANY);
69 _sizer->Add (_dcp_content_type);
71 add_label_to_sizer (_sizer, this, "Format");
72 _format = new wxComboBox (this, wxID_ANY);
73 _sizer->Add (_format);
76 add_label_to_sizer (_sizer, this, "Crop");
77 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
79 add_label_to_sizer (s, this, "L");
80 _left_crop = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
81 s->Add (_left_crop, 0);
82 add_label_to_sizer (s, this, "R");
83 _right_crop = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
84 s->Add (_right_crop, 0);
85 add_label_to_sizer (s, this, "T");
86 _top_crop = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
87 s->Add (_top_crop, 0);
88 add_label_to_sizer (s, this, "B");
89 _bottom_crop = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
90 s->Add (_bottom_crop, 0);
95 /* VIDEO-only stuff */
97 video_control (add_label_to_sizer (_sizer, this, "Filters"));
98 wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
99 _filters = new wxStaticText (this, wxID_ANY, wxT ("None"));
100 video_control (_filters);
101 s->Add (_filters, 1, wxEXPAND | wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM | wxRIGHT, 6);
102 _filters_button = new wxButton (this, wxID_ANY, wxT ("Edit..."));
103 video_control (_filters_button);
104 s->Add (_filters_button, 0);
108 video_control (add_label_to_sizer (_sizer, this, "Scaler"));
109 _scaler = new wxComboBox (this, wxID_ANY);
110 _sizer->Add (video_control (_scaler), 1);
113 video_control (add_label_to_sizer (_sizer, this, "Audio Gain"));
114 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
115 _audio_gain = new wxSpinCtrl (this);
116 s->Add (video_control (_audio_gain), 1);
117 video_control (add_label_to_sizer (s, this, "dB"));
118 _audio_gain_calculate_button = new wxButton (this, wxID_ANY, _("Calculate..."));
119 video_control (_audio_gain_calculate_button);
120 s->Add (_audio_gain_calculate_button, 1, wxEXPAND);
125 video_control (add_label_to_sizer (_sizer, this, "Audio Delay"));
126 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
127 _audio_delay = new wxSpinCtrl (this);
128 s->Add (video_control (_audio_delay), 1);
129 video_control (add_label_to_sizer (s, this, "ms"));
133 video_control (add_label_to_sizer (_sizer, this, "Frames Per Second"));
134 _frames_per_second = new wxStaticText (this, wxID_ANY, wxT (""));
135 _sizer->Add (video_control (_frames_per_second), 1, wxALIGN_CENTER_VERTICAL);
137 video_control (add_label_to_sizer (_sizer, this, "Original Size"));
138 _original_size = new wxStaticText (this, wxID_ANY, wxT (""));
139 _sizer->Add (video_control (_original_size), 1, wxALIGN_CENTER_VERTICAL);
141 video_control (add_label_to_sizer (_sizer, this, "Length"));
142 _length = new wxStaticText (this, wxID_ANY, wxT (""));
143 _sizer->Add (video_control (_length), 1, wxALIGN_CENTER_VERTICAL);
145 video_control (add_label_to_sizer (_sizer, this, "Audio"));
146 _audio = new wxStaticText (this, wxID_ANY, wxT (""));
147 _sizer->Add (video_control (_audio), 1, wxALIGN_CENTER_VERTICAL);
150 video_control (add_label_to_sizer (_sizer, this, "Range"));
151 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
152 _dcp_range = new wxStaticText (this, wxID_ANY, wxT (""));
153 s->Add (video_control (_dcp_range), 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM | wxRIGHT, 6);
154 _change_dcp_range_button = new wxButton (this, wxID_ANY, wxT ("Edit..."));
155 s->Add (video_control (_change_dcp_range_button), 0, 0, 6);
159 _dcp_ab = new wxCheckBox (this, wxID_ANY, wxT ("A/B"));
160 video_control (_dcp_ab);
161 _sizer->Add (_dcp_ab, 1);
162 _sizer->AddSpacer (0);
164 /* STILL-only stuff */
166 still_control (add_label_to_sizer (_sizer, this, "Duration"));
167 wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
168 _still_duration = new wxSpinCtrl (this);
169 still_control (_still_duration);
170 s->Add (_still_duration, 1, wxEXPAND);
171 still_control (add_label_to_sizer (s, this, "s"));
175 /* Set up our editing widgets */
177 _left_crop->SetRange (0, 1024);
178 _top_crop->SetRange (0, 1024);
179 _right_crop->SetRange (0, 1024);
180 _bottom_crop->SetRange (0, 1024);
181 _audio_gain->SetRange (-60, 60);
182 _audio_delay->SetRange (-1000, 1000);
183 _still_duration->SetRange (0, 60 * 60);
185 vector<DCPContentType const *> const ct = DCPContentType::all ();
186 for (vector<DCPContentType const *>::const_iterator i = ct.begin(); i != ct.end(); ++i) {
187 _dcp_content_type->Append (std_to_wx ((*i)->pretty_name ()));
190 vector<Scaler const *> const sc = Scaler::all ();
191 for (vector<Scaler const *>::const_iterator i = sc.begin(); i != sc.end(); ++i) {
192 _scaler->Append (std_to_wx ((*i)->name()));
195 /* And set their values from the Film */
198 /* Now connect to them, since initial values are safely set */
199 _name->Connect (wxID_ANY, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEventHandler (FilmEditor::name_changed), 0, this);
200 _format->Connect (wxID_ANY, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEventHandler (FilmEditor::format_changed), 0, this);
201 _content->Connect (wxID_ANY, wxEVT_COMMAND_FILEPICKER_CHANGED, wxCommandEventHandler (FilmEditor::content_changed), 0, this);
202 _left_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::left_crop_changed), 0, this);
203 _right_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::right_crop_changed), 0, this);
204 _top_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::top_crop_changed), 0, this);
205 _bottom_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::bottom_crop_changed), 0, this);
206 _filters_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::edit_filters_clicked), 0, this);
207 _scaler->Connect (wxID_ANY, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEventHandler (FilmEditor::scaler_changed), 0, this);
208 _dcp_content_type->Connect (wxID_ANY, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEventHandler (FilmEditor::dcp_content_type_changed), 0, this);
209 _dcp_ab->Connect (wxID_ANY, wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEventHandler (FilmEditor::dcp_ab_toggled), 0, this);
210 _audio_gain->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::audio_gain_changed), 0, this);
211 _audio_gain_calculate_button->Connect (
212 wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::audio_gain_calculate_button_clicked), 0, this
214 _audio_delay->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::audio_delay_changed), 0, this);
215 _still_duration->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::still_duration_changed), 0, this);
216 _change_dcp_range_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::change_dcp_range_clicked), 0, this);
222 /** Called when the left crop widget has been changed */
224 FilmEditor::left_crop_changed (wxCommandEvent &)
230 _ignore_changes = Film::CROP;
231 _film->set_left_crop (_left_crop->GetValue ());
232 _ignore_changes = Film::NONE;
235 /** Called when the right crop widget has been changed */
237 FilmEditor::right_crop_changed (wxCommandEvent &)
243 _ignore_changes = Film::CROP;
244 _film->set_right_crop (_right_crop->GetValue ());
245 _ignore_changes = Film::NONE;
248 /** Called when the top crop widget has been changed */
250 FilmEditor::top_crop_changed (wxCommandEvent &)
256 _ignore_changes = Film::CROP;
257 _film->set_top_crop (_top_crop->GetValue ());
258 _ignore_changes = Film::NONE;
261 /** Called when the bottom crop value has been changed */
263 FilmEditor::bottom_crop_changed (wxCommandEvent &)
269 _ignore_changes = Film::CROP;
270 _film->set_bottom_crop (_bottom_crop->GetValue ());
271 _ignore_changes = Film::NONE;
274 /** Called when the content filename has been changed */
276 FilmEditor::content_changed (wxCommandEvent &)
282 _ignore_changes = Film::CONTENT;
285 _film->set_content (wx_to_std (_content->GetPath ()));
286 } catch (std::exception& e) {
287 _content->SetPath (std_to_wx (_film->directory ()));
288 error_dialog (this, String::compose ("Could not set content: %1", e.what ()));
291 _ignore_changes = Film::NONE;
297 /** Called when the DCP A/B switch has been toggled */
299 FilmEditor::dcp_ab_toggled (wxCommandEvent &)
305 _ignore_changes = Film::DCP_AB;
306 _film->set_dcp_ab (_dcp_ab->GetValue ());
307 _ignore_changes = Film::NONE;
310 /** Called when the name widget has been changed */
312 FilmEditor::name_changed (wxCommandEvent &)
318 _ignore_changes = Film::NAME;
319 _film->set_name (string (_name->GetValue().mb_str()));
320 _ignore_changes = Film::NONE;
323 /** Called when the metadata stored in the Film object has changed;
324 * so that we can update the GUI.
325 * @param p Property of the Film that has changed.
328 FilmEditor::film_changed (Film::Property p)
330 if (!_film || _ignore_changes == p) {
340 _content->SetPath (std_to_wx (_film->content ()));
347 vector<Format const *>::iterator i = _formats.begin ();
348 while (i != _formats.end() && *i != _film->format ()) {
352 _format->SetSelection (n);
356 _left_crop->SetValue (_film->crop().left);
357 _right_crop->SetValue (_film->crop().right);
358 _top_crop->SetValue (_film->crop().top);
359 _bottom_crop->SetValue (_film->crop().bottom);
363 pair<string, string> p = Filter::ffmpeg_strings (_film->filters ());
364 if (p.first.empty () && p.second.empty ()) {
365 _filters->SetLabel (_("None"));
367 string const b = p.first + " " + p.second;
368 _filters->SetLabel (std_to_wx (b));
374 _name->ChangeValue (std_to_wx (_film->name ()));
376 case Film::FRAMES_PER_SECOND:
379 s << fixed << setprecision(2) << _film->frames_per_second();
380 _frames_per_second->SetLabel (std_to_wx (s.str ()));
383 case Film::AUDIO_CHANNELS:
384 case Film::AUDIO_SAMPLE_RATE:
385 if (_film->audio_channels() == 0 && _film->audio_sample_rate() == 0) {
386 _audio->SetLabel (wxT (""));
388 s << _film->audio_channels () << " channels, " << _film->audio_sample_rate() << "Hz";
389 _audio->SetLabel (std_to_wx (s.str ()));
393 if (_film->size().width == 0 && _film->size().height == 0) {
394 _original_size->SetLabel (wxT (""));
396 s << _film->size().width << " x " << _film->size().height;
397 _original_size->SetLabel (std_to_wx (s.str ()));
401 if (_film->frames_per_second() > 0 && _film->length() > 0) {
402 s << _film->length() << " frames; " << seconds_to_hms (_film->length() / _film->frames_per_second());
403 } else if (_film->length() > 0) {
404 s << _film->length() << " frames";
406 _length->SetLabel (std_to_wx (s.str ()));
408 case Film::DCP_CONTENT_TYPE:
409 _dcp_content_type->SetSelection (DCPContentType::as_index (_film->dcp_content_type ()));
413 case Film::DCP_FRAMES:
414 if (_film->dcp_frames() == 0) {
415 _dcp_range->SetLabel (wxT ("Whole film"));
418 s << "First " << _film->dcp_frames() << " frames";
419 _dcp_range->SetLabel (std_to_wx (s.str ()));
423 case Film::DCP_TRIM_ACTION:
426 _dcp_ab->SetValue (_film->dcp_ab ());
429 _scaler->SetSelection (Scaler::as_index (_film->scaler ()));
431 case Film::AUDIO_GAIN:
432 _audio_gain->SetValue (_film->audio_gain ());
434 case Film::AUDIO_DELAY:
435 _audio_delay->SetValue (_film->audio_delay ());
437 case Film::STILL_DURATION:
438 _still_duration->SetValue (_film->still_duration ());
443 /** Called when the format widget has been changed */
445 FilmEditor::format_changed (wxCommandEvent &)
451 _ignore_changes = Film::FORMAT;
452 int const n = _format->GetSelection ();
454 assert (n < int (_formats.size()));
455 _film->set_format (_formats[n]);
457 _ignore_changes = Film::NONE;
460 /** Called when the DCP content type widget has been changed */
462 FilmEditor::dcp_content_type_changed (wxCommandEvent &)
468 _ignore_changes = Film::DCP_CONTENT_TYPE;
469 int const n = _dcp_content_type->GetSelection ();
471 _film->set_dcp_content_type (DCPContentType::from_index (n));
473 _ignore_changes = Film::NONE;
476 /** Sets the Film that we are editing */
478 FilmEditor::set_film (Film* f)
482 set_things_sensitive (_film != 0);
485 _film->Changed.connect (sigc::mem_fun (*this, &FilmEditor::film_changed));
489 FileChanged (_film->directory ());
494 film_changed (Film::NAME);
495 film_changed (Film::CONTENT);
496 film_changed (Film::DCP_CONTENT_TYPE);
497 film_changed (Film::FORMAT);
498 film_changed (Film::CROP);
499 film_changed (Film::FILTERS);
500 film_changed (Film::DCP_FRAMES);
501 film_changed (Film::DCP_TRIM_ACTION);
502 film_changed (Film::DCP_AB);
503 film_changed (Film::SIZE);
504 film_changed (Film::LENGTH);
505 film_changed (Film::FRAMES_PER_SECOND);
506 film_changed (Film::AUDIO_CHANNELS);
507 film_changed (Film::AUDIO_SAMPLE_RATE);
508 film_changed (Film::SCALER);
509 film_changed (Film::AUDIO_GAIN);
510 film_changed (Film::AUDIO_DELAY);
511 film_changed (Film::STILL_DURATION);
514 /** Updates the sensitivity of lots of widgets to a given value.
515 * @param s true to make sensitive, false to make insensitive.
518 FilmEditor::set_things_sensitive (bool s)
521 _frames_per_second->Enable (s);
523 _content->Enable (s);
524 _left_crop->Enable (s);
525 _right_crop->Enable (s);
526 _top_crop->Enable (s);
527 _bottom_crop->Enable (s);
528 _filters_button->Enable (s);
530 _dcp_content_type->Enable (s);
531 _dcp_range->Enable (s);
532 _change_dcp_range_button->Enable (s);
534 _audio_gain->Enable (s);
535 _audio_gain_calculate_button->Enable (s);
536 _audio_delay->Enable (s);
537 _still_duration->Enable (s);
540 /** Called when the `Edit filters' button has been clicked */
542 FilmEditor::edit_filters_clicked (wxCommandEvent &)
544 FilterDialog* d = new FilterDialog (this, _film->filters ());
545 d->ActiveChanged.connect (sigc::mem_fun (*_film, &Film::set_filters));
550 /** Called when the scaler widget has been changed */
552 FilmEditor::scaler_changed (wxCommandEvent &)
558 _ignore_changes = Film::SCALER;
559 int const n = _scaler->GetSelection ();
561 _film->set_scaler (Scaler::from_index (n));
563 _ignore_changes = Film::NONE;
567 FilmEditor::audio_gain_changed (wxCommandEvent &)
573 _ignore_changes = Film::AUDIO_GAIN;
574 _film->set_audio_gain (_audio_gain->GetValue ());
575 _ignore_changes = Film::NONE;
579 FilmEditor::audio_delay_changed (wxCommandEvent &)
585 _ignore_changes = Film::AUDIO_DELAY;
586 _film->set_audio_delay (_audio_delay->GetValue ());
587 _ignore_changes = Film::NONE;
591 FilmEditor::video_control (wxControl* c)
593 _video_controls.push_back (c);
598 FilmEditor::still_control (wxControl* c)
600 _still_controls.push_back (c);
605 FilmEditor::setup_visibility ()
607 ContentType c = VIDEO;
610 c = _film->content_type ();
613 for (list<wxControl*>::iterator i = _video_controls.begin(); i != _video_controls.end(); ++i) {
614 (*i)->Show (c == VIDEO);
617 for (list<wxControl*>::iterator i = _still_controls.begin(); i != _still_controls.end(); ++i) {
618 (*i)->Show (c == STILL);
625 FilmEditor::still_duration_changed (wxCommandEvent &)
631 _ignore_changes = Film::STILL_DURATION;
632 _film->set_still_duration (_still_duration->GetValue ());
633 _ignore_changes = Film::NONE;
637 FilmEditor::change_dcp_range_clicked (wxCommandEvent &)
639 DCPRangeDialog* d = new DCPRangeDialog (this, _film);
640 d->Changed.connect (sigc::mem_fun (*this, &FilmEditor::dcp_range_changed));
645 FilmEditor::dcp_range_changed (int frames, TrimAction action)
647 _film->set_dcp_frames (frames);
648 _film->set_dcp_trim_action (action);
652 FilmEditor::audio_gain_calculate_button_clicked (wxCommandEvent &)
654 GainCalculatorDialog* d = new GainCalculatorDialog (this);
657 if (d->wanted_fader() == 0 || d->actual_fader() == 0) {
662 _audio_gain->SetValue (
663 Config::instance()->sound_processor()->db_for_fader_change (
669 /* This appears to be necessary, as the change is not signalled,
672 wxCommandEvent dummy;
673 audio_gain_changed (dummy);
679 FilmEditor::setup_formats ()
681 ContentType c = VIDEO;
684 c = _film->content_type ();
689 vector<Format const *> fmt = Format::all ();
690 for (vector<Format const *>::iterator i = fmt.begin(); i != fmt.end(); ++i) {
691 if (c == VIDEO && dynamic_cast<FixedFormat const *> (*i)) {
692 _formats.push_back (*i);
693 } else if (c == STILL && dynamic_cast<VariableFormat const *> (*i)) {
694 _formats.push_back (*i);
699 for (vector<Format const *>::iterator i = _formats.begin(); i != _formats.end(); ++i) {
700 _format->Append (std_to_wx ((*i)->name ()));