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