src/wx/content_menu.cc

   1 /*
   2     Copyright (C) 2013-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 "content_menu.h"
  22 #include "repeat_dialog.h"
  23 #include "wx_util.h"
  24 #include "timeline_video_content_view.h"
  25 #include "timeline_audio_content_view.h"
  26 #include "content_properties_dialog.h"
  27 #include "content_advanced_dialog.h"
  28 #include "lib/playlist.h"
  29 #include "lib/film.h"
  30 #include "lib/image_content.h"
  31 #include "lib/content_factory.h"
  32 #include "lib/examine_content_job.h"
  33 #include "lib/job_manager.h"
  34 #include "lib/exceptions.h"
  35 #include "lib/dcp_content.h"
  36 #include "lib/dcp_examiner.h"
  37 #include "lib/ffmpeg_content.h"
  38 #include "lib/audio_content.h"
  39 #include "lib/config.h"
  40 #include "lib/copy_dcp_details_to_film.h"
  41 #include <dcp/cpl.h>
  42 #include <dcp/exceptions.h>
  43 #include <dcp/decrypted_kdm.h>
  44 #include <wx/wx.h>
  45 #include <wx/dirdlg.h>
  46 #include <boost/foreach.hpp>
  47 #include <iostream>
  48
  49 using std::cout;
  50 using std::vector;
  51 using std::exception;
  52 using std::list;
  53 using std::shared_ptr;
  54 using std::weak_ptr;
  55 using std::dynamic_pointer_cast;
  56 using boost::optional;
  57 #if BOOST_VERSION >= 106100
  58 using namespace boost::placeholders;
  59 #endif
  60
  61
  62 enum {
  63         /* Start at 256 so we can have IDs on _cpl_menu from 1 to 255 */
  64         ID_repeat = 256,
  65         ID_join,
  66         ID_find_missing,
  67         ID_properties,
  68         ID_advanced,
  69         ID_re_examine,
  70         ID_kdm,
  71         ID_ov,
  72         ID_choose_cpl,
  73         ID_set_dcp_settings,
  74         ID_remove
  75 };
  76
  77 ContentMenu::ContentMenu (wxWindow* p)
  78         : _menu (new wxMenu)
  79         , _parent (p)
  80         , _pop_up_open (false)
  81 {
  82         _repeat = _menu->Append (ID_repeat, _("Repeat..."));
  83         _join = _menu->Append (ID_join, _("Join"));
  84         _find_missing = _menu->Append (ID_find_missing, _("Find missing..."));
  85         _properties = _menu->Append (ID_properties, _("Properties..."));
  86         _advanced = _menu->Append (ID_advanced, _("Advanced settings..."));
  87         _re_examine = _menu->Append (ID_re_examine, _("Re-examine..."));
  88         _menu->AppendSeparator ();
  89         _kdm = _menu->Append (ID_kdm, _("Add KDM..."));
  90         _ov = _menu->Append (ID_ov, _("Add OV..."));
  91         _cpl_menu = new wxMenu ();
  92         _choose_cpl = _menu->Append (ID_choose_cpl, _("Choose CPL..."), _cpl_menu);
  93         _set_dcp_settings = _menu->Append (ID_set_dcp_settings, _("Set project DCP settings from this DCP"));
  94         _menu->AppendSeparator ();
  95         _remove = _menu->Append (ID_remove, _("Remove"));
  96
  97         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::repeat, this), ID_repeat);
  98         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::join, this), ID_join);
  99         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::find_missing, this), ID_find_missing);
 100         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::properties, this), ID_properties);
 101         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::advanced, this), ID_advanced);
 102         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::re_examine, this), ID_re_examine);
 103         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::kdm, this), ID_kdm);
 104         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::ov, this), ID_ov);
 105         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::set_dcp_settings, this), ID_set_dcp_settings);
 106         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::remove, this), ID_remove);
 107         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::cpl_selected, this, _1), 1, ID_repeat - 1);
 108 }
 109
 110 void
 111 ContentMenu::popup (weak_ptr<Film> film, ContentList c, TimelineContentViewList v, wxPoint p)
 112 {
 113         _film = film;
 114         _content = c;
 115         _views = v;
 116
 117         int const N = _cpl_menu->GetMenuItemCount();
 118         for (int i = 1; i <= N; ++i) {
 119                 _cpl_menu->Delete (i);
 120         }
 121
 122         _repeat->Enable (!_content.empty ());
 123
 124         int n = 0;
 125         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 126                 if (dynamic_pointer_cast<FFmpegContent> (i)) {
 127                         ++n;
 128                 }
 129         }
 130
 131         _join->Enable (n > 1);
 132
 133         _find_missing->Enable (_content.size() == 1 && !_content.front()->paths_valid ());
 134         _properties->Enable (_content.size() == 1);
 135         _advanced->Enable (_content.size() == 1);
 136         _re_examine->Enable (!_content.empty ());
 137
 138         if (_content.size() == 1) {
 139                 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (_content.front ());
 140                 if (dcp) {
 141                         _kdm->Enable (dcp->encrypted ());
 142                         _ov->Enable (dcp->needs_assets ());
 143                         _set_dcp_settings->Enable (static_cast<bool>(dcp));
 144                         try {
 145                                 DCPExaminer ex (dcp, true);
 146                                 list<shared_ptr<dcp::CPL> > cpls = ex.cpls ();
 147                                 _choose_cpl->Enable (cpls.size() > 1);
 148                                 /* We can't have 0 as a menu item ID on OS X */
 149                                 int id = 1;
 150                                 BOOST_FOREACH (shared_ptr<dcp::CPL> i, cpls) {
 151                                         wxMenuItem* item = _cpl_menu->AppendRadioItem (
 152                                                 id++,
 153                                                 wxString::Format (
 154                                                         "%s (%s)",
 155                                                         std_to_wx(i->annotation_text()).data(),
 156                                                         std_to_wx(i->id()).data()
 157                                                         )
 158                                                 );
 159                                         item->Check (dcp->cpl() && dcp->cpl() == i->id());
 160                                 }
 161                         } catch (dcp::ReadError &) {
 162                                 /* The DCP is probably missing */
 163                         } catch (dcp::KDMDecryptionError &) {
 164                                 /* We have an incorrect KDM */
 165                         } catch (KDMError &) {
 166                                 /* We have an incorrect KDM */
 167                         }
 168                 } else {
 169                         _kdm->Enable (false);
 170                         _ov->Enable (false);
 171                         _choose_cpl->Enable (false);
 172                         _set_dcp_settings->Enable (false);
 173                 }
 174         } else {
 175                 _kdm->Enable (false);
 176                 _set_dcp_settings->Enable (false);
 177         }
 178
 179         _remove->Enable (!_content.empty ());
 180
 181         _pop_up_open = true;
 182         _parent->PopupMenu (_menu, p);
 183         _pop_up_open = false;
 184 }
 185
 186
 187 void
 188 ContentMenu::set_dcp_settings ()
 189 {
 190         shared_ptr<Film> film = _film.lock ();
 191         if (!film) {
 192                 return;
 193         }
 194
 195         DCPOMATIC_ASSERT (_content.size() == 1);
 196         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent>(_content.front());
 197         DCPOMATIC_ASSERT (dcp);
 198         copy_dcp_details_to_film (dcp, film);
 199 }
 200
 201
 202 void
 203 ContentMenu::repeat ()
 204 {
 205         if (_content.empty ()) {
 206                 return;
 207         }
 208
 209         RepeatDialog* d = new RepeatDialog (_parent);
 210         if (d->ShowModal() != wxID_OK) {
 211                 d->Destroy ();
 212                 return;
 213         }
 214
 215         shared_ptr<Film> film = _film.lock ();
 216         if (!film) {
 217                 return;
 218         }
 219
 220         film->repeat_content (_content, d->number ());
 221         d->Destroy ();
 222
 223         _content.clear ();
 224         _views.clear ();
 225 }
 226
 227 void
 228 ContentMenu::join ()
 229 {
 230         vector<shared_ptr<Content> > fc;
 231         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 232                 shared_ptr<FFmpegContent> f = dynamic_pointer_cast<FFmpegContent> (i);
 233                 if (f) {
 234                         fc.push_back (f);
 235                 }
 236         }
 237
 238         DCPOMATIC_ASSERT (fc.size() > 1);
 239
 240         shared_ptr<Film> film = _film.lock ();
 241         if (!film) {
 242                 return;
 243         }
 244
 245         try {
 246                 shared_ptr<FFmpegContent> joined (new FFmpegContent(fc));
 247                 film->remove_content (_content);
 248                 film->examine_and_add_content (joined);
 249         } catch (JoinError& e) {
 250                 error_dialog (_parent, std_to_wx (e.what ()));
 251         }
 252 }
 253
 254 void
 255 ContentMenu::remove ()
 256 {
 257         if (_content.empty ()) {
 258                 return;
 259         }
 260
 261         shared_ptr<Film> film = _film.lock ();
 262         if (!film) {
 263                 return;
 264         }
 265
 266         /* We are removing from the timeline if _views is not empty */
 267         bool handled = false;
 268         if (!_views.empty ()) {
 269                 /* Special case: we only remove FFmpegContent if its video view is selected;
 270                    if not, and its audio view is selected, we unmap the audio.
 271                 */
 272                 BOOST_FOREACH (shared_ptr<Content> i, _content) {
 273                         shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (i);
 274                         if (!fc) {
 275                                 continue;
 276                         }
 277
 278                         shared_ptr<TimelineVideoContentView> video;
 279                         shared_ptr<TimelineAudioContentView> audio;
 280
 281                         BOOST_FOREACH (shared_ptr<TimelineContentView> j, _views) {
 282                                 shared_ptr<TimelineVideoContentView> v = dynamic_pointer_cast<TimelineVideoContentView> (j);
 283                                 shared_ptr<TimelineAudioContentView> a = dynamic_pointer_cast<TimelineAudioContentView> (j);
 284                                 if (v && v->content() == fc) {
 285                                         video = v;
 286                                 } else if (a && a->content() == fc) {
 287                                         audio = a;
 288                                 }
 289                         }
 290
 291                         if (!video && audio) {
 292                                 AudioMapping m = fc->audio->mapping ();
 293                                 m.unmap_all ();
 294                                 fc->audio->set_mapping (m);
 295                                 handled = true;
 296                         }
 297                 }
 298         }
 299
 300         if (!handled) {
 301                 film->remove_content (_content);
 302         }
 303
 304         _content.clear ();
 305         _views.clear ();
 306 }
 307
 308 void
 309 ContentMenu::find_missing ()
 310 {
 311         if (_content.size() != 1) {
 312                 return;
 313         }
 314
 315         shared_ptr<const Film> film = _film.lock ();
 316         if (!film) {
 317                 return;
 318         }
 319
 320         /* XXX: a bit nasty */
 321         shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (_content.front ());
 322         shared_ptr<DCPContent> dc = dynamic_pointer_cast<DCPContent> (_content.front ());
 323
 324         int r = wxID_CANCEL;
 325         boost::filesystem::path path;
 326
 327         if ((ic && !ic->still ()) || dc) {
 328                 wxDirDialog* d = new wxDirDialog (0, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
 329                 r = d->ShowModal ();
 330                 path = wx_to_std (d->GetPath ());
 331                 d->Destroy ();
 332         } else {
 333                 wxFileDialog* d = new wxFileDialog (0, _("Choose a file"), wxT (""), wxT (""), wxT ("*.*"), wxFD_MULTIPLE);
 334                 r = d->ShowModal ();
 335                 path = wx_to_std (d->GetPath ());
 336                 d->Destroy ();
 337         }
 338
 339         list<shared_ptr<Content> > content;
 340
 341         if (r == wxID_OK) {
 342                 if (dc) {
 343                         content.push_back (shared_ptr<DCPContent>(new DCPContent(path)));
 344                 } else {
 345                         content = content_factory (path);
 346                 }
 347         }
 348
 349         if (content.empty ()) {
 350                 return;
 351         }
 352
 353         BOOST_FOREACH (shared_ptr<Content> i, content) {
 354                 shared_ptr<Job> j (new ExamineContentJob (film, i));
 355
 356                 j->Finished.connect (
 357                         bind (
 358                                 &ContentMenu::maybe_found_missing,
 359                                 this,
 360                                 std::weak_ptr<Job> (j),
 361                                 std::weak_ptr<Content> (_content.front ()),
 362                                 std::weak_ptr<Content> (i)
 363                                 )
 364                         );
 365
 366                 JobManager::instance()->add (j);
 367         }
 368 }
 369
 370 void
 371 ContentMenu::re_examine ()
 372 {
 373         shared_ptr<Film> film = _film.lock ();
 374         if (!film) {
 375                 return;
 376         }
 377
 378         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 379                 JobManager::instance()->add (shared_ptr<Job> (new ExamineContentJob (film, i)));
 380         }
 381 }
 382
 383 void
 384 ContentMenu::maybe_found_missing (weak_ptr<Job> j, weak_ptr<Content> oc, weak_ptr<Content> nc)
 385 {
 386         shared_ptr<Job> job = j.lock ();
 387         if (!job || !job->finished_ok ()) {
 388                 return;
 389         }
 390
 391         shared_ptr<Content> old_content = oc.lock ();
 392         shared_ptr<Content> new_content = nc.lock ();
 393         DCPOMATIC_ASSERT (old_content);
 394         DCPOMATIC_ASSERT (new_content);
 395
 396         if (new_content->digest() != old_content->digest()) {
 397                 error_dialog (0, _("The content file(s) you specified are not the same as those that are missing.  Either try again with the correct content file or remove the missing content."));
 398                 return;
 399         }
 400
 401         old_content->set_paths (new_content->paths());
 402 }
 403
 404 void
 405 ContentMenu::kdm ()
 406 {
 407         DCPOMATIC_ASSERT (!_content.empty ());
 408         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (_content.front ());
 409         DCPOMATIC_ASSERT (dcp);
 410
 411         wxFileDialog* d = new wxFileDialog (_parent, _("Select KDM"));
 412
 413         if (d->ShowModal() == wxID_OK) {
 414                 optional<dcp::EncryptedKDM> kdm;
 415                 try {
 416                         kdm = dcp::EncryptedKDM (dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE));
 417                 } catch (exception& e) {
 418                         error_dialog (_parent, _("Could not load KDM"), std_to_wx(e.what()));
 419                         d->Destroy ();
 420                         return;
 421                 }
 422
 423                 /* Try to decrypt it to get an early preview of any errors */
 424                 try {
 425                         decrypt_kdm_with_helpful_error (*kdm);
 426                 } catch (KDMError& e) {
 427                         error_dialog (_parent, std_to_wx(e.summary()), std_to_wx(e.detail()));
 428                         return;
 429                 } catch (exception& e) {
 430                         error_dialog (_parent, e.what());
 431                         return;
 432                 }
 433
 434                 DCPExaminer ex (dcp, true);
 435
 436                 bool kdm_matches_any_cpl = false;
 437                 BOOST_FOREACH (shared_ptr<dcp::CPL> i, ex.cpls()) {
 438                         if (i->id() == kdm->cpl_id()) {
 439                                 kdm_matches_any_cpl = true;
 440                         }
 441                 }
 442
 443                 bool kdm_matches_selected_cpl = dcp->cpl() || kdm->cpl_id() == dcp->cpl().get();
 444
 445                 if (!kdm_matches_any_cpl) {
 446                         error_dialog (_parent, _("This KDM was not made for this DCP.  You will need a different one."));
 447                         return;
 448                 }
 449
 450                 if (!kdm_matches_selected_cpl && kdm_matches_any_cpl) {
 451                         message_dialog (_parent, _("This KDM was made for one of the CPLs in this DCP, but not the currently selected one.  To play the currently-selected CPL you will need a different KDM."));
 452                 }
 453
 454                 dcp->add_kdm (*kdm);
 455
 456                 shared_ptr<Film> film = _film.lock ();
 457                 DCPOMATIC_ASSERT (film);
 458                 JobManager::instance()->add (shared_ptr<Job> (new ExamineContentJob (film, dcp)));
 459         }
 460
 461         d->Destroy ();
 462 }
 463
 464 void
 465 ContentMenu::ov ()
 466 {
 467         DCPOMATIC_ASSERT (!_content.empty ());
 468         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (_content.front ());
 469         DCPOMATIC_ASSERT (dcp);
 470
 471         wxDirDialog* d = new wxDirDialog (_parent, _("Select OV"));
 472
 473         if (d->ShowModal() == wxID_OK) {
 474                 dcp->add_ov (wx_to_std (d->GetPath ()));
 475                 shared_ptr<Film> film = _film.lock ();
 476                 DCPOMATIC_ASSERT (film);
 477                 JobManager::instance()->add (shared_ptr<Job> (new ExamineContentJob (film, dcp)));
 478         }
 479
 480         d->Destroy ();
 481 }
 482
 483 void
 484 ContentMenu::properties ()
 485 {
 486         shared_ptr<Film> film = _film.lock ();
 487         DCPOMATIC_ASSERT (film);
 488         ContentPropertiesDialog* d = new ContentPropertiesDialog (_parent, film, _content.front());
 489         d->ShowModal ();
 490         d->Destroy ();
 491 }
 492
 493
 494 void
 495 ContentMenu::advanced ()
 496 {
 497         ContentAdvancedDialog* d = new ContentAdvancedDialog (_parent, _content.front());
 498         d->ShowModal ();
 499         d->Destroy ();
 500 }
 501
 502
 503 void
 504 ContentMenu::cpl_selected (wxCommandEvent& ev)
 505 {
 506         if (!_pop_up_open) {
 507                 return;
 508         }
 509
 510         DCPOMATIC_ASSERT (!_content.empty ());
 511         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (_content.front ());
 512         DCPOMATIC_ASSERT (dcp);
 513
 514         DCPExaminer ex (dcp, true);
 515         list<shared_ptr<dcp::CPL> > cpls = ex.cpls ();
 516         DCPOMATIC_ASSERT (ev.GetId() > 0);
 517         DCPOMATIC_ASSERT (ev.GetId() <= int (cpls.size()));
 518
 519         list<shared_ptr<dcp::CPL> >::const_iterator i = cpls.begin ();
 520         for (int j = 0; j < ev.GetId() - 1; ++j) {
 521                 ++i;
 522         }
 523
 524         dcp->set_cpl ((*i)->id ());
 525         shared_ptr<Film> film = _film.lock ();
 526         DCPOMATIC_ASSERT (film);
 527         JobManager::instance()->add (shared_ptr<Job> (new ExamineContentJob (film, dcp)));
 528 }