src/wx/playlist_controls.cc

   1 /*
   2     Copyright (C) 2018-2020 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 "content_view.h"
  23 #include "dcpomatic_button.h"
  24 #include "film_viewer.h"
  25 #include "playlist_controls.h"
  26 #include "static_text.h"
  27 #include "wx_util.h"
  28 #include "lib/compose.hpp"
  29 #include "lib/cross.h"
  30 #include "lib/dcp_content.h"
  31 #include "lib/ffmpeg_content.h"
  32 #include "lib/internet.h"
  33 #include "lib/player_video.h"
  34 #include "lib/scoped_temporary.h"
  35 #include <dcp/exceptions.h>
  36 #include <dcp/raw_convert.h>
  37 #include <dcp/warnings.h>
  38 LIBDCP_DISABLE_WARNINGS
  39 #include <wx/listctrl.h>
  40 #include <wx/progdlg.h>
  41 LIBDCP_ENABLE_WARNINGS
  42
  43
  44 using std::cout;
  45 using std::dynamic_pointer_cast;
  46 using std::exception;
  47 using std::shared_ptr;
  48 using std::sort;
  49 using std::string;
  50 using boost::optional;
  51 using namespace dcpomatic;
  52
  53
  54 PlaylistControls::PlaylistControls(wxWindow* parent, FilmViewer& viewer)
  55         : Controls (parent, viewer, false)
  56         , _play_button (new Button(this, _("Play")))
  57         , _pause_button (new Button(this, _("Pause")))
  58         , _stop_button (new Button(this, _("Stop")))
  59         , _next_button (new Button(this, "Next"))
  60         , _previous_button (new Button(this, "Previous"))
  61 {
  62         _button_sizer->Add (_previous_button, 0, wxEXPAND);
  63         _button_sizer->Add (_play_button, 0, wxEXPAND);
  64         _button_sizer->Add (_pause_button, 0, wxEXPAND);
  65         _button_sizer->Add (_stop_button, 0, wxEXPAND);
  66         _button_sizer->Add (_next_button, 0, wxEXPAND);
  67
  68         _spl_view = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_NO_HEADER);
  69         _spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 740);
  70
  71         wxBoxSizer* left_sizer = new wxBoxSizer (wxVERTICAL);
  72         wxBoxSizer* e_sizer = new wxBoxSizer (wxHORIZONTAL);
  73
  74         wxFont subheading_font (*wxNORMAL_FONT);
  75         subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
  76
  77         wxBoxSizer* spl_header = new wxBoxSizer (wxHORIZONTAL);
  78         {
  79                 wxStaticText* m = new StaticText (this, "Playlists");
  80                 m->SetFont (subheading_font);
  81                 spl_header->Add (m, 1, wxALIGN_CENTER_VERTICAL);
  82         }
  83         _refresh_spl_view = new Button (this, "Refresh");
  84         spl_header->Add (_refresh_spl_view, 0, wxBOTTOM, DCPOMATIC_SIZER_GAP / 2);
  85
  86         left_sizer->Add (spl_header, 0, wxLEFT | wxRIGHT | wxEXPAND, DCPOMATIC_SIZER_GAP);
  87         left_sizer->Add (_spl_view, 1, wxLEFT | wxRIGHT | wxBOTTOM | wxEXPAND, DCPOMATIC_SIZER_GAP);
  88
  89         _content_view = new ContentView (this);
  90
  91         wxBoxSizer* content_header = new wxBoxSizer (wxHORIZONTAL);
  92         {
  93                 wxStaticText* m = new StaticText (this, "Content");
  94                 m->SetFont (subheading_font);
  95                 content_header->Add (m, 1, wxALIGN_CENTER_VERTICAL);
  96         }
  97         _refresh_content_view = new Button (this, "Refresh");
  98         content_header->Add (_refresh_content_view, 0, wxBOTTOM, DCPOMATIC_SIZER_GAP / 2);
  99
 100         left_sizer->Add (content_header, 0, wxTOP | wxLEFT | wxRIGHT | wxEXPAND, DCPOMATIC_SIZER_GAP);
 101         left_sizer->Add (_content_view, 1, wxLEFT | wxRIGHT | wxBOTTOM | wxEXPAND, DCPOMATIC_SIZER_GAP);
 102
 103         _current_spl_view = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_NO_HEADER);
 104         _current_spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 500);
 105         _current_spl_view->AppendColumn (wxT(""), wxLIST_FORMAT_LEFT, 80);
 106         e_sizer->Add (left_sizer, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
 107         e_sizer->Add (_current_spl_view, 1, wxALL | wxEXPAND, DCPOMATIC_SIZER_GAP);
 108
 109         _v_sizer->Add (e_sizer, 1, wxEXPAND);
 110
 111         _play_button->Bind     (wxEVT_BUTTON, boost::bind(&PlaylistControls::play_clicked,  this));
 112         _pause_button->Bind    (wxEVT_BUTTON, boost::bind(&PlaylistControls::pause_clicked, this));
 113         _stop_button->Bind     (wxEVT_BUTTON, boost::bind(&PlaylistControls::stop_clicked,  this));
 114         _next_button->Bind     (wxEVT_BUTTON, boost::bind(&PlaylistControls::next_clicked,  this));
 115         _previous_button->Bind (wxEVT_BUTTON, boost::bind(&PlaylistControls::previous_clicked,  this));
 116         _spl_view->Bind        (wxEVT_LIST_ITEM_SELECTED,   boost::bind(&PlaylistControls::spl_selection_changed, this));
 117         _spl_view->Bind        (wxEVT_LIST_ITEM_DESELECTED, boost::bind(&PlaylistControls::spl_selection_changed, this));
 118         _viewer.Finished.connect(boost::bind(&PlaylistControls::viewer_finished, this));
 119         _refresh_spl_view->Bind (wxEVT_BUTTON, boost::bind(&PlaylistControls::update_playlist_directory, this));
 120         _refresh_content_view->Bind (wxEVT_BUTTON, boost::bind(&ContentView::update, _content_view));
 121
 122         _content_view->update ();
 123         update_playlist_directory ();
 124 }
 125
 126 void
 127 PlaylistControls::started ()
 128 {
 129         Controls::started ();
 130         _play_button->Enable (false);
 131         _pause_button->Enable (true);
 132 }
 133
 134 /** Called when the viewer finishes a single piece of content, or it is explicitly stopped */
 135 void
 136 PlaylistControls::stopped ()
 137 {
 138         Controls::stopped ();
 139         _play_button->Enable (true);
 140         _pause_button->Enable (false);
 141 }
 142
 143 void
 144 PlaylistControls::deselect_playlist ()
 145 {
 146         long int const selected = _spl_view->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 147         if (selected != -1) {
 148                 _selected_playlist = boost::none;
 149                 _spl_view->SetItemState (selected, 0, wxLIST_STATE_SELECTED);
 150         }
 151         ResetFilm(std::make_shared<Film>(optional<boost::filesystem::path>()));
 152 }
 153
 154 void
 155 PlaylistControls::play_clicked ()
 156 {
 157         _viewer.start();
 158 }
 159
 160 void
 161 PlaylistControls::setup_sensitivity ()
 162 {
 163         Controls::setup_sensitivity ();
 164         bool const active_job = _active_job && *_active_job != "examine_content";
 165         bool const c = _film && !_film->content().empty() && !active_job;
 166         _play_button->Enable(c && !_viewer.playing());
 167         _pause_button->Enable(_viewer.playing());
 168         _spl_view->Enable(!_viewer.playing());
 169         _next_button->Enable (can_do_next());
 170         _previous_button->Enable (can_do_previous());
 171 }
 172
 173 void
 174 PlaylistControls::pause_clicked ()
 175 {
 176         _viewer.stop();
 177 }
 178
 179 void
 180 PlaylistControls::stop_clicked ()
 181 {
 182         _viewer.stop();
 183         _viewer.seek(DCPTime(), true);
 184         if (_selected_playlist) {
 185                 _selected_playlist_position = 0;
 186                 update_current_content ();
 187         }
 188         deselect_playlist ();
 189 }
 190
 191 bool
 192 PlaylistControls::can_do_previous ()
 193 {
 194         return _selected_playlist && (_selected_playlist_position - 1) >= 0;
 195 }
 196
 197 void
 198 PlaylistControls::previous_clicked ()
 199 {
 200         if (!can_do_previous ()) {
 201                 return;
 202         }
 203
 204         _selected_playlist_position--;
 205         update_current_content ();
 206 }
 207
 208 bool
 209 PlaylistControls::can_do_next ()
 210 {
 211         return _selected_playlist && (_selected_playlist_position + 1) < int(_playlists[*_selected_playlist].get().size());
 212 }
 213
 214 void
 215 PlaylistControls::next_clicked ()
 216 {
 217         if (!can_do_next ()) {
 218                 return;
 219         }
 220
 221         _selected_playlist_position++;
 222         update_current_content ();
 223 }
 224
 225
 226 void
 227 PlaylistControls::add_playlist_to_list (SPL spl)
 228 {
 229         int const N = _spl_view->GetItemCount();
 230
 231         wxListItem it;
 232         it.SetId(N);
 233         it.SetColumn(0);
 234         string t = spl.name();
 235         if (spl.missing()) {
 236                 t += " (content missing)";
 237         }
 238         it.SetText (std_to_wx(t));
 239         _spl_view->InsertItem (it);
 240 }
 241
 242 struct SPLComparator
 243 {
 244         bool operator() (SPL const & a, SPL const & b) {
 245                 return a.name() < b.name();
 246         }
 247 };
 248
 249 void
 250 PlaylistControls::update_playlist_directory ()
 251 {
 252         using namespace boost::filesystem;
 253
 254         _spl_view->DeleteAllItems ();
 255         optional<path> dir = Config::instance()->player_playlist_directory();
 256         if (!dir) {
 257                 return;
 258         }
 259
 260         _playlists.clear ();
 261
 262         for (directory_iterator i = directory_iterator(*dir); i != directory_iterator(); ++i) {
 263                 try {
 264                         if (is_regular_file(i->path()) && i->path().extension() == ".xml") {
 265                                 SPL spl;
 266                                 spl.read (i->path(), _content_view);
 267                                 _playlists.push_back (spl);
 268                         }
 269                 } catch (exception& e) {
 270                         /* Never mind */
 271                 }
 272         }
 273
 274         sort (_playlists.begin(), _playlists.end(), SPLComparator());
 275         for (auto i: _playlists) {
 276                 add_playlist_to_list (i);
 277         }
 278
 279         _selected_playlist = boost::none;
 280 }
 281
 282 optional<dcp::EncryptedKDM>
 283 PlaylistControls::get_kdm_from_directory (shared_ptr<DCPContent> dcp)
 284 {
 285         using namespace boost::filesystem;
 286         optional<path> kdm_dir = Config::instance()->player_kdm_directory();
 287         if (!kdm_dir) {
 288                 return optional<dcp::EncryptedKDM>();
 289         }
 290         for (directory_iterator i = directory_iterator(*kdm_dir); i != directory_iterator(); ++i) {
 291                 try {
 292                         if (file_size(i->path()) < MAX_KDM_SIZE) {
 293                                 dcp::EncryptedKDM kdm (dcp::file_to_string(i->path()));
 294                                 if (kdm.cpl_id() == dcp->cpl()) {
 295                                         return kdm;
 296                                 }
 297                         }
 298                 } catch (std::exception& e) {
 299                         /* Hey well */
 300                 }
 301         }
 302         return optional<dcp::EncryptedKDM>();
 303 }
 304
 305 void
 306 PlaylistControls::spl_selection_changed ()
 307 {
 308         long int selected = _spl_view->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 309         if (selected == -1) {
 310                 _current_spl_view->DeleteAllItems ();
 311                 _selected_playlist = boost::none;
 312                 return;
 313         }
 314
 315         if (_playlists[selected].missing()) {
 316                 error_dialog (this, "This playlist cannot be loaded as some content is missing.");
 317                 deselect_playlist ();
 318                 return;
 319         }
 320
 321         if (_playlists[selected].get().empty()) {
 322                 error_dialog (this, "This playlist is empty.");
 323                 return;
 324         }
 325
 326         select_playlist (selected, 0);
 327 }
 328
 329 void
 330 PlaylistControls::select_playlist (int selected, int position)
 331 {
 332         wxProgressDialog dialog (_("DCP-o-matic"), "Loading playlist and KDMs");
 333
 334         for (auto const& i: _playlists[selected].get()) {
 335                 dialog.Pulse ();
 336                 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i.content);
 337                 if (dcp && dcp->needs_kdm()) {
 338                         optional<dcp::EncryptedKDM> kdm;
 339                         kdm = get_kdm_from_directory (dcp);
 340                         if (kdm) {
 341                                 try {
 342                                         dcp->add_kdm (*kdm);
 343                                         dcp->examine (_film, shared_ptr<Job>());
 344                                 } catch (KDMError& e) {
 345                                         error_dialog (this, "Could not load KDM.");
 346                                 }
 347                         }
 348                         if (dcp->needs_kdm()) {
 349                                 /* We didn't get a KDM for this */
 350                                 error_dialog (this, "This playlist cannot be loaded as a KDM is missing or incorrect.");
 351                                 deselect_playlist ();
 352                                 return;
 353                         }
 354                 }
 355         }
 356
 357         _current_spl_view->DeleteAllItems ();
 358
 359         int N = 0;
 360         for (auto i: _playlists[selected].get()) {
 361                 wxListItem it;
 362                 it.SetId (N);
 363                 it.SetColumn (0);
 364                 it.SetText (std_to_wx(i.name));
 365                 _current_spl_view->InsertItem (it);
 366                 ++N;
 367         }
 368
 369         _selected_playlist = selected;
 370         _selected_playlist_position = position;
 371         dialog.Pulse ();
 372         reset_film ();
 373         dialog.Pulse ();
 374         update_current_content ();
 375 }
 376
 377 void
 378 PlaylistControls::reset_film ()
 379 {
 380         DCPOMATIC_ASSERT (_selected_playlist);
 381         shared_ptr<Film> film (new Film(optional<boost::filesystem::path>()));
 382         film->add_content (_playlists[*_selected_playlist].get()[_selected_playlist_position].content);
 383         ResetFilm (film);
 384 }
 385
 386 void
 387 PlaylistControls::config_changed (int property)
 388 {
 389         Controls::config_changed (property);
 390
 391         if (property == Config::PLAYER_CONTENT_DIRECTORY) {
 392                 _content_view->update ();
 393         } else if (property == Config::PLAYER_PLAYLIST_DIRECTORY) {
 394                 update_playlist_directory ();
 395         }
 396 }
 397
 398 void
 399 PlaylistControls::set_film (shared_ptr<Film> film)
 400 {
 401         Controls::set_film (film);
 402         setup_sensitivity ();
 403 }
 404
 405 void
 406 PlaylistControls::update_current_content ()
 407 {
 408         DCPOMATIC_ASSERT (_selected_playlist);
 409
 410         wxProgressDialog dialog (_("DCP-o-matic"), "Loading content");
 411
 412         setup_sensitivity ();
 413         dialog.Pulse ();
 414         reset_film ();
 415 }
 416
 417 /** One piece of content in our SPL has finished playing */
 418 void
 419 PlaylistControls::viewer_finished ()
 420 {
 421         if (!_selected_playlist) {
 422                 return;
 423         }
 424
 425         _selected_playlist_position++;
 426         if (_selected_playlist_position < int(_playlists[*_selected_playlist].get().size())) {
 427                 /* Next piece of content on the SPL */
 428                 update_current_content ();
 429                 _viewer.start();
 430         } else {
 431                 /* Finished the whole SPL */
 432                 _selected_playlist_position = 0;
 433                 ResetFilm(std::make_shared<Film>(optional<boost::filesystem::path>()));
 434                 _play_button->Enable (true);
 435                 _pause_button->Enable (false);
 436         }
 437 }
 438
 439 void
 440 PlaylistControls::play ()
 441 {
 442         play_clicked ();
 443 }
 444
 445 void
 446 PlaylistControls::stop ()
 447 {
 448         stop_clicked ();
 449 }