Remove PositionChanged in favour of consumers having their own GUI-thread timers.
[dcpomatic.git] / src / wx / controls.cc
index e96d8055e262a73152ed3ee75554ab384ce8b4b0..71af4e8cf28f53f7e1a09561616918a04aaf6d43 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2018-2019 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "wx_util.h"
 #include "playhead_to_timecode_dialog.h"
 #include "playhead_to_frame_dialog.h"
+#include "content_view.h"
+#include "static_text.h"
+#include "check_box.h"
+#include "dcpomatic_button.h"
 #include "lib/job_manager.h"
+#include "lib/player_video.h"
+#include "lib/dcp_content.h"
+#include "lib/job.h"
+#include "lib/examine_content_job.h"
+#include "lib/content_factory.h"
+#include "lib/cross.h"
+#include <dcp/dcp.h>
+#include <dcp/cpl.h>
+#include <dcp/reel.h>
+#include <dcp/reel_picture_asset.h>
 #include <wx/wx.h>
 #include <wx/tglbtn.h>
 #include <wx/listctrl.h>
+#include <wx/progdlg.h>
 
 using std::string;
+using std::list;
+using std::cout;
+using std::make_pair;
+using std::exception;
 using boost::optional;
 using boost::shared_ptr;
 using boost::weak_ptr;
+using boost::dynamic_pointer_cast;
+using namespace dcpomatic;
 
 Controls::Controls (wxWindow* parent, shared_ptr<FilmViewer> viewer, bool editor_controls)
        : wxPanel (parent)
+       , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
        , _viewer (viewer)
        , _slider_being_moved (false)
-       , _was_running_before_slider (false)
        , _outline_content (0)
        , _eye (0)
        , _jump_to_selected (0)
-       , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
-       , _rewind_button (new wxButton (this, wxID_ANY, wxT("|<")))
-       , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
-       , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
-       , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
-       , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
-#ifdef DCPOMATIC_VARIANT_SWAROOP
-       , _play_button (new wxButton(this, wxID_ANY, _("Play")))
-       , _pause_button (new wxButton(this, wxID_ANY, _("Pause")))
-       , _stop_button (new wxButton(this, wxID_ANY, _("Stop")))
-#else
-       , _play_button (new wxToggleButton(this, wxID_ANY, _("Play")))
-#endif
+       , _rewind_button (new Button (this, wxT("|<")))
+       , _back_button (new Button (this, wxT("<")))
+       , _forward_button (new Button (this, wxT(">")))
+       , _frame_number (new StaticText (this, wxT("")))
+       , _timecode (new StaticText (this, wxT("")))
+       , _timer (this)
 {
        _v_sizer = new wxBoxSizer (wxVERTICAL);
        SetSizer (_v_sizer);
 
        wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
        if (editor_controls) {
-               _outline_content = new wxCheckBox (this, wxID_ANY, _("Outline content"));
+               _outline_content = new CheckBox (this, _("Outline content"));
                view_options->Add (_outline_content, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
                _eye = new wxChoice (this, wxID_ANY);
                _eye->Append (_("Left"));
                _eye->Append (_("Right"));
                _eye->SetSelection (0);
                view_options->Add (_eye, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
-               _jump_to_selected = new wxCheckBox (this, wxID_ANY, _("Jump to selected content"));
+               _jump_to_selected = new CheckBox (this, _("Jump to selected content"));
                view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
        }
 
        _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
 
-       _dcp_directory = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxSize(600, -1), wxLC_REPORT | wxLC_NO_HEADER);
-       _dcp_directory->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 580);
-       _v_sizer->Add (_dcp_directory, 0, wxALL, DCPOMATIC_SIZER_GAP);
-       _dcp_directory->Show (false);
-
        wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
 
        wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
@@ -85,14 +94,13 @@ Controls::Controls (wxWindow* parent, shared_ptr<FilmViewer> viewer, bool editor
        time_sizer->Add (_timecode, 0, wxEXPAND);
 
        h_sizer->Add (_rewind_button, 0, wxALL, 2);
-       h_sizer->Add (_back_button, 0, wxALL, 2);
        h_sizer->Add (time_sizer, 0, wxEXPAND);
+       h_sizer->Add (_back_button, 0, wxALL, 2);
        h_sizer->Add (_forward_button, 0, wxALL, 2);
-       h_sizer->Add (_play_button, 0, wxEXPAND);
-#ifdef DCPOMATIC_VARIANT_SWAROOP
-       h_sizer->Add (_pause_button, 0, wxEXPAND);
-       h_sizer->Add (_stop_button, 0, wxEXPAND);
-#endif
+
+       _button_sizer = new wxBoxSizer (wxHORIZONTAL);
+       h_sizer->Add (_button_sizer, 0, wxEXPAND);
+
        h_sizer->Add (_slider, 1, wxEXPAND);
 
        _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
@@ -109,79 +117,65 @@ Controls::Controls (wxWindow* parent, shared_ptr<FilmViewer> viewer, bool editor
                _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::outline_content_changed, this));
        }
 
