src/wx/content_menu.cc

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