src/tools/dcpomatic_playlist.cc

   1 /*
   2     Copyright (C) 2018 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 #include "../wx/wx_util.h"
  22 #include "../wx/wx_signal_manager.h"
  23 #include "../wx/content_view.h"
  24 #include "../wx/dcpomatic_button.h"
  25 #include "../lib/util.h"
  26 #include "../lib/config.h"
  27 #include "../lib/cross.h"
  28 #include "../lib/film.h"
  29 #include "../lib/dcp_content.h"
  30 #include "../lib/spl_entry.h"
  31 #include "../lib/spl.h"
  32 #include <wx/wx.h>
  33 #include <wx/listctrl.h>
  34 #include <wx/imaglist.h>
  35
  36 using std::exception;
  37 using std::cout;
  38 using std::string;
  39 using boost::optional;
  40 using boost::shared_ptr;
  41 using boost::weak_ptr;
  42 using boost::bind;
  43 using boost::dynamic_pointer_cast;
  44
  45 class ContentDialog : public wxDialog, public ContentStore
  46 {
  47 public:
  48         ContentDialog (wxWindow* parent, weak_ptr<Film> film)
  49                 : wxDialog (parent, wxID_ANY, _("Add content"), wxDefaultPosition, wxSize(800, 640))
  50                 , _content_view (new ContentView(this))
  51         {
  52                 _content_view->update ();
  53
  54                 wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
  55                 SetSizer (overall_sizer);
  56
  57                 overall_sizer->Add (_content_view, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
  58
  59                 wxSizer* buttons = CreateSeparatedButtonSizer (wxOK | wxCANCEL);
  60                 if (buttons) {
  61                         overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
  62                 }
  63
  64                 overall_sizer->Layout ();
  65         }
  66
  67         shared_ptr<Content> selected () const
  68         {
  69                 return _content_view->selected ();
  70         }
  71
  72         shared_ptr<Content> get (string digest) const
  73         {
  74                 return _content_view->get (digest);
  75         }
  76
  77 private:
  78         ContentView* _content_view;
  79 };
  80
  81 class DOMFrame : public wxFrame
  82 {
  83 public:
  84         explicit DOMFrame (wxString const & title)
  85                 : wxFrame (0, -1, title)
  86                 /* XXX: this is a bit of a hack, but we need it to be able to use the Content class hierarchy */
  87                 , _film (new Film(optional<boost::filesystem::path>()))
  88                 , _content_dialog (new ContentDialog(this, _film))
  89         {
  90                 /* Use a panel as the only child of the Frame so that we avoid
  91                    the dark-grey background on Windows.
  92                 */
  93                 wxPanel* overall_panel = new wxPanel (this, wxID_ANY);
  94                 wxBoxSizer* main_sizer = new wxBoxSizer (wxHORIZONTAL);
  95
  96                 _list = new wxListCtrl (
  97                         overall_panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_SINGLE_SEL
  98                         );
  99
 100                 _list->AppendColumn (_("Name"), wxLIST_FORMAT_LEFT, 400);
 101                 _list->AppendColumn (_("CPL"), wxLIST_FORMAT_LEFT, 350);
 102                 _list->AppendColumn (_("Type"), wxLIST_FORMAT_CENTRE, 100);
 103                 _list->AppendColumn (_("Format"), wxLIST_FORMAT_CENTRE, 75);
 104                 _list->AppendColumn (_("Encrypted"), wxLIST_FORMAT_CENTRE, 90);
 105                 _list->AppendColumn (_("Skippable"), wxLIST_FORMAT_CENTRE, 90);
 106                 _list->AppendColumn (_("Disable timeline"), wxLIST_FORMAT_CENTRE, 125);
 107                 _list->AppendColumn (_("Stop after play"), wxLIST_FORMAT_CENTRE, 125);
 108
 109                 wxImageList* images = new wxImageList (16, 16);
 110                 wxIcon tick_icon;
 111                 wxIcon no_tick_icon;
 112 #ifdef DCPOMATIX_OSX
 113                 tick_icon.LoadFile ("tick.png", wxBITMAP_TYPE_PNG_RESOURCE);
 114                 no_tick_icon.LoadFile ("no_tick.png", wxBITMAP_TYPE_PNG_RESOURCE);
 115 #else
 116                 boost::filesystem::path tick_path = shared_path() / "tick.png";
 117                 tick_icon.LoadFile (std_to_wx(tick_path.string()));
 118                 boost::filesystem::path no_tick_path = shared_path() / "no_tick.png";
 119                 no_tick_icon.LoadFile (std_to_wx(no_tick_path.string()));
 120 #endif
 121                 images->Add (tick_icon);
 122                 images->Add (no_tick_icon);
 123
 124                 _list->SetImageList (images, wxIMAGE_LIST_SMALL);
 125
 126                 main_sizer->Add (_list, 1, wxEXPAND | wxALL, DCPOMATIC_SIZER_GAP);
 127
 128                 wxBoxSizer* button_sizer = new wxBoxSizer (wxVERTICAL);
 129                 _up = new Button (overall_panel, _("Up"));
 130                 _down = new Button (overall_panel, _("Down"));
 131                 _add = new Button (overall_panel, _("Add"));
 132                 _remove = new Button (overall_panel, _("Remove"));
 133                 _save = new Button (overall_panel, _("Save playlist"));
 134                 _load = new Button (overall_panel, _("Load playlist"));
 135                 button_sizer->Add (_up, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
 136                 button_sizer->Add (_down, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
 137                 button_sizer->Add (_add, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
 138                 button_sizer->Add (_remove, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
 139                 button_sizer->Add (_save, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
 140                 button_sizer->Add (_load, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
 141
 142                 main_sizer->Add (button_sizer, 0, wxALL, DCPOMATIC_SIZER_GAP);
 143                 overall_panel->SetSizer (main_sizer);
 144
 145                 _list->Bind (wxEVT_LEFT_DOWN, bind(&DOMFrame::list_left_click, this, _1));
 146                 _list->Bind (wxEVT_COMMAND_LIST_ITEM_SELECTED, boost::bind (&DOMFrame::selection_changed, this));
 147                 _list->Bind (wxEVT_COMMAND_LIST_ITEM_DESELECTED, boost::bind (&DOMFrame::selection_changed, this));
 148                 _up->Bind (wxEVT_BUTTON, bind(&DOMFrame::up_clicked, this));
 149                 _down->Bind (wxEVT_BUTTON, bind(&DOMFrame::down_clicked, this));
 150                 _add->Bind (wxEVT_BUTTON, bind(&DOMFrame::add_clicked, this));
 151                 _remove->Bind (wxEVT_BUTTON, bind(&DOMFrame::remove_clicked, this));
 152                 _save->Bind (wxEVT_BUTTON, bind(&DOMFrame::save_clicked, this));
 153                 _load->Bind (wxEVT_BUTTON, bind(&DOMFrame::load_clicked, this));
 154
 155                 setup_sensitivity ();
 156         }
 157
 158 private:
 159
 160         void add (SPLEntry e)
 161         {
 162                 wxListItem item;
 163                 item.SetId (_list->GetItemCount());
 164                 long const N = _list->InsertItem (item);
 165                 set_item (N, e);
 166                 _playlist.add (e);
 167         }
 168
 169         void selection_changed ()
 170         {
 171                 setup_sensitivity ();
 172         }
 173
 174         void set_item (long N, SPLEntry e)
 175         {
 176                 _list->SetItem (N, 0, std_to_wx(e.name));
 177                 _list->SetItem (N, 1, std_to_wx(e.id));
 178                 _list->SetItem (N, 2, std_to_wx(dcp::content_kind_to_string(e.kind)));
 179                 _list->SetItem (N, 3, e.type == SPLEntry::DCP ? _("DCP") : _("E-cinema"));
 180                 _list->SetItem (N, 4, e.encrypted ? _("Y") : _("N"));
 181                 _list->SetItem (N, COLUMN_SKIPPABLE, wxEmptyString, e.skippable ? 0 : 1);
 182                 _list->SetItem (N, COLUMN_DISABLE_TIMELINE, wxEmptyString, e.disable_timeline ? 0 : 1);
 183                 _list->SetItem (N, COLUMN_STOP_AFTER_PLAY, wxEmptyString, e.stop_after_play ? 0 : 1);
 184         }
 185
 186         void setup_sensitivity ()
 187         {
 188                 int const num_selected = _list->GetSelectedItemCount ();
 189                 long int selected = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 190                 _up->Enable (selected > 0);
 191                 _down->Enable (selected != -1 && selected < (_list->GetItemCount() - 1));
 192                 _remove->Enable (num_selected > 0);
 193         }
 194
 195         void list_left_click (wxMouseEvent& ev)
 196         {
 197                 int flags;
 198                 long item = _list->HitTest (ev.GetPosition(), flags, 0);
 199                 int x = ev.GetPosition().x;
 200                 optional<int> column;
 201                 for (int i = 0; i < _list->GetColumnCount(); ++i) {
 202                         x -= _list->GetColumnWidth (i);
 203                         if (x < 0) {
 204                                 column = i;
 205                                 break;
 206                         }
 207                 }
 208
 209                 if (item != -1 && column) {
 210                         switch (*column) {
 211                         case COLUMN_SKIPPABLE:
 212                                 _playlist[item].skippable = !_playlist[item].skippable;
 213                                 break;
 214                         case COLUMN_DISABLE_TIMELINE:
 215                                 _playlist[item].disable_timeline = !_playlist[item].disable_timeline;
 216                                 break;
 217                         case COLUMN_STOP_AFTER_PLAY:
 218                                 _playlist[item].stop_after_play = !_playlist[item].stop_after_play;
 219                                 break;
 220                         default:
 221                                 ev.Skip ();
 222                         }
 223                         set_item (item, _playlist[item]);
 224                 } else {
 225                         ev.Skip ();
 226                 }
 227         }
 228
 229         void add_clicked ()
 230         {
 231                 int const r = _content_dialog->ShowModal ();
 232                 if (r == wxID_OK) {
 233                         shared_ptr<Content> content = _content_dialog->selected ();
 234                         if (content) {
 235                                 add (SPLEntry(content));
 236                         }
 237                 }
 238         }
 239
 240         void up_clicked ()
 241         {
 242                 long int s = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 243                 if (s < 1) {
 244                         return;
 245                 }
 246
 247                 SPLEntry tmp = _playlist[s];
 248                 _playlist[s] = _playlist[s-1];
 249                 _playlist[s-1] = tmp;
 250
 251                 set_item (s - 1, _playlist[s-1]);
 252                 set_item (s, _playlist[s]);
 253         }
 254
 255         void down_clicked ()
 256         {
 257                 long int s = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 258                 if (s > (_list->GetItemCount() - 1)) {
 259                         return;
 260                 }
 261
 262                 SPLEntry tmp = _playlist[s];
 263                 _playlist[s] = _playlist[s+1];
 264                 _playlist[s+1] = tmp;
 265
 266                 set_item (s + 1, _playlist[s+1]);
 267                 set_item (s, _playlist[s]);
 268         }
 269
 270         void remove_clicked ()
 271         {
 272                 long int s = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 273                 if (s == -1) {
 274                         return;
 275                 }
 276
 277                 _playlist.remove (s);
 278                 _list->DeleteItem (s);
 279         }
 280
 281         void save_clicked ()
 282         {
 283                 Config* c = Config::instance ();
 284                 wxString default_dir = c->player_playlist_directory() ? std_to_wx(c->player_playlist_directory()->string()) : wxString(wxEmptyString);
 285                 wxFileDialog* d = new wxFileDialog (this, _("Select playlist file"), default_dir, wxEmptyString, wxT("XML files (*.xml)|*.xml"), wxFD_SAVE | wxFD_OVERWRITE_PROMPT);
 286                 if (d->ShowModal() == wxID_OK) {
 287                         _playlist.write (wx_to_std(d->GetPath()));
 288                 }
 289         }
 290
 291         void load_clicked ()
 292         {
 293                 Config* c = Config::instance ();
 294                 wxString default_dir = c->player_playlist_directory() ? std_to_wx(c->player_playlist_directory()->string()) : wxString(wxEmptyString);
 295                 wxFileDialog* d = new wxFileDialog (this, _("Select playlist file"), default_dir, wxEmptyString, wxT("XML files (*.xml)|*.xml"));
 296                 if (d->ShowModal() == wxID_OK) {
 297                         _list->DeleteAllItems ();
 298                         _playlist.read (wx_to_std(d->GetPath()), _content_dialog);
 299                         if (!_playlist.missing()) {
 300                                 BOOST_FOREACH (SPLEntry i, _playlist.get()) {
 301                                         add (i);
 302                                 }
 303                         } else {
 304                                 error_dialog (this, _("Some content in this playlist was not found."));
 305                         }
 306                 }
 307         }
 308
 309         wxListCtrl* _list;
 310         wxButton* _up;
 311         wxButton* _down;
 312         wxButton* _add;
 313         wxButton* _remove;
 314         wxButton* _save;
 315         wxButton* _load;
 316         boost::shared_ptr<Film> _film;
 317         SPL _playlist;
 318         ContentDialog* _content_dialog;
 319
 320         enum {
 321                 COLUMN_SKIPPABLE = 5,
 322                 COLUMN_DISABLE_TIMELINE = 6,
 323                 COLUMN_STOP_AFTER_PLAY = 7
 324         };
 325 };
 326
 327 /** @class App
 328  *  @brief The magic App class for wxWidgets.
 329  */
 330 class App : public wxApp
 331 {
 332 public:
 333         App ()
 334                 : wxApp ()
 335                 , _frame (0)
 336         {}
 337
 338 private:
 339
 340         bool OnInit ()
 341         try
 342         {
 343                 SetAppName (_("DCP-o-matic KDM Creator"));
 344
 345                 if (!wxApp::OnInit()) {
 346                         return false;
 347                 }
 348
 349 #ifdef DCPOMATIC_LINUX
 350                 unsetenv ("UBUNTU_MENUPROXY");
 351 #endif
 352
 353                 #ifdef __WXOSX__
 354                 ProcessSerialNumber serial;
 355                 GetCurrentProcess (&serial);
 356                 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
 357 #endif
 358
 359                 dcpomatic_setup_path_encoding ();
 360
 361                 /* Enable i18n; this will create a Config object
 362                    to look for a force-configured language.  This Config
 363                    object will be wrong, however, because dcpomatic_setup
 364                    hasn't yet been called and there aren't any filters etc.
 365                    set up yet.
 366                 */
 367                 dcpomatic_setup_i18n ();
 368
 369                 /* Set things up, including filters etc.
 370                    which will now be internationalised correctly.
 371                 */
 372                 dcpomatic_setup ();
 373
 374                 /* Force the configuration to be re-loaded correctly next
 375                    time it is needed.
 376                 */
 377                 Config::drop ();
 378
 379                 _frame = new DOMFrame (_("DCP-o-matic Playlist Editor"));
 380                 SetTopWindow (_frame);
 381                 _frame->Maximize ();
 382                 _frame->Show ();
 383
 384                 signal_manager = new wxSignalManager (this);
 385                 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
 386
 387                 return true;
 388         }
 389         catch (exception& e)
 390         {
 391                 error_dialog (0, _("DCP-o-matic could not start"), std_to_wx(e.what()));
 392                 return true;
 393         }
 394
 395         /* An unhandled exception has occurred inside the main event loop */
 396         bool OnExceptionInMainLoop ()
 397         {
 398                 try {
 399                         throw;
 400                 } catch (FileError& e) {
 401                         error_dialog (
 402                                 0,
 403                                 wxString::Format (
 404                                         _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
 405                                         std_to_wx (e.what()),
 406                                         std_to_wx (e.file().string().c_str ())
 407                                         )
 408                                 );
 409                 } catch (exception& e) {
 410                         error_dialog (
 411                                 0,
 412                                 wxString::Format (
 413                                         _("An exception occurred: %s.\n\n") + " " + REPORT_PROBLEM,
 414                                         std_to_wx (e.what ())
 415                                         )
 416                                 );
 417                 } catch (...) {
 418                         error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
 419                 }
 420
 421                 /* This will terminate the program */
 422                 return false;
 423         }
 424
 425         void OnUnhandledException ()
 426         {
 427                 error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
 428         }
 429
 430         void idle ()
 431         {
 432                 signal_manager->ui_idle ();
 433         }
 434
 435         DOMFrame* _frame;
 436 };
 437
 438 IMPLEMENT_APP (App)