-       _slider->Bind           (wxEVT_SCROLL_THUMBTRACK,   boost::bind (&Controls::slider_moved,    this, false));
-       _slider->Bind           (wxEVT_SCROLL_PAGEUP,       boost::bind (&Controls::slider_moved,    this, true));
-       _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,     boost::bind (&Controls::slider_moved,    this, true));
-       _slider->Bind           (wxEVT_SCROLL_CHANGED,      boost::bind (&Controls::slider_released, this));
-#ifdef DCPOMATIC_VARIANT_SWAROOP
-       _play_button->Bind      (wxEVT_BUTTON,              boost::bind (&Controls::play_clicked,    this));
-       _pause_button->Bind     (wxEVT_BUTTON,              boost::bind (&Controls::pause_clicked,   this));
-       _stop_button->Bind      (wxEVT_BUTTON,              boost::bind (&Controls::stop_clicked,    this));
-#else
-       _play_button->Bind      (wxEVT_TOGGLEBUTTON,        boost::bind (&Controls::play_clicked,    this));
+       _slider->Bind           (wxEVT_SCROLL_THUMBTRACK,    boost::bind(&Controls::slider_moved,    this, false));
+       _slider->Bind           (wxEVT_SCROLL_PAGEUP,        boost::bind(&Controls::slider_moved,    this, true));
+       _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,      boost::bind(&Controls::slider_moved,    this, true));
+       _slider->Bind           (wxEVT_SCROLL_CHANGED,       boost::bind(&Controls::slider_released, this));
+#ifdef DCPOMATIC_OSX
+       /* _CHANGED is not received on OS X (at least, not when the
+          slider is dragged), so use this instead.  Perhaps all
+          platforms could just use _THUMBRELEASE.
+       */
+       _slider->Bind           (wxEVT_SCROLL_THUMBRELEASE,  boost::bind(&Controls::slider_released, this));
 #endif
-       _rewind_button->Bind    (wxEVT_LEFT_DOWN,           boost::bind (&Controls::rewind_clicked,  this, _1));
-       _back_button->Bind      (wxEVT_LEFT_DOWN,           boost::bind (&Controls::back_clicked,    this, _1));
-       _forward_button->Bind   (wxEVT_LEFT_DOWN,           boost::bind (&Controls::forward_clicked, this, _1));
-       _frame_number->Bind     (wxEVT_LEFT_DOWN,           boost::bind (&Controls::frame_number_clicked, this));
-       _timecode->Bind         (wxEVT_LEFT_DOWN,           boost::bind (&Controls::timecode_clicked, this));
-       _dcp_directory->Bind    (wxEVT_LIST_ITEM_SELECTED,  boost::bind (&Controls::dcp_directory_selected, this));
+       _rewind_button->Bind    (wxEVT_LEFT_DOWN,            boost::bind(&Controls::rewind_clicked,  this, _1));
+       _back_button->Bind      (wxEVT_LEFT_DOWN,            boost::bind(&Controls::back_clicked,    this, _1));
+       _forward_button->Bind   (wxEVT_LEFT_DOWN,            boost::bind(&Controls::forward_clicked, this, _1));
+       _frame_number->Bind     (wxEVT_LEFT_DOWN,            boost::bind(&Controls::frame_number_clicked, this));
+       _timecode->Bind         (wxEVT_LEFT_DOWN,            boost::bind(&Controls::timecode_clicked, this));
        if (_jump_to_selected) {
                _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::jump_to_selected_clicked, this));
                _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
        }
 
