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/constants.h"
35 #include "lib/copy_dcp_details_to_film.h"
36 #include "lib/dcp_content.h"
37 #include "lib/dcp_examiner.h"
38 #include "lib/examine_content_job.h"
39 #include "lib/exceptions.h"
40 #include "lib/ffmpeg_content.h"
42 #include "lib/find_missing.h"
43 #include "lib/guess_crop.h"
44 #include "lib/image_content.h"
45 #include "lib/job_manager.h"
46 #include "lib/playlist.h"
47 #include "lib/video_content.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>
56 LIBDCP_ENABLE_WARNINGS
59 using std::dynamic_pointer_cast;
62 using std::make_shared;
63 using std::shared_ptr;
66 using boost::optional;
67 #if BOOST_VERSION >= 106100
68 using namespace boost::placeholders;
70 using namespace dcpomatic;
74 /* Start at 256 so we can have IDs on _cpl_menu from 1 to 255 */
90 ContentMenu::ContentMenu(wxWindow* p, FilmViewer& viewer)
93 , _pop_up_open (false)
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"));
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);
127 ContentMenu::popup (weak_ptr<Film> film, ContentList c, TimelineContentViewList v, wxPoint p)
133 int const N = _cpl_menu->GetMenuItemCount();
134 for (int i = 1; i <= N; ++i) {
135 _cpl_menu->Delete (i);
138 _repeat->Enable (!_content.empty ());
141 for (auto i: _content) {
142 if (dynamic_pointer_cast<FFmpegContent> (i)) {
147 _join->Enable (n > 1);
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);
155 if (_content.size() == 1) {
156 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
158 _kdm->Enable (dcp->encrypted ());
159 _ov->Enable (dcp->needs_assets ());
160 _set_dcp_settings->Enable (static_cast<bool>(dcp));
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 */
167 auto item = _cpl_menu->AppendRadioItem (
171 std_to_wx(i->annotation_text().get_value_or("")).data(),
172 std_to_wx(i->id()).data()
175 item->Check (dcp->cpl() && dcp->cpl() == i->id());
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 */
185 _kdm->Enable (false);
187 _choose_cpl->Enable (false);
188 _set_dcp_settings->Enable (false);
191 _kdm->Enable (false);
192 _set_dcp_settings->Enable (false);
195 _remove->Enable (!_content.empty ());
198 _parent->PopupMenu (_menu, p);
199 _pop_up_open = false;
204 ContentMenu::set_dcp_settings ()
206 auto film = _film.lock ();
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);
219 ContentMenu::repeat ()
221 if (_content.empty ()) {
225 auto d = make_wx<RepeatDialog>(_parent);
226 if (d->ShowModal() != wxID_OK) {
230 auto film = _film.lock ();
235 film->repeat_content (_content, d->number ());
245 vector<shared_ptr<Content>> fc;
246 for (auto i: _content) {
247 auto f = dynamic_pointer_cast<FFmpegContent> (i);
253 DCPOMATIC_ASSERT (fc.size() > 1);
255 auto film = _film.lock ();
261 auto joined = make_shared<FFmpegContent>(fc);
262 film->remove_content (_content);
263 film->examine_and_add_content (joined);
264 } catch (JoinError& e) {
265 error_dialog (_parent, std_to_wx (e.what ()));
271 ContentMenu::remove ()
273 if (_content.empty ()) {
277 auto film = _film.lock ();
282 /* We are removing from the timeline if _views is not empty */
283 bool handled = false;
284 if (!_views.empty ()) {
285 /* Special case: we only remove FFmpegContent if its video view is selected;
286 if not, and its audio view is selected, we unmap the audio.
288 for (auto i: _content) {
289 auto fc = dynamic_pointer_cast<FFmpegContent> (i);
294 shared_ptr<TimelineVideoContentView> video;
295 shared_ptr<TimelineAudioContentView> audio;
297 for (auto j: _views) {
298 auto v = dynamic_pointer_cast<TimelineVideoContentView>(j);
299 auto a = dynamic_pointer_cast<TimelineAudioContentView>(j);
300 if (v && v->content() == fc) {
302 } else if (a && a->content() == fc) {
307 if (!video && audio) {
308 auto m = fc->audio->mapping ();
310 fc->audio->set_mapping (m);
317 film->remove_content (_content);
326 ContentMenu::find_missing ()
328 if (_content.size() != 1) {
332 auto film = _film.lock ();
337 /* XXX: a bit nasty */
338 auto ic = dynamic_pointer_cast<ImageContent> (_content.front());
339 auto dc = dynamic_pointer_cast<DCPContent> (_content.front());
342 boost::filesystem::path path;
344 if ((ic && !ic->still ()) || dc) {
345 auto d = make_wx<wxDirDialog>(nullptr, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
347 path = wx_to_std (d->GetPath());
349 auto d = make_wx<wxFileDialog>(nullptr, _("Choose a file"), wxT (""), wxT (""), wxT ("*.*"));
351 path = wx_to_std (d->GetPath());
354 if (r == wxID_CANCEL) {
358 dcpomatic::find_missing (film->content(), path);
362 ContentMenu::re_examine ()
364 auto film = _film.lock ();
369 for (auto i: _content) {
370 JobManager::instance()->add(make_shared<ExamineContentJob>(film, i));
378 DCPOMATIC_ASSERT (!_content.empty ());
379 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
380 DCPOMATIC_ASSERT (dcp);
382 auto d = make_wx<wxFileDialog>(_parent, _("Select KDM"));
384 if (d->ShowModal() != wxID_OK) {
388 optional<dcp::EncryptedKDM> kdm;
390 kdm = dcp::EncryptedKDM (dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE));
391 } catch (exception& e) {
392 error_dialog (_parent, _("Could not load KDM"), std_to_wx(e.what()));
396 /* Try to decrypt it to get an early preview of any errors */
398 decrypt_kdm_with_helpful_error (*kdm);
399 } catch (KDMError& e) {
400 error_dialog (_parent, std_to_wx(e.summary()), std_to_wx(e.detail()));
402 } catch (exception& e) {
403 error_dialog (_parent, e.what());
407 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
408 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(); });
409 bool const kdm_matches_selected_cpl = dcp->cpl() || kdm->cpl_id() == dcp->cpl().get();
411 if (!kdm_matches_any_cpl) {
412 error_dialog (_parent, _("This KDM was not made for this DCP. You will need a different one."));
416 if (!kdm_matches_selected_cpl && kdm_matches_any_cpl) {
417 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."));
422 auto film = _film.lock ();
423 DCPOMATIC_ASSERT (film);
424 JobManager::instance()->add (make_shared<ExamineContentJob>(film, dcp));
430 DCPOMATIC_ASSERT (!_content.empty ());
431 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
432 DCPOMATIC_ASSERT (dcp);
434 auto d = make_wx<wxDirDialog>(_parent, _("Select OV"));
436 if (d->ShowModal() == wxID_OK) {
437 dcp->add_ov (wx_to_std (d->GetPath()));
438 shared_ptr<Film> film = _film.lock ();
439 DCPOMATIC_ASSERT (film);
440 JobManager::instance()->add (make_shared<ExamineContentJob>(film, dcp));
445 ContentMenu::properties ()
447 auto film = _film.lock ();
448 DCPOMATIC_ASSERT (film);
449 auto d = make_wx<ContentPropertiesDialog>(_parent, film, _content.front());
455 ContentMenu::advanced ()
457 DCPOMATIC_ASSERT(!_content.empty());
459 auto content = _content.front();
460 auto dialog = make_wx<ContentAdvancedDialog>(_parent, content);
462 if (dialog->ShowModal() == wxID_CANCEL) {
466 if (content->video) {
467 content->video->set_use(!dialog->ignore_video());
468 content->video->set_burnt_subtitle_language(dialog->burnt_subtitle_language());
471 auto ffmpeg = dynamic_pointer_cast<FFmpegContent>(content);
473 ffmpeg->set_filters(dialog->filters());
476 if (dialog->video_frame_rate()) {
477 auto film = _film.lock();
478 DCPOMATIC_ASSERT(film);
479 content->set_video_frame_rate(film, *dialog->video_frame_rate());
481 content->unset_video_frame_rate();
487 ContentMenu::cpl_selected (wxCommandEvent& ev)
493 DCPOMATIC_ASSERT (!_content.empty ());
494 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
495 DCPOMATIC_ASSERT (dcp);
497 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
498 DCPOMATIC_ASSERT (ev.GetId() > 0);
499 DCPOMATIC_ASSERT (ev.GetId() <= int (cpls.size()));
501 auto i = cpls.begin ();
502 for (int j = 0; j < ev.GetId() - 1; ++j) {
506 dcp->set_cpl ((*i)->id ());
507 auto film = _film.lock ();
508 DCPOMATIC_ASSERT (film);
509 JobManager::instance()->add (make_shared<ExamineContentJob>(film, dcp));
514 ContentMenu::auto_crop ()
516 DCPOMATIC_ASSERT (_content.size() == 1);
518 auto film = _film.lock ();
519 DCPOMATIC_ASSERT (film);
521 auto update_viewer = [this](Crop crop) {
522 auto film = _film.lock();
523 DCPOMATIC_ASSERT (film);
524 auto const content = _content.front();
525 auto const current_crop = content->video->actual_crop();
526 _viewer.set_crop_guess(
527 dcpomatic::Rect<float>(
528 static_cast<float>(std::max(0, crop.left - current_crop.left)) / content->video->size().width,
529 static_cast<float>(std::max(0, crop.top - current_crop.top)) / content->video->size().height,
530 1.0f - (static_cast<float>(std::max(0, crop.left - current_crop.left + crop.right - current_crop.right)) / content->video->size().width),
531 1.0f - (static_cast<float>(std::max(0, crop.top - current_crop.top + crop.bottom - current_crop.bottom)) / content->video->size().height)
535 auto guess_crop_for_content = [this, film]() {
536 auto position = _viewer.position_in_content(_content.front()).get_value_or(
537 ContentTime::from_frames(_content.front()->video->length(), _content.front()->video_frame_rate().get_value_or(24))
539 return guess_crop(film, _content.front(), Config::instance()->auto_crop_threshold(), position);
542 /* Make an initial guess in the view and open the dialog */
544 auto const crop = guess_crop_for_content ();
545 update_viewer (crop);
547 _auto_crop_dialog.reset(_parent, crop);
548 _auto_crop_dialog->Show ();
550 /* Update the dialog and view when the crop threshold changes */
551 _auto_crop_config_connection = Config::instance()->Changed.connect([this, guess_crop_for_content, update_viewer](Config::Property property) {
552 auto film = _film.lock();
553 DCPOMATIC_ASSERT (film);
554 if (property == Config::AUTO_CROP_THRESHOLD) {
555 auto const crop = guess_crop_for_content();
556 _auto_crop_dialog->set(crop);
561 /* Also update the dialog and view when we're looking at a different frame */
562 _auto_crop_viewer_connection = _viewer.ImageChanged.connect([this, guess_crop_for_content, update_viewer](shared_ptr<PlayerVideo>) {
563 auto const crop = guess_crop_for_content();
564 _auto_crop_dialog->set(crop);
568 /* Handle the user closing the dialog (with OK or cancel) */
569 _auto_crop_dialog->Bind(wxEVT_BUTTON, [this](wxCommandEvent& ev) {
570 _auto_crop_config_connection.disconnect ();
571 _auto_crop_viewer_connection.disconnect ();
572 if (ev.GetId() == wxID_OK) {
573 _content.front()->video->set_crop(_auto_crop_dialog->get());
575 _auto_crop_dialog->Show (false);
576 _viewer.unset_crop_guess ();
579 /* Update the view when something in the dialog is changed */
580 _auto_crop_dialog->Changed.connect([update_viewer](Crop crop) {
581 update_viewer (crop);