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"
30 #include <dcp/reel_picture_asset.h>
32 #include <wx/tglbtn.h>
33 #include <wx/listctrl.h>
38 using boost::optional;
39 using boost::shared_ptr;
40 using boost::weak_ptr;
42 Controls::Controls (wxWindow* parent, shared_ptr<FilmViewer> viewer, bool editor_controls)
45 , _slider_being_moved (false)
46 , _was_running_before_slider (false)
47 , _outline_content (0)
49 , _jump_to_selected (0)
50 , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
51 , _rewind_button (new wxButton (this, wxID_ANY, wxT("|<")))
52 , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
53 , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
54 , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
55 , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
56 #ifdef DCPOMATIC_VARIANT_SWAROOP
57 , _play_button (new wxButton(this, wxID_ANY, _("Play")))
58 , _pause_button (new wxButton(this, wxID_ANY, _("Pause")))
59 , _stop_button (new wxButton(this, wxID_ANY, _("Stop")))
61 , _play_button (new wxToggleButton(this, wxID_ANY, _("Play")))
64 _v_sizer = new wxBoxSizer (wxVERTICAL);
67 wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
68 if (editor_controls) {
69 _outline_content = new wxCheckBox (this, wxID_ANY, _("Outline content"));
70 view_options->Add (_outline_content, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
71 _eye = new wxChoice (this, wxID_ANY);
72 _eye->Append (_("Left"));
73 _eye->Append (_("Right"));
74 _eye->SetSelection (0);
75 view_options->Add (_eye, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
76 _jump_to_selected = new wxCheckBox (this, wxID_ANY, _("Jump to selected content"));
77 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
80 _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
82 wxBoxSizer* e_sizer = new wxBoxSizer (wxHORIZONTAL);
84 _cpl = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_NO_HEADER);
86 _cpl->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
88 _cpl->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
90 _cpl->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 580);
91 e_sizer->Add (_cpl, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
93 _spl_view = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_NO_HEADER);
94 _spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
95 _spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
96 _spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 580);
97 e_sizer->Add (_spl_view, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
99 wxBoxSizer* buttons_sizer = new wxBoxSizer (wxVERTICAL);
100 _add_button = new wxButton(this, wxID_ANY, _("Add"));
101 buttons_sizer->Add (_add_button);
102 e_sizer->Add (buttons_sizer, 0, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
104 _v_sizer->Add (e_sizer, 1, wxEXPAND);
106 _log = new wxTextCtrl (this, wxID_ANY, wxT(""), wxDefaultPosition, wxSize(-1, 200), wxTE_READONLY | wxTE_MULTILINE);
107 _v_sizer->Add (_log, 0, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
110 _spl_view->Show (false);
111 _add_button->Show (false);
114 wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
116 wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
117 time_sizer->Add (_frame_number, 0, wxEXPAND);
118 time_sizer->Add (_timecode, 0, wxEXPAND);
120 h_sizer->Add (_rewind_button, 0, wxALL, 2);
121 h_sizer->Add (_back_button, 0, wxALL, 2);
122 h_sizer->Add (time_sizer, 0, wxEXPAND);
123 h_sizer->Add (_forward_button, 0, wxALL, 2);
124 h_sizer->Add (_play_button, 0, wxEXPAND);
125 #ifdef DCPOMATIC_VARIANT_SWAROOP
126 h_sizer->Add (_pause_button, 0, wxEXPAND);
127 h_sizer->Add (_stop_button, 0, wxEXPAND);
129 h_sizer->Add (_slider, 1, wxEXPAND);
131 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
133 _frame_number->SetMinSize (wxSize (84, -1));
134 _rewind_button->SetMinSize (wxSize (32, -1));
135 _back_button->SetMinSize (wxSize (32, -1));
136 _forward_button->SetMinSize (wxSize (32, -1));
139 _eye->Bind (wxEVT_CHOICE, boost::bind (&Controls::eye_changed, this));
141 if (_outline_content) {
142 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::outline_content_changed, this));
145 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&Controls::slider_moved, this, false));
146 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&Controls::slider_moved, this, true));
147 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&Controls::slider_moved, this, true));
148 _slider->Bind (wxEVT_SCROLL_CHANGED, boost::bind(&Controls::slider_released, this));
149 #ifdef DCPOMATIC_VARIANT_SWAROOP
150 _play_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::play_clicked, this));
151 _pause_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::pause_clicked, this));
152 _stop_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::stop_clicked, this));
154 _play_button->Bind (wxEVT_TOGGLEBUTTON, boost::bind(&Controls::play_clicked, this));
156 _rewind_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::rewind_clicked, this, _1));
157 _back_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::back_clicked, this, _1));
158 _forward_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::forward_clicked, this, _1));
159 _frame_number->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::frame_number_clicked, this));
160 _timecode->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::timecode_clicked, this));
161 _cpl->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind(&Controls::setup_sensitivity, this));
162 _cpl->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind(&Controls::setup_sensitivity, this));
163 if (_jump_to_selected) {
164 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::jump_to_selected_clicked, this));
165 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
167 _add_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::add_clicked, this));
169 _viewer->PositionChanged.connect (boost::bind(&Controls::position_changed, this));
170 _viewer->Started.connect (boost::bind(&Controls::started, this));
171 _viewer->Stopped.connect (boost::bind(&Controls::stopped, this));
172 _viewer->FilmChanged.connect (boost::bind(&Controls::film_changed, this));
176 setup_sensitivity ();
177 update_dcp_directory ();
179 JobManager::instance()->ActiveJobsChanged.connect (
180 bind (&Controls::active_jobs_changed, this, _2)
183 _config_changed_connection = Config::instance()->Changed.connect (bind(&Controls::config_changed, this, _1));
187 Controls::add_clicked ()
189 optional<CPL> sel = selected_cpl ();
190 DCPOMATIC_ASSERT (sel);
191 _spl.push_back (SPLEntry(sel->first, sel->second));
192 add_cpl_to_list (sel->first, _spl_view);
194 setup_sensitivity ();
198 Controls::config_changed (int property)
200 if (property == Config::PLAYER_DCP_DIRECTORY) {
201 update_dcp_directory ();
208 #ifdef DCPOMATIC_VARIANT_SWAROOP
209 _play_button->Enable (false);
210 _pause_button->Enable (true);
212 _play_button->SetValue (true);
214 setup_sensitivity ();
220 #ifdef DCPOMATIC_VARIANT_SWAROOP
221 _play_button->Enable (true);
222 _pause_button->Enable (false);
224 _play_button->SetValue (false);
226 setup_sensitivity ();
230 Controls::position_changed ()
232 if (!_slider_being_moved) {
233 update_position_label ();
234 update_position_slider ();
239 Controls::eye_changed ()
241 _viewer->set_eyes (_eye->GetSelection() == 0 ? EYES_LEFT : EYES_RIGHT);
245 Controls::outline_content_changed ()
247 _viewer->set_outline_content (_outline_content->GetValue());
251 Controls::film_change (ChangeType type, Film::Property p)
253 if (type != CHANGE_TYPE_DONE) {
257 if (p == Film::CONTENT || p == Film::THREE_D) {
258 setup_sensitivity ();
262 /** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
264 Controls::slider_moved (bool page)
270 if (!page && !_slider_being_moved) {
271 /* This is the first event of a drag; stop playback for the duration of the drag */
272 _was_running_before_slider = _viewer->stop ();
273 _slider_being_moved = true;
276 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
277 t = t.round (_film->video_frame_rate());
278 /* Ensure that we hit the end of the film at the end of the slider */
279 if (t >= _film->length ()) {
280 t = _film->length() - _viewer->one_video_frame();
282 _viewer->seek (t, false);
283 update_position_label ();
287 Controls::slider_released ()
289 if (_was_running_before_slider) {
290 /* Restart after a drag */
293 _slider_being_moved = false;
297 Controls::play_clicked ()
299 #ifdef DCPOMATIC_VARIANT_SWAROOP
307 #ifndef DCPOMATIC_VARIANT_SWAROOP
309 Controls::check_play_state ()
311 if (!_film || _film->video_frame_rate() == 0) {
315 if (_play_button->GetValue()) {
324 Controls::update_position_slider ()
327 _slider->SetValue (0);
331 DCPTime const len = _film->length ();
334 int const new_slider_position = 4096 * _viewer->position().get() / len.get();
335 if (new_slider_position != _slider->GetValue()) {
336 _slider->SetValue (new_slider_position);
342 Controls::update_position_label ()
345 _frame_number->SetLabel ("0");
346 _timecode->SetLabel ("0:0:0.0");
350 double const fps = _film->video_frame_rate ();
351 /* Count frame number from 1 ... not sure if this is the best idea */
352 _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_viewer->position().seconds() * fps) + 1));
353 _timecode->SetLabel (time_to_timecode (_viewer->position(), fps));
357 Controls::active_jobs_changed (optional<string> j)
360 setup_sensitivity ();
364 Controls::nudge_amount (wxKeyboardState& ev)
366 DCPTime amount = _viewer->one_video_frame ();
368 if (ev.ShiftDown() && !ev.ControlDown()) {
369 amount = DCPTime::from_seconds (1);
370 } else if (!ev.ShiftDown() && ev.ControlDown()) {
371 amount = DCPTime::from_seconds (10);
372 } else if (ev.ShiftDown() && ev.ControlDown()) {
373 amount = DCPTime::from_seconds (60);
380 Controls::rewind_clicked (wxMouseEvent& ev)
382 _viewer->seek (DCPTime(), true);
387 Controls::back_frame ()
389 _viewer->seek_by (-_viewer->one_video_frame(), true);
393 Controls::forward_frame ()
395 _viewer->seek_by (_viewer->one_video_frame(), true);
399 Controls::back_clicked (wxKeyboardState& ev)
401 _viewer->seek_by (-nudge_amount(ev), true);
405 Controls::forward_clicked (wxKeyboardState& ev)
407 _viewer->seek_by (nudge_amount(ev), true);
411 Controls::setup_sensitivity ()
413 /* examine content is the only job which stops the viewer working */
414 bool const active_job = _active_job && *_active_job != "examine_content";
415 bool const c = ((_film && !_film->content().empty()) || !_spl.empty()) && !active_job;
418 _rewind_button->Enable (c);
419 _back_button->Enable (c);
420 _forward_button->Enable (c);
421 #ifdef DCPOMATIC_VARIANT_SWAROOP
422 _play_button->Enable (c && !_viewer->playing());
423 _pause_button->Enable (c && _viewer->playing());
424 _stop_button->Enable (c);
426 _play_button->Enable (c);
428 if (_outline_content) {
429 _outline_content->Enable (c);
431 _frame_number->Enable (c);
432 _timecode->Enable (c);
433 if (_jump_to_selected) {
434 _jump_to_selected->Enable (c);
438 _eye->Enable (c && _film->three_d ());
441 _add_button->Enable (static_cast<bool>(selected_cpl()));
444 optional<Controls::CPL>
445 Controls::selected_cpl () const
447 long int s = _cpl->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
449 return optional<CPL>();
452 DCPOMATIC_ASSERT (s < int(_cpls.size()));
457 Controls::timecode_clicked ()
459 PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
460 if (dialog->ShowModal() == wxID_OK) {
461 _viewer->seek (dialog->get(), true);
467 Controls::frame_number_clicked ()
469 PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
470 if (dialog->ShowModal() == wxID_OK) {
471 _viewer->seek (dialog->get(), true);
477 Controls::jump_to_selected_clicked ()
479 Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
483 Controls::film_changed ()
485 shared_ptr<Film> film = _viewer->film ();
493 setup_sensitivity ();
495 update_position_slider ();
496 update_position_label ();
499 _film->Change.connect (boost::bind (&Controls::film_change, this, _1, _2));
504 Controls::film () const
510 Controls::show_extended_player_controls (bool s)
514 update_dcp_directory ();
518 _add_button->Show (s);
523 Controls::add_cpl_to_list (shared_ptr<dcp::CPL> cpl, wxListCtrl* ctrl)
525 list<shared_ptr<dcp::Reel> > reels = cpl->reels ();
527 int const N = ctrl->GetItemCount();
530 if (!reels.empty() && reels.front()->main_picture()) {
533 int seconds = rint(double(cpl->duration()) / reels.front()->main_picture()->frame_rate().as_float());
534 int minutes = seconds / 60;
535 seconds -= minutes * 60;
536 int hours = minutes / 60;
537 minutes -= hours * 60;
538 it.SetText(wxString::Format("%02d:%02d:%02d", hours, minutes, seconds));
539 ctrl->InsertItem(it);
544 it.SetText(std_to_wx(dcp::content_kind_to_string(cpl->content_kind())));
549 it.SetText(std_to_wx(cpl->annotation_text()));
554 Controls::update_dcp_directory ()
556 if (!_cpl->IsShown()) {
560 using namespace boost::filesystem;
562 _cpl->DeleteAllItems ();
564 optional<path> dir = Config::instance()->player_dcp_directory();
569 for (directory_iterator i = directory_iterator(*dir); i != directory_iterator(); ++i) {
571 if (is_directory(*i) && (is_regular_file(*i / "ASSETMAP") || is_regular_file(*i / "ASSETMAP.xml"))) {
572 string const x = i->path().string().substr(dir->string().length() + 1);
575 BOOST_FOREACH (shared_ptr<dcp::CPL> j, dcp.cpls()) {
576 add_cpl_to_list (j, _cpl);
577 _cpls.push_back (make_pair(j, *i));
580 } catch (boost::filesystem::filesystem_error& e) {
586 #ifdef DCPOMATIC_VARIANT_SWAROOP
588 Controls::pause_clicked ()
594 Controls::stop_clicked ()
597 _viewer->seek (DCPTime(), true);
602 Controls::log (wxString s)
605 gettimeofday (&time, 0);
607 time_t const sec = time.tv_sec;
608 struct tm* t = localtime (&sec);
609 strftime (buffer, 64, "%c", t);
610 wxString ts = std_to_wx(string(buffer)) + N_(": ");
611 _log->SetValue(_log->GetValue() + ts + s + "\n");