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