2 Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
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"
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"
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/video_content.h"
48 #include <dcp/decrypted_kdm.h>
49 #include <dcp/exceptions.h>
50 #include <dcp/search.h>
51 #include <dcp/warnings.h>
52 LIBDCP_DISABLE_WARNINGS
53 #include <wx/dirdlg.h>
55 LIBDCP_ENABLE_WARNINGS
58 using std::dynamic_pointer_cast;
61 using std::make_shared;
62 using std::shared_ptr;
65 using boost::optional;
66 #if BOOST_VERSION >= 106100
67 using namespace boost::placeholders;
69 using namespace dcpomatic;
73 /* Start at 256 so we can have IDs on _cpl_menu from 1 to 255 */
89 ContentMenu::ContentMenu (wxWindow* p, weak_ptr<FilmViewer> viewer)
92 , _pop_up_open (false)
95 _repeat = _menu->Append (ID_repeat, _("Repeat..."));
96 _join = _menu->Append (ID_join, _("Join"));
97 _find_missing = _menu->Append (ID_find_missing, _("Find missing..."));
98 _re_examine = _menu->Append (ID_re_examine, _("Re-examine..."));
99 _auto_crop = _menu->Append (ID_auto_crop, _("Auto-crop..."));
100 _properties = _menu->Append (ID_properties, _("Properties..."));
101 _advanced = _menu->Append (ID_advanced, _("Advanced settings..."));
102 _menu->AppendSeparator ();
103 _kdm = _menu->Append (ID_kdm, _("Add KDM..."));
104 _ov = _menu->Append (ID_ov, _("Add OV..."));
105 _cpl_menu = new wxMenu ();
106 _choose_cpl = _menu->Append (ID_choose_cpl, _("Choose CPL..."), _cpl_menu);
107 _set_dcp_settings = _menu->Append (ID_set_dcp_settings, _("Set project DCP settings from this DCP"));
108 _menu->AppendSeparator ();
109 _remove = _menu->Append (ID_remove, _("Remove"));
111 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::repeat, this), ID_repeat);
112 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::join, this), ID_join);
113 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::find_missing, this), ID_find_missing);
114 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::properties, this), ID_properties);
115 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::advanced, this), ID_advanced);
116 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::re_examine, this), ID_re_examine);
117 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::auto_crop, this), ID_auto_crop);
118 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::kdm, this), ID_kdm);
119 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::ov, this), ID_ov);
120 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::set_dcp_settings, this), ID_set_dcp_settings);
121 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::remove, this), ID_remove);
122 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::cpl_selected, this, _1), 1, ID_repeat - 1);
126 ContentMenu::popup (weak_ptr<Film> film, ContentList c, TimelineContentViewList v, wxPoint p)
132 int const N = _cpl_menu->GetMenuItemCount();
133 for (int i = 1; i <= N; ++i) {
134 _cpl_menu->Delete (i);
137 _repeat->Enable (!_content.empty ());
140 for (auto i: _content) {
141 if (dynamic_pointer_cast<FFmpegContent> (i)) {
146 _join->Enable (n > 1);
148 _find_missing->Enable (_content.size() == 1 && !_content.front()->paths_valid ());
149 _properties->Enable (_content.size() == 1);
150 _advanced->Enable (_content.size() == 1);
151 _re_examine->Enable (!_content.empty ());
152 _auto_crop->Enable (_content.size() == 1);
154 if (_content.size() == 1) {
155 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
157 _kdm->Enable (dcp->encrypted ());
158 _ov->Enable (dcp->needs_assets ());
159 _set_dcp_settings->Enable (static_cast<bool>(dcp));
161 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
162 _choose_cpl->Enable (cpls.size() > 1);
163 /* We can't have 0 as a menu item ID on OS X */
166 auto item = _cpl_menu->AppendRadioItem (
170 std_to_wx(i->annotation_text().get_value_or("")).data(),
171 std_to_wx(i->id()).data()
174 item->Check (dcp->cpl() && dcp->cpl() == i->id());
176 } catch (dcp::ReadError &) {
177 /* The DCP is probably missing */
178 } catch (dcp::KDMDecryptionError &) {
179 /* We have an incorrect KDM */
180 } catch (KDMError &) {
181 /* We have an incorrect KDM */
184 _kdm->Enable (false);
186 _choose_cpl->Enable (false);
187 _set_dcp_settings->Enable (false);
190 _kdm->Enable (false);
191 _set_dcp_settings->Enable (false);
194 _remove->Enable (!_content.empty ());
197 _parent->PopupMenu (_menu, p);
198 _pop_up_open = false;
203 ContentMenu::set_dcp_settings ()
205 auto film = _film.lock ();
210 DCPOMATIC_ASSERT (_content.size() == 1);
211 auto dcp = dynamic_pointer_cast<DCPContent>(_content.front());
212 DCPOMATIC_ASSERT (dcp);
213 copy_dcp_details_to_film (dcp, film);
218 ContentMenu::repeat ()
220 if (_content.empty ()) {
224 auto d = new RepeatDialog (_parent);
225 if (d->ShowModal() != wxID_OK) {
230 auto film = _film.lock ();
235 film->repeat_content (_content, d->number ());
246 vector<shared_ptr<Content>> fc;
247 for (auto i: _content) {
248 auto f = dynamic_pointer_cast<FFmpegContent> (i);
254 DCPOMATIC_ASSERT (fc.size() > 1);
256 auto film = _film.lock ();
262 auto joined = make_shared<FFmpegContent>(fc);
263 film->remove_content (_content);
264 film->examine_and_add_content (joined);
265 } catch (JoinError& e) {
266 error_dialog (_parent, std_to_wx (e.what ()));
272 ContentMenu::remove ()
274 if (_content.empty ()) {
278 auto film = _film.lock ();
283 /* We are removing from the timeline if _views is not empty */
284 bool handled = false;
285 if (!_views.empty ()) {
286 /* Special case: we only remove FFmpegContent if its video view is selected;
287 if not, and its audio view is selected, we unmap the audio.
289 for (auto i: _content) {
290 auto fc = dynamic_pointer_cast<FFmpegContent> (i);
295 shared_ptr<TimelineVideoContentView> video;
296 shared_ptr<TimelineAudioContentView> audio;
298 for (auto j: _views) {
299 auto v = dynamic_pointer_cast<TimelineVideoContentView>(j);
300 auto a = dynamic_pointer_cast<TimelineAudioContentView>(j);
301 if (v && v->content() == fc) {
303 } else if (a && a->content() == fc) {
308 if (!video && audio) {
309 auto m = fc->audio->mapping ();
311 fc->audio->set_mapping (m);
318 film->remove_content (_content);
327 ContentMenu::find_missing ()
329 if (_content.size() != 1) {
333 auto film = _film.lock ();
338 /* XXX: a bit nasty */
339 auto ic = dynamic_pointer_cast<ImageContent> (_content.front());
340 auto dc = dynamic_pointer_cast<DCPContent> (_content.front());
343 boost::filesystem::path path;
345 if ((ic && !ic->still ()) || dc) {
346 auto d = new wxDirDialog (nullptr, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
348 path = wx_to_std (d->GetPath());
351 auto d = new wxFileDialog (nullptr, _("Choose a file"), wxT (""), wxT (""), wxT ("*.*"));
353 path = wx_to_std (d->GetPath());
357 list<shared_ptr<Content>> content;
361 content.push_back (make_shared<DCPContent>(path));
363 content = content_factory (path);
367 if (content.empty ()) {
371 for (auto i: content) {
372 auto j = make_shared<ExamineContentJob>(film, i);
374 j->Finished.connect (
376 &ContentMenu::maybe_found_missing,
378 std::weak_ptr<Job> (j),
379 std::weak_ptr<Content> (_content.front ()),
380 std::weak_ptr<Content> (i)
384 JobManager::instance()->add (j);
389 ContentMenu::re_examine ()
391 auto film = _film.lock ();
396 for (auto i: _content) {
397 JobManager::instance()->add(make_shared<ExamineContentJob>(film, i));
402 ContentMenu::maybe_found_missing (weak_ptr<Job> j, weak_ptr<Content> oc, weak_ptr<Content> nc)
404 auto job = j.lock ();
405 if (!job || !job->finished_ok ()) {
409 auto old_content = oc.lock ();
410 auto new_content = nc.lock ();
411 DCPOMATIC_ASSERT (old_content);
412 DCPOMATIC_ASSERT (new_content);
414 if (new_content->digest() != old_content->digest()) {
415 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."));
419 old_content->set_paths (new_content->paths());
425 DCPOMATIC_ASSERT (!_content.empty ());
426 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
427 DCPOMATIC_ASSERT (dcp);
429 auto d = new wxFileDialog (_parent, _("Select KDM"));
431 if (d->ShowModal() == wxID_OK) {
432 optional<dcp::EncryptedKDM> kdm;
434 kdm = dcp::EncryptedKDM (dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE));
435 } catch (exception& e) {
436 error_dialog (_parent, _("Could not load KDM"), std_to_wx(e.what()));
441 /* Try to decrypt it to get an early preview of any errors */
443 decrypt_kdm_with_helpful_error (*kdm);
444 } catch (KDMError& e) {
445 error_dialog (_parent, std_to_wx(e.summary()), std_to_wx(e.detail()));
447 } catch (exception& e) {
448 error_dialog (_parent, e.what());
452 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
453 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(); });
454 bool const kdm_matches_selected_cpl = dcp->cpl() || kdm->cpl_id() == dcp->cpl().get();
456 if (!kdm_matches_any_cpl) {
457 error_dialog (_parent, _("This KDM was not made for this DCP. You will need a different one."));
461 if (!kdm_matches_selected_cpl && kdm_matches_any_cpl) {
462 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."));
467 auto film = _film.lock ();
468 DCPOMATIC_ASSERT (film);
469 JobManager::instance()->add (make_shared<ExamineContentJob>(film, dcp));
478 DCPOMATIC_ASSERT (!_content.empty ());
479 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
480 DCPOMATIC_ASSERT (dcp);
482 auto d = new wxDirDialog (_parent, _("Select OV"));
484 if (d->ShowModal() == wxID_OK) {
485 dcp->add_ov (wx_to_std (d->GetPath()));
486 shared_ptr<Film> film = _film.lock ();
487 DCPOMATIC_ASSERT (film);
488 JobManager::instance()->add (make_shared<ExamineContentJob>(film, dcp));
495 ContentMenu::properties ()
497 auto film = _film.lock ();
498 DCPOMATIC_ASSERT (film);
499 auto d = new ContentPropertiesDialog (_parent, film, _content.front());
506 ContentMenu::advanced ()
508 auto d = new ContentAdvancedDialog (_parent, _content.front());
515 ContentMenu::cpl_selected (wxCommandEvent& ev)
521 DCPOMATIC_ASSERT (!_content.empty ());
522 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
523 DCPOMATIC_ASSERT (dcp);
525 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
526 DCPOMATIC_ASSERT (ev.GetId() > 0);
527 DCPOMATIC_ASSERT (ev.GetId() <= int (cpls.size()));
529 auto i = cpls.begin ();
530 for (int j = 0; j < ev.GetId() - 1; ++j) {
534 dcp->set_cpl ((*i)->id ());
535 auto film = _film.lock ();
536 DCPOMATIC_ASSERT (film);
537 JobManager::instance()->add (make_shared<ExamineContentJob>(film, dcp));
542 ContentMenu::auto_crop ()
544 DCPOMATIC_ASSERT (_content.size() == 1);
546 auto film = _film.lock ();
547 DCPOMATIC_ASSERT (film);
548 auto viewer = _viewer.lock ();
549 DCPOMATIC_ASSERT (viewer);
551 auto update_viewer = [this](Crop crop) {
552 auto film = _film.lock();
553 DCPOMATIC_ASSERT (film);
554 auto viewer = _viewer.lock ();
555 DCPOMATIC_ASSERT (viewer);
556 auto const content = _content.front();
557 auto const current_crop = content->video->actual_crop();
558 viewer->set_crop_guess (
559 dcpomatic::Rect<float>(
560 static_cast<float>(std::max(0, crop.left - current_crop.left)) / content->video->size().width,
561 static_cast<float>(std::max(0, crop.top - current_crop.top)) / content->video->size().height,
562 1.0f - (static_cast<float>(std::max(0, crop.left - current_crop.left + crop.right - current_crop.right)) / content->video->size().width),
563 1.0f - (static_cast<float>(std::max(0, crop.top - current_crop.top + crop.bottom - current_crop.bottom)) / content->video->size().height)
567 auto guess_crop_for_content = [this, film, viewer]() {
568 auto position = viewer->position_in_content(_content.front()).get_value_or(
569 ContentTime::from_frames(_content.front()->video->length(), _content.front()->video_frame_rate().get_value_or(24))
571 return guess_crop(film, _content.front(), Config::instance()->auto_crop_threshold(), position);
574 /* Make an initial guess in the view and open the dialog */
576 auto const crop = guess_crop_for_content ();
577 update_viewer (crop);
579 if (_auto_crop_dialog) {
580 _auto_crop_dialog->Destroy();
581 _auto_crop_dialog = nullptr;
583 _auto_crop_dialog = new AutoCropDialog (_parent, crop);
584 _auto_crop_dialog->Show ();
586 /* Update the dialog and view when the crop threshold changes */
587 _auto_crop_config_connection = Config::instance()->Changed.connect([this, guess_crop_for_content, update_viewer](Config::Property property) {
588 auto film = _film.lock();
589 DCPOMATIC_ASSERT (film);
590 if (property == Config::AUTO_CROP_THRESHOLD) {
591 auto const crop = guess_crop_for_content();
592 _auto_crop_dialog->set(crop);
597 /* Also update the dialog and view when we're looking at a different frame */
598 _auto_crop_viewer_connection = viewer->ImageChanged.connect([this, guess_crop_for_content, update_viewer](shared_ptr<PlayerVideo>) {
599 auto const crop = guess_crop_for_content();
600 _auto_crop_dialog->set(crop);
604 /* Handle the user closing the dialog (with OK or cancel) */
605 _auto_crop_dialog->Bind (wxEVT_BUTTON, [this, viewer](wxCommandEvent& ev) {
606 _auto_crop_config_connection.disconnect ();
607 _auto_crop_viewer_connection.disconnect ();
608 if (ev.GetId() == wxID_OK) {
609 _content.front()->video->set_crop(_auto_crop_dialog->get());
611 _auto_crop_dialog->Show (false);
612 viewer->unset_crop_guess ();
615 /* Update the view when something in the dialog is changed */
616 _auto_crop_dialog->Changed.connect([update_viewer](Crop crop) {
617 update_viewer (crop);