-       _viewer->PositionChanged.connect (boost::bind(&Controls::position_changed, this));
        _viewer->Started.connect (boost::bind(&Controls::started, this));
        _viewer->Stopped.connect (boost::bind(&Controls::stopped, this));
-       _viewer->FilmChanged.connect (boost::bind(&Controls::film_changed, this));
 
-       film_changed ();
+       Bind (wxEVT_TIMER, boost::bind(&Controls::update_position, this));
+       _timer.Start (80, wxTIMER_CONTINUOUS);
+
+       set_film (_viewer->film());
 
        setup_sensitivity ();
-       update_dcp_directory ();
 
        JobManager::instance()->ActiveJobsChanged.connect (
                bind (&Controls::active_jobs_changed, this, _2)
                );
 
        _config_changed_connection = Config::instance()->Changed.connect (bind(&Controls::config_changed, this, _1));
+       config_changed (Config::OTHER);
 }
 
 void
-Controls::config_changed (int property)
+Controls::config_changed (int)
 {
-       if (property == Config::PLAYER_DCP_DIRECTORY) {
-               update_dcp_directory ();
-       }
+       setup_sensitivity ();
 }
 
 void
 Controls::started ()
 {
-#ifdef DCPOMATIC_VARIANT_SWAROOP
-       _play_button->Enable (false);
-       _pause_button->Enable (true);
-#else
-       _play_button->SetValue (true);
-#endif
        setup_sensitivity ();
 }
 
 void
 Controls::stopped ()
 {
-#ifdef DCPOMATIC_VARIANT_SWAROOP
-       _play_button->Enable (true);
-       _pause_button->Enable (false);
-#else
-       _play_button->SetValue (false);
-#endif
        setup_sensitivity ();
 }
 
 void
-Controls::position_changed ()
+Controls::update_position ()
 {
        if (!_slider_being_moved) {
                update_position_label ();
@@ -201,18 +195,6 @@ Controls::outline_content_changed ()
        _viewer->set_outline_content (_outline_content->GetValue());
 }
 
-void
-Controls::film_change (ChangeType type, Film::Property p)
-{
-       if (type != CHANGE_TYPE_DONE) {
-               return;
-       }
-
-       if (p == Film::CONTENT || p == Film::THREE_D) {
-               setup_sensitivity ();
-       }
-}
-
 /** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
 void
 Controls::slider_moved (bool page)
@@ -223,57 +205,38 @@ Controls::slider_moved (bool page)
 
        if (!page && !_slider_being_moved) {
                /* This is the first event of a drag; stop playback for the duration of the drag */
-               _was_running_before_slider = _viewer->stop ();
+               _viewer->suspend ();
                _slider_being_moved = true;
        }
 
        DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
        t = t.round (_film->video_frame_rate());
-       /* Ensure that we hit the end of the film at the end of the slider */
+       /* Ensure that we hit the end of the film at the end of the slider.  In particular, we
+          need to do an accurate seek in case there isn't a keyframe near the end.
+       */
+       bool accurate = false;
        if (t >= _film->length ()) {
                t = _film->length() - _viewer->one_video_frame();
+               accurate = true;
        }
-       _viewer->seek (t, false);
+       _viewer->seek (t, accurate);
        update_position_label ();
+
+       log (
+               wxString::Format(
+                       "playback-seeked %s", t.timecode(_film->video_frame_rate()).c_str()
+                       )
+               );
 }
 
 void
 Controls::slider_released ()
 {
-       if (_was_running_before_slider) {
-               /* Restart after a drag */
-               _viewer->start ();
-       }
+       /* Restart after a drag */
+       _viewer->resume ();
        _slider_being_moved = false;
 }
 
