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/id.h"
  26 #include "wx/job_manager_view.h"
  27 #include "wx/servers_list_dialog.h"
  28 #include "wx/wx_ptr.h"
  29 #include "wx/wx_signal_manager.h"
  30 #include "wx/wx_util.h"
  31 #include "lib/compose.hpp"
  32 #include "lib/config.h"
  33 #include "lib/dcpomatic_socket.h"
  34 #include "lib/film.h"
  35 #include "lib/job.h"
  36 #include "lib/job_manager.h"
  37 #include "lib/make_dcp.h"
  38 #include "lib/transcode_job.h"
  39 #include "lib/util.h"
  40 #include "lib/version.h"
  41 #include <dcp/filesystem.h>
  42 #include <dcp/warnings.h>
  43 LIBDCP_DISABLE_WARNINGS
  44 #include <wx/aboutdlg.h>
  45 #include <wx/cmdline.h>
  46 #include <wx/dnd.h>
  47 #include <wx/preferences.h>
  48 #include <wx/splash.h>
  49 #include <wx/stdpaths.h>
  50 #include <wx/wx.h>
  51 LIBDCP_ENABLE_WARNINGS
  52 #include <iostream>
  53 #include <set>
  54
  55
  56 using std::cout;
  57 using std::dynamic_pointer_cast;
  58 using std::exception;
  59 using std::list;
  60 using std::make_shared;
  61 using std::set;
  62 using std::shared_ptr;
  63 using std::string;
  64 using boost::scoped_array;
  65 using boost::thread;
  66 #if BOOST_VERSION >= 106100
  67 using namespace boost::placeholders;
  68 #endif
  69
  70
  71 static list<boost::filesystem::path> films_to_load;
  72
  73
  74 enum {
  75         ID_file_add_film = DCPOMATIC_MAIN_MENU,
  76         ID_tools_encoding_servers,
  77         ID_help_about
  78 };
  79
  80
  81 void
  82 setup_menu (wxMenuBar* m)
  83 {
  84         auto file = new wxMenu;
  85         file->Append (ID_file_add_film, _("&Add Film...\tCtrl-A"));
  86 #ifdef DCPOMATIC_OSX
  87         file->Append (wxID_EXIT, _("&Exit"));
  88 #else
  89         file->Append (wxID_EXIT, _("&Quit"));
  90 #endif
  91
  92 #ifdef DCPOMATIC_OSX
  93         file->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
  94 #else
  95         auto edit = new wxMenu;
  96         edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
  97 #endif
  98
  99         auto tools = new wxMenu;
 100         tools->Append (ID_tools_encoding_servers, _("Encoding servers..."));
 101
 102         auto help = new wxMenu;
 103         help->Append (ID_help_about, _("About"));
 104
 105         m->Append (file, _("&File"));
 106 #ifndef DCPOMATIC_OSX
 107         m->Append (edit, _("&Edit"));
 108 #endif
 109         m->Append (tools, _("&Tools"));
 110         m->Append (help, _("&Help"));
 111 }
 112
 113
 114 class DOMFrame : public wxFrame
 115 {
 116 public:
 117         enum class Tool {
 118                 ADD,
 119                 PAUSE
 120         };
 121
 122         class DCPDropTarget : public wxFileDropTarget
 123         {
 124         public:
 125                 DCPDropTarget(DOMFrame* owner)
 126                         : _frame(owner)
 127                 {}
 128
 129                 bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
 130                 {
 131                         if (filenames.GetCount() == 1) {
 132                                 /* Try to load a directory */
 133                                 auto path = boost::filesystem::path(wx_to_std(filenames[0]));
 134                                 if (dcp::filesystem::is_directory(path)) {
 135                                         _frame->start_job(wx_to_std(filenames[0]));
 136                                         return true;
 137                                 }
 138                         }
 139
 140                         return false;
 141                 }
 142
 143         private:
 144                 DOMFrame* _frame;
 145         };
 146
 147         explicit DOMFrame (wxString const & title)
 148                 : wxFrame (nullptr, -1, title)
 149                 , _sizer (new wxBoxSizer(wxVERTICAL))
 150         {
 151                 auto bar = new wxMenuBar;
 152                 setup_menu (bar);
 153                 SetMenuBar (bar);
 154
 155                 Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
 156
 157                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_film, this),    ID_file_add_film);
 158                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_quit, this),        wxID_EXIT);
 159                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
 160                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
 161                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this),       ID_help_about);
 162
 163                 auto panel = new wxPanel (this);
 164                 auto s = new wxBoxSizer (wxHORIZONTAL);
 165                 s->Add (panel, 1, wxEXPAND);
 166                 SetSizer (s);
 167
 168                 wxBitmap add(icon_path("add"), wxBITMAP_TYPE_PNG);
 169                 wxBitmap pause(icon_path("pause"), wxBITMAP_TYPE_PNG);
 170
 171                 auto toolbar = new wxToolBar(panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTB_HORIZONTAL);
 172                 toolbar->SetMargins(4, 4);
 173                 toolbar->SetToolBitmapSize(wxSize(32, 32));
 174                 toolbar->AddTool(static_cast<int>(Tool::ADD), _("Add film"), add, _("Add film for conversion"));
 175                 toolbar->AddCheckTool(static_cast<int>(Tool::PAUSE), _("Pause/resume"), pause, wxNullBitmap, _("Pause or resume conversion"));
 176                 toolbar->Realize();
 177                 _sizer->Add(toolbar, 0, wxALL, 6);
 178
 179                 toolbar->Bind(wxEVT_TOOL, bind(&DOMFrame::tool_clicked, this, _1));
 180
 181                 auto job_manager_view = new JobManagerView (panel, true);
 182                 _sizer->Add (job_manager_view, 1, wxALL | wxEXPAND, 6);
 183
 184                 panel->SetSizer (_sizer);
 185
 186                 Bind (wxEVT_CLOSE_WINDOW, boost::bind(&DOMFrame::close, this, _1));
 187                 Bind (wxEVT_SIZE, boost::bind(&DOMFrame::sized, this, _1));
 188
 189                 SetDropTarget(new DCPDropTarget(this));
 190         }
 191
 192         void tool_clicked(wxCommandEvent& ev)
 193         {
 194                 switch (static_cast<Tool>(ev.GetId())) {
 195                 case Tool::ADD:
 196                         add_film();
 197                         break;
 198                 case Tool::PAUSE:
 199                 {
 200                         auto jm = JobManager::instance();
 201                         if (jm->paused()) {
 202                                 jm->resume();
 203                         } else {
 204                                 jm->pause();
 205                         }
 206                         break;
 207                 }
 208                 }
 209         }
 210
 211         void start_job (boost::filesystem::path path)
 212         {
 213                 try {
 214                         auto film = make_shared<Film>(path);
 215                         film->read_metadata ();
 216
 217                         double total_required;
 218                         double available;
 219                         bool can_hard_link;
 220
 221                         film->should_be_enough_disk_space (total_required, available, can_hard_link);
 222
 223                         set<shared_ptr<const Film>> films;
 224
 225                         for (auto i: JobManager::instance()->get()) {
 226                                 films.insert (i->film());
 227                         }
 228
 229                         for (auto i: films) {
 230                                 double progress = 0;
 231                                 for (auto j: JobManager::instance()->get()) {
 232                                         if (i == j->film() && dynamic_pointer_cast<TranscodeJob>(j)) {
 233                                                 progress = j->progress().get_value_or(0);
 234                                         }
 235                                 }
 236
 237                                 double required;
 238                                 i->should_be_enough_disk_space (required, available, can_hard_link);
 239                                 total_required += (1 - progress) * required;
 240                         }
 241
 242                         if ((total_required - available) > 1) {
 243                                 if (!confirm_dialog (
 244                                             this,
 245                                             wxString::Format(
 246                                                     _("The DCPs for this film and the films already in the queue will take up about %.1f GB.  The "
 247                                                       "disks that you are using only have %.1f GB available.  Do you want to add this film to the queue anyway?"),
 248                                                     total_required, available))) {
 249                                         return;
 250                                 }
 251                         }
 252
 253                         make_dcp (film, TranscodeJob::ChangedBehaviour::STOP);
 254                 } catch (std::exception& e) {
 255                         auto p = std_to_wx (path.string ());
 256                         auto b = p.ToUTF8 ();
 257                         error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
 258                 }
 259         }
 260
 261 private:
 262         void sized (wxSizeEvent& ev)
 263         {
 264                 _sizer->Layout ();
 265                 ev.Skip ();
 266         }
 267
 268         bool should_close ()
 269         {
 270                 if (!JobManager::instance()->work_to_do()) {
 271                         return true;
 272                 }
 273
 274                 auto d = make_wx<wxMessageDialog>(
 275                         nullptr,
 276                         _("There are unfinished jobs; are you sure you want to quit?"),
 277                         _("Unfinished jobs"),
 278                         wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
 279                         );
 280
 281                 return d->ShowModal() == wxID_YES;
 282         }
 283
 284         void close (wxCloseEvent& ev)
 285         {
 286                 if (!should_close()) {
 287                         ev.Veto ();
 288                         return;
 289                 }
 290
 291                 ev.Skip ();
 292                 JobManager::drop ();
 293         }
 294
 295         void file_add_film ()
 296         {
 297                 add_film ();
 298         }
 299
 300         void file_quit ()
 301         {
 302                 if (should_close()) {
 303                         Close (true);
 304                 }
 305         }
 306
 307         void edit_preferences ()
 308         {
 309                 if (!_config_dialog) {
 310                         _config_dialog = create_full_config_dialog ();
 311                 }
 312                 _config_dialog->Show (this);
 313         }
 314
 315         void tools_encoding_servers ()
 316         {
 317                 if (!_servers_list_dialog) {
 318                         _servers_list_dialog = new ServersListDialog (this);
 319                 }
 320
 321                 _servers_list_dialog->Show ();
 322         }
 323
 324         void help_about ()
 325         {
 326                 auto d = make_wx<AboutDialog>(this);
 327                 d->ShowModal ();
 328         }
 329
 330         void add_film ()
 331         {
 332                 auto dialog = make_wx<wxDirDialog>(this, _("Select film to open"), wxStandardPaths::Get().GetDocumentsDir(), wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
 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, public Signaller
 398 {
 399 public:
 400         JobServer()
 401                 : Server (BATCH_JOB_PORT)
 402         {}
 403
 404         void handle (shared_ptr<Socket> socket) override
 405         {
 406                 try {
 407                         auto const length = socket->read_uint32();
 408                         if (length < 65536) {
 409                                 scoped_array<char> buffer(new char[length]);
 410                                 socket->read(reinterpret_cast<uint8_t*>(buffer.get()), length);
 411                                 string s(buffer.get());
 412                                 emit(boost::bind(boost::ref(StartJob), s));
 413                                 socket->write (reinterpret_cast<uint8_t const *>("OK"), 3);
 414                         }
 415                 } catch (...) {
 416
 417                 }
 418         }
 419
 420         boost::signals2::signal<void(std::string)> StartJob;
 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();
 476                         server->StartJob.connect(bind(&DOMFrame::start_job, _frame, _1));
 477                         new thread (boost::bind (&JobServer::run, server));
 478                 } catch (boost::system::system_error& e) {
 479                         error_dialog(_frame, _("Could not listen for new batch jobs.  Perhaps another instance of the DCP-o-matic Batch Converter is running."));
 480                 }
 481
 482                 signal_manager = new wxSignalManager (this);
 483                 this->Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
 484
 485                 shared_ptr<Film> film;
 486                 for (auto i: films_to_load) {
 487                         if (dcp::filesystem::is_directory(i)) {
 488                                 try {
 489                                         film = make_shared<Film>(i);
 490                                         film->read_metadata ();
 491                                         make_dcp (film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
 492                                 } catch (exception& e) {
 493                                         error_dialog (
 494                                                 0,
 495                                                 std_to_wx(String::compose(wx_to_std(_("Could not load film %1")), i.string())),
 496                                                 std_to_wx(e.what())
 497                                                 );
 498                                 }
 499                         }
 500                 }
 501
 502                 return true;
 503         }
 504
 505         void idle ()
 506         {
 507                 signal_manager->ui_idle ();
 508         }
 509
 510         void OnInitCmdLine (wxCmdLineParser& parser) override
 511         {
 512                 parser.SetDesc (command_line_description);
 513                 parser.SetSwitchChars (wxT ("-"));
 514         }
 515
 516         bool OnCmdLineParsed (wxCmdLineParser& parser) override
 517         {
 518                 for (size_t i = 0; i < parser.GetParamCount(); ++i) {
 519                         films_to_load.push_back (wx_to_std(parser.GetParam(i)));
 520                 }
 521
 522                 return true;
 523         }
 524
 525         void config_failed_to_load(Config::LoadFailure what)
 526         {
 527                 report_config_load_failure(_frame, what);
 528         }
 529
 530         void config_warning (string m)
 531         {
 532                 message_dialog (_frame, std_to_wx(m));
 533         }
 534
 535         DOMFrame* _frame;
 536 };
 537
 538
 539 IMPLEMENT_APP (App)