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"
35 #include "lib/audio_content.h"
36 #include "lib/case_insensitive_sorter.h"
37 #include "lib/compose.hpp"
38 #include "lib/config.h"
39 #include "lib/content_factory.h"
40 #include "lib/cross.h"
41 #include "lib/dcp_content.h"
42 #include "lib/dcp_subtitle_content.h"
43 #include "lib/dcp_subtitle_decoder.h"
44 #include "lib/dcpomatic_log.h"
45 #include "lib/ffmpeg_content.h"
46 #include "lib/image_content.h"
48 #include "lib/playlist.h"
49 #include "lib/string_text_file.h"
50 #include "lib/string_text_file_content.h"
51 #include "lib/text_content.h"
52 #include "lib/video_content.h"
53 #include <dcp/warnings.h>
54 LIBDCP_DISABLE_WARNINGS
55 #include <wx/display.h>
57 #include <wx/listctrl.h>
58 #include <wx/notebook.h>
60 LIBDCP_ENABLE_WARNINGS
61 #include <boost/filesystem.hpp>
64 using std::dynamic_pointer_cast;
67 using std::make_shared;
68 using std::shared_ptr;
72 using boost::optional;
73 using namespace dcpomatic;
74 #if BOOST_VERSION >= 106100
75 using namespace boost::placeholders;
79 class LimitedContentPanelSplitter : public wxSplitterWindow
82 LimitedContentPanelSplitter(wxWindow* parent)
83 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
85 /* This value doesn't really mean much but we just want to stop double-click on the
86 divider from shrinking the bottom panel (#1601).
88 SetMinimumPaneSize(64);
90 Bind(wxEVT_SIZE, boost::bind(&LimitedContentPanelSplitter::sized, this, _1));
93 bool OnSashPositionChange(int new_position) override
95 /* Try to stop the top bit of the splitter getting so small that buttons disappear */
96 auto const ok = new_position > 220;
98 Config::instance()->set_main_content_divider_sash_position(new_position);
103 void first_shown(wxWindow* top, wxWindow* bottom)
105 int const sn = wxDisplay::GetFromWindow(this);
106 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
109 wxRect const screen = wxDisplay(sn).GetClientArea();
110 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
111 enough on small displays to leave space for the content area.
113 pos = screen.height > 800 ? -600 : -_top_panel_minimum_size;
115 SplitHorizontally(top, bottom, Config::instance()->main_content_divider_sash_position().get_value_or(pos));
120 void sized(wxSizeEvent& ev)
122 auto const height = GetSize().GetHeight();
123 if (_first_shown && (!_last_height || *_last_height != height) && height > _top_panel_minimum_size && GetSashPosition() < _top_panel_minimum_size) {
124 /* The window is now fairly big but the top panel is small; this happens when the DCP-o-matic window
125 * is shrunk and then made larger again. Try to set a sensible top panel size in this case (#1839).
127 SetSashPosition(Config::instance()->main_content_divider_sash_position().get_value_or(_top_panel_minimum_size));
131 _last_height = height;
134 bool _first_shown = false;
135 int const _top_panel_minimum_size = 350;
136 boost::optional<int> _last_height;
140 class ContentDropTarget : public wxFileDropTarget
143 ContentDropTarget(ContentPanel* owner)
147 bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
149 vector<boost::filesystem::path> files;
150 vector<boost::filesystem::path> dcps;
151 vector<boost::filesystem::path> folders;
152 for (size_t i = 0; i < filenames.GetCount(); ++i) {
153 auto path = boost::filesystem::path(wx_to_std(filenames[i]));
154 if (boost::filesystem::is_regular_file(path)) {
155 files.push_back(path);
156 } else if (boost::filesystem::is_directory(path)) {
157 if (contains_assetmap(path)) {
158 dcps.push_back(path);
160 folders.push_back(path);
165 if (!filenames.empty()) {
166 _panel->add_files(files);
169 for (auto dcp: dcps) {
170 _panel->add_dcp(dcp);
173 for (auto dir: folders) {
174 _panel->add_folder(dir);
181 ContentPanel* _panel;
185 /** A wxListCtrl that can middle-ellipsize its text */
186 class ContentListCtrl : public wxListCtrl
189 ContentListCtrl(wxWindow* parent)
190 : wxListCtrl(parent, wxID_ANY, wxDefaultPosition, wxSize(320, 160), wxLC_REPORT | wxLC_NO_HEADER | wxLC_VIRTUAL)
192 _red.SetTextColour(*wxRED);
201 void set(vector<Item> const& items)
204 SetItemCount(items.size());
207 wxString OnGetItemText(long item, long) const override
209 DCPOMATIC_ASSERT(item >= 0 && item < static_cast<long>(_items.size()));
210 wxClientDC dc(const_cast<wxWindow*>(static_cast<wxWindow const*>(this)));
211 return wxControl::Ellipsize(_items[item].text, dc, wxELLIPSIZE_MIDDLE, GetSize().GetWidth());
214 wxListItemAttr* OnGetItemAttr(long item) const override
216 DCPOMATIC_ASSERT(item >= 0 && item < static_cast<long>(_items.size()));
217 return _items[item].error ? const_cast<wxListItemAttr*>(&_red) : nullptr;
221 std::vector<Item> _items;
226 ContentPanel::ContentPanel(wxNotebook* n, shared_ptr<Film> film, FilmViewer& viewer)
229 , _film_viewer (viewer)
230 , _generally_sensitive (true)
231 , _ignore_deselect (false)
232 , _no_check_selection (false)
234 _splitter = new LimitedContentPanelSplitter(n);
235 _top_panel = new wxPanel (_splitter);
237 _menu = new ContentMenu (_splitter, _film_viewer);
240 auto s = new wxBoxSizer (wxHORIZONTAL);
242 _content = new ContentListCtrl(_top_panel);
243 _content->DragAcceptFiles (true);
244 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
246 _content->InsertColumn (0, wxT(""));
247 _content->SetColumnWidth(0, 2048);
249 auto b = new wxBoxSizer (wxVERTICAL);
251 _add_file = new Button (_top_panel, _("Add file(s)..."));
252 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
253 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
255 _add_folder = new Button (_top_panel, _("Add folder..."));
256 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
257 b->Add (_add_folder, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
259 _add_dcp = new Button (_top_panel, _("Add DCP..."));
260 _add_dcp->SetToolTip (_("Add a DCP."));
261 b->Add (_add_dcp, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
263 _remove = new Button (_top_panel, _("Remove"));
264 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
265 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
267 _earlier = new Button (_top_panel, _("Earlier"));
268 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
269 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
271 _later = new Button (_top_panel, _("Later"));
272 _later->SetToolTip (_("Move the selected piece of content later in the film."));
273 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
275 _timeline = new Button (_top_panel, _("Timeline..."));
276 _timeline->SetToolTip (_("Open the timeline for the film."));
277 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
279 s->Add (b, 0, wxALL, 4);
280 _top_panel->SetSizer (s);
283 _notebook = new wxNotebook (_splitter, wxID_ANY);
285 _timing_panel = new TimingPanel (this, _film_viewer);
286 _notebook->AddPage (_timing_panel, _("Timing"), false);
287 _timing_panel->create ();
289 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
290 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
291 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
292 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
293 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
294 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
295 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
296 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
297 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
298 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
299 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
301 _content->SetDropTarget(new ContentDropTarget(this));
306 ContentPanel::first_shown ()
308 _splitter->first_shown (_top_panel, _notebook);
313 ContentPanel::selected ()
318 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
323 auto cl = _film->content();
324 if (s < int (cl.size())) {
325 sel.push_back (cl[s]);
334 ContentPanel::selected_video ()
338 for (auto i: selected()) {
349 ContentPanel::selected_audio ()
353 for (auto i: selected()) {
364 ContentPanel::selected_text ()
368 for (auto i: selected()) {
369 if (!i->text.empty()) {
379 ContentPanel::selected_ffmpeg ()
381 FFmpegContentList sc;
383 for (auto i: selected()) {
384 auto t = dynamic_pointer_cast<FFmpegContent> (i);
395 ContentPanel::film_changed (Film::Property p)
398 case Film::Property::CONTENT:
399 case Film::Property::CONTENT_ORDER:
406 for (auto i: panels()) {
413 ContentPanel::item_deselected ()
415 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
416 false and item_deselected_foo will handle the deselection.
418 _ignore_deselect = false;
419 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
424 ContentPanel::item_deselected_idle ()
426 if (!_ignore_deselect) {
433 ContentPanel::item_selected ()
435 _ignore_deselect = true;
441 ContentPanel::check_selection ()
443 if (_no_check_selection) {
447 setup_sensitivity ();
449 for (auto i: panels()) {
450 i->content_selection_changed ();
453 optional<DCPTime> go_to;
454 for (auto content: selected()) {
455 if (content->paths_valid()) {
456 auto position = content->position();
457 if (auto text_content = dynamic_pointer_cast<StringTextFileContent>(content)) {
458 /* Rather special case; if we select a text subtitle file jump to its
461 StringTextFile ts(text_content);
462 if (auto first = ts.first()) {
463 position += DCPTime(first.get(), _film->active_frame_rate_change(content->position()));
465 } else if (auto dcp_content = dynamic_pointer_cast<DCPSubtitleContent>(content)) {
466 /* Do the same for DCP subtitles */
467 DCPSubtitleDecoder ts(_film, dcp_content);
468 if (auto first = ts.first()) {
469 position += DCPTime(first.get(), _film->active_frame_rate_change(content->position()));
472 if (!go_to || position < go_to.get()) {
478 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
479 signal_manager->when_idle(boost::bind(&FilmViewer::seek, &_film_viewer, go_to.get().ceil(_film->video_frame_rate()), true));
482 if (_timeline_dialog) {
483 _timeline_dialog->set_selection (selected());
486 /* Make required tabs visible */
488 if (_notebook->GetPageCount() > 1) {
489 /* There's more than one tab in the notebook so the current selection could be meaningful
490 to the user; store it so that we can try to restore it later.
492 _last_selected_tab = 0;
493 if (_notebook->GetSelection() != wxNOT_FOUND) {
494 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
498 bool have_video = false;
499 bool have_audio = false;
500 EnumIndexedVector<bool, TextType> have_text;
501 for (auto i: selected()) {
508 for (auto j: i->text) {
509 have_text[static_cast<int>(j->original_type())] = true;
515 if (have_video && !_video_panel) {
516 _video_panel = new VideoPanel (this);
517 _notebook->InsertPage (off, _video_panel, _video_panel->name());
518 _video_panel->create ();
519 } else if (!have_video && _video_panel) {
520 _notebook->DeletePage (off);
528 if (have_audio && !_audio_panel) {
529 _audio_panel = new AudioPanel (this);
530 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
531 _audio_panel->create ();
532 } else if (!have_audio && _audio_panel) {
533 _notebook->DeletePage (off);
541 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
542 if (have_text[i] && !_text_panel[i]) {
543 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
544 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
545 _text_panel[i]->create ();
546 } else if (!have_text[i] && _text_panel[i]) {
547 _notebook->DeletePage (off);
548 _text_panel[i] = nullptr;
555 /* Set up the tab selection */
558 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
559 if (_notebook->GetPage(i) == _last_selected_tab) {
560 _notebook->SetSelection (i);
565 if (!done && _notebook->GetPageCount() > 0) {
566 _notebook->SetSelection (0);
569 setup_sensitivity ();
574 optional<boost::filesystem::path>
575 ContentPanel::add_files_override_path() const
577 DCPOMATIC_ASSERT(_film->directory());
578 return Config::instance()->default_add_file_location() == Config::DefaultAddFileLocation::SAME_AS_PROJECT
579 ? _film->directory()->parent_path()
580 : boost::optional<boost::filesystem::path>();
586 ContentPanel::add_file_clicked ()
588 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
591 if (_parent->GetCurrentPage() != _splitter || !_film) {
595 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
596 non-Latin filenames or paths.
598 auto dialog = make_wx<FileDialog>(
600 _("Choose a file or files"),
601 wxT("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
602 wxFD_MULTIPLE | wxFD_CHANGE_DIR,
604 add_files_override_path()
607 if (dialog->show()) {
608 add_files(dialog->paths());
614 ContentPanel::add_folder_clicked ()
616 auto d = make_wx<DirDialog>(_splitter, _("Choose a folder"), wxDD_DIR_MUST_EXIST, "AddFilesPath", add_files_override_path());
618 add_folder(d->path());
624 ContentPanel::add_folder(boost::filesystem::path folder)
626 vector<shared_ptr<Content>> content;
629 content = content_factory(folder);
630 } catch (exception& e) {
631 error_dialog (_parent, e.what());
635 if (content.empty ()) {
636 error_dialog (_parent, _("No content found in this folder."));
640 for (auto i: content) {
641 auto ic = dynamic_pointer_cast<ImageContent> (i);
643 auto e = make_wx<ImageSequenceDialog>(_splitter);
645 if (e->ShowModal() != wxID_OK) {
648 ic->set_video_frame_rate(_film, e->frame_rate());
651 _film->examine_and_add_content (i);
657 ContentPanel::add_dcp_clicked ()
659 auto d = make_wx<DirDialog>(_splitter, _("Choose a DCP folder"), wxDD_DIR_MUST_EXIST, "AddFilesPath", add_files_override_path());
667 ContentPanel::add_dcp(boost::filesystem::path dcp)
670 _film->examine_and_add_content(make_shared<DCPContent>(dcp));
671 } catch (ProjectFolderError &) {
675 "This looks like a DCP-o-matic project folder, which cannot be added to a different project. "
676 "Choose the DCP folder inside the DCP-o-matic project folder if that's what you want to import."
679 } catch (exception& e) {
680 error_dialog(_parent, e.what());
685 /** @return true if this remove "click" should be ignored */
687 ContentPanel::remove_clicked (bool hotkey)
689 /* If the method was called because Delete was pressed check that our notebook page
690 is visible and that the content list is focused.
692 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
696 for (auto i: selected ()) {
697 _film->remove_content (i);
706 ContentPanel::timeline_clicked ()
712 _timeline_dialog.reset(this, _film, _film_viewer);
713 _timeline_dialog->set_selection (selected());
714 _timeline_dialog->Show ();
719 ContentPanel::right_click (wxListEvent& ev)
721 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
725 /** Set up broad sensitivity based on the type of content that is selected */
727 ContentPanel::setup_sensitivity ()
729 _add_file->Enable (_generally_sensitive);
730 _add_folder->Enable (_generally_sensitive);
731 _add_dcp->Enable (_generally_sensitive);
733 auto selection = selected ();
734 auto video_selection = selected_video ();
735 auto audio_selection = selected_audio ();
737 _remove->Enable (_generally_sensitive && !selection.empty());
738 _earlier->Enable (_generally_sensitive && selection.size() == 1);
739 _later->Enable (_generally_sensitive && selection.size() == 1);
740 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
743 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
746 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
748 for (auto text: _text_panel) {
750 text->Enable(_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
753 _timing_panel->Enable (_generally_sensitive);
758 ContentPanel::set_film (shared_ptr<Film> film)
761 _audio_panel->set_film (film);
766 film_changed (Film::Property::CONTENT);
767 film_changed (Film::Property::AUDIO_CHANNELS);
773 setup_sensitivity ();
778 ContentPanel::set_general_sensitivity (bool s)
780 _generally_sensitive = s;
781 setup_sensitivity ();
786 ContentPanel::earlier_clicked ()
788 auto sel = selected ();
789 if (sel.size() == 1) {
790 _film->move_content_earlier (sel.front ());
797 ContentPanel::later_clicked ()
799 auto sel = selected ();
800 if (sel.size() == 1) {
801 _film->move_content_later (sel.front ());
808 ContentPanel::set_selection (weak_ptr<Content> wc)
810 auto content = _film->content ();
811 for (size_t i = 0; i < content.size(); ++i) {
812 set_selected_state(i, content[i] == wc.lock());
818 ContentPanel::set_selection (ContentList cl)
820 _no_check_selection = true;
822 auto content = _film->content ();
823 for (size_t i = 0; i < content.size(); ++i) {
824 set_selected_state(i, find(cl.begin(), cl.end(), content[i]) != cl.end());
827 _no_check_selection = false;
833 ContentPanel::select_all ()
835 set_selection (_film->content());
840 ContentPanel::film_content_changed (int property)
843 property == ContentProperty::PATH ||
844 property == DCPContentProperty::NEEDS_ASSETS ||
845 property == DCPContentProperty::NEEDS_KDM ||
846 property == DCPContentProperty::NAME
852 for (auto i: panels()) {
853 i->film_content_changed (property);
859 ContentPanel::setup ()
862 _content->DeleteAllItems ();
863 setup_sensitivity ();
867 auto content = _film->content ();
869 Content* selected_content = nullptr;
870 auto const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
874 item.SetMask (wxLIST_MASK_DATA);
875 _content->GetItem (item);
876 selected_content = reinterpret_cast<Content*> (item.GetData ());
879 vector<ContentListCtrl::Item> items;
881 for (auto i: content) {
882 int const t = _content->GetItemCount ();
883 bool const valid = i->paths_valid ();
885 auto dcp = dynamic_pointer_cast<DCPContent> (i);
886 bool const needs_kdm = dcp && dcp->needs_kdm ();
887 bool const needs_assets = dcp && dcp->needs_assets ();
889 auto s = std_to_wx (i->summary ());
892 s = _("MISSING: ") + s;
896 s = _("NEEDS KDM: ") + s;
900 s = _("NEEDS OV: ") + s;
903 items.push_back({s, !valid || needs_kdm || needs_assets});
905 if (i.get() == selected_content) {
906 set_selected_state(t, true);
910 _content->set(items);
912 if (!selected_content && !content.empty ()) {
913 /* Select the item of content if none was selected before */
914 set_selected_state(0, true);
917 setup_sensitivity ();
922 ContentPanel::files_dropped (wxDropFilesEvent& event)
928 auto paths = event.GetFiles ();
929 vector<boost::filesystem::path> path_list;
930 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
931 path_list.push_back (wx_to_std(paths[i]));
934 add_files (path_list);
939 ContentPanel::add_files (vector<boost::filesystem::path> paths)
945 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
946 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
947 alphabetical sort is expected here.
950 std::sort (paths.begin(), paths.end(), CaseInsensitiveSorter());
952 /* XXX: check for lots of files here and do something */
955 for (auto i: paths) {
956 for (auto j: content_factory(i)) {
957 _film->examine_and_add_content (j);
960 } catch (exception& e) {
961 error_dialog (_parent, e.what());
966 list<ContentSubPanel*>
967 ContentPanel::panels () const
969 list<ContentSubPanel*> p;
971 p.push_back (_video_panel);
974 p.push_back (_audio_panel);
976 for (auto text: _text_panel) {
981 p.push_back (_timing_panel);
987 ContentPanel::set_selected_state(int item, bool state)
989 _content->SetItemState(item, state ? wxLIST_STATE_SELECTED : 0, wxLIST_STATE_SELECTED);
990 _content->SetItemState(item, state ? wxLIST_STATE_FOCUSED : 0, wxLIST_STATE_FOCUSED);
995 ContentPanel::window() const