-void
-Controls::play_clicked ()
-{
-#ifdef DCPOMATIC_VARIANT_SWAROOP
-       _viewer->start ();
-#else
-       check_play_state ();
-#endif
-}
-
-
-#ifndef DCPOMATIC_VARIANT_SWAROOP
-void
-Controls::check_play_state ()
-{
-       if (!_film || _film->video_frame_rate() == 0) {
-               return;
-       }
-
-       if (_play_button->GetValue()) {
-               _viewer->start ();
-       } else {
-               _viewer->stop ();
-       }
-}
-#endif
-
 void
 Controls::update_position_slider ()
 {
@@ -365,19 +328,13 @@ void
 Controls::setup_sensitivity ()
 {
        /* examine content is the only job which stops the viewer working */
-       bool const c = _film && !_film->content().empty() && (!_active_job || *_active_job != "examine_content");
+       bool const active_job = _active_job && *_active_job != "examine_content";
+       bool const c = _film && !_film->content().empty() && !active_job;
 
        _slider->Enable (c);
        _rewind_button->Enable (c);
        _back_button->Enable (c);
        _forward_button->Enable (c);
-#ifdef DCPOMATIC_VARIANT_SWAROOP
-       _play_button->Enable (c && !_viewer->playing());
-       _pause_button->Enable (c && _viewer->playing());
-       _stop_button->Enable (c);
-#else
-       _play_button->Enable (c);
-#endif
        if (_outline_content) {
                _outline_content->Enable (c);
        }
@@ -419,24 +376,22 @@ Controls::jump_to_selected_clicked ()
 }
 
 void
-Controls::film_changed ()
+Controls::set_film (shared_ptr<Film> film)
 {
-       shared_ptr<Film> film = _viewer->film ();
-
        if (_film == film) {
                return;
        }
 
        _film = film;
 
+       if (_film) {
+               _film_change_connection = _film->Change.connect (boost::bind(&Controls::film_change, this, _1, _2));
+       }
+
        setup_sensitivity ();
 
        update_position_slider ();
        update_position_label ();
-
-       if (_film) {
-               _film->Change.connect (boost::bind (&Controls::film_change, this, _1, _2));
-       }
 }
 
 shared_ptr<Film>
@@ -446,59 +401,15 @@ Controls::film () const
 }
 
 void
-Controls::show_extended_player_controls (bool s)
-{
-       _dcp_directory->Show (s);
-}
-
-void
-Controls::update_dcp_directory ()
+Controls::film_change (ChangeType type, Film::Property p)
 {
-       using namespace boost::filesystem;
-
-       _dcp_directory->DeleteAllItems ();
-       _dcp_directories.clear ();
-       optional<path> dir = Config::instance()->player_dcp_directory();
-       if (!dir) {
-               return;
-       }
-
-       for (directory_iterator i = directory_iterator(*dir); i != directory_iterator(); ++i) {
-               try {
-                       if (is_directory(*i) && (is_regular_file(*i / "ASSETMAP") || is_regular_file(*i / "ASSETMAP.xml"))) {
-                               string const x = i->path().string().substr(dir->string().length() + 1);
-                               _dcp_directory->InsertItem(_dcp_directory->GetItemCount(), std_to_wx(x));
-                               _dcp_directories.push_back(x);
-                       }
-               } catch (boost::filesystem::filesystem_error& e) {
-                       /* Never mind */
+       if (type == CHANGE_TYPE_DONE) {
+               if (p == Film::CONTENT) {
+                       setup_sensitivity ();
+                       update_position_label ();
+                       update_position_slider ();
+               } else if (p == Film::THREE_D) {
+                       setup_sensitivity ();
                }
        }
 }
-
-void
-Controls::dcp_directory_selected ()
-{
-       long int s = _dcp_directory->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
-       if (s == -1) {
-               return;
-       }
-
-       DCPOMATIC_ASSERT (s < int(_dcp_directories.size()));
-       DCPDirectorySelected (*Config::instance()->player_dcp_directory() / _dcp_directories[s]);
-}
-
-#ifdef DCPOMATIC_VARIANT_SWAROOP
-void
-Controls::pause_clicked ()
-{
-       _viewer->stop ();
-}
-
-void
-Controls::stop_clicked ()
-{
-       _viewer->stop ();
-       DCPEjected ();
-}
-#endif