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 "content_view.h"
27 #include "lib/job_manager.h"
28 #include "lib/player_video.h"
29 #include "lib/dcp_content.h"
31 #include "lib/examine_content_job.h"
32 #include "lib/content_factory.h"
33 #include "lib/cross.h"
37 #include <dcp/reel_picture_asset.h>
39 #include <wx/tglbtn.h>
40 #include <wx/listctrl.h>
41 #include <wx/progdlg.h>
48 using boost::optional;
49 using boost::shared_ptr;
50 using boost::weak_ptr;
51 using boost::dynamic_pointer_cast;
53 Controls::Controls (wxWindow* parent, shared_ptr<FilmViewer> viewer, bool editor_controls)
56 , _slider_being_moved (false)
57 , _was_running_before_slider (false)
58 , _outline_content (0)
60 , _jump_to_selected (0)
61 , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
62 , _rewind_button (new wxButton (this, wxID_ANY, wxT("|<")))
63 , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
64 , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
65 , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
66 , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
67 #ifdef DCPOMATIC_VARIANT_SWAROOP
68 , _play_button (new wxButton(this, wxID_ANY, _("Play")))
69 , _pause_button (new wxButton(this, wxID_ANY, _("Pause")))
70 , _stop_button (new wxButton(this, wxID_ANY, _("Stop")))
72 , _play_button (new wxToggleButton(this, wxID_ANY, _("Play")))
75 _v_sizer = new wxBoxSizer (wxVERTICAL);
78 wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
79 if (editor_controls) {
80 _outline_content = new wxCheckBox (this, wxID_ANY, _("Outline content"));
81 view_options->Add (_outline_content, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
82 _eye = new wxChoice (this, wxID_ANY);
83 _eye->Append (_("Left"));
84 _eye->Append (_("Right"));
85 _eye->SetSelection (0);
86 view_options->Add (_eye, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
87 _jump_to_selected = new wxCheckBox (this, wxID_ANY, _("Jump to selected content"));
88 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
91 _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
93 wxBoxSizer* left_sizer = new wxBoxSizer (wxVERTICAL);
95 _spl_view = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_NO_HEADER);
96 _spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 740);
97 left_sizer->Add (_spl_view, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
99 _content_view = new ContentView (this, _film);
100 left_sizer->Add (_content_view, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
102 wxBoxSizer* e_sizer = new wxBoxSizer (wxHORIZONTAL);
103 e_sizer->Add (left_sizer, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
105 _current_spl_view = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_NO_HEADER);
106 _current_spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
107 _current_spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
108 _current_spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 580);
109 e_sizer->Add (_current_spl_view, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
111 _v_sizer->Add (e_sizer, 1, wxEXPAND);
113 _log = new wxTextCtrl (this, wxID_ANY, wxT(""), wxDefaultPosition, wxSize(-1, 200), wxTE_READONLY | wxTE_MULTILINE);
114 _v_sizer->Add (_log, 0, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
116 _content_view->Show (false);
117 _spl_view->Show (false);
118 _current_spl_view->Show (false);
121 wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
123 wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
124 time_sizer->Add (_frame_number, 0, wxEXPAND);
125 time_sizer->Add (_timecode, 0, wxEXPAND);
127 h_sizer->Add (_rewind_button, 0, wxALL, 2);
128 h_sizer->Add (_back_button, 0, wxALL, 2);
129 h_sizer->Add (time_sizer, 0, wxEXPAND);
130 h_sizer->Add (_forward_button, 0, wxALL, 2);
131 h_sizer->Add (_play_button, 0, wxEXPAND);
132 #ifdef DCPOMATIC_VARIANT_SWAROOP
133 h_sizer->Add (_pause_button, 0, wxEXPAND);
134 h_sizer->Add (_stop_button, 0, wxEXPAND);
136 h_sizer->Add (_slider, 1, wxEXPAND);
138 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
140 _frame_number->SetMinSize (wxSize (84, -1));
141 _rewind_button->SetMinSize (wxSize (32, -1));
142 _back_button->SetMinSize (wxSize (32, -1));
143 _forward_button->SetMinSize (wxSize (32, -1));
146 _eye->Bind (wxEVT_CHOICE, boost::bind (&Controls::eye_changed, this));
148 if (_outline_content) {
149 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::outline_content_changed, this));
152 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&Controls::slider_moved, this, false));
153 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&Controls::slider_moved, this, true));
154 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&Controls::slider_moved, this, true));
155 _slider->Bind (wxEVT_SCROLL_CHANGED, boost::bind(&Controls::slider_released, this));
156 #ifdef DCPOMATIC_VARIANT_SWAROOP
157 _play_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::play_clicked, this));
158 _pause_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::pause_clicked, this));
159 _stop_button->Bind (wxEVT_BUTTON, boost::bind(&Controls::stop_clicked, this));
161 _play_button->Bind (wxEVT_TOGGLEBUTTON, boost::bind(&Controls::play_clicked, this));
163 _rewind_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::rewind_clicked, this, _1));
164 _back_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::back_clicked, this, _1));
165 _forward_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::forward_clicked, this, _1));
166 _frame_number->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::frame_number_clicked, this));
167 _timecode->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::timecode_clicked, this));
168 _content_view->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind(&Controls::setup_sensitivity, this));
169 _content_view->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind(&Controls::setup_sensitivity, this));
170 if (_jump_to_selected) {
171 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::jump_to_selected_clicked, this));
172 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
175 _viewer->PositionChanged.connect (boost::bind(&Controls::position_changed, this));
176 _viewer->Started.connect (boost::bind(&Controls::started, this));
177 _viewer->Stopped.connect (boost::bind(&Controls::stopped, this));
178 _viewer->FilmChanged.connect (boost::bind(&Controls::film_changed, this));
179 _viewer->ImageChanged.connect (boost::bind(&Controls::image_changed, this, _1));
183 setup_sensitivity ();
184 update_playlist_directory ();
186 JobManager::instance()->ActiveJobsChanged.connect (
187 bind (&Controls::active_jobs_changed, this, _2)
190 _config_changed_connection = Config::instance()->Changed.connect (bind(&Controls::config_changed, this, _1));
191 config_changed (Config::OTHER);
195 Controls::config_changed (int property)
197 if (property == Config::PLAYER_CONTENT_DIRECTORY) {
198 _content_view->update ();
199 } else if (property == Config::PLAYER_PLAYLIST_DIRECTORY) {
200 update_playlist_directory ();
202 setup_sensitivity ();
209 #ifdef DCPOMATIC_VARIANT_SWAROOP
210 _play_button->Enable (false);
211 _pause_button->Enable (true);
213 _play_button->SetValue (true);
215 setup_sensitivity ();
221 #ifdef DCPOMATIC_VARIANT_SWAROOP
222 _play_button->Enable (true);
223 _pause_button->Enable (false);
225 _play_button->SetValue (false);
227 setup_sensitivity ();
231 Controls::position_changed ()
233 if (!_slider_being_moved) {
234 update_position_label ();
235 update_position_slider ();
240 Controls::eye_changed ()
242 _viewer->set_eyes (_eye->GetSelection() == 0 ? EYES_LEFT : EYES_RIGHT);
246 Controls::outline_content_changed ()
248 _viewer->set_outline_content (_outline_content->GetValue());
252 Controls::film_change (ChangeType type, Film::Property p)
254 if (type != CHANGE_TYPE_DONE) {
258 if (p == Film::CONTENT || p == Film::THREE_D) {
259 setup_sensitivity ();
263 /** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
265 Controls::slider_moved (bool page)
271 if (!page && !_slider_being_moved) {
272 /* This is the first event of a drag; stop playback for the duration of the drag */
273 _was_running_before_slider = _viewer->stop ();
274 _slider_being_moved = true;
277 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
278 t = t.round (_film->video_frame_rate());
279 /* Ensure that we hit the end of the film at the end of the slider */
280 if (t >= _film->length ()) {
281 t = _film->length() - _viewer->one_video_frame();
283 _viewer->seek (t, false);
284 update_position_label ();
288 Controls::slider_released ()
290 if (_was_running_before_slider) {
291 /* Restart after a drag */
294 _slider_being_moved = false;
298 Controls::play_clicked ()
300 #ifdef DCPOMATIC_VARIANT_SWAROOP
308 #ifndef DCPOMATIC_VARIANT_SWAROOP
310 Controls::check_play_state ()
312 if (!_film || _film->video_frame_rate() == 0) {
316 if (_play_button->GetValue()) {
325 Controls::update_position_slider ()
328 _slider->SetValue (0);
332 DCPTime const len = _film->length ();
335 int const new_slider_position = 4096 * _viewer->position().get() / len.get();
336 if (new_slider_position != _slider->GetValue()) {
337 _slider->SetValue (new_slider_position);
343 Controls::update_position_label ()
346 _frame_number->SetLabel ("0");
347 _timecode->SetLabel ("0:0:0.0");
351 double const fps = _film->video_frame_rate ();
352 /* Count frame number from 1 ... not sure if this is the best idea */
353 _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_viewer->position().seconds() * fps) + 1));
354 _timecode->SetLabel (time_to_timecode (_viewer->position(), fps));
358 Controls::active_jobs_changed (optional<string> j)
361 setup_sensitivity ();
365 Controls::nudge_amount (wxKeyboardState& ev)
367 DCPTime amount = _viewer->one_video_frame ();
369 if (ev.ShiftDown() && !ev.ControlDown()) {
370 amount = DCPTime::from_seconds (1);
371 } else if (!ev.ShiftDown() && ev.ControlDown()) {
372 amount = DCPTime::from_seconds (10);
373 } else if (ev.ShiftDown() && ev.ControlDown()) {
374 amount = DCPTime::from_seconds (60);
381 Controls::rewind_clicked (wxMouseEvent& ev)
383 _viewer->seek (DCPTime(), true);
388 Controls::back_frame ()
390 _viewer->seek_by (-_viewer->one_video_frame(), true);
394 Controls::forward_frame ()
396 _viewer->seek_by (_viewer->one_video_frame(), true);
400 Controls::back_clicked (wxKeyboardState& ev)
402 _viewer->seek_by (-nudge_amount(ev), true);
406 Controls::forward_clicked (wxKeyboardState& ev)
408 _viewer->seek_by (nudge_amount(ev), true);
412 Controls::setup_sensitivity ()
414 /* examine content is the only job which stops the viewer working */
415 bool const active_job = _active_job && *_active_job != "examine_content";
416 bool const c = _film && !_film->content().empty() && !active_job;
419 _rewind_button->Enable (c);
420 _back_button->Enable (c);
421 _forward_button->Enable (c);
422 #ifdef DCPOMATIC_VARIANT_SWAROOP
423 _play_button->Enable (c && !_viewer->playing());
424 _pause_button->Enable (c && (!_current_kind || _current_kind != dcp::ADVERTISEMENT) && _viewer->playing());
425 _stop_button->Enable (c && (!_current_kind || _current_kind != dcp::ADVERTISEMENT));
426 _slider->Enable (c && (!_current_kind || _current_kind != dcp::ADVERTISEMENT));
428 _play_button->Enable (c);
430 if (_outline_content) {
431 _outline_content->Enable (c);
433 _frame_number->Enable (c);
434 _timecode->Enable (c);
435 if (_jump_to_selected) {
436 _jump_to_selected->Enable (c);
440 _eye->Enable (c && _film->three_d ());
445 Controls::timecode_clicked ()
447 PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
448 if (dialog->ShowModal() == wxID_OK) {
449 _viewer->seek (dialog->get(), true);
455 Controls::frame_number_clicked ()
457 PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
458 if (dialog->ShowModal() == wxID_OK) {
459 _viewer->seek (dialog->get(), true);
465 Controls::jump_to_selected_clicked ()
467 Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
471 Controls::film_changed ()
473 shared_ptr<Film> film = _viewer->film ();
481 setup_sensitivity ();
483 update_position_slider ();
484 update_position_label ();
487 _film->Change.connect (boost::bind (&Controls::film_change, this, _1, _2));
490 _content_view->set_film (film);
491 _content_view->update ();
495 Controls::film () const
501 Controls::show_extended_player_controls (bool s)
503 _content_view->Show (s);
506 _content_view->update ();
507 update_playlist_directory ();
509 _current_spl_view->Show (s);
515 Controls::add_playlist_to_list (shared_ptr<Film> film)
517 int const N = _spl_view->GetItemCount();
522 it.SetText (std_to_wx(film->name()));
523 _spl_view->InsertItem (it);
527 Controls::update_playlist_directory ()
529 if (!_spl_view->IsShown()) {
533 using namespace boost::filesystem;
535 _spl_view->DeleteAllItems ();
536 optional<path> dir = Config::instance()->player_playlist_directory();
541 for (directory_iterator i = directory_iterator(*dir); i != directory_iterator(); ++i) {
543 shared_ptr<Film> film (new Film(optional<path>()));
544 film->read_metadata (i->path());
545 _playlists.push_back (film);
546 add_playlist_to_list (film);
547 } catch (exception& e) {
553 #ifdef DCPOMATIC_VARIANT_SWAROOP
555 Controls::pause_clicked ()
561 Controls::stop_clicked ()
564 _viewer->seek (DCPTime(), true);
569 Controls::log (wxString s)
572 gettimeofday (&time, 0);
574 time_t const sec = time.tv_sec;
575 struct tm* t = localtime (&sec);
576 strftime (buffer, 64, "%c", t);
577 wxString ts = std_to_wx(string(buffer)) + N_(": ");
578 _log->SetValue(_log->GetValue() + ts + s + "\n");
582 Controls::image_changed (boost::weak_ptr<PlayerVideo> weak_pv)
584 #ifdef DCPOMATIC_VARIANT_SWAROOP
585 shared_ptr<PlayerVideo> pv = weak_pv.lock ();
590 shared_ptr<Content> c = pv->content().lock();
595 shared_ptr<DCPContent> dc = dynamic_pointer_cast<DCPContent> (c);
600 if (!_current_kind || *_current_kind != dc->content_kind()) {
601 _current_kind = dc->content_kind ();
602 setup_sensitivity ();