2 Copyright (C) 2018 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 "film_viewer.h"
24 #include "playhead_to_timecode_dialog.h"
25 #include "playhead_to_frame_dialog.h"
26 #include "lib/job_manager.h"
27 #include "lib/player_video.h"
28 #include "lib/dcp_content.h"
30 #include "lib/examine_content_job.h"
31 #include "lib/content_factory.h"
32 #include "lib/cross.h"
36 #include <dcp/reel_picture_asset.h>
38 #include <wx/tglbtn.h>
39 #include <wx/listctrl.h>
40 #include <wx/progdlg.h>
46 using boost::optional;
47 using boost::shared_ptr;
48 using boost::weak_ptr;
49 using boost::dynamic_pointer_cast;
51 Controls::Controls (wxWindow* parent, shared_ptr<FilmViewer> viewer, bool editor_controls)
54 , _slider_being_moved (false)
55 , _was_running_before_slider (false)
56 , _outline_content (0)
58 , _jump_to_selected (0)
59 , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
60 , _rewind_button (new wxButton (this, wxID_ANY, wxT("|<")))
61 , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
62 , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
63 , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
64 , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
65 #ifdef DCPOMATIC_VARIANT_SWAROOP
66 , _play_button (new wxButton(this, wxID_ANY, _("Play")))
67 , _pause_button (new wxButton(this, wxID_ANY, _("Pause")))
68 , _stop_button (new wxButton(this, wxID_ANY, _("Stop")))
70 , _play_button (new wxToggleButton(this, wxID_ANY, _("Play")))
73 _v_sizer = new wxBoxSizer (wxVERTICAL);
76 wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
77 if (editor_controls) {
78 _outline_content = new wxCheckBox (this, wxID_ANY, _("Outline content"));
79 view_options->Add (_outline_content, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
80 _eye = new wxChoice (this, wxID_ANY);
81 _eye->Append (_("Left"));
82 _eye->Append (_("Right"));
83 _eye->SetSelection (0);
84 view_options->Add (_eye, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
85 _jump_to_selected = new wxCheckBox (this, wxID_ANY, _("Jump to selected content"));
86 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
89 _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
91 wxBoxSizer* left_sizer = new wxBoxSizer (wxVERTICAL);
93 _spl_view = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_NO_HEADER);
94 _spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 740);
95 left_sizer->Add (_spl_view, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
97 _content_view = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_NO_HEADER);
99 _content_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
101 _content_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
102 /* annotation text */
103 _content_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 580);
104 left_sizer->Add (_content_view, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
106 wxBoxSizer* e_sizer = new wxBoxSizer (wxHORIZONTAL);
107 e_sizer->Add (left_sizer, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
109 _current_spl_view = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_NO_HEADER);
110 _current_spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
111 _current_spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
112 _current_spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 580);
113 e_sizer->Add (_current_spl_view, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
115 wxBoxSizer* buttons_sizer = new wxBoxSizer (wxVERTICAL);
116 _add_button = new wxButton(this, wxID_ANY, _("Add"));
117 buttons_sizer->Add (_add_button);
118 _save_button = new wxButton(this, wxID_ANY, _("Save..."));
119 buttons_sizer->Add (_save_button);
120 _load_button = new wxButton(this, wxID_ANY, _("Load..."));
121 buttons_sizer->Add (_load_button);
122 e_sizer->Add (buttons_sizer, 0, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
124 _v_sizer->Add (e_sizer, 1, wxEXPAND);
126 _log = new wxTextCtrl (this, wxID_ANY, wxT(""), wxDefaultPosition, wxSize(-1, 200), wxTE_READONLY | wxTE_MULTILINE);
127 _v_sizer->Add (_log, 0, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
129 _content_view->Show (false);
130 _spl_view->Show (false);
131 _current_spl_view->Show (false);
132 _add_button->Show (false);
133 _save_button->Show (false);
134 _load_button->Show (false);
137 wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
139 wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
140 time_sizer->Add (_frame_number, 0, wxEXPAND);
141 time_sizer->Add (_timecode, 0, wxEXPAND);
143 h_sizer->Add (_rewind_button, 0, wxALL, 2);
144 h_sizer->Add (_back_button, 0, wxALL, 2);
145 h_sizer->Add (time_sizer, 0, wxEXPAND);
146 h_sizer->Add (_forward_button, 0, wxALL, 2);
147 h_sizer->Add (_play_button, 0, wxEXPAND);
148 #ifdef DCPOMATIC_VARIANT_SWAROOP
149 h_sizer->Add (_pause_button, 0, wxEXPAND);
150 h_sizer->Add (_stop_button, 0, wxEXPAND);
152 h_sizer->Add (_slider, 1, wxEXPAND);
154 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
156 _frame_number->SetMinSize (wxSize (84, -1));
157 _rewind_button->SetMinSize (wxSize (32, -1));
158 _back_button->SetMinSize (wxSize (32, -1));
159 _forward_button->SetMinSize (wxSize (32, -1));
162 _eye->Bind (wxEVT_CHOICE, boost::bind (&Controls::eye_changed, this));
164 if (_outline_content) {
165 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::outline_content_changed, this));
168 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&Controls::slider_moved, this, false));
169 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&Controls::slider_moved, this, true));
170 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&Controls::slider_moved, this, true));
171 _slider->Bind (wxEVT_SCROLL_CHANGED, boost::bind(&Controls::slider_released, this));
172 #ifdef DCPOMATIC_VARIANT_SWAROOP
173 _play_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::play_clicked, this));
174 _pause_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::pause_clicked, this));
175 _stop_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::stop_clicked, this));
177 _play_button->Bind (wxEVT_TOGGLEBUTTON, boost::bind(&Controls::play_clicked, this));
179 _rewind_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::rewind_clicked, this, _1));
180 _back_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::back_clicked, this, _1));
181 _forward_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::forward_clicked, this, _1));
182 _frame_number->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::frame_number_clicked, this));
183 _timecode->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::timecode_clicked, this));
184 _content_view->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind(&Controls::setup_sensitivity, this));
185 _content_view->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind(&Controls::setup_sensitivity, this));
186 if (_jump_to_selected) {
187 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::jump_to_selected_clicked, this));
188 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
190 _add_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::add_clicked, this));
191 _save_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::save_clicked, this));
192 _load_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::load_clicked, this));
194 _viewer->PositionChanged.connect (boost::bind(&Controls::position_changed, this));
195 _viewer->Started.connect (boost::bind(&Controls::started, this));
196 _viewer->Stopped.connect (boost::bind(&Controls::stopped, this));
197 _viewer->FilmChanged.connect (boost::bind(&Controls::film_changed, this));
198 _viewer->ImageChanged.connect (boost::bind(&Controls::image_changed, this, _1));
202 setup_sensitivity ();
203 update_content_directory ();
204 update_playlist_directory ();
206 JobManager::instance()->ActiveJobsChanged.connect (
207 bind (&Controls::active_jobs_changed, this, _2)
210 _config_changed_connection = Config::instance()->Changed.connect (bind(&Controls::config_changed, this, _1));
211 config_changed (Config::OTHER);
215 Controls::add_clicked ()
217 shared_ptr<Content> sel = selected_content()->clone();
218 DCPOMATIC_ASSERT (sel);
219 _film->examine_and_add_content (sel);
220 bool const ok = display_progress (_("DCP-o-matic"), _("Loading DCP"));
221 if (!ok || !report_errors_from_last_job(this)) {
224 add_content_to_list (sel, _current_spl_view);
225 setup_sensitivity ();
229 Controls::save_clicked ()
231 wxFileDialog* d = new wxFileDialog (
232 this, _("Select playlist file"), wxEmptyString, wxEmptyString, wxT ("XML files (*.xml)|*.xml"),
233 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
236 if (d->ShowModal() == wxID_OK) {
237 boost::filesystem::path p(wx_to_std(d->GetPath()));
238 _film->set_name(p.stem().string());
239 _film->write_metadata(p);
246 Controls::load_clicked ()
248 wxFileDialog* d = new wxFileDialog (
249 this, _("Select playlist file"), wxEmptyString, wxEmptyString, wxT ("XML files (*.xml)|*.xml")
252 if (d->ShowModal() == wxID_OK) {
253 _film->read_metadata (boost::filesystem::path(wx_to_std(d->GetPath())));
254 _current_spl_view->DeleteAllItems ();
255 BOOST_FOREACH (shared_ptr<Content> i, _film->content()) {
256 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent>(i);
257 add_content_to_list (dcp, _current_spl_view);
265 Controls::config_changed (int property)
267 if (property == Config::PLAYER_CONTENT_DIRECTORY) {
268 update_content_directory ();
269 } else if (property == Config::PLAYER_PLAYLIST_DIRECTORY) {
270 update_playlist_directory ();
272 setup_sensitivity ();
279 #ifdef DCPOMATIC_VARIANT_SWAROOP
280 _play_button->Enable (false);
281 _pause_button->Enable (true);
283 _play_button->SetValue (true);
285 setup_sensitivity ();
291 #ifdef DCPOMATIC_VARIANT_SWAROOP
292 _play_button->Enable (true);
293 _pause_button->Enable (false);
295 _play_button->SetValue (false);
297 setup_sensitivity ();
301 Controls::position_changed ()
303 if (!_slider_being_moved) {
304 update_position_label ();
305 update_position_slider ();
310 Controls::eye_changed ()
312 _viewer->set_eyes (_eye->GetSelection() == 0 ? EYES_LEFT : EYES_RIGHT);
316 Controls::outline_content_changed ()
318 _viewer->set_outline_content (_outline_content->GetValue());
322 Controls::film_change (ChangeType type, Film::Property p)
324 if (type != CHANGE_TYPE_DONE) {
328 if (p == Film::CONTENT || p == Film::THREE_D) {
329 setup_sensitivity ();
333 /** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
335 Controls::slider_moved (bool page)
341 if (!page && !_slider_being_moved) {
342 /* This is the first event of a drag; stop playback for the duration of the drag */
343 _was_running_before_slider = _viewer->stop ();
344 _slider_being_moved = true;
347 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
348 t = t.round (_film->video_frame_rate());
349 /* Ensure that we hit the end of the film at the end of the slider */
350 if (t >= _film->length ()) {
351 t = _film->length() - _viewer->one_video_frame();
353 _viewer->seek (t, false);
354 update_position_label ();
358 Controls::slider_released ()
360 if (_was_running_before_slider) {
361 /* Restart after a drag */
364 _slider_being_moved = false;
368 Controls::play_clicked ()
370 #ifdef DCPOMATIC_VARIANT_SWAROOP
378 #ifndef DCPOMATIC_VARIANT_SWAROOP
380 Controls::check_play_state ()
382 if (!_film || _film->video_frame_rate() == 0) {
386 if (_play_button->GetValue()) {
395 Controls::update_position_slider ()
398 _slider->SetValue (0);
402 DCPTime const len = _film->length ();
405 int const new_slider_position = 4096 * _viewer->position().get() / len.get();
406 if (new_slider_position != _slider->GetValue()) {
407 _slider->SetValue (new_slider_position);
413 Controls::update_position_label ()
416 _frame_number->SetLabel ("0");
417 _timecode->SetLabel ("0:0:0.0");
421 double const fps = _film->video_frame_rate ();
422 /* Count frame number from 1 ... not sure if this is the best idea */
423 _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_viewer->position().seconds() * fps) + 1));
424 _timecode->SetLabel (time_to_timecode (_viewer->position(), fps));
428 Controls::active_jobs_changed (optional<string> j)
431 setup_sensitivity ();
435 Controls::nudge_amount (wxKeyboardState& ev)
437 DCPTime amount = _viewer->one_video_frame ();
439 if (ev.ShiftDown() && !ev.ControlDown()) {
440 amount = DCPTime::from_seconds (1);
441 } else if (!ev.ShiftDown() && ev.ControlDown()) {
442 amount = DCPTime::from_seconds (10);
443 } else if (ev.ShiftDown() && ev.ControlDown()) {
444 amount = DCPTime::from_seconds (60);
451 Controls::rewind_clicked (wxMouseEvent& ev)
453 _viewer->seek (DCPTime(), true);
458 Controls::back_frame ()
460 _viewer->seek_by (-_viewer->one_video_frame(), true);
464 Controls::forward_frame ()
466 _viewer->seek_by (_viewer->one_video_frame(), true);
470 Controls::back_clicked (wxKeyboardState& ev)
472 _viewer->seek_by (-nudge_amount(ev), true);
476 Controls::forward_clicked (wxKeyboardState& ev)
478 _viewer->seek_by (nudge_amount(ev), true);
482 Controls::setup_sensitivity ()
484 /* examine content is the only job which stops the viewer working */
485 bool const active_job = _active_job && *_active_job != "examine_content";
486 bool const c = _film && !_film->content().empty() && !active_job;
489 _rewind_button->Enable (c);
490 _back_button->Enable (c);
491 _forward_button->Enable (c);
492 #ifdef DCPOMATIC_VARIANT_SWAROOP
493 _play_button->Enable (c && !_viewer->playing());
494 _pause_button->Enable (c && (!_current_kind || _current_kind != dcp::ADVERTISEMENT) && _viewer->playing());
495 _stop_button->Enable (c && (!_current_kind || _current_kind != dcp::ADVERTISEMENT));
496 _slider->Enable (c && (!_current_kind || _current_kind != dcp::ADVERTISEMENT));
498 _play_button->Enable (c);
500 if (_outline_content) {
501 _outline_content->Enable (c);
503 _frame_number->Enable (c);
504 _timecode->Enable (c);
505 if (_jump_to_selected) {
506 _jump_to_selected->Enable (c);
510 _eye->Enable (c && _film->three_d ());
513 _add_button->Enable (Config::instance()->allow_spl_editing() && static_cast<bool>(selected_content()));
514 _save_button->Enable (Config::instance()->allow_spl_editing());
518 Controls::selected_content () const
520 long int s = _content_view->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
522 return shared_ptr<Content>();
525 DCPOMATIC_ASSERT (s < int(_content.size()));
530 Controls::timecode_clicked ()
532 PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
533 if (dialog->ShowModal() == wxID_OK) {
534 _viewer->seek (dialog->get(), true);
540 Controls::frame_number_clicked ()
542 PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
543 if (dialog->ShowModal() == wxID_OK) {
544 _viewer->seek (dialog->get(), true);
550 Controls::jump_to_selected_clicked ()
552 Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
556 Controls::film_changed ()
558 shared_ptr<Film> film = _viewer->film ();
566 setup_sensitivity ();
568 update_position_slider ();
569 update_position_label ();
572 _film->Change.connect (boost::bind (&Controls::film_change, this, _1, _2));
577 Controls::film () const
583 Controls::show_extended_player_controls (bool s)
585 _content_view->Show (s);
588 update_content_directory ();
589 update_playlist_directory ();
591 _current_spl_view->Show (s);
593 _add_button->Show (s);
594 _save_button->Show (s);
595 _load_button->Show (s);
600 Controls::add_content_to_list (shared_ptr<Content> content, wxListCtrl* ctrl)
602 int const N = ctrl->GetItemCount();
607 DCPTime length = content->length_after_trim (_film);
608 int seconds = length.seconds();
609 int minutes = seconds / 60;
610 seconds -= minutes * 60;
611 int hours = minutes / 60;
612 minutes -= hours * 60;
613 it.SetText(wxString::Format("%02d:%02d:%02d", hours, minutes, seconds));
614 ctrl->InsertItem(it);
616 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent>(content);
617 if (dcp && dcp->content_kind()) {
620 it.SetText(std_to_wx(dcp::content_kind_to_string(*dcp->content_kind())));
626 it.SetText(std_to_wx(content->summary()));
631 Controls::add_playlist_to_list (shared_ptr<Film> film)
633 int const N = _spl_view->GetItemCount();
638 it.SetText (std_to_wx(film->name()));
639 _spl_view->InsertItem (it);
643 Controls::update_content_directory ()
645 if (!_content_view->IsShown()) {
649 using namespace boost::filesystem;
651 _content_view->DeleteAllItems ();
653 optional<path> dir = Config::instance()->player_content_directory();
658 wxProgressDialog progress (_("DCP-o-matic"), _("Reading content directory"));
659 JobManager* jm = JobManager::instance ();
661 for (directory_iterator i = directory_iterator(*dir); i != directory_iterator(); ++i) {
663 shared_ptr<Content> content;
664 if (is_directory(*i) && (is_regular_file(*i / "ASSETMAP") || is_regular_file(*i / "ASSETMAP.xml"))) {
665 content.reset (new DCPContent(*i));
666 } else if (i->path().extension() == ".mp4" || i->path().extension() == ".ecinema") {
667 content = content_factory(*i).front();
671 jm->add (shared_ptr<Job>(new ExamineContentJob(_film, content)));
672 while (jm->work_to_do()) {
673 if (!progress.Pulse()) {
674 /* user pressed cancel */
675 BOOST_FOREACH (shared_ptr<Job> i, jm->get()) {
682 if (report_errors_from_last_job (this)) {
683 add_content_to_list (content, _content_view);
684 _content.push_back (content);
687 } catch (boost::filesystem::filesystem_error& e) {
689 } catch (dcp::DCPReadError& e) {
696 Controls::update_playlist_directory ()
698 if (!_spl_view->IsShown()) {
702 using namespace boost::filesystem;
704 _spl_view->DeleteAllItems ();
705 optional<path> dir = Config::instance()->player_playlist_directory();
710 for (directory_iterator i = directory_iterator(*dir); i != directory_iterator(); ++i) {
712 shared_ptr<Film> film (new Film(optional<path>()));
713 film->read_metadata (i->path());
714 _playlists.push_back (film);
715 add_playlist_to_list (film);
716 } catch (exception& e) {
722 #ifdef DCPOMATIC_VARIANT_SWAROOP
724 Controls::pause_clicked ()
730 Controls::stop_clicked ()
733 _viewer->seek (DCPTime(), true);
738 Controls::log (wxString s)
741 gettimeofday (&time, 0);
743 time_t const sec = time.tv_sec;
744 struct tm* t = localtime (&sec);
745 strftime (buffer, 64, "%c", t);
746 wxString ts = std_to_wx(string(buffer)) + N_(": ");
747 _log->SetValue(_log->GetValue() + ts + s + "\n");
751 Controls::image_changed (boost::weak_ptr<PlayerVideo> weak_pv)
753 #ifdef DCPOMATIC_VARIANT_SWAROOP
754 shared_ptr<PlayerVideo> pv = weak_pv.lock ();
759 shared_ptr<Content> c = pv->content().lock();
764 shared_ptr<DCPContent> dc = dynamic_pointer_cast<DCPContent> (c);
769 if (!_current_kind || *_current_kind != dc->content_kind()) {
770 _current_kind = dc->content_kind ();
771 setup_sensitivity ();