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 "content_timeline_audio_view.h"
27 #include "content_timeline_video_view.h"
28 #include "dir_dialog.h"
29 #include "file_dialog.h"
30 #include "film_viewer.h"
32 #include "repeat_dialog.h"
34 #include "lib/audio_content.h"
35 #include "lib/config.h"
36 #include "lib/content_factory.h"
37 #include "lib/constants.h"
38 #include "lib/copy_dcp_details_to_film.h"
39 #include "lib/dcp_content.h"
40 #include "lib/dcp_examiner.h"
41 #include "lib/examine_content_job.h"
42 #include "lib/exceptions.h"
43 #include "lib/ffmpeg_content.h"
45 #include "lib/film_util.h"
46 #include "lib/find_missing.h"
47 #include "lib/guess_crop.h"
48 #include "lib/image_content.h"
49 #include "lib/job_manager.h"
50 #include "lib/playlist.h"
51 #include "lib/video_content.h"
53 #include <dcp/decrypted_kdm.h>
54 #include <dcp/exceptions.h>
55 #include <dcp/search.h>
56 #include <dcp/warnings.h>
57 LIBDCP_DISABLE_WARNINGS
58 #include <wx/dirdlg.h>
60 LIBDCP_ENABLE_WARNINGS
63 using std::dynamic_pointer_cast;
66 using std::make_shared;
67 using std::shared_ptr;
70 using boost::optional;
71 #if BOOST_VERSION >= 106100
72 using namespace boost::placeholders;
74 using namespace dcpomatic;
78 ID_repeat = DCPOMATIC_CONTENT_MENU,
94 ContentMenu::ContentMenu(wxWindow* p, FilmViewer& viewer)
97 , _pop_up_open (false)
100 _repeat = _menu->Append (ID_repeat, _("Repeat..."));
101 _join = _menu->Append (ID_join, _("Join"));
102 _find_missing = _menu->Append (ID_find_missing, _("Find missing..."));
103 _re_examine = _menu->Append (ID_re_examine, _("Re-examine..."));
104 _auto_crop = _menu->Append (ID_auto_crop, _("Auto-crop..."));
105 _properties = _menu->Append (ID_properties, _("Properties..."));
106 _advanced = _menu->Append (ID_advanced, _("Advanced settings..."));
107 _menu->AppendSeparator ();
108 _kdm = _menu->Append (ID_kdm, _("Add KDM..."));
109 _ov = _menu->Append (ID_ov, _("Add OV..."));
110 _cpl_menu = new wxMenu ();
111 _choose_cpl = _menu->Append (ID_choose_cpl, _("Choose CPL..."), _cpl_menu);
112 _set_dcp_settings = _menu->Append (ID_set_dcp_settings, _("Set project DCP settings from this DCP"));
113 _set_dcp_markers = _menu->Append(ID_set_dcp_markers, _("Set project markers from this DCP"));
114 _menu->AppendSeparator ();
115 _remove = _menu->Append (ID_remove, _("Remove"));
117 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::repeat, this), ID_repeat);
118 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::join, this), ID_join);
119 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::find_missing, this), ID_find_missing);
120 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::properties, this), ID_properties);
121 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::advanced, this), ID_advanced);
122 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::re_examine, this), ID_re_examine);
123 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::auto_crop, this), ID_auto_crop);
124 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::kdm, this), ID_kdm);
125 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::ov, this), ID_ov);
126 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::set_dcp_settings, this), ID_set_dcp_settings);
127 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::set_dcp_markers, this), ID_set_dcp_markers);
128 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::remove, this), ID_remove);
129 _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::cpl_selected, this, _1), 1, ID_repeat - 1);
133 ContentMenu::popup (weak_ptr<Film> film, ContentList c, TimelineContentViewList v, wxPoint p)
139 int const N = _cpl_menu->GetMenuItemCount();
140 for (int i = DCPOMATIC_CPL_MENU; i < DCPOMATIC_CPL_MENU + N; ++i) {
141 _cpl_menu->Delete (i);
144 _repeat->Enable (!_content.empty ());
147 for (auto i: _content) {
148 if (dynamic_pointer_cast<FFmpegContent> (i)) {
153 _join->Enable (n > 1);
155 _find_missing->Enable (_content.size() == 1 && !_content.front()->paths_valid ());
156 _properties->Enable (_content.size() == 1);
157 _advanced->Enable (_content.size() == 1);
158 _re_examine->Enable (!_content.empty ());
159 _auto_crop->Enable (_content.size() == 1);
161 if (_content.size() == 1) {
162 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
164 _kdm->Enable (dcp->encrypted ());
165 _ov->Enable (dcp->needs_assets ());
166 _set_dcp_settings->Enable (static_cast<bool>(dcp));
167 _set_dcp_markers->Enable(static_cast<bool>(dcp));
169 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
170 _choose_cpl->Enable (cpls.size() > 1);
171 int id = DCPOMATIC_CPL_MENU;
173 auto item = _cpl_menu->AppendRadioItem (
177 std_to_wx(i->annotation_text().get_value_or("")).data(),
178 std_to_wx(i->id()).data()
181 item->Check (dcp->cpl() && dcp->cpl() == i->id());
183 } catch (dcp::ReadError &) {
184 /* The DCP is probably missing */
185 } catch (dcp::KDMDecryptionError &) {
186 /* We have an incorrect KDM */
187 } catch (KDMError &) {
188 /* We have an incorrect KDM */
191 _kdm->Enable (false);
193 _choose_cpl->Enable (false);
194 _set_dcp_settings->Enable (false);
195 _set_dcp_markers->Enable(false);
198 _kdm->Enable (false);
199 _set_dcp_settings->Enable (false);
200 _set_dcp_markers->Enable(false);
203 _remove->Enable (!_content.empty ());
206 _parent->PopupMenu (_menu, p);
207 _pop_up_open = false;
212 ContentMenu::set_dcp_settings ()
214 auto film = _film.lock ();
219 DCPOMATIC_ASSERT (_content.size() == 1);
220 auto dcp = dynamic_pointer_cast<DCPContent>(_content.front());
221 DCPOMATIC_ASSERT (dcp);
222 copy_dcp_settings_to_film(dcp, film);
227 ContentMenu::set_dcp_markers()
229 auto film = _film.lock();
234 DCPOMATIC_ASSERT(_content.size() == 1);
235 auto dcp = dynamic_pointer_cast<DCPContent>(_content.front());
236 DCPOMATIC_ASSERT(dcp);
237 copy_dcp_markers_to_film(dcp, film);
242 ContentMenu::repeat ()
244 if (_content.empty ()) {
248 auto d = make_wx<RepeatDialog>(_parent);
249 if (d->ShowModal() != wxID_OK) {
253 auto film = _film.lock ();
258 film->repeat_content (_content, d->number ());
268 vector<shared_ptr<Content>> fc;
269 for (auto i: _content) {
270 auto f = dynamic_pointer_cast<FFmpegContent> (i);
276 DCPOMATIC_ASSERT (fc.size() > 1);
278 auto film = _film.lock ();
284 auto joined = make_shared<FFmpegContent>(fc);
285 film->remove_content (_content);
286 film->examine_and_add_content (joined);
287 } catch (JoinError& e) {
288 error_dialog (_parent, std_to_wx (e.what ()));
294 ContentMenu::remove ()
296 if (_content.empty ()) {
300 auto film = _film.lock ();
305 /* We are removing from the timeline if _views is not empty */
306 bool handled = false;
307 if (!_views.empty ()) {
308 /* Special case: we only remove FFmpegContent if its video view is selected;
309 if not, and its audio view is selected, we unmap the audio.
311 for (auto i: _content) {
312 auto fc = dynamic_pointer_cast<FFmpegContent> (i);
317 shared_ptr<ContentTimelineVideoView> video;
318 shared_ptr<ContentTimelineAudioView> audio;
320 for (auto j: _views) {
321 auto v = dynamic_pointer_cast<ContentTimelineVideoView>(j);
322 auto a = dynamic_pointer_cast<ContentTimelineAudioView>(j);
323 if (v && v->content() == fc) {
325 } else if (a && a->content() == fc) {
330 if (!video && audio) {
331 auto m = fc->audio->mapping ();
333 fc->audio->set_mapping (m);
340 film->remove_content (_content);
349 ContentMenu::find_missing ()
351 if (_content.size() != 1) {
355 auto film = _film.lock ();
360 /* XXX: a bit nasty */
361 auto ic = dynamic_pointer_cast<ImageContent> (_content.front());
362 auto dc = dynamic_pointer_cast<DCPContent> (_content.front());
365 boost::filesystem::path path;
367 if ((ic && !ic->still ()) || dc) {
368 wxDirDialog dialog(nullptr, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
369 r = dialog.ShowModal();
370 path = wx_to_std(dialog.GetPath());
372 wxFileDialog dialog(nullptr, _("Choose a file"), wxT(""), wxT(""), wxT("*.*"));
373 r = dialog.ShowModal();
374 path = wx_to_std(dialog.GetPath());
377 if (r == wxID_CANCEL) {
381 dcpomatic::find_missing (film->content(), path);
385 ContentMenu::re_examine ()
387 auto film = _film.lock ();
392 for (auto i: _content) {
393 JobManager::instance()->add(make_shared<ExamineContentJob>(film, i));
401 DCPOMATIC_ASSERT (!_content.empty ());
402 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
403 DCPOMATIC_ASSERT (dcp);
405 FileDialog dialog(_parent, _("Select KDM"), wxT("XML files|*.xml|All files|*.*"), 0, "AddKDMPath");
407 if (!dialog.show()) {
411 optional<dcp::EncryptedKDM> kdm;
413 kdm = dcp::EncryptedKDM(dcp::file_to_string(dialog.path(), MAX_KDM_SIZE));
414 } catch (exception& e) {
415 error_dialog (_parent, _("Could not load KDM"), std_to_wx(e.what()));
419 /* Try to decrypt it to get an early preview of any errors */
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()));
425 } catch (exception& e) {
426 error_dialog (_parent, e.what());
430 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
431 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(); });
432 bool const kdm_matches_selected_cpl = dcp->cpl() || kdm->cpl_id() == dcp->cpl().get();
434 if (!kdm_matches_any_cpl) {
435 error_dialog (_parent, _("This KDM was not made for this DCP. You will need a different one."));
439 if (!kdm_matches_selected_cpl && kdm_matches_any_cpl) {
440 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."));
445 auto film = _film.lock ();
446 DCPOMATIC_ASSERT (film);
447 JobManager::instance()->add (make_shared<ExamineContentJob>(film, dcp));
453 DCPOMATIC_ASSERT (!_content.empty ());
454 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
455 DCPOMATIC_ASSERT (dcp);
457 auto film = _film.lock();
458 DCPOMATIC_ASSERT(film);
459 DirDialog dialog(_parent, _("Select OV"), wxDD_DIR_MUST_EXIST, "AddFilesPath", add_files_override_path(film));
462 dcp->add_ov(dialog.path());
463 auto film = _film.lock();
464 DCPOMATIC_ASSERT (film);
465 JobManager::instance()->add (make_shared<ExamineContentJob>(film, dcp));
470 ContentMenu::properties ()
472 auto film = _film.lock ();
473 DCPOMATIC_ASSERT (film);
474 auto d = make_wx<ContentPropertiesDialog>(_parent, film, _content.front());
480 ContentMenu::advanced ()
482 DCPOMATIC_ASSERT(!_content.empty());
484 auto content = _content.front();
485 auto dialog = make_wx<ContentAdvancedDialog>(_parent, content);
487 if (dialog->ShowModal() == wxID_CANCEL) {
491 if (content->video) {
492 content->video->set_use(!dialog->ignore_video());
493 content->video->set_burnt_subtitle_language(dialog->burnt_subtitle_language());
496 auto ffmpeg = dynamic_pointer_cast<FFmpegContent>(content);
498 ffmpeg->set_filters(dialog->filters());
501 if (dialog->video_frame_rate()) {
502 auto film = _film.lock();
503 DCPOMATIC_ASSERT(film);
504 content->set_video_frame_rate(film, *dialog->video_frame_rate());
506 content->unset_video_frame_rate();
512 ContentMenu::cpl_selected (wxCommandEvent& ev)
518 DCPOMATIC_ASSERT (!_content.empty ());
519 auto dcp = dynamic_pointer_cast<DCPContent> (_content.front());
520 DCPOMATIC_ASSERT (dcp);
522 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
524 DCPOMATIC_ASSERT(ev.GetId() >= DCPOMATIC_CPL_MENU);
525 DCPOMATIC_ASSERT(ev.GetId() < int(DCPOMATIC_CPL_MENU + cpls.size()));
526 dcp->set_cpl(cpls[ev.GetId() - DCPOMATIC_CPL_MENU]->id());
528 auto film = _film.lock ();
529 DCPOMATIC_ASSERT (film);
530 JobManager::instance()->add (make_shared<ExamineContentJob>(film, dcp));
535 ContentMenu::auto_crop ()
537 DCPOMATIC_ASSERT (_content.size() == 1);
539 auto film = _film.lock ();
540 DCPOMATIC_ASSERT (film);
542 auto update_viewer = [this](Crop crop) {
543 auto film = _film.lock();
544 DCPOMATIC_ASSERT (film);
545 auto const content = _content.front();
546 auto const current_crop = content->video->actual_crop();
547 auto const video_size_guess = content->video->size().get_value_or(dcp::Size(1998, 1080));
548 _viewer.set_crop_guess(
549 dcpomatic::Rect<float>(
550 static_cast<float>(std::max(0, crop.left - current_crop.left)) / video_size_guess.width,
551 static_cast<float>(std::max(0, crop.top - current_crop.top)) / video_size_guess.height,
552 1.0f - (static_cast<float>(std::max(0, crop.left - current_crop.left + crop.right - current_crop.right)) / video_size_guess.width),
553 1.0f - (static_cast<float>(std::max(0, crop.top - current_crop.top + crop.bottom - current_crop.bottom)) / video_size_guess.height)
557 auto guess_crop_for_content = [this, film]() {
558 auto position = _viewer.position_in_content(_content.front()).get_value_or(
559 ContentTime::from_frames(_content.front()->video->length(), _content.front()->video_frame_rate().get_value_or(24))
561 return guess_crop(film, _content.front(), Config::instance()->auto_crop_threshold(), position);
564 /* Make an initial guess in the view and open the dialog */
566 auto const crop = guess_crop_for_content ();
567 update_viewer (crop);
569 _auto_crop_dialog.reset(_parent, crop);
570 _auto_crop_dialog->Show ();
572 /* Update the dialog and view when the crop threshold changes */
573 _auto_crop_config_connection = Config::instance()->Changed.connect([this, guess_crop_for_content, update_viewer](Config::Property property) {
574 auto film = _film.lock();
575 DCPOMATIC_ASSERT (film);
576 if (property == Config::AUTO_CROP_THRESHOLD) {
577 auto const crop = guess_crop_for_content();
578 _auto_crop_dialog->set(crop);
583 /* Also update the dialog and view when we're looking at a different frame */
584 _auto_crop_viewer_connection = _viewer.ImageChanged.connect([this, guess_crop_for_content, update_viewer](shared_ptr<PlayerVideo>) {
585 auto const crop = guess_crop_for_content();
586 _auto_crop_dialog->set(crop);
590 /* Handle the user closing the dialog (with OK or cancel) */
591 _auto_crop_dialog->Bind(wxEVT_BUTTON, [this](wxCommandEvent& ev) {
592 _auto_crop_config_connection.disconnect ();
593 _auto_crop_viewer_connection.disconnect ();
594 if (ev.GetId() == wxID_OK) {
595 _content.front()->video->set_crop(_auto_crop_dialog->get());
597 _auto_crop_dialog->Show (false);
598 _viewer.unset_crop_guess ();
601 /* Update the view when something in the dialog is changed */
602 _auto_crop_dialog->Changed.connect([update_viewer](Crop crop) {
603 update_viewer (crop);