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