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 s->Add (_audio_gain_calculate_button, 1, wxEXPAND);
124 video_control (add_label_to_sizer (_sizer, this, "Audio Delay"));
125 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
126 _audio_delay = new wxSpinCtrl (this);
127 s->Add (video_control (_audio_delay), 1);
128 video_control (add_label_to_sizer (s, this, "ms"));
132 video_control (add_label_to_sizer (_sizer, this, "Frames Per Second"));
133 _frames_per_second = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, wxDefaultSize, 0, wxTextValidator (wxFILTER_NUMERIC));
134 _sizer->Add (video_control (_frames_per_second));
136 video_control (add_label_to_sizer (_sizer, this, "Original Size"));
137 _original_size = new wxStaticText (this, wxID_ANY, wxT (""));
138 _sizer->Add (video_control (_original_size), 1, wxALIGN_CENTER_VERTICAL);
140 video_control (add_label_to_sizer (_sizer, this, "Length"));
141 _length = new wxStaticText (this, wxID_ANY, wxT (""));
142 _sizer->Add (video_control (_length), 1, wxALIGN_CENTER_VERTICAL);
144 video_control (add_label_to_sizer (_sizer, this, "Audio"));
145 _audio = new wxStaticText (this, wxID_ANY, wxT (""));
146 _sizer->Add (video_control (_audio), 1, wxALIGN_CENTER_VERTICAL);
149 video_control (add_label_to_sizer (_sizer, this, "Range"));
150 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
151 _dcp_range = new wxStaticText (this, wxID_ANY, wxT (""));
152 s->Add (video_control (_dcp_range), 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM | wxRIGHT, 6);
153 _change_dcp_range_button = new wxButton (this, wxID_ANY, wxT ("Edit..."));
154 s->Add (video_control (_change_dcp_range_button), 0, 0, 6);
158 _dcp_ab = new wxCheckBox (this, wxID_ANY, wxT ("A/B"));
159 video_control (_dcp_ab);
160 _sizer->Add (_dcp_ab, 1);
161 _sizer->AddSpacer (0);
163 /* STILL-only stuff */
165 still_control (add_label_to_sizer (_sizer, this, "Duration"));
166 wxSizer* s = new wxBoxSizer (wxHORIZONTAL);
167 _still_duration = new wxSpinCtrl (this);
168 still_control (_still_duration);
169 s->Add (_still_duration, 1, wxEXPAND);
170 still_control (add_label_to_sizer (s, this, "s"));
174 /* Set up our editing widgets */
176 _left_crop->SetRange (0, 1024);
177 _top_crop->SetRange (0, 1024);
178 _right_crop->SetRange (0, 1024);
179 _bottom_crop->SetRange (0, 1024);
180 _audio_gain->SetRange (-60, 60);
181 _audio_delay->SetRange (-1000, 1000);
182 _still_duration->SetRange (0, 60 * 60);
184 vector<Format const *> fmt = Format::all ();
185 for (vector<Format const *>::iterator i = fmt.begin(); i != fmt.end(); ++i) {
186 _format->Append (std_to_wx ((*i)->name ()));
189 vector<DCPContentType const *> const ct = DCPContentType::all ();
190 for (vector<DCPContentType const *>::const_iterator i = ct.begin(); i != ct.end(); ++i) {
191 _dcp_content_type->Append (std_to_wx ((*i)->pretty_name ()));
194 vector<Scaler const *> const sc = Scaler::all ();
195 for (vector<Scaler const *>::const_iterator i = sc.begin(); i != sc.end(); ++i) {
196 _scaler->Append (std_to_wx ((*i)->name()));
199 /* And set their values from the Film */
202 /* Now connect to them, since initial values are safely set */
203 _name->Connect (wxID_ANY, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEventHandler (FilmEditor::name_changed), 0, this);
204 _frames_per_second->Connect (wxID_ANY, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEventHandler (FilmEditor::frames_per_second_changed), 0, this);
205 _format->Connect (wxID_ANY, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEventHandler (FilmEditor::format_changed), 0, this);
206 _content->Connect (wxID_ANY, wxEVT_COMMAND_FILEPICKER_CHANGED, wxCommandEventHandler (FilmEditor::content_changed), 0, this);
207 _left_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::left_crop_changed), 0, this);
208 _right_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::right_crop_changed), 0, this);
209 _top_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::top_crop_changed), 0, this);
210 _bottom_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::bottom_crop_changed), 0, this);
211 _filters_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::edit_filters_clicked), 0, this);
212 _scaler->Connect (wxID_ANY, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEventHandler (FilmEditor::scaler_changed), 0, this);
213 _dcp_content_type->Connect (wxID_ANY, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEventHandler (FilmEditor::dcp_content_type_changed), 0, this);
214 _dcp_ab->Connect (wxID_ANY, wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEventHandler (FilmEditor::dcp_ab_toggled), 0, this);
215 _audio_gain->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::audio_gain_changed), 0, this);
216 _audio_gain_calculate_button->Connect (
217 wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::audio_gain_calculate_button_clicked), 0, this
219 _audio_delay->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::audio_delay_changed), 0, this);
220 _still_duration->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::still_duration_changed), 0, this);
221 _change_dcp_range_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::change_dcp_range_clicked), 0, this);
226 /** Called when the left crop widget has been changed */
228 FilmEditor::left_crop_changed (wxCommandEvent &)
234 _ignore_changes = Film::CROP;
235 _film->set_left_crop (_left_crop->GetValue ());
236 _ignore_changes = Film::NONE;
239 /** Called when the right crop widget has been changed */
241 FilmEditor::right_crop_changed (wxCommandEvent &)
247 _ignore_changes = Film::CROP;
248 _film->set_right_crop (_right_crop->GetValue ());
249 _ignore_changes = Film::NONE;
252 /** Called when the top crop widget has been changed */
254 FilmEditor::top_crop_changed (wxCommandEvent &)
260 _ignore_changes = Film::CROP;
261 _film->set_top_crop (_top_crop->GetValue ());
262 _ignore_changes = Film::NONE;
265 /** Called when the bottom crop value has been changed */
267 FilmEditor::bottom_crop_changed (wxCommandEvent &)
273 _ignore_changes = Film::CROP;
274 _film->set_bottom_crop (_bottom_crop->GetValue ());
275 _ignore_changes = Film::NONE;
278 /** Called when the content filename has been changed */
280 FilmEditor::content_changed (wxCommandEvent &)
286 _ignore_changes = Film::CONTENT;
289 _film->set_content (wx_to_std (_content->GetPath ()));
290 } catch (std::exception& e) {
291 _content->SetPath (std_to_wx (_film->directory ()));
293 m << "Could not set content: " << e.what() << ".";
294 error_dialog (this, m.str ());
297 _ignore_changes = Film::NONE;
302 /** Called when the DCP A/B switch has been toggled */
304 FilmEditor::dcp_ab_toggled (wxCommandEvent &)
310 _ignore_changes = Film::DCP_AB;
311 _film->set_dcp_ab (_dcp_ab->GetValue ());
312 _ignore_changes = Film::NONE;
315 /** Called when the name widget has been changed */
317 FilmEditor::name_changed (wxCommandEvent &)
323 _ignore_changes = Film::NAME;
324 _film->set_name (string (_name->GetValue().mb_str()));
325 _ignore_changes = Film::NONE;
328 /** Called when the metadata stored in the Film object has changed;
329 * so that we can update the GUI.
330 * @param p Property of the Film that has changed.
333 FilmEditor::film_changed (Film::Property p)
335 if (!_film || _ignore_changes == p) {
345 _content->SetPath (std_to_wx (_film->content ()));
349 _format->SetSelection (Format::as_index (_film->format ()));
352 _left_crop->SetValue (_film->crop().left);
353 _right_crop->SetValue (_film->crop().right);
354 _top_crop->SetValue (_film->crop().top);
355 _bottom_crop->SetValue (_film->crop().bottom);
359 pair<string, string> p = Filter::ffmpeg_strings (_film->filters ());
360 if (p.first.empty () && p.second.empty ()) {
361 _filters->SetLabel (_("None"));
363 string const b = p.first + " " + p.second;
364 _filters->SetLabel (std_to_wx (b));
370 _name->ChangeValue (std_to_wx (_film->name ()));
372 case Film::FRAMES_PER_SECOND:
375 s << fixed << setprecision(2) << _film->frames_per_second();
376 _frames_per_second->ChangeValue (std_to_wx (s.str ()));
379 case Film::AUDIO_CHANNELS:
380 case Film::AUDIO_SAMPLE_RATE:
381 if (_film->audio_channels() == 0 && _film->audio_sample_rate() == 0) {
382 _audio->SetLabel (wxT (""));
384 s << _film->audio_channels () << " channels, " << _film->audio_sample_rate() << "Hz";
385 _audio->SetLabel (std_to_wx (s.str ()));
389 if (_film->size().width == 0 && _film->size().height == 0) {
390 _original_size->SetLabel (wxT (""));
392 s << _film->size().width << " x " << _film->size().height;
393 _original_size->SetLabel (std_to_wx (s.str ()));
397 if (_film->frames_per_second() > 0 && _film->length() > 0) {
398 s << _film->length() << " frames; " << seconds_to_hms (_film->length() / _film->frames_per_second());
399 } else if (_film->length() > 0) {
400 s << _film->length() << " frames";
402 _length->SetLabel (std_to_wx (s.str ()));
404 case Film::DCP_CONTENT_TYPE:
405 _dcp_content_type->SetSelection (DCPContentType::as_index (_film->dcp_content_type ()));
409 case Film::DCP_FRAMES:
410 if (_film->dcp_frames() == 0) {
411 _dcp_range->SetLabel (wxT ("Whole film"));
414 s << "First " << _film->dcp_frames() << " frames";
415 _dcp_range->SetLabel (std_to_wx (s.str ()));
419 case Film::DCP_TRIM_ACTION:
422 _dcp_ab->SetValue (_film->dcp_ab ());
425 _scaler->SetSelection (Scaler::as_index (_film->scaler ()));
427 case Film::AUDIO_GAIN:
428 _audio_gain->SetValue (_film->audio_gain ());
430 case Film::AUDIO_DELAY:
431 _audio_delay->SetValue (_film->audio_delay ());
433 case Film::STILL_DURATION:
434 _still_duration->SetValue (_film->still_duration ());
439 /** Called when the format widget has been changed */
441 FilmEditor::format_changed (wxCommandEvent &)
447 _ignore_changes = Film::FORMAT;
448 int const n = _format->GetSelection ();
450 _film->set_format (Format::from_index (n));
452 _ignore_changes = Film::NONE;
455 /** Called when the DCP content type widget has been changed */
457 FilmEditor::dcp_content_type_changed (wxCommandEvent &)
463 _ignore_changes = Film::DCP_CONTENT_TYPE;
464 int const n = _dcp_content_type->GetSelection ();
466 _film->set_dcp_content_type (DCPContentType::from_index (n));
468 _ignore_changes = Film::NONE;
471 /** Sets the Film that we are editing */
473 FilmEditor::set_film (Film* f)
477 set_things_sensitive (_film != 0);
480 _film->Changed.connect (sigc::mem_fun (*this, &FilmEditor::film_changed));
484 FileChanged (_film->directory ());
489 film_changed (Film::NAME);
490 film_changed (Film::CONTENT);
491 film_changed (Film::DCP_CONTENT_TYPE);
492 film_changed (Film::FORMAT);
493 film_changed (Film::CROP);
494 film_changed (Film::FILTERS);
495 film_changed (Film::DCP_FRAMES);
496 film_changed (Film::DCP_TRIM_ACTION);
497 film_changed (Film::DCP_AB);
498 film_changed (Film::SIZE);
499 film_changed (Film::LENGTH);
500 film_changed (Film::FRAMES_PER_SECOND);
501 film_changed (Film::AUDIO_CHANNELS);
502 film_changed (Film::AUDIO_SAMPLE_RATE);
503 film_changed (Film::SCALER);
504 film_changed (Film::AUDIO_GAIN);
505 film_changed (Film::AUDIO_DELAY);
506 film_changed (Film::STILL_DURATION);
509 /** Updates the sensitivity of lots of widgets to a given value.
510 * @param s true to make sensitive, false to make insensitive.
513 FilmEditor::set_things_sensitive (bool s)
516 _frames_per_second->Enable (s);
518 _content->Enable (s);
519 _left_crop->Enable (s);
520 _right_crop->Enable (s);
521 _top_crop->Enable (s);
522 _bottom_crop->Enable (s);
523 _filters_button->Enable (s);
525 _dcp_content_type->Enable (s);
526 _dcp_range->Enable (s);
527 _change_dcp_range_button->Enable (s);
529 _audio_gain->Enable (s);
530 _audio_gain_calculate_button->Enable (s);
531 _audio_delay->Enable (s);
532 _still_duration->Enable (s);
535 /** Called when the `Edit filters' button has been clicked */
537 FilmEditor::edit_filters_clicked (wxCommandEvent &)
539 FilterDialog* d = new FilterDialog (this, _film->filters ());
540 d->ActiveChanged.connect (sigc::mem_fun (*_film, &Film::set_filters));
545 /** Called when the scaler widget has been changed */
547 FilmEditor::scaler_changed (wxCommandEvent &)
553 _ignore_changes = Film::SCALER;
554 int const n = _scaler->GetSelection ();
556 _film->set_scaler (Scaler::from_index (n));
558 _ignore_changes = Film::NONE;
561 /** Called when the frames per second widget has been changed */
563 FilmEditor::frames_per_second_changed (wxCommandEvent &)
569 _ignore_changes = Film::FRAMES_PER_SECOND;
570 _film->set_frames_per_second (boost::lexical_cast<float> (wx_to_std (_frames_per_second->GetValue ())));
571 _ignore_changes = Film::NONE;
575 FilmEditor::audio_gain_changed (wxCommandEvent &)
581 _ignore_changes = Film::AUDIO_GAIN;
582 _film->set_audio_gain (_audio_gain->GetValue ());
583 _ignore_changes = Film::NONE;
587 FilmEditor::audio_delay_changed (wxCommandEvent &)
593 _ignore_changes = Film::AUDIO_DELAY;
594 _film->set_audio_delay (_audio_delay->GetValue ());
595 _ignore_changes = Film::NONE;
599 FilmEditor::video_control (wxControl* c)
601 _video_controls.push_back (c);
606 FilmEditor::still_control (wxControl* c)
608 _still_controls.push_back (c);
613 FilmEditor::setup_visibility ()
615 ContentType c = VIDEO;
618 c = _film->content_type ();
621 for (list<wxControl*>::iterator i = _video_controls.begin(); i != _video_controls.end(); ++i) {
622 (*i)->Show (c == VIDEO);
625 for (list<wxControl*>::iterator i = _still_controls.begin(); i != _still_controls.end(); ++i) {
626 (*i)->Show (c == STILL);
633 FilmEditor::still_duration_changed (wxCommandEvent &)
639 _ignore_changes = Film::STILL_DURATION;
640 _film->set_still_duration (_still_duration->GetValue ());
641 _ignore_changes = Film::NONE;
645 FilmEditor::change_dcp_range_clicked (wxCommandEvent &)
647 DCPRangeDialog* d = new DCPRangeDialog (this, _film);
648 d->Changed.connect (sigc::mem_fun (*this, &FilmEditor::dcp_range_changed));
653 FilmEditor::dcp_range_changed (int frames, TrimAction action)
655 _film->set_dcp_frames (frames);
656 _film->set_dcp_trim_action (action);
660 FilmEditor::audio_gain_calculate_button_clicked (wxCommandEvent &)
662 GainCalculatorDialog* d = new GainCalculatorDialog (this);
664 _audio_gain->SetValue (
665 Config::instance()->sound_processor()->db_for_fader_change (