Comments.
[dcpomatic.git] / src / tools / dcpomatic_player.cc
index 793600001145b96bf87f5d22734fa0e24b0e0916..cb81c5b89d7aaa24a2fc4bdfc4aee7cd97f5ac49 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2017-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2017-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "wx/player_config_dialog.h"
 #include "wx/verify_dcp_dialog.h"
 #include "wx/standard_controls.h"
+#include "wx/playlist_controls.h"
+#ifdef DCPOMATIC_VARIANT_SWAROOP
 #include "wx/swaroop_controls.h"
+#endif
+#include "wx/timer_display.h"
+#include "wx/system_information_dialog.h"
 #include "lib/cross.h"
 #include "lib/config.h"
 #include "lib/util.h"
@@ -53,6 +58,7 @@
 #include "lib/lock_file_checker.h"
 #include "lib/ffmpeg_content.h"
 #include "lib/dcpomatic_log.h"
+#include "lib/file_log.h"
 #include <dcp/dcp.h>
 #include <dcp/raw_convert.h>
 #include <dcp/exceptions.h>
 #include <wx/preferences.h>
 #include <wx/progdlg.h>
 #include <wx/display.h>
+#ifdef __WXGTK__
+#include <X11/Xlib.h>
+#endif
 #ifdef __WXOSX__
 #include <ApplicationServices/ApplicationServices.h>
 #endif
 #include <boost/bind.hpp>
+#include <boost/algorithm/string.hpp>
 #include <iostream>
 
 #ifdef check
@@ -87,6 +97,61 @@ using boost::optional;
 using boost::dynamic_pointer_cast;
 using boost::thread;
 using boost::bind;
