2 Copyright (C) 2012-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 "audio_panel.h"
23 #include "content_panel.h"
24 #include "dcpomatic_button.h"
25 #include "dir_dialog.h"
26 #include "file_dialog.h"
27 #include "film_viewer.h"
28 #include "image_sequence_dialog.h"
29 #include "text_panel.h"
30 #include "timeline_dialog.h"
31 #include "timing_panel.h"
32 #include "video_panel.h"
34 #include "lib/audio_content.h"
35 #include "lib/case_insensitive_sorter.h"
36 #include "lib/compose.hpp"
37 #include "lib/config.h"
38 #include "lib/content_factory.h"
39 #include "lib/cross.h"
40 #include "lib/dcp_content.h"
41 #include "lib/dcp_subtitle_content.h"
42 #include "lib/dcp_subtitle_decoder.h"
43 #include "lib/dcpomatic_log.h"
44 #include "lib/ffmpeg_content.h"
46 #include "lib/film_util.h"
47 #include "lib/image_content.h"
49 #include "lib/playlist.h"
50 #include "lib/scope_guard.h"
51 #include "lib/string_text_file.h"
52 #include "lib/string_text_file_content.h"
53 #include "lib/text_content.h"
54 #include "lib/video_content.h"
55 #include <dcp/filesystem.h>
56 #include <dcp/warnings.h>
57 LIBDCP_DISABLE_WARNINGS
58 #include <wx/display.h>
60 #include <wx/listctrl.h>
61 #include <wx/notebook.h>
63 LIBDCP_ENABLE_WARNINGS
64 #include <boost/filesystem.hpp>
67 using std::dynamic_pointer_cast;
70 using std::make_shared;
71 using std::shared_ptr;
75 using boost::optional;
76 using namespace dcpomatic;
77 #if BOOST_VERSION >= 106100
78 using namespace boost::placeholders;
82 class LimitedContentPanelSplitter : public wxSplitterWindow
85 LimitedContentPanelSplitter(wxWindow* parent)
86 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
88 /* This value doesn't really mean much but we just want to stop double-click on the
89 divider from shrinking the bottom panel (#1601).
91 SetMinimumPaneSize(64);
93 Bind(wxEVT_SIZE, boost::bind(&LimitedContentPanelSplitter::sized, this, _1));
96 bool OnSashPositionChange(int new_position) override
98 /* Try to stop the top bit of the splitter getting so small that buttons disappear */
99 auto const ok = new_position > 220;
101 Config::instance()->set_main_content_divider_sash_position(new_position);
106 void first_shown(wxWindow* top, wxWindow* bottom)
108 int const sn = wxDisplay::GetFromWindow(this);
109 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
112 wxRect const screen = wxDisplay(sn).GetClientArea();
113 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
114 enough on small displays to leave space for the content area.
116 pos = screen.height > 800 ? -600 : -_top_panel_minimum_size;
118 SplitHorizontally(top, bottom, Config::instance()->main_content_divider_sash_position().get_value_or(pos));
123 void sized(wxSizeEvent& ev)
125 auto const height = GetSize().GetHeight();
126 if (_first_shown && (!_last_height || *_last_height != height) && height > _top_panel_minimum_size && GetSashPosition() < _top_panel_minimum_size) {
127 /* The window is now fairly big but the top panel is small; this happens when the DCP-o-matic window
128 * is shrunk and then made larger again. Try to set a sensible top panel size in this case (#1839).
130 SetSashPosition(Config::instance()->main_content_divider_sash_position().get_value_or(_top_panel_minimum_size));
134 _last_height = height;
137 bool _first_shown = false;
138 int const _top_panel_minimum_size = 350;
139 boost::optional<int> _last_height;
143 class ContentDropTarget : public wxFileDropTarget
146 ContentDropTarget(ContentPanel* owner)
150 bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
152 vector<boost::filesystem::path> files;
153 vector<boost::filesystem::path> dcps;
154 vector<boost::filesystem::path> folders;
155 for (size_t i = 0; i < filenames.GetCount(); ++i) {
156 auto path = boost::filesystem::path(wx_to_std(filenames[i]));
157 if (dcp::filesystem::is_regular_file(path)) {
158 files.push_back(path);
159 } else if (dcp::filesystem::is_directory(path)) {
160 if (contains_assetmap(path)) {
161 dcps.push_back(path);
163 folders.push_back(path);
168 if (!filenames.empty()) {
169 _panel->add_files(files);
172 for (auto dcp: dcps) {
173 _panel->add_dcp(dcp);
176 for (auto dir: folders) {
177 _panel->add_folder(dir);
184 ContentPanel* _panel;
188 /** A wxListCtrl that can middle-ellipsize its text */
189 class ContentListCtrl : public wxListCtrl
192 ContentListCtrl(wxWindow* parent)
193 : wxListCtrl(parent, wxID_ANY, wxDefaultPosition, wxSize(320, 160), wxLC_REPORT | wxLC_NO_HEADER | wxLC_VIRTUAL)
195 _red.SetTextColour(*wxRED);
201 weak_ptr<Content> content;
205 void set(vector<Item> const& items)
208 SetItemCount(items.size());
211 wxString OnGetItemText(long item, long) const override
213 DCPOMATIC_ASSERT(item >= 0 && item < static_cast<long>(_items.size()));
214 wxClientDC dc(const_cast<wxWindow*>(static_cast<wxWindow const*>(this)));
215 return wxControl::Ellipsize(_items[item].text, dc, wxELLIPSIZE_MIDDLE, GetSize().GetWidth());
218 wxListItemAttr* OnGetItemAttr(long item) const override
220 DCPOMATIC_ASSERT(item >= 0 && item < static_cast<long>(_items.size()));
221 return _items[item].error ? const_cast<wxListItemAttr*>(&_red) : nullptr;
224 weak_ptr<Content> content_at_index(long index)
226 if (index < 0 || index >= static_cast<long>(_items.size())) {
229 return _items[index].content;
233 std::vector<Item> _items;
238 ContentPanel::ContentPanel(wxNotebook* n, shared_ptr<Film> film, FilmViewer& viewer)
241 , _film_viewer (viewer)
242 , _generally_sensitive (true)
243 , _ignore_deselect (false)
244 , _no_check_selection (false)
246 _splitter = new LimitedContentPanelSplitter(n);
247 _top_panel = new wxPanel (_splitter);
249 _menu = new ContentMenu (_splitter, _film_viewer);
252 auto s = new wxBoxSizer (wxHORIZONTAL);
254 _content = new ContentListCtrl(_top_panel);
255 _content->DragAcceptFiles (true);
256 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
258 _content->InsertColumn (0, wxT(""));
259 _content->SetColumnWidth(0, 2048);
261 auto b = new wxBoxSizer (wxVERTICAL);
263 _add_file = new Button (_top_panel, _("Add file(s)..."));
264 _add_file->SetToolTip(_("Add video, image, sound or subtitle files to the film (Ctrl+A)."));
265 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
267 _add_folder = new Button (_top_panel, _("Add folder..."));
268 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
269 b->Add (_add_folder, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
271 _add_dcp = new Button (_top_panel, _("Add DCP..."));
272 _add_dcp->SetToolTip (_("Add a DCP."));
273 b->Add (_add_dcp, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
275 _remove = new Button (_top_panel, _("Remove"));
276 _remove->SetToolTip(_("Remove the selected piece of content from the film (Delete)."));
277 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
279 _earlier = new Button (_top_panel, _("Earlier"));
280 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
281 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
283 _later = new Button (_top_panel, _("Later"));
284 _later->SetToolTip (_("Move the selected piece of content later in the film."));
285 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
287 _timeline = new Button (_top_panel, _("Timeline..."));
288 _timeline->SetToolTip(_("Open the timeline for the film (Ctrl+T)."));
289 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
291 s->Add (b, 0, wxALL, 4);
292 _top_panel->SetSizer (s);
295 _notebook = new wxNotebook (_splitter, wxID_ANY);
297 _timing_panel = new TimingPanel (this, _film_viewer);
298 _notebook->AddPage (_timing_panel, _("Timing"), false);
299 _timing_panel->create ();
301 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
302 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
303 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
304 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
305 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
306 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
307 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
308 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
309 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
310 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
311 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
313 _content->SetDropTarget(new ContentDropTarget(this));
318 ContentPanel::first_shown ()
320 _splitter->first_shown (_top_panel, _notebook);
325 ContentPanel::selected ()
330 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
335 auto weak = _content->content_at_index(s);
336 if (auto content = weak.lock()) {
337 sel.push_back(content);
346 ContentPanel::selected_video ()
350 for (auto i: selected()) {
361 ContentPanel::selected_audio ()
365 for (auto i: selected()) {
376 ContentPanel::selected_text ()
380 for (auto i: selected()) {
381 if (!i->text.empty()) {
391 ContentPanel::selected_ffmpeg ()
393 FFmpegContentList sc;
395 for (auto i: selected()) {
396 auto t = dynamic_pointer_cast<FFmpegContent> (i);
407 ContentPanel::film_changed(FilmProperty p)
410 case FilmProperty::CONTENT:
411 case FilmProperty::CONTENT_ORDER:
418 for (auto i: panels()) {
425 ContentPanel::item_deselected ()
427 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
428 false and item_deselected_foo will handle the deselection.
430 _ignore_deselect = false;
431 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
436 ContentPanel::item_deselected_idle ()
438 if (!_ignore_deselect) {
445 ContentPanel::item_selected ()
447 _ignore_deselect = true;
453 ContentPanel::check_selection ()
455 if (_no_check_selection) {
459 setup_sensitivity ();
461 for (auto i: panels()) {
462 i->content_selection_changed ();
465 optional<DCPTime> go_to;
466 for (auto content: selected()) {
467 if (content->paths_valid()) {
468 auto position = content->position();
469 if (auto text_content = dynamic_pointer_cast<StringTextFileContent>(content)) {
470 /* Rather special case; if we select a text subtitle file jump to its
473 StringTextFile ts(text_content);
474 if (auto first = ts.first()) {
475 position += DCPTime(first.get(), _film->active_frame_rate_change(content->position()));
477 } else if (auto dcp_content = dynamic_pointer_cast<DCPSubtitleContent>(content)) {
478 /* Do the same for DCP subtitles */
479 DCPSubtitleDecoder ts(_film, dcp_content);
480 if (auto first = ts.first()) {
481 position += DCPTime(first.get(), _film->active_frame_rate_change(content->position()));
484 if (!go_to || position < go_to.get()) {
490 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
491 signal_manager->when_idle(boost::bind(&FilmViewer::seek, &_film_viewer, go_to.get().ceil(_film->video_frame_rate()), true));
494 if (_timeline_dialog) {
495 _timeline_dialog->set_selection (selected());
498 /* Make required tabs visible */
500 if (_notebook->GetPageCount() > 1) {
501 /* There's more than one tab in the notebook so the current selection could be meaningful
502 to the user; store it so that we can try to restore it later.
504 _last_selected_tab = 0;
505 if (_notebook->GetSelection() != wxNOT_FOUND) {
506 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
510 bool have_video = false;
511 bool have_audio = false;
512 EnumIndexedVector<bool, TextType> have_text;
513 for (auto i: selected()) {
520 for (auto j: i->text) {
521 have_text[static_cast<int>(j->original_type())] = true;
527 if (have_video && !_video_panel) {
528 _video_panel = new VideoPanel (this);
529 _notebook->InsertPage (off, _video_panel, _video_panel->name());
530 _video_panel->create ();
531 } else if (!have_video && _video_panel) {
532 _notebook->DeletePage (off);
533 _video_panel = nullptr;
540 if (have_audio && !_audio_panel) {
541 _audio_panel = new AudioPanel (this);
542 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
543 _audio_panel->create ();
544 } else if (!have_audio && _audio_panel) {
545 _notebook->DeletePage (off);
546 _audio_panel = nullptr;
553 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
554 if (have_text[i] && !_text_panel[i]) {
555 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
556 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
557 _text_panel[i]->create ();
558 } else if (!have_text[i] && _text_panel[i]) {
559 _notebook->DeletePage (off);
560 _text_panel[i] = nullptr;
567 /* Set up the tab selection */
570 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
571 if (_notebook->GetPage(i) == _last_selected_tab) {
572 _notebook->SetSelection (i);
577 if (!done && _notebook->GetPageCount() > 0) {
578 _notebook->SetSelection (0);
581 setup_sensitivity ();
587 ContentPanel::add_file_clicked ()
589 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
592 if (_parent->GetCurrentPage() != _splitter || !_film) {
596 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
597 non-Latin filenames or paths.
601 _("Choose a file or files"),
602 wxT("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
603 wxFD_MULTIPLE | wxFD_CHANGE_DIR,
605 add_files_override_path(_film)
609 add_files(dialog.paths());
615 ContentPanel::add_folder_clicked ()
617 DirDialog dialog(_splitter, _("Choose a folder"), wxDD_DIR_MUST_EXIST, "AddFilesPath", add_files_override_path(_film));
619 add_folder(dialog.path());
625 ContentPanel::add_folder(boost::filesystem::path folder)
627 vector<shared_ptr<Content>> content;
630 content = content_factory(folder);
631 } catch (exception& e) {
632 error_dialog (_parent, e.what());
636 if (content.empty ()) {
637 error_dialog (_parent, _("No content found in this folder."));
641 for (auto i: content) {
642 auto ic = dynamic_pointer_cast<ImageContent> (i);
644 ImageSequenceDialog dialog(_splitter);
646 if (dialog.ShowModal() != wxID_OK) {
649 ic->set_video_frame_rate(_film, dialog.frame_rate());
652 _film->examine_and_add_content (i);
658 ContentPanel::add_dcp_clicked ()
660 DirDialog dialog(_splitter, _("Choose a DCP folder"), wxDD_DIR_MUST_EXIST, "AddFilesPath", add_files_override_path(_film));
662 add_dcp(dialog.path());
668 ContentPanel::add_dcp(boost::filesystem::path dcp)
671 _film->examine_and_add_content(make_shared<DCPContent>(dcp));
672 } catch (ProjectFolderError &) {
676 "This looks like a DCP-o-matic project folder, which cannot be added to a different project. "
677 "Choose the DCP folder inside the DCP-o-matic project folder if that's what you want to import."
680 } catch (exception& e) {
681 error_dialog(_parent, e.what());
686 /** @return true if this remove "click" should be ignored */
688 ContentPanel::remove_clicked (bool hotkey)
690 /* If the method was called because Delete was pressed check that our notebook page
691 is visible and that the content list is focused.
693 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
697 for (auto i: selected ()) {
698 _film->remove_content (i);
707 ContentPanel::timeline_clicked ()
709 if (!_film || _film->content().empty()) {
713 _timeline_dialog.reset(this, _film, _film_viewer);
714 _timeline_dialog->set_selection (selected());
715 _timeline_dialog->Show ();
720 ContentPanel::right_click (wxListEvent& ev)
722 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
726 /** Set up broad sensitivity based on the type of content that is selected */
728 ContentPanel::setup_sensitivity ()
730 _add_file->Enable (_generally_sensitive);
731 _add_folder->Enable (_generally_sensitive);
732 _add_dcp->Enable (_generally_sensitive);
734 auto selection = selected ();
735 auto video_selection = selected_video ();
736 auto audio_selection = selected_audio ();
738 _remove->Enable (_generally_sensitive && !selection.empty());
739 _earlier->Enable (_generally_sensitive && selection.size() == 1);
740 _later->Enable (_generally_sensitive && selection.size() == 1);
741 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
744 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
747 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
749 for (auto text: _text_panel) {
751 text->Enable(_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
754 _timing_panel->Enable (_generally_sensitive);
759 ContentPanel::set_film (shared_ptr<Film> film)
762 _audio_panel->set_film (film);
767 film_changed(FilmProperty::CONTENT);
768 film_changed(FilmProperty::AUDIO_CHANNELS);
774 setup_sensitivity ();
779 ContentPanel::set_general_sensitivity (bool s)
781 _generally_sensitive = s;
782 setup_sensitivity ();
787 ContentPanel::earlier_clicked ()
789 auto sel = selected ();
790 if (sel.size() == 1) {
791 _film->move_content_earlier (sel.front ());
798 ContentPanel::later_clicked ()
800 auto sel = selected ();
801 if (sel.size() == 1) {
802 _film->move_content_later (sel.front ());
809 ContentPanel::set_selection (weak_ptr<Content> wc)
811 auto content = _film->content ();
812 for (size_t i = 0; i < content.size(); ++i) {
813 set_selected_state(i, content[i] == wc.lock());
819 ContentPanel::set_selection (ContentList cl)
822 _no_check_selection = true;
823 ScopeGuard sg = [this]() { _no_check_selection = false; };
825 auto content = _film->content ();
826 for (size_t i = 0; i < content.size(); ++i) {
827 set_selected_state(i, find(cl.begin(), cl.end(), content[i]) != cl.end());
836 ContentPanel::select_all ()
838 set_selection (_film->content());
843 ContentPanel::film_content_changed (int property)
846 property == ContentProperty::PATH ||
847 property == DCPContentProperty::NEEDS_ASSETS ||
848 property == DCPContentProperty::NEEDS_KDM ||
849 property == DCPContentProperty::NAME
855 for (auto i: panels()) {
856 i->film_content_changed (property);
862 ContentPanel::setup ()
865 _content->DeleteAllItems ();
866 setup_sensitivity ();
870 auto content = _film->content ();
871 auto selection = selected();
873 vector<ContentListCtrl::Item> items;
875 for (auto i: content) {
876 bool const valid = i->paths_valid ();
878 auto dcp = dynamic_pointer_cast<DCPContent> (i);
879 bool const needs_kdm = dcp && dcp->needs_kdm ();
880 bool const needs_assets = dcp && dcp->needs_assets ();
882 auto s = std_to_wx (i->summary ());
885 s = _("MISSING: ") + s;
889 s = _("NEEDS KDM: ") + s;
893 s = _("NEEDS OV: ") + s;
896 items.push_back({s, i, !valid || needs_kdm || needs_assets});
899 _content->set(items);
901 if (selection.empty() && !content.empty()) {
902 set_selected_state(0, true);
904 set_selection(selection);
907 setup_sensitivity ();
912 ContentPanel::files_dropped (wxDropFilesEvent& event)
918 auto paths = event.GetFiles ();
919 vector<boost::filesystem::path> path_list;
920 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
921 path_list.push_back (wx_to_std(paths[i]));
924 add_files (path_list);
929 ContentPanel::add_files (vector<boost::filesystem::path> paths)
935 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
936 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
937 alphabetical sort is expected here.
940 std::sort (paths.begin(), paths.end(), CaseInsensitiveSorter());
942 /* XXX: check for lots of files here and do something */
945 for (auto i: paths) {
946 for (auto j: content_factory(i)) {
947 _film->examine_and_add_content (j);
950 } catch (exception& e) {
951 error_dialog (_parent, e.what());
956 list<ContentSubPanel*>
957 ContentPanel::panels () const
959 list<ContentSubPanel*> p;
961 p.push_back (_video_panel);
964 p.push_back (_audio_panel);
966 for (auto text: _text_panel) {
971 p.push_back (_timing_panel);
977 ContentPanel::set_selected_state(int item, bool state)
979 _content->SetItemState(item, state ? wxLIST_STATE_SELECTED : 0, wxLIST_STATE_SELECTED);
980 _content->SetItemState(item, state ? wxLIST_STATE_FOCUSED : 0, wxLIST_STATE_FOCUSED);
985 ContentPanel::window() const