src/tools/dcpomatic_batch.cc

   1 /*
   2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21
  22 #include "wx/about_dialog.h"
  23 #include "wx/dcpomatic_button.h"
  24 #include "wx/full_config_dialog.h"
  25 #include "wx/job_manager_view.h"
  26 #include "wx/servers_list_dialog.h"
  27 #include "wx/wx_signal_manager.h"
  28 #include "wx/wx_util.h"
  29 #include "lib/compose.hpp"
  30 #include "lib/config.h"
  31 #include "lib/dcpomatic_socket.h"
  32 #include "lib/film.h"
  33 #include "lib/job.h"
  34 #include "lib/job_manager.h"
  35 #include "lib/make_dcp.h"
  36 #include "lib/scope_guard.h"
  37 #include "lib/transcode_job.h"
  38 #include "lib/util.h"
  39 #include "lib/version.h"
  40 #include <dcp/warnings.h>
  41 LIBDCP_DISABLE_WARNINGS
  42 #include <wx/aboutdlg.h>
  43 #include <wx/cmdline.h>
  44 #include <wx/dnd.h>
  45 #include <wx/preferences.h>
  46 #include <wx/splash.h>
  47 #include <wx/stdpaths.h>
  48 #include <wx/wx.h>
  49 LIBDCP_ENABLE_WARNINGS
  50 #include <iostream>
  51 #include <set>
  52
  53
  54 using std::cout;
  55 using std::dynamic_pointer_cast;
  56 using std::exception;
  57 using std::list;
  58 using std::make_shared;
  59 using std::set;
  60 using std::shared_ptr;
  61 using std::string;
  62 using boost::scoped_array;
  63 using boost::thread;
  64 #if BOOST_VERSION >= 106100
  65 using namespace boost::placeholders;
  66 #endif
  67
  68
  69 static list<boost::filesystem::path> films_to_load;
  70
  71
  72 enum {
  73         ID_file_add_film = 1,
  74         ID_tools_encoding_servers,
  75         ID_help_about
  76 };
  77
  78
  79 void
  80 setup_menu (wxMenuBar* m)
  81 {
  82         auto file = new wxMenu;
  83         file->Append (ID_file_add_film, _("&Add Film...\tCtrl-A"));
  84 #ifdef DCPOMATIC_OSX
  85         file->Append (wxID_EXIT, _("&Exit"));
  86 #else
  87         file->Append (wxID_EXIT, _("&Quit"));
  88 #endif
  89
  90 #ifdef DCPOMATIC_OSX
  91         file->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
  92 #else
  93         auto edit = new wxMenu;
  94         edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
  95 #endif
  96
  97         auto tools = new wxMenu;
  98         tools->Append (ID_tools_encoding_servers, _("Encoding servers..."));
  99
 100         auto help = new wxMenu;
 101         help->Append (ID_help_about, _("About"));
 102
 103         m->Append (file, _("&File"));
 104 #ifndef DCPOMATIC_OSX
 105         m->Append (edit, _("&Edit"));
 106 #endif
 107         m->Append (tools, _("&Tools"));
 108         m->Append (help, _("&Help"));
 109 }
 110
 111
 112 class DOMFrame : public wxFrame
 113 {
 114 public:
 115         enum class Tool {
 116                 ADD,
 117                 PAUSE
 118         };
 119
 120         class DCPDropTarget : public wxFileDropTarget
 121         {
 122         public:
 123                 DCPDropTarget(DOMFrame* owner)
 124                         : _frame(owner)
 125                 {}
 126
 127                 bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
 128                 {
 129                         if (filenames.GetCount() == 1) {
 130                                 /* Try to load a directory */
 131                                 auto path = boost::filesystem::path(wx_to_std(filenames[0]));
 132                                 if (boost::filesystem::is_directory(path)) {
 133                                         _frame->start_job(wx_to_std(filenames[0]));
 134                                         return true;
 135                                 }
 136                         }
 137
 138                         return false;
 139                 }
 140
 141         private:
 142                 DOMFrame* _frame;
 143         };
 144
 145         explicit DOMFrame (wxString const & title)
 146                 : wxFrame (nullptr, -1, title)
 147                 , _sizer (new wxBoxSizer(wxVERTICAL))
 148         {
 149                 auto bar = new wxMenuBar;
 150                 setup_menu (bar);
 151                 SetMenuBar (bar);
 152
 153                 Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
 154
 155                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_film, this),    ID_file_add_film);
 156                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_quit, this),        wxID_EXIT);
 157                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
 158                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
 159                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this),       ID_help_about);
 160
 161                 auto panel = new wxPanel (this);
 162                 auto s = new wxBoxSizer (wxHORIZONTAL);
 163                 s->Add (panel, 1, wxEXPAND);
 164                 SetSizer (s);
 165
 166                 wxBitmap add(icon_path("add"), wxBITMAP_TYPE_PNG);
 167                 wxBitmap pause(icon_path("pause"), wxBITMAP_TYPE_PNG);
 168
 169                 auto toolbar = new wxToolBar(panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTB_HORIZONTAL);
 170                 toolbar->SetMargins(4, 4);
 171                 toolbar->SetToolBitmapSize(wxSize(32, 32));
 172                 toolbar->AddTool(static_cast<int>(Tool::ADD), _("Add film"), add, _("Add film for conversion"));
 173                 toolbar->AddCheckTool(static_cast<int>(Tool::PAUSE), _("Pause/resume"), pause, wxNullBitmap, _("Pause or resume conversion"));
 174                 toolbar->Realize();
 175                 _sizer->Add(toolbar, 0, wxALL, 6);
 176
 177                 toolbar->Bind(wxEVT_TOOL, bind(&DOMFrame::tool_clicked, this, _1));
 178
 179                 auto job_manager_view = new JobManagerView (panel, true);
 180                 _sizer->Add (job_manager_view, 1, wxALL | wxEXPAND, 6);
 181
 182                 panel->SetSizer (_sizer);
 183
 184                 Bind (wxEVT_CLOSE_WINDOW, boost::bind(&DOMFrame::close, this, _1));
 185                 Bind (wxEVT_SIZE, boost::bind(&DOMFrame::sized, this, _1));
 186
 187                 SetDropTarget(new DCPDropTarget(this));
 188         }
 189
 190         void tool_clicked(wxCommandEvent& ev)
 191         {
 192                 switch (static_cast<Tool>(ev.GetId())) {
 193                 case Tool::ADD:
 194                         add_film();
 195                         break;
 196                 case Tool::PAUSE:
 197                 {
 198                         auto jm = JobManager::instance();
 199                         if (jm->paused()) {
 200                                 jm->resume();
 201                         } else {
 202                                 jm->pause();
 203                         }
 204                         break;
 205                 }
 206                 }
 207         }
 208
 209         void start_job (boost::filesystem::path path)
 210         {
 211                 try {
 212                         auto film = make_shared<Film>(path);
 213                         film->read_metadata ();
 214
 215                         double total_required;
 216                         double available;
 217                         bool can_hard_link;
 218
 219                         film->should_be_enough_disk_space (total_required, available, can_hard_link);
 220
 221                         set<shared_ptr<const Film>> films;
 222
 223                         for (auto i: JobManager::instance()->get()) {
 224                                 films.insert (i->film());
 225                         }
 226
 227                         for (auto i: films) {
 228                                 double progress = 0;
 229                                 for (auto j: JobManager::instance()->get()) {
 230                                         if (i == j->film() && dynamic_pointer_cast<TranscodeJob>(j)) {
 231                                                 progress = j->progress().get_value_or(0);
 232                                         }
 233                                 }
 234
 235                                 double required;
 236                                 i->should_be_enough_disk_space (required, available, can_hard_link);
 237                                 total_required += (1 - progress) * required;
 238                         }
 239
 240                         if ((total_required - available) > 1) {
 241                                 if (!confirm_dialog (
 242                                             this,
 243                                             wxString::Format(
 244                                                     _("The DCPs for this film and the films already in the queue will take up about %.1f GB.  The "
 245                                                       "disks that you are using only have %.1f GB available.  Do you want to add this film to the queue anyway?"),
 246                                                     total_required, available))) {
 247                                         return;
 248                                 }
 249                         }
 250
 251                         make_dcp (film, TranscodeJob::ChangedBehaviour::STOP);
 252                 } catch (std::exception& e) {
 253                         auto p = std_to_wx (path.string ());
 254                         auto b = p.ToUTF8 ();
 255                         error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
 256                 }
 257         }
 258
 259 private:
 260         void sized (wxSizeEvent& ev)
 261         {
 262                 _sizer->Layout ();
 263                 ev.Skip ();
 264         }
 265
 266         bool should_close ()
 267         {
 268                 if (!JobManager::instance()->work_to_do()) {
 269                         return true;
 270                 }
 271
 272                 auto d = new wxMessageDialog (
 273                         0,
 274                         _("There are unfinished jobs; are you sure you want to quit?"),
 275                         _("Unfinished jobs"),
 276                         wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
 277                         );
 278                 ScopeGuard sg = [d]{ d->Destroy(); };
 279
 280                 return d->ShowModal() == wxID_YES;
 281         }
 282
 283         void close (wxCloseEvent& ev)
 284         {
 285                 if (!should_close()) {
 286                         ev.Veto ();
 287                         return;
 288                 }
 289
 290                 ev.Skip ();
 291         }
 292
 293         void file_add_film ()
 294         {
 295                 add_film ();
 296         }
 297
 298         void file_quit ()
 299         {
 300                 if (should_close()) {
 301                         Close (true);
 302                 }
 303         }
 304
 305         void edit_preferences ()
 306         {
 307                 if (!_config_dialog) {
 308                         _config_dialog = create_full_config_dialog ();
 309                 }
 310                 _config_dialog->Show (this);
 311         }
 312
 313         void tools_encoding_servers ()
 314         {
 315                 if (!_servers_list_dialog) {
 316                         _servers_list_dialog = new ServersListDialog (this);
 317                 }
 318
 319                 _servers_list_dialog->Show ();
 320         }
 321
 322         void help_about ()
 323         {
 324                 auto d = new AboutDialog (this);
 325                 ScopeGuard sg = [d]() { d->Destroy(); };
 326                 d->ShowModal ();
 327         }
 328
 329         void add_film ()
 330         {
 331                 auto dialog = new wxDirDialog(this, _("Select film to open"), wxStandardPaths::Get().GetDocumentsDir(), wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
 332                 ScopeGuard sg = [dialog]() { dialog->Destroy(); };
 333                 if (_last_parent) {
 334                         dialog->SetPath(std_to_wx(_last_parent.get().string()));
 335                 }
 336
 337                 int r;
 338                 while (true) {
 339                         r = dialog->ShowModal();
 340                         if (r == wxID_OK && dialog->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
 341                                 error_dialog (this, _("You did not select a folder.  Make sure that you select a folder before clicking Open."));
 342                         } else {
 343                                 break;
 344                         }
 345                 }
 346
 347                 if (r == wxID_OK) {
 348                         start_job(wx_to_std(dialog->GetPath()));
 349                 }
 350
 351                 _last_parent = boost::filesystem::path(wx_to_std(dialog->GetPath())).parent_path();
 352         }
 353
 354         void config_changed (Config::Property what)
 355         {
 356                 /* Instantly save any config changes when using the DCP-o-matic GUI */
 357                 if (what == Config::CINEMAS) {
 358                         try {
 359                                 Config::instance()->write_cinemas();
 360                         } catch (exception& e) {
 361                                 error_dialog (
 362                                         this,
 363                                         wxString::Format(
 364                                                 _("Could not write to cinemas file at %s.  Your changes have not been saved."),
 365                                                 std_to_wx (Config::instance()->cinemas_file().string()).data()
 366                                                 )
 367                                         );
 368                         }
 369                 } else {
 370                         try {
 371                                 Config::instance()->write_config();
 372                         } catch (exception& e) {
 373                                 error_dialog (
 374                                         this,
 375                                         wxString::Format(
 376                                                 _("Could not write to config file at %s.  Your changes have not been saved."),
 377                                                 std_to_wx (Config::instance()->cinemas_file().string()).data()
 378                                                 )
 379                                         );
 380                         }
 381                 }
 382         }
 383
 384         boost::optional<boost::filesystem::path> _last_parent;
 385         wxSizer* _sizer;
 386         wxPreferencesEditor* _config_dialog = nullptr;
 387         ServersListDialog* _servers_list_dialog = nullptr;
 388 };
 389
 390
 391 static const wxCmdLineEntryDesc command_line_description[] = {
 392         { wxCMD_LINE_PARAM, 0, 0, "film to load", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_MULTIPLE | wxCMD_LINE_PARAM_OPTIONAL },
 393         { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
 394 };
 395
 396
 397 class JobServer : public Server
 398 {
 399 public:
 400         explicit JobServer (DOMFrame* frame)
 401                 : Server (BATCH_JOB_PORT)
 402                 , _frame (frame)
 403         {}
 404
 405         void handle (shared_ptr<Socket> socket) override
 406         {
 407                 try {
 408                         int const length = socket->read_uint32 ();
 409                         scoped_array<char> buffer(new char[length]);
 410                         socket->read (reinterpret_cast<uint8_t*>(buffer.get()), length);
 411                         string s (buffer.get());
 412                         _frame->start_job (s);
 413                         socket->write (reinterpret_cast<uint8_t const *>("OK"), 3);
 414                 } catch (...) {
 415
 416                 }
 417         }
 418
 419 private:
 420         DOMFrame* _frame;
 421 };
 422
 423
 424 class App : public wxApp
 425 {
 426         bool OnInit () override
 427         {
 428                 wxInitAllImageHandlers ();
 429
 430                 SetAppName (_("DCP-o-matic Batch Converter"));
 431                 is_batch_converter = true;
 432
 433                 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
 434                 Config::Warning.connect (boost::bind(&App::config_warning, this, _1));
 435
 436                 auto splash = maybe_show_splash ();
 437
 438                 if (!wxApp::OnInit()) {
 439                         return false;
 440                 }
 441
 442 #ifdef DCPOMATIC_LINUX
 443                 unsetenv ("UBUNTU_MENUPROXY");
 444 #endif
 445
 446                 dcpomatic_setup_path_encoding ();
 447
 448                 /* Enable i18n; this will create a Config object
 449                    to look for a force-configured language.  This Config
 450                    object will be wrong, however, because dcpomatic_setup
 451                    hasn't yet been called and there aren't any filters etc.
 452                    set up yet.
 453                 */
 454                 dcpomatic_setup_i18n ();
 455
 456                 /* Set things up, including filters etc.
 457                    which will now be internationalised correctly.
 458                 */
 459                 dcpomatic_setup ();
 460
 461                 /* Force the configuration to be re-loaded correctly next
 462                    time it is needed.
 463                 */
 464                 Config::drop ();
 465
 466                 _frame = new DOMFrame (_("DCP-o-matic Batch Converter"));
 467                 SetTopWindow (_frame);
 468                 _frame->Maximize ();
 469                 if (splash) {
 470                         splash->Destroy ();
 471                 }
 472                 _frame->Show ();
 473
 474                 try {
 475                         auto server = new JobServer (_frame);
 476                         new thread (boost::bind (&JobServer::run, server));
 477                 } catch (boost::system::system_error& e) {
 478                         error_dialog(_frame, _("Could not listen for new batch jobs.  Perhaps another instance of the DCP-o-matic Batch Converter is running."));
 479                 }
 480
 481                 signal_manager = new wxSignalManager (this);
 482                 this->Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
 483
 484                 shared_ptr<Film> film;
 485                 for (auto i: films_to_load) {
 486                         if (boost::filesystem::is_directory(i)) {
 487                                 try {
 488                                         film = make_shared<Film>(i);
 489                                         film->read_metadata ();
 490                                         make_dcp (film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
 491                                 } catch (exception& e) {
 492                                         error_dialog (
 493                                                 0,
 494                                                 std_to_wx(String::compose(wx_to_std(_("Could not load film %1")), i.string())),
 495                                                 std_to_wx(e.what())
 496                                                 );
 497                                 }
 498                         }
 499                 }
 500
 501                 return true;
 502         }
 503
 504         void idle ()
 505         {
 506                 signal_manager->ui_idle ();
 507         }
 508
 509         void OnInitCmdLine (wxCmdLineParser& parser) override
 510         {
 511                 parser.SetDesc (command_line_description);
 512                 parser.SetSwitchChars (wxT ("-"));
 513         }
 514
 515         bool OnCmdLineParsed (wxCmdLineParser& parser) override
 516         {
 517                 for (size_t i = 0; i < parser.GetParamCount(); ++i) {
 518                         films_to_load.push_back (wx_to_std(parser.GetParam(i)));
 519                 }
 520
 521                 return true;
 522         }
 523
 524         void config_failed_to_load(Config::LoadFailure what)
 525         {
 526                 report_config_load_failure(_frame, what);
 527         }
 528
 529         void config_warning (string m)
 530         {
 531                 message_dialog (_frame, std_to_wx(m));
 532         }
 533
 534         DOMFrame* _frame;
 535 };
 536
 537
 538 IMPLEMENT_APP (App)