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"
46 using namespace boost;
48 /** @param f Film to edit */
49 FilmEditor::FilmEditor (Film* f, wxWindow* parent)
51 , _ignore_changes (false)
54 wxSizer* sizer = new wxFlexGridSizer (2, 6, 6);
57 add_label_to_sizer (sizer, this, "Name");
58 _name = new wxTextCtrl (this, wxID_ANY);
59 sizer->Add (_name, 1, wxEXPAND);
61 add_label_to_sizer (sizer, this, "Content");
62 _content = new wxFilePickerCtrl (this, wxID_ANY, wxT (""), wxT ("Select Content File"), wxT("*.*"));
63 sizer->Add (_content, 1, wxEXPAND);
65 add_label_to_sizer (sizer, this, "Content Type");
66 _dcp_content_type = new wxComboBox (this, wxID_ANY);
67 sizer->Add (_dcp_content_type);
69 add_label_to_sizer (sizer, this, "Format");
70 _format = new wxComboBox (this, wxID_ANY);
74 add_label_to_sizer (sizer, this, "Crop");
75 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
77 add_label_to_sizer (s, this, "L");
78 _left_crop = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
79 s->Add (_left_crop, 0);
80 add_label_to_sizer (s, this, "R");
81 _right_crop = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
82 s->Add (_right_crop, 0);
83 add_label_to_sizer (s, this, "T");
84 _top_crop = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
85 s->Add (_top_crop, 0);
86 add_label_to_sizer (s, this, "B");
87 _bottom_crop = new wxSpinCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (64, -1));
88 s->Add (_bottom_crop, 0);
93 /* VIDEO-only stuff */
95 video_control (add_label_to_sizer (sizer, this, "Filters"));
96 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
97 _filters = new wxStaticText (this, wxID_ANY, wxT (""));
98 s->Add (_filters, 1, wxEXPAND | wxALIGN_CENTER_VERTICAL | wxALL, 6);
99 _filters_button = new wxButton (this, wxID_ANY, wxT ("Edit..."));
100 s->Add (_filters_button, 0);
104 video_control (add_label_to_sizer (sizer, this, "Scaler"));
105 _scaler = new wxComboBox (this, wxID_ANY);
106 sizer->Add (video_control (_scaler), 1);
109 video_control (add_label_to_sizer (sizer, this, "Audio Gain"));
110 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
111 _audio_gain = new wxSpinCtrl (this);
112 s->Add (video_control (_audio_gain), 1);
113 video_control (add_label_to_sizer (s, this, "dB"));
118 video_control (add_label_to_sizer (sizer, this, "Audio Delay"));
119 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
120 _audio_delay = new wxSpinCtrl (this);
121 s->Add (video_control (_audio_delay), 1);
122 video_control (add_label_to_sizer (s, this, "ms"));
126 video_control (add_label_to_sizer (sizer, this, "Frames Per Second"));
127 _frames_per_second = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, wxDefaultSize, 0, wxTextValidator (wxFILTER_NUMERIC));
128 sizer->Add (video_control (_frames_per_second));
130 video_control (add_label_to_sizer (sizer, this, "Original Size"));
131 _original_size = new wxStaticText (this, wxID_ANY, wxT (""));
132 sizer->Add (video_control (_original_size), 1, wxALIGN_CENTER_VERTICAL);
134 video_control (add_label_to_sizer (sizer, this, "Length"));
135 _length = new wxStaticText (this, wxID_ANY, wxT (""));
136 sizer->Add (video_control (_length), 1, wxALIGN_CENTER_VERTICAL);
138 video_control (add_label_to_sizer (sizer, this, "Audio"));
139 _audio = new wxStaticText (this, wxID_ANY, wxT (""));
140 sizer->Add (video_control (_audio), 1, wxALIGN_CENTER_VERTICAL);
143 video_control (add_label_to_sizer (sizer, this, "Range"));
144 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
145 _dcp_range = new wxStaticText (this, wxID_ANY, wxT (""));
146 s->Add (video_control (_dcp_range), 1, wxALIGN_CENTER_VERTICAL);
147 _change_dcp_range_button = new wxButton (this, wxID_ANY, wxT ("Edit..."));
148 s->Add (video_control (_change_dcp_range_button));
152 _dcp_ab = new wxCheckBox (this, wxID_ANY, wxT ("A/B"));
153 video_control (_dcp_ab);
154 sizer->Add (_dcp_ab, 1);
155 sizer->AddSpacer (0);
157 /* STILL-only stuff */
158 still_control (add_label_to_sizer (sizer, this, "Duration"));
159 _still_duration = new wxSpinCtrl (this);
160 sizer->Add (still_control (_still_duration));
161 still_control (add_label_to_sizer (sizer, this, "s"));
163 /* Set up our editing widgets */
165 _left_crop->SetRange (0, 1024);
166 _top_crop->SetRange (0, 1024);
167 _right_crop->SetRange (0, 1024);
168 _bottom_crop->SetRange (0, 1024);
169 _audio_gain->SetRange (-60, 60);
170 _audio_delay->SetRange (-1000, 1000);
171 _still_duration->SetRange (0, 60 * 60);
173 vector<Format const *> fmt = Format::all ();
174 for (vector<Format const *>::iterator i = fmt.begin(); i != fmt.end(); ++i) {
175 _format->Append (std_to_wx ((*i)->name ()));
178 vector<DCPContentType const *> const ct = DCPContentType::all ();
179 for (vector<DCPContentType const *>::const_iterator i = ct.begin(); i != ct.end(); ++i) {
180 _dcp_content_type->Append (std_to_wx ((*i)->pretty_name ()));
183 vector<Scaler const *> const sc = Scaler::all ();
184 for (vector<Scaler const *>::const_iterator i = sc.begin(); i != sc.end(); ++i) {
185 _scaler->Append (std_to_wx ((*i)->name()));
188 /* And set their values from the Film */
191 /* Now connect to them, since initial values are safely set */
192 _name->Connect (wxID_ANY, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEventHandler (FilmEditor::name_changed), 0, this);
193 _frames_per_second->Connect (wxID_ANY, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEventHandler (FilmEditor::frames_per_second_changed), 0, this);
194 _format->Connect (wxID_ANY, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEventHandler (FilmEditor::format_changed), 0, this);
195 _content->Connect (wxID_ANY, wxEVT_COMMAND_FILEPICKER_CHANGED, wxCommandEventHandler (FilmEditor::content_changed), 0, this);
196 _left_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::left_crop_changed), 0, this);
197 _right_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::right_crop_changed), 0, this);
198 _top_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::top_crop_changed), 0, this);
199 _bottom_crop->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::bottom_crop_changed), 0, this);
200 _filters_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::edit_filters_clicked), 0, this);
201 _scaler->Connect (wxID_ANY, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEventHandler (FilmEditor::scaler_changed), 0, this);
202 _dcp_content_type->Connect (wxID_ANY, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEventHandler (FilmEditor::dcp_content_type_changed), 0, this);
203 _dcp_ab->Connect (wxID_ANY, wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEventHandler (FilmEditor::dcp_ab_toggled), 0, this);
204 _audio_gain->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::audio_gain_changed), 0, this);
205 _audio_delay->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::audio_delay_changed), 0, this);
206 _still_duration->Connect (wxID_ANY, wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEventHandler (FilmEditor::still_duration_changed), 0, this);
207 _change_dcp_range_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmEditor::change_dcp_range_clicked), 0, this);
212 /** Called when the left crop widget has been changed */
214 FilmEditor::left_crop_changed (wxCommandEvent &)
220 _ignore_changes = true;
221 _film->set_left_crop (_left_crop->GetValue ());
222 _ignore_changes = false;
225 /** Called when the right crop widget has been changed */
227 FilmEditor::right_crop_changed (wxCommandEvent &)
233 _ignore_changes = true;
234 _film->set_right_crop (_right_crop->GetValue ());
235 _ignore_changes = false;
238 /** Called when the top crop widget has been changed */
240 FilmEditor::top_crop_changed (wxCommandEvent &)
246 _ignore_changes = true;
247 _film->set_top_crop (_top_crop->GetValue ());
248 _ignore_changes = false;
251 /** Called when the bottom crop value has been changed */
253 FilmEditor::bottom_crop_changed (wxCommandEvent &)
259 _ignore_changes = true;
260 _film->set_bottom_crop (_bottom_crop->GetValue ());
261 _ignore_changes = false;
264 /** Called when the content filename has been changed */
266 FilmEditor::content_changed (wxCommandEvent &)
272 _ignore_changes = true;
275 _film->set_content (wx_to_std (_content->GetPath ()));
276 } catch (std::exception& e) {
277 _content->SetPath (std_to_wx (_film->directory ()));
279 m << "Could not set content: " << e.what() << ".";
280 error_dialog (this, m.str ());
283 _ignore_changes = false;
286 /** Called when the DCP A/B switch has been toggled */
288 FilmEditor::dcp_ab_toggled (wxCommandEvent &)
294 _ignore_changes = true;
295 _film->set_dcp_ab (_dcp_ab->GetValue ());
296 _ignore_changes = false;
299 /** Called when the name widget has been changed */
301 FilmEditor::name_changed (wxCommandEvent &)
307 _ignore_changes = true;
308 _film->set_name (string (_name->GetValue().mb_str()));
309 _ignore_changes = false;
312 /** Called when the metadata stored in the Film object has changed;
313 * so that we can update the GUI.
314 * @param p Property of the Film that has changed.
317 FilmEditor::film_changed (Film::Property p)
319 if (!_film || _ignore_changes) {
327 _content->SetPath (std_to_wx (_film->content ()));
331 _format->SetSelection (Format::as_index (_film->format ()));
333 case Film::LEFT_CROP:
334 _left_crop->SetValue (_film->left_crop ());
336 case Film::RIGHT_CROP:
337 _right_crop->SetValue (_film->right_crop ());
340 _top_crop->SetValue (_film->top_crop ());
342 case Film::BOTTOM_CROP:
343 _bottom_crop->SetValue (_film->bottom_crop ());
347 pair<string, string> p = Filter::ffmpeg_strings (_film->filters ());
348 string const b = p.first + " " + p.second;
349 _filters->SetLabel (std_to_wx (b));
353 _name->ChangeValue (std_to_wx (_film->name ()));
355 case Film::FRAMES_PER_SECOND:
358 s << fixed << setprecision(2) << _film->frames_per_second();
359 _frames_per_second->ChangeValue (std_to_wx (s.str ()));
362 case Film::AUDIO_CHANNELS:
363 case Film::AUDIO_SAMPLE_RATE:
364 if (_film->audio_channels() == 0 && _film->audio_sample_rate() == 0) {
365 _audio->SetLabel (wxT (""));
367 s << _film->audio_channels () << " channels, " << _film->audio_sample_rate() << "Hz";
368 _audio->SetLabel (std_to_wx (s.str ()));
372 if (_film->size().width == 0 && _film->size().height == 0) {
373 _original_size->SetLabel (wxT (""));
375 s << _film->size().width << " x " << _film->size().height;
376 _original_size->SetLabel (std_to_wx (s.str ()));
380 if (_film->frames_per_second() > 0 && _film->length() > 0) {
381 s << _film->length() << " frames; " << seconds_to_hms (_film->length() / _film->frames_per_second());
382 } else if (_film->length() > 0) {
383 s << _film->length() << " frames";
385 _length->SetLabel (std_to_wx (s.str ()));
387 case Film::DCP_CONTENT_TYPE:
388 _dcp_content_type->SetSelection (DCPContentType::as_index (_film->dcp_content_type ()));
392 case Film::DCP_FRAMES:
393 if (_film->dcp_frames() == 0) {
394 _dcp_range->SetLabel (wxT ("Whole film"));
397 s << "First " << _film->dcp_frames() << " frames";
398 _dcp_range->SetLabel (std_to_wx (s.str ()));
401 case Film::DCP_TRIM_ACTION:
404 _dcp_ab->SetValue (_film->dcp_ab ());
407 _scaler->SetSelection (Scaler::as_index (_film->scaler ()));
409 case Film::AUDIO_GAIN:
410 _audio_gain->SetValue (_film->audio_gain ());
412 case Film::AUDIO_DELAY:
413 _audio_delay->SetValue (_film->audio_delay ());
415 case Film::STILL_DURATION:
416 _still_duration->SetValue (_film->still_duration ());
421 /** Called when the format widget has been changed */
423 FilmEditor::format_changed (wxCommandEvent &)
429 _ignore_changes = true;
430 int const n = _format->GetSelection ();
432 _film->set_format (Format::from_index (n));
434 _ignore_changes = false;
437 /** Called when the DCP content type widget has been changed */
439 FilmEditor::dcp_content_type_changed (wxCommandEvent &)
445 _ignore_changes = true;
446 int const n = _dcp_content_type->GetSelection ();
448 _film->set_dcp_content_type (DCPContentType::from_index (n));
450 _ignore_changes = false;
453 /** Sets the Film that we are editing */
455 FilmEditor::set_film (Film* f)
459 set_things_sensitive (_film != 0);
462 _film->Changed.connect (sigc::mem_fun (*this, &FilmEditor::film_changed));
466 FileChanged (_film->directory ());
471 film_changed (Film::NAME);
472 film_changed (Film::CONTENT);
473 film_changed (Film::DCP_CONTENT_TYPE);
474 film_changed (Film::FORMAT);
475 film_changed (Film::LEFT_CROP);
476 film_changed (Film::RIGHT_CROP);
477 film_changed (Film::TOP_CROP);
478 film_changed (Film::BOTTOM_CROP);
479 film_changed (Film::FILTERS);
480 film_changed (Film::DCP_FRAMES);
481 film_changed (Film::DCP_TRIM_ACTION);
482 film_changed (Film::DCP_AB);
483 film_changed (Film::SIZE);
484 film_changed (Film::LENGTH);
485 film_changed (Film::FRAMES_PER_SECOND);
486 film_changed (Film::AUDIO_CHANNELS);
487 film_changed (Film::AUDIO_SAMPLE_RATE);
488 film_changed (Film::SCALER);
489 film_changed (Film::AUDIO_GAIN);
490 film_changed (Film::AUDIO_DELAY);
491 film_changed (Film::STILL_DURATION);
494 /** Updates the sensitivity of lots of widgets to a given value.
495 * @param s true to make sensitive, false to make insensitive.
498 FilmEditor::set_things_sensitive (bool s)
501 _frames_per_second->Enable (s);
503 _content->Enable (s);
504 _left_crop->Enable (s);
505 _right_crop->Enable (s);
506 _top_crop->Enable (s);
507 _bottom_crop->Enable (s);
508 _filters_button->Enable (s);
510 _dcp_content_type->Enable (s);
511 _dcp_range->Enable (s);
512 _change_dcp_range_button->Enable (s);
514 _audio_gain->Enable (s);
515 _audio_delay->Enable (s);
516 _still_duration->Enable (s);
519 /** Called when the `Edit filters' button has been clicked */
521 FilmEditor::edit_filters_clicked (wxCommandEvent &)
523 // FilterDialog d (_film->filters ());
524 // d.ActiveChanged.connect (sigc::mem_fun (*_film, &Film::set_filters));
528 /** Called when the scaler widget has been changed */
530 FilmEditor::scaler_changed (wxCommandEvent &)
536 _ignore_changes = true;
537 int const n = _scaler->GetSelection ();
539 _film->set_scaler (Scaler::from_index (n));
541 _ignore_changes = false;
544 /** Called when the frames per second widget has been changed */
546 FilmEditor::frames_per_second_changed (wxCommandEvent &)
552 _ignore_changes = true;
553 _film->set_frames_per_second (boost::lexical_cast<float> (wx_to_std (_frames_per_second->GetValue ())));
554 _ignore_changes = false;
558 FilmEditor::audio_gain_changed (wxCommandEvent &)
564 _ignore_changes = true;
565 _film->set_audio_gain (_audio_gain->GetValue ());
566 _ignore_changes = false;
570 FilmEditor::audio_delay_changed (wxCommandEvent &)
576 _ignore_changes = true;
577 _film->set_audio_delay (_audio_delay->GetValue ());
578 _ignore_changes = false;
582 FilmEditor::video_control (wxControl* c)
584 _video_controls.push_back (c);
589 FilmEditor::still_control (wxControl* c)
591 _still_controls.push_back (c);
596 FilmEditor::setup_visibility ()
598 ContentType c = VIDEO;
601 c = _film->content_type ();
604 for (list<wxControl*>::iterator i = _video_controls.begin(); i != _video_controls.end(); ++i) {
605 (*i)->Show (c == VIDEO);
608 for (list<wxControl*>::iterator i = _still_controls.begin(); i != _still_controls.end(); ++i) {
609 (*i)->Show (c == STILL);
614 FilmEditor::still_duration_changed (wxCommandEvent &)
620 _ignore_changes = true;
621 _film->set_still_duration (_still_duration->GetValue ());
622 _ignore_changes = false;
626 FilmEditor::change_dcp_range_clicked (wxCommandEvent &)
628 //XXX DCPRangeDialog d (_film);
629 //XXX d.Changed.connect (sigc::mem_fun (*this, &FilmEditor::dcp_range_changed));
634 FilmEditor::dcp_range_changed (int frames, TrimAction action)
636 _ignore_changes = true;
637 _film->set_dcp_frames (frames);
638 _film->set_dcp_trim_action (action);
639 _ignore_changes = false;