2 Copyright (C) 2018-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 #include "wx/about_dialog.h"
23 #include "wx/content_view.h"
24 #include "wx/dcpomatic_button.h"
25 #include "wx/playlist_editor_config_dialog.h"
26 #include "wx/wx_signal_manager.h"
27 #include "wx/wx_util.h"
28 #include "lib/config.h"
29 #include "lib/constants.h"
30 #include "lib/cross.h"
31 #include "lib/dcp_content.h"
34 #include "lib/spl_entry.h"
35 #include <dcp/warnings.h>
36 LIBDCP_DISABLE_WARNINGS
37 #include <wx/imaglist.h>
38 #include <wx/listctrl.h>
39 #include <wx/preferences.h>
40 #include <wx/spinctrl.h>
42 LIBDCP_ENABLE_WARNINGS
48 using std::make_shared;
50 using std::shared_ptr;
55 using boost::optional;
56 using std::dynamic_pointer_cast;
57 #if BOOST_VERSION >= 106100
58 using namespace boost::placeholders;
64 save_playlist(shared_ptr<const SPL> playlist)
66 if (auto dir = Config::instance()->player_playlist_directory()) {
67 playlist->write(*dir / (playlist->id() + ".xml"));
72 class ContentDialog : public wxDialog, public ContentStore
75 ContentDialog (wxWindow* parent)
76 : wxDialog (parent, wxID_ANY, _("Add content"), wxDefaultPosition, wxSize(800, 640))
77 , _content_view (new ContentView(this))
79 _content_view->update ();
81 auto overall_sizer = new wxBoxSizer (wxVERTICAL);
82 SetSizer (overall_sizer);
84 overall_sizer->Add (_content_view, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
86 auto buttons = CreateSeparatedButtonSizer (wxOK | wxCANCEL);
88 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
91 overall_sizer->Layout ();
93 _content_view->Bind(wxEVT_LIST_ITEM_ACTIVATED, boost::bind(&ContentDialog::EndModal, this, wxID_OK));
94 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&ContentView::update, _content_view));
97 shared_ptr<Content> selected () const
99 return _content_view->selected ();
102 shared_ptr<Content> get (string digest) const override
104 return _content_view->get (digest);
108 ContentView* _content_view;
109 boost::signals2::scoped_connection _config_changed_connection;
117 PlaylistList (wxPanel* parent, ContentStore* content_store)
118 : _sizer (new wxBoxSizer(wxVERTICAL))
119 , _content_store (content_store)
122 auto label = new wxStaticText (parent, wxID_ANY, wxEmptyString);
123 label->SetLabelMarkup (_("<b>Playlists</b>"));
124 _sizer->Add (label, 0, wxTOP | wxLEFT, DCPOMATIC_SIZER_GAP * 2);
126 _list = new wxListCtrl (
127 parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_SINGLE_SEL
130 _list->AppendColumn (_("Name"), wxLIST_FORMAT_LEFT, 840);
131 _list->AppendColumn (_("Length"), wxLIST_FORMAT_LEFT, 100);
133 auto button_sizer = new wxBoxSizer (wxVERTICAL);
134 _new = new Button (parent, _("New"));
135 button_sizer->Add (_new, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
136 _delete = new Button (parent, _("Delete"));
137 button_sizer->Add (_delete, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
139 auto list = new wxBoxSizer (wxHORIZONTAL);
140 list->Add (_list, 1, wxEXPAND | wxALL, DCPOMATIC_SIZER_GAP);
141 list->Add (button_sizer, 0, wxALL, DCPOMATIC_SIZER_GAP);
147 _list->Bind (wxEVT_COMMAND_LIST_ITEM_SELECTED, bind(&PlaylistList::selection_changed, this));
148 _list->Bind (wxEVT_COMMAND_LIST_ITEM_DESELECTED, bind(&PlaylistList::selection_changed, this));
149 _new->Bind (wxEVT_BUTTON, bind(&PlaylistList::new_playlist, this));
150 _delete->Bind (wxEVT_BUTTON, bind(&PlaylistList::delete_playlist, this));
160 shared_ptr<SignalSPL> first_playlist () const
162 if (_playlists.empty()) {
166 return _playlists.front ();
169 boost::signals2::signal<void (shared_ptr<SignalSPL>)> Edit;
172 void setup_sensitivity()
174 _delete->Enable(static_cast<bool>(selected()));
177 void add_playlist_to_view (shared_ptr<const SignalSPL> playlist)
180 item.SetId (_list->GetItemCount());
181 long const N = _list->InsertItem (item);
182 _list->SetItem (N, 0, std_to_wx(playlist->name()));
185 void add_playlist_to_model (shared_ptr<SignalSPL> playlist)
187 _playlists.push_back (playlist);
188 playlist->Changed.connect(bind(&PlaylistList::changed, this, weak_ptr<SignalSPL>(playlist), _1));
191 void changed(weak_ptr<SignalSPL> wp, SignalSPL::Change change)
193 auto playlist = wp.lock ();
199 case SignalSPL::Change::NAME:
202 for (auto i: _playlists) {
204 _list->SetItem (N, 0, std_to_wx(i->name()));
210 case SignalSPL::Change::CONTENT:
211 save_playlist(playlist);
216 void load_playlists ()
218 auto path = Config::instance()->player_playlist_directory();
223 _list->DeleteAllItems ();
225 for (auto i: boost::filesystem::directory_iterator(*path)) {
226 auto spl = make_shared<SignalSPL>();
228 spl->read (i, _content_store);
229 add_playlist_to_model (spl);
233 for (auto i: _playlists) {
234 add_playlist_to_view (i);
240 auto dir = Config::instance()->player_playlist_directory();
242 error_dialog(_parent, _("No playlist folder is specified in preferences. Please set one and then try again."));
246 shared_ptr<SignalSPL> spl (new SignalSPL(wx_to_std(_("New Playlist"))));
247 add_playlist_to_model (spl);
248 add_playlist_to_view (spl);
249 _list->SetItemState (_list->GetItemCount() - 1, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
252 boost::optional<int> selected() const
254 long int selected = _list->GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
255 if (selected < 0 || selected >= int(_playlists.size())) {
262 void delete_playlist ()
264 auto index = selected();
269 auto dir = Config::instance()->player_playlist_directory();
274 boost::filesystem::remove(*dir / (_playlists[*index]->id() + ".xml"));
275 _list->DeleteItem(*index);
276 _playlists.erase(_playlists.begin() + *index);
278 Edit(shared_ptr<SignalSPL>());
281 void selection_changed ()
283 long int selected = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
284 if (selected < 0 || selected >= int(_playlists.size())) {
285 Edit (shared_ptr<SignalSPL>());
287 Edit (_playlists[selected]);
297 vector<shared_ptr<SignalSPL>> _playlists;
298 ContentStore* _content_store;
303 class PlaylistContent
306 PlaylistContent (wxPanel* parent, ContentDialog* content_dialog)
307 : _content_dialog (content_dialog)
308 , _sizer (new wxBoxSizer(wxVERTICAL))
310 auto title = new wxBoxSizer (wxHORIZONTAL);
311 auto label = new wxStaticText (parent, wxID_ANY, wxEmptyString);
312 label->SetLabelMarkup (_("<b>Playlist:</b>"));
313 title->Add (label, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_GAP);
314 _name = new wxTextCtrl (parent, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(400, -1));
315 title->Add (_name, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
316 _save_name = new Button(parent, _("Save"));
317 title->Add(_save_name);
318 _sizer->Add (title, 0, wxTOP | wxLEFT, DCPOMATIC_SIZER_GAP * 2);
320 auto list = new wxBoxSizer (wxHORIZONTAL);
322 _list = new wxListCtrl (
323 parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_SINGLE_SEL
326 _list->AppendColumn (_("Name"), wxLIST_FORMAT_LEFT, 400);
327 _list->AppendColumn (_("CPL"), wxLIST_FORMAT_LEFT, 350);
328 _list->AppendColumn (_("Type"), wxLIST_FORMAT_LEFT, 100);
329 _list->AppendColumn (_("Encrypted"), wxLIST_FORMAT_CENTRE, 90);
331 auto images = new wxImageList (16, 16);
334 tick_icon.LoadFile (bitmap_path("tick.png"), wxBITMAP_TYPE_PNG);
335 no_tick_icon.LoadFile (bitmap_path("no_tick.png"), wxBITMAP_TYPE_PNG);
336 images->Add (tick_icon);
337 images->Add (no_tick_icon);
339 _list->SetImageList (images, wxIMAGE_LIST_SMALL);
341 list->Add (_list, 1, wxEXPAND | wxALL, DCPOMATIC_SIZER_GAP);
343 auto button_sizer = new wxBoxSizer (wxVERTICAL);
344 _up = new Button (parent, _("Up"));
345 _down = new Button (parent, _("Down"));
346 _add = new Button (parent, _("Add"));
347 _remove = new Button (parent, _("Remove"));
348 button_sizer->Add (_up, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
349 button_sizer->Add (_down, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
350 button_sizer->Add (_add, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
351 button_sizer->Add (_remove, 0, wxEXPAND | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
353 list->Add (button_sizer, 0, wxALL, DCPOMATIC_SIZER_GAP);
357 _list->Bind (wxEVT_COMMAND_LIST_ITEM_SELECTED, bind(&PlaylistContent::setup_sensitivity, this));
358 _list->Bind (wxEVT_COMMAND_LIST_ITEM_DESELECTED, bind(&PlaylistContent::setup_sensitivity, this));
359 _name->Bind (wxEVT_TEXT, bind(&PlaylistContent::name_changed, this));
360 _save_name->bind(&PlaylistContent::save_name_clicked, this);
361 _up->Bind (wxEVT_BUTTON, bind(&PlaylistContent::up_clicked, this));
362 _down->Bind (wxEVT_BUTTON, bind(&PlaylistContent::down_clicked, this));
363 _add->Bind (wxEVT_BUTTON, bind(&PlaylistContent::add_clicked, this));
364 _remove->Bind (wxEVT_BUTTON, bind(&PlaylistContent::remove_clicked, this));
374 void set (shared_ptr<SignalSPL> playlist)
376 _playlist = playlist;
377 _list->DeleteAllItems ();
379 for (auto i: _playlist->get()) {
382 _name->SetValue (std_to_wx(_playlist->name()));
384 _name->SetValue (wxT(""));
386 setup_sensitivity ();
389 shared_ptr<SignalSPL> playlist () const
396 void save_name_clicked()
399 _playlist->set_name(wx_to_std(_name->GetValue()));
400 save_playlist(_playlist);
410 void add (SPLEntry e)
413 item.SetId (_list->GetItemCount());
414 long const N = _list->InsertItem (item);
418 void set_item (long N, SPLEntry e)
420 _list->SetItem (N, 0, std_to_wx(e.name));
421 _list->SetItem (N, 1, std_to_wx(e.id));
422 _list->SetItem (N, 2, std_to_wx(e.kind->name()));
423 _list->SetItem (N, 3, e.encrypted ? S_("Question|Y") : S_("Question|N"));
426 void setup_sensitivity ()
428 bool const have_list = static_cast<bool>(_playlist);
429 int const num_selected = _list->GetSelectedItemCount ();
430 long int selected = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
431 _name->Enable (have_list);
432 _save_name->Enable(_playlist && _playlist->name() != wx_to_std(_name->GetValue()));
433 _list->Enable (have_list);
434 _up->Enable (have_list && selected > 0);
435 _down->Enable (have_list && selected != -1 && selected < (_list->GetItemCount() - 1));
436 _add->Enable (have_list);
437 _remove->Enable (have_list && num_selected > 0);
442 int const r = _content_dialog->ShowModal ();
444 auto content = _content_dialog->selected ();
446 SPLEntry e (content);
448 DCPOMATIC_ASSERT (_playlist);
456 long int s = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
461 DCPOMATIC_ASSERT (_playlist);
463 _playlist->swap(s, s - 1);
465 set_item (s - 1, (*_playlist)[s-1]);
466 set_item (s, (*_playlist)[s]);
471 long int s = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
472 if (s > (_list->GetItemCount() - 1)) {
476 DCPOMATIC_ASSERT (_playlist);
478 _playlist->swap(s, s + 1);
480 set_item (s + 1, (*_playlist)[s+1]);
481 set_item (s, (*_playlist)[s]);
484 void remove_clicked ()
486 long int s = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
491 DCPOMATIC_ASSERT (_playlist);
492 _playlist->remove (s);
493 _list->DeleteItem (s);
496 ContentDialog* _content_dialog;
505 shared_ptr<SignalSPL> _playlist;
509 class DOMFrame : public wxFrame
512 explicit DOMFrame (wxString const & title)
513 : wxFrame (nullptr, wxID_ANY, title)
514 , _content_dialog (new ContentDialog(this))
515 , _config_dialog (nullptr)
517 auto bar = new wxMenuBar;
521 /* Use a panel as the only child of the Frame so that we avoid
522 the dark-grey background on Windows.
524 auto overall_panel = new wxPanel (this, wxID_ANY);
525 auto sizer = new wxBoxSizer (wxVERTICAL);
527 _playlist_list = new PlaylistList (overall_panel, _content_dialog);
528 _playlist_content = new PlaylistContent (overall_panel, _content_dialog);
530 sizer->Add (_playlist_list->sizer());
531 sizer->Add (_playlist_content->sizer());
533 overall_panel->SetSizer (sizer);
535 _playlist_list->Edit.connect (bind(&DOMFrame::change_playlist, this, _1));
537 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
538 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
539 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
541 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this));
548 /* false here allows the close handler to veto the close request */
554 auto d = make_wx<AboutDialog>(this);
558 void edit_preferences ()
560 if (!_config_dialog) {
561 _config_dialog = create_playlist_editor_config_dialog ();
563 _config_dialog->Show (this);
566 void change_playlist (shared_ptr<SignalSPL> playlist)
568 auto old = _playlist_content->playlist ();
572 _playlist_content->set (playlist);
575 void setup_menu (wxMenuBar* m)
577 auto file = new wxMenu;
579 file->Append (wxID_EXIT, _("&Exit"));
581 file->Append (wxID_EXIT, _("&Quit"));
585 auto edit = new wxMenu;
586 edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
589 auto help = new wxMenu;
591 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
593 help->Append (wxID_ABOUT, _("About"));
596 m->Append (file, _("&File"));
598 m->Append (edit, _("&Edit"));
600 m->Append (help, _("&Help"));
604 void config_changed ()
607 Config::instance()->write_config();
608 } catch (exception& e) {
612 _("Could not write to config file at %s. Your changes have not been saved."),
613 std_to_wx (Config::instance()->cinemas_file().string()).data()
619 ContentDialog* _content_dialog;
620 PlaylistList* _playlist_list;
621 PlaylistContent* _playlist_content;
622 wxPreferencesEditor* _config_dialog;
623 boost::signals2::scoped_connection _config_changed_connection;
628 * @brief The magic App class for wxWidgets.
630 class App : public wxApp
640 bool OnInit () override
643 wxInitAllImageHandlers ();
644 SetAppName (_("DCP-o-matic Playlist Editor"));
646 if (!wxApp::OnInit()) {
650 #ifdef DCPOMATIC_LINUX
651 unsetenv ("UBUNTU_MENUPROXY");
655 make_foreground_application ();
658 dcpomatic_setup_path_encoding ();
660 /* Enable i18n; this will create a Config object
661 to look for a force-configured language. This Config
662 object will be wrong, however, because dcpomatic_setup
663 hasn't yet been called and there aren't any filters etc.
666 dcpomatic_setup_i18n ();
668 /* Set things up, including filters etc.
669 which will now be internationalised correctly.
673 /* Force the configuration to be re-loaded correctly next
678 _frame = new DOMFrame (_("DCP-o-matic Playlist Editor"));
679 SetTopWindow (_frame);
683 signal_manager = new wxSignalManager (this);
684 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
690 error_dialog (0, _("DCP-o-matic could not start"), std_to_wx(e.what()));
694 /* An unhandled exception has occurred inside the main event loop */
695 bool OnExceptionInMainLoop () override
699 } catch (FileError& e) {
703 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
704 std_to_wx (e.what()),
705 std_to_wx (e.file().string().c_str ())
708 } catch (exception& e) {
712 _("An exception occurred: %s.\n\n") + " " + REPORT_PROBLEM,
713 std_to_wx (e.what ())
717 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
720 /* This will terminate the program */
724 void OnUnhandledException () override
726 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
731 signal_manager->ui_idle ();