+using dcp::raw_convert;
+using namespace dcpomatic;
+
+#ifdef DCPOMATIC_PLAYER_STRESS_TEST
+/* Interval to check what to do next with the stress checker, in milliseconds */
+#define STRESS_TEST_CHECK_INTERVAL 20
+
+class Command
+{
+public:
+       enum Type {
+               NONE,
+               OPEN,
+               PLAY,
+               WAIT,
+               STOP,
+               SEEK,
+       };
+
+       Command(string line)
+               : type (NONE)
+               , int_param (0)
+       {
+               vector<string> bits;
+               boost::split (bits, line, boost::is_any_of(" "));
+               if (bits[0] == "O") {
+                       if (bits.size() != 2) {
+                               return;
+                       }
+                       type = OPEN;
+                       string_param = bits[1];
+               } else if (bits[0] == "P") {
+                       type = PLAY;
+               } else if (bits[0] == "W") {
+                       if (bits.size() != 2) {
+                               return;
+                       }
+                       type = WAIT;
+                       int_param = raw_convert<int>(bits[1]);
+               } else if (bits[0] == "S") {
+                       type = STOP;
+               } else if (bits[0] == "K") {
+                       if (bits.size() != 2) {
+                               return;
+                       }
+                       type = SEEK;
+                       int_param = raw_convert<int>(bits[1]);
+               }
+       }
+
+       Type type;
+       string string_param;
+       int int_param;
+};
+#endif
 
 enum {
        ID_file_open = 1,
@@ -107,6 +172,8 @@ enum {
        ID_help_report_a_problem,
        ID_tools_verify,
        ID_tools_check_for_updates,
+       ID_tools_timing,
+       ID_tools_system_information,
        /* IDs for shortcuts (with no associated menu item) */
        ID_start_stop,
        ID_back_frame,
@@ -127,9 +194,13 @@ public:
                , _history_items (0)
                , _history_position (0)
                , _history_separator (0)
+               , _system_information_dialog (0)
                , _view_full_screen (0)
                , _view_dual_screen (0)
-       {
+#ifdef DCPOMATIC_PLAYER_STRESS_TEST
+               , _timer (this)
+#endif
+{
                dcpomatic_log.reset (new NullLog());
 
 #if defined(DCPOMATIC_WINDOWS)
@@ -147,7 +218,7 @@ public:
 #endif
 
                _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
-               update_from_config ();
+               update_from_config (Config::PLAYER_DEBUG_LOG);
 
                Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
                Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
@@ -167,6 +238,8 @@ public:
                Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
                Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
                Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
+               Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
+               Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
 
                /* Use a panel as the only child of the Frame so that we avoid
                   the dark-grey background on Windows.
@@ -179,7 +252,13 @@ public:
                _controls = sc;
                sc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
 #else
-               _controls = new StandardControls (_overall_panel, _viewer, false);
+               if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
+                       PlaylistControls* pc = new PlaylistControls (_overall_panel, _viewer);
+                       _controls = pc;
+                       pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
+               } else {
+                       _controls = new StandardControls (_overall_panel, _viewer, false);
+               }
 #endif
                _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
                _viewer->PlaybackPermitted.connect (bind(&DOMFrame::playback_permitted, this));
@@ -224,6 +303,71 @@ public:
 #endif
        }
 
+#ifdef DCPOMATIC_PLAYER_STRESS_TEST
+       void stress (boost::filesystem::path script_file)
+       {
+               Bind (wxEVT_TIMER, boost::bind(&DOMFrame::check_commands, this));
+               _timer.Start(STRESS_TEST_CHECK_INTERVAL);
+               vector<string> lines;
+               string const script = dcp::file_to_string(script_file);
+               boost::split (lines, script, boost::is_any_of("\n"));
+               BOOST_FOREACH (string i, lines) {
+                       _commands.push_back (Command(i));
+               }
+               _current_command = _commands.begin();
+       }
+
+       void check_commands ()
+       {
+               if (_current_command == _commands.end()) {
+                       _timer.Stop ();
+                       cout << "ST: finished.\n";
+                       return;
+               }
+
+               switch (_current_command->type) {
+                       case Command::OPEN:
+                               cout << "ST: load " << _current_command->string_param << "\n";
+                               load_dcp (_current_command->string_param);
+                               ++_current_command;
+                               break;
+                       case Command::PLAY:
+                               cout << "ST: play\n";
+                               _controls->play ();
+                               ++_current_command;
+                               break;
+                       case Command::WAIT:
+                               /* int_param here is the number of milliseconds to wait */
+                               if (_wait_remaining) {
+                                       _wait_remaining = *_wait_remaining - STRESS_TEST_CHECK_INTERVAL;
+                                       if (_wait_remaining < 0) {
+                                               cout << "ST: wait done.\n";
+                                               _wait_remaining = optional<int>();
+                                               ++_current_command;
+                                       }
+                               } else {
+                                       _wait_remaining = _current_command->int_param;
+                                       cout << "ST: waiting for " << *_wait_remaining << ".\n";
+                               }
+                               break;
+                       case Command::STOP:
+                               cout << "ST: stop\n";
+                               _controls->stop ();
+                               ++_current_command;
+                               break;
+                       case Command::NONE:
+                               ++_current_command;
+                               break;
+                       case Command::SEEK:
+                               /* int_param here is a number between 0 and 4095, corresponding to the possible slider positions */
+                               cout << "ST: seek to " << _current_command->int_param << "\n";
+                               _controls->seek (_current_command->int_param);
+                               ++_current_command;
+                               break;
+               }
+       }
+#endif
+
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        void monitor_checker_state_changed ()
        {
@@ -278,6 +422,15 @@ public:
                        }
                }
 
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+               BOOST_FOREACH (shared_ptr<Content> i, _film->content()) {
+                       shared_ptr<FFmpegContent> c = dynamic_pointer_cast<FFmpegContent>(i);
+                       if (c && !c->kdm_timing_window_valid()) {
+                               ok = false;
+                       }
+               }
+#endif
+
                if (!ok) {
                        error_dialog (this, _("The KDM does not allow playback of this content at this time."));
                }
@@ -288,10 +441,13 @@ public:
        void playback_started (DCPTime time)
        {
                /* XXX: this only logs the first piece of content; probably should be each piece? */
+               if (_film->content().empty()) {
+                       return;
+               }
 
                shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
                if (dcp) {
-                       DCPExaminer ex (dcp);
+                       DCPExaminer ex (dcp, true);
                        shared_ptr<dcp::CPL> playing_cpl;
                        BOOST_FOREACH (shared_ptr<dcp::CPL> i, ex.cpls()) {
                                if (!dcp->cpl() || i->id() == *dcp->cpl()) {
@@ -373,6 +529,8 @@ public:
        void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
        {
                _film = film;
+               _film->set_tolerant (true);
+               _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
                _viewer->set_film (_film);
                _controls->set_film (_film);
                _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
@@ -427,7 +585,7 @@ public:
                        /* Offer a CPL menu */
                        shared_ptr<DCPContent> first = dynamic_pointer_cast<DCPContent>(_film->content().front());
                        if (first) {
-                               DCPExaminer ex (first);
+                               DCPExaminer ex (first, true);
                                int id = ID_view_cpl;
                                BOOST_FOREACH (shared_ptr<dcp::CPL> i, ex.cpls()) {
                                        wxMenuItem* j = _cpl_menu->AppendRadioItem(
@@ -443,12 +601,27 @@ public:
 
 private:
 
+       bool report_errors_from_last_job (wxWindow* parent) const
+       {
+               JobManager* jm = JobManager::instance ();
+
+               DCPOMATIC_ASSERT (!jm->get().empty());
+
+               shared_ptr<Job> last = jm->get().back();
+               if (last->finished_in_error()) {
+                       error_dialog(parent, wxString::Format(_("Could not load DCP.\n\n%s."), std_to_wx(last->error_summary()).data()), std_to_wx(last->error_details()));
+                       return false;
+               }
+
+               return true;
+       }
+
        void setup_menu (wxMenuBar* m)
        {
                _file_menu = new wxMenu;
                _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
                _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
-               _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("&Add KDM..."));
+               _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
 
                _history_position = _file_menu->GetMenuItems().GetCount();
 
@@ -494,6 +667,8 @@ private:
                _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP"));
                tools->AppendSeparator ();
                tools->Append (ID_tools_check_for_updates, _("Check for updates"));
+               tools->Append (ID_tools_timing, _("Timing..."));
+               tools->Append (ID_tools_system_information, _("System information..."));
 
                wxMenu* help = new wxMenu;
 #ifdef __WXOSX__
@@ -590,11 +765,27 @@ private:
 
                if (d->ShowModal() == wxID_OK) {
                        DCPOMATIC_ASSERT (_film);
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+                       shared_ptr<FFmpegContent> ffmpeg = boost::dynamic_pointer_cast<FFmpegContent>(_film->content().front());
+                       if (ffmpeg) {
+                               try {
+                                       ffmpeg->add_kdm (EncryptedECinemaKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
+                               } catch (exception& e) {
+                                       error_dialog (this, wxString::Format(_("Could not load KDM.")), std_to_wx(e.what()));
+                                       d->Destroy();
+                                       return;
+                               }
+                       }
+#endif
                        shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
+#ifndef DCPOMATIC_VARIANT_SWAROOP
                        DCPOMATIC_ASSERT (dcp);
+#endif
                        try {
-                               dcp->add_kdm (dcp::EncryptedKDM (dcp::file_to_string (wx_to_std (d->GetPath ()), MAX_KDM_SIZE)));
-                               dcp->examine (_film, shared_ptr<Job>());
+                               if (dcp) {
+                                       dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
+                                       dcp->examine (_film, shared_ptr<Job>());
+                               }
                        } catch (exception& e) {
                                error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
                                d->Destroy ();
@@ -611,7 +802,11 @@ private:
                vector<boost::filesystem::path> history = Config::instance()->player_history ();
                int n = event.GetId() - ID_file_history;
                if (n >= 0 && n < static_cast<int> (history.size ())) {
-                       load_dcp (history[n]);
+                       try {
+                               load_dcp (history[n]);
+                       } catch (exception& e) {
+                               error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
+                       }
                }
        }
 
@@ -643,7 +838,7 @@ private:
        {
                shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
                DCPOMATIC_ASSERT (dcp);
-               DCPExaminer ex (dcp);
+               DCPExaminer ex (dcp, true);
                int id = ev.GetId() - ID_view_cpl;
                DCPOMATIC_ASSERT (id >= 0);
                DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
@@ -760,6 +955,22 @@ private:
                _update_news_requested = true;
        }
 
+       void tools_timing ()
+       {
+               TimerDisplay* d = new TimerDisplay (this, _viewer->state_timer(), _viewer->gets());
+               d->ShowModal ();
+               d->Destroy ();
+       }
+
+       void tools_system_information ()
+       {
+               if (!_system_information_dialog) {
+                       _system_information_dialog = new SystemInformationDialog (this, _viewer);
+               }
+
+               _system_information_dialog->Show ();
+       }
+
        void help_about ()
        {
                AboutDialog* d = new AboutDialog (this);
@@ -826,10 +1037,10 @@ private:
                                );
                }
 
-               update_from_config ();
+               update_from_config (prop);
        }
 
-       void update_from_config ()
+       void update_from_config (Config::Property prop)
        {
                for (int i = 0; i < _history_items; ++i) {
                        delete _file_menu->Remove (ID_file_history + i);
@@ -843,6 +1054,8 @@ private:
 
                int pos = _history_position;
 
+               /* Clear out non-existant history items before we re-build the menu */
+               Config::instance()->clean_player_history ();
                vector<boost::filesystem::path> history = Config::instance()->player_history ();
 
                if (!history.empty ()) {
@@ -860,6 +1073,16 @@ private:
                }
 
                _history_items = history.size ();
+
+               if (prop == Config::PLAYER_DEBUG_LOG) {
+                       optional<boost::filesystem::path> p = Config::instance()->player_debug_log_file();
+                       if (p) {
+                               dcpomatic_log.reset (new FileLog(*p));
+                       } else {
+                               dcpomatic_log.reset (new NullLog());
+                       }
+                       dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_PLAYER);
+               }
        }
 
        void set_menu_sensitivity ()
@@ -905,6 +1128,7 @@ private:
        wxMenuItem* _history_separator;
        shared_ptr<FilmViewer> _viewer;
        Controls* _controls;
+       SystemInformationDialog* _system_information_dialog;
        boost::shared_ptr<Film> _film;
        boost::signals2::scoped_connection _config_changed_connection;
        wxMenuItem* _file_add_ov;
@@ -912,11 +1136,21 @@ private:
        wxMenuItem* _tools_verify;
        wxMenuItem* _view_full_screen;
        wxMenuItem* _view_dual_screen;
+#ifdef DCPOMATIC_PLAYER_STRESS_TEST
+       wxTimer _timer;
+       list<Command> _commands;
+       list<Command>::const_iterator _current_command;
+       /** Remaining time that the script must wait, in milliseconds */
+       optional<int> _wait_remaining;
+#endif
 };
 
 static const wxCmdLineEntryDesc command_line_description[] = {
        { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
        { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
+#ifdef DCPOMATIC_PLAYER_STRESS_TEST
+       { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
+#endif
        { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
 };
 
@@ -955,7 +1189,11 @@ public:
        App ()
                : wxApp ()
                , _frame (0)
-       {}
+       {
+#ifdef DCPOMATIC_LINUX
+               XInitThreads ();
+#endif
+       }
 
 private:
 
@@ -1028,6 +1266,16 @@ private:
                                }
                        }
 
+#ifdef DCPOMATIC_PLAYER_STRESS_TEST
+                       if (_stress) {
+                               try {
+                                       _frame->stress (_stress.get());
+                               } catch (exception& e) {
+                                       error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
+                               }
+                       }
+#endif
+
                        Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
 
                        if (Config::instance()->check_for_updates ()) {
@@ -1061,6 +1309,12 @@ private:
                if (parser.Found("c", &config)) {
                        Config::override_path = wx_to_std (config);
                }
+#ifdef DCPOMATIC_PLAYER_STRESS_TEST
+               wxString stress;
+               if (parser.Found("s", &stress)) {
+                       _stress = wx_to_std (stress);
+               }
+#endif
 
                return true;
        }
@@ -1121,6 +1375,9 @@ private:
 
        DOMFrame* _frame;
        string _dcp_to_load;
+#ifdef DCPOMATIC_PLAYER_STRESS_TEST
+       boost::optional<string> _stress;
+#endif
 };
 
 IMPLEMENT_APP (App)