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 "film_viewer.h"
26 #include "image_sequence_dialog.h"
27 #include "text_panel.h"
28 #include "timeline_dialog.h"
29 #include "timing_panel.h"
30 #include "video_panel.h"
32 #include "lib/audio_content.h"
33 #include "lib/case_insensitive_sorter.h"
34 #include "lib/compose.hpp"
35 #include "lib/config.h"
36 #include "lib/content_factory.h"
37 #include "lib/cross.h"
38 #include "lib/dcp_content.h"
39 #include "lib/dcp_subtitle_content.h"
40 #include "lib/dcp_subtitle_decoder.h"
41 #include "lib/dcpomatic_log.h"
42 #include "lib/ffmpeg_content.h"
43 #include "lib/image_content.h"
45 #include "lib/playlist.h"
46 #include "lib/string_text_file.h"
47 #include "lib/string_text_file_content.h"
48 #include "lib/text_content.h"
49 #include "lib/video_content.h"
50 #include <dcp/warnings.h>
51 LIBDCP_DISABLE_WARNINGS
52 #include <wx/display.h>
54 #include <wx/listctrl.h>
55 #include <wx/notebook.h>
57 LIBDCP_ENABLE_WARNINGS
58 #include <boost/filesystem.hpp>
61 using std::dynamic_pointer_cast;
64 using std::make_shared;
65 using std::shared_ptr;
69 using boost::optional;
70 using namespace dcpomatic;
71 #if BOOST_VERSION >= 106100
72 using namespace boost::placeholders;
76 class LimitedContentPanelSplitter : public wxSplitterWindow
79 LimitedContentPanelSplitter(wxWindow* parent)
80 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
82 /* This value doesn't really mean much but we just want to stop double-click on the
83 divider from shrinking the bottom panel (#1601).
85 SetMinimumPaneSize(64);
87 Bind(wxEVT_SIZE, boost::bind(&LimitedContentPanelSplitter::sized, this, _1));
90 bool OnSashPositionChange(int new_position) override
92 /* Try to stop the top bit of the splitter getting so small that buttons disappear */
93 return new_position > 220;
96 void first_shown(wxWindow* top, wxWindow* bottom)
98 int const sn = wxDisplay::GetFromWindow(this);
100 wxRect const screen = wxDisplay(sn).GetClientArea();
101 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
102 enough on small displays to leave space for the content area.
104 SplitHorizontally(top, bottom, screen.height > 800 ? -600 : -_top_panel_minimum_size);
106 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
107 SplitHorizontally(top, bottom, -600);
113 void sized(wxSizeEvent& ev)
115 auto const height = GetSize().GetHeight();
116 if (_first_shown && (!_last_height || *_last_height != height) && height > _top_panel_minimum_size && GetSashPosition() < _top_panel_minimum_size) {
117 /* The window is now fairly big but the top panel is small; this happens when the DCP-o-matic window
118 * is shrunk and then made larger again. Try to set a sensible top panel size in this case (#1839).
120 SetSashPosition(_top_panel_minimum_size);
124 _last_height = height;
127 bool _first_shown = false;
128 int const _top_panel_minimum_size = 350;
129 boost::optional<int> _last_height;
133 class ContentDropTarget : public wxFileDropTarget
136 ContentDropTarget(ContentPanel* owner)
140 bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
142 vector<boost::filesystem::path> files;
143 vector<boost::filesystem::path> dcps;
144 vector<boost::filesystem::path> folders;
145 for (size_t i = 0; i < filenames.GetCount(); ++i) {
146 auto path = boost::filesystem::path(wx_to_std(filenames[i]));
147 if (boost::filesystem::is_regular_file(path)) {
148 files.push_back(path);
149 } else if (boost::filesystem::is_directory(path)) {
150 if (contains_assetmap(path)) {
151 dcps.push_back(path);
153 folders.push_back(path);
158 if (!filenames.empty()) {
159 _panel->add_files(files);
162 for (auto dcp: dcps) {
163 _panel->add_dcp(dcp);
166 for (auto dir: folders) {
167 _panel->add_folder(dir);
174 ContentPanel* _panel;
178 ContentPanel::ContentPanel(wxNotebook* n, shared_ptr<Film> film, FilmViewer& viewer)
181 , _film_viewer (viewer)
182 , _generally_sensitive (true)
183 , _ignore_deselect (false)
184 , _no_check_selection (false)
186 _splitter = new LimitedContentPanelSplitter(n);
187 _top_panel = new wxPanel (_splitter);
189 _menu = new ContentMenu (_splitter, _film_viewer);
192 auto s = new wxBoxSizer (wxHORIZONTAL);
194 _content = new wxListCtrl (_top_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
195 _content->DragAcceptFiles (true);
196 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
198 _content->InsertColumn (0, wxT(""));
199 _content->SetColumnWidth (0, 512);
201 auto b = new wxBoxSizer (wxVERTICAL);
203 _add_file = new Button (_top_panel, _("Add file(s)..."));
204 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
205 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
207 _add_folder = new Button (_top_panel, _("Add folder..."));
208 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
209 b->Add (_add_folder, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
211 _add_dcp = new Button (_top_panel, _("Add DCP..."));
212 _add_dcp->SetToolTip (_("Add a DCP."));
213 b->Add (_add_dcp, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
215 _remove = new Button (_top_panel, _("Remove"));
216 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
217 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
219 _earlier = new Button (_top_panel, _("Earlier"));
220 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
221 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
223 _later = new Button (_top_panel, _("Later"));
224 _later->SetToolTip (_("Move the selected piece of content later in the film."));
225 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
227 _timeline = new Button (_top_panel, _("Timeline..."));
228 _timeline->SetToolTip (_("Open the timeline for the film."));
229 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
231 s->Add (b, 0, wxALL, 4);
232 _top_panel->SetSizer (s);
235 _notebook = new wxNotebook (_splitter, wxID_ANY);
237 _timing_panel = new TimingPanel (this, _film_viewer);
238 _notebook->AddPage (_timing_panel, _("Timing"), false);
239 _timing_panel->create ();
241 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
242 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
243 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
244 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
245 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
246 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
247 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
248 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
249 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
250 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
251 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
253 _content->SetDropTarget(new ContentDropTarget(this));
258 ContentPanel::first_shown ()
260 _splitter->first_shown (_top_panel, _notebook);
265 ContentPanel::selected ()
270 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
275 auto cl = _film->content();
276 if (s < int (cl.size())) {
277 sel.push_back (cl[s]);
286 ContentPanel::selected_video ()
290 for (auto i: selected()) {
301 ContentPanel::selected_audio ()
305 for (auto i: selected()) {
316 ContentPanel::selected_text ()
320 for (auto i: selected()) {
321 if (!i->text.empty()) {
331 ContentPanel::selected_ffmpeg ()
333 FFmpegContentList sc;
335 for (auto i: selected()) {
336 auto t = dynamic_pointer_cast<FFmpegContent> (i);
347 ContentPanel::film_changed (Film::Property p)
350 case Film::Property::CONTENT:
351 case Film::Property::CONTENT_ORDER:
358 for (auto i: panels()) {
365 ContentPanel::item_deselected ()
367 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
368 false and item_deselected_foo will handle the deselection.
370 _ignore_deselect = false;
371 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
376 ContentPanel::item_deselected_idle ()
378 if (!_ignore_deselect) {
385 ContentPanel::item_selected ()
387 _ignore_deselect = true;
393 ContentPanel::check_selection ()
395 if (_no_check_selection) {
399 setup_sensitivity ();
401 for (auto i: panels()) {
402 i->content_selection_changed ();
405 optional<DCPTime> go_to;
406 for (auto content: selected()) {
407 if (content->paths_valid()) {
408 auto position = content->position();
409 if (auto text_content = dynamic_pointer_cast<StringTextFileContent>(content)) {
410 /* Rather special case; if we select a text subtitle file jump to its
413 StringTextFile ts(text_content);
414 if (auto first = ts.first()) {
415 position += DCPTime(first.get(), _film->active_frame_rate_change(content->position()));
417 } else if (auto dcp_content = dynamic_pointer_cast<DCPSubtitleContent>(content)) {
418 /* Do the same for DCP subtitles */
419 DCPSubtitleDecoder ts(_film, dcp_content);
420 if (auto first = ts.first()) {
421 position += DCPTime(first.get(), _film->active_frame_rate_change(content->position()));
424 if (!go_to || position < go_to.get()) {
430 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
431 signal_manager->when_idle(boost::bind(&FilmViewer::seek, &_film_viewer, go_to.get().ceil(_film->video_frame_rate()), true));
434 if (_timeline_dialog) {
435 _timeline_dialog->set_selection (selected());
438 /* Make required tabs visible */
440 if (_notebook->GetPageCount() > 1) {
441 /* There's more than one tab in the notebook so the current selection could be meaningful
442 to the user; store it so that we can try to restore it later.
444 _last_selected_tab = 0;
445 if (_notebook->GetSelection() != wxNOT_FOUND) {
446 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
450 bool have_video = false;
451 bool have_audio = false;
452 EnumIndexedVector<bool, TextType> have_text;
453 for (auto i: selected()) {
460 for (auto j: i->text) {
461 have_text[static_cast<int>(j->original_type())] = true;
467 if (have_video && !_video_panel) {
468 _video_panel = new VideoPanel (this);
469 _notebook->InsertPage (off, _video_panel, _video_panel->name());
470 _video_panel->create ();
471 } else if (!have_video && _video_panel) {
472 _notebook->DeletePage (off);
480 if (have_audio && !_audio_panel) {
481 _audio_panel = new AudioPanel (this);
482 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
483 _audio_panel->create ();
484 } else if (!have_audio && _audio_panel) {
485 _notebook->DeletePage (off);
493 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
494 if (have_text[i] && !_text_panel[i]) {
495 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
496 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
497 _text_panel[i]->create ();
498 } else if (!have_text[i] && _text_panel[i]) {
499 _notebook->DeletePage (off);
500 _text_panel[i] = nullptr;
507 /* Set up the tab selection */
510 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
511 if (_notebook->GetPage(i) == _last_selected_tab) {
512 _notebook->SetSelection (i);
517 if (!done && _notebook->GetPageCount() > 0) {
518 _notebook->SetSelection (0);
521 setup_sensitivity ();
527 ContentPanel::add_file_clicked ()
529 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
532 if (_parent->GetCurrentPage() != _splitter || !_film) {
536 auto path = Config::instance()->add_files_path();
538 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
539 non-Latin filenames or paths.
541 auto d = new wxFileDialog (
543 _("Choose a file or files"),
544 std_to_wx(path ? path->string() : home_directory().string()),
546 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
547 wxFD_MULTIPLE | wxFD_CHANGE_DIR
550 int const r = d->ShowModal ();
559 vector<boost::filesystem::path> path_list;
560 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
561 path_list.push_back (wx_to_std(paths[i]));
563 add_files (path_list);
565 if (!path_list.empty()) {
566 Config::instance()->set_add_files_path(path_list[0].parent_path());
574 ContentPanel::add_folder_clicked ()
576 auto d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
577 int r = d->ShowModal ();
578 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
590 ContentPanel::add_folder(boost::filesystem::path folder)
592 vector<shared_ptr<Content>> content;
595 content = content_factory(folder);
596 } catch (exception& e) {
597 error_dialog (_parent, e.what());
601 if (content.empty ()) {
602 error_dialog (_parent, _("No content found in this folder."));
606 for (auto i: content) {
607 auto ic = dynamic_pointer_cast<ImageContent> (i);
609 auto e = new ImageSequenceDialog (_splitter);
610 int const r = e->ShowModal();
611 auto const frame_rate = e->frame_rate ();
618 ic->set_video_frame_rate (frame_rate);
621 _film->examine_and_add_content (i);
627 ContentPanel::add_dcp_clicked ()
629 auto d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
630 int r = d->ShowModal ();
631 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
643 ContentPanel::add_dcp(boost::filesystem::path dcp)
646 _film->examine_and_add_content(make_shared<DCPContent>(dcp));
647 } catch (ProjectFolderError &) {
651 "This looks like a DCP-o-matic project folder, which cannot be added to a different project. "
652 "Choose the DCP folder inside the DCP-o-matic project folder if that's what you want to import."
655 } catch (exception& e) {
656 error_dialog(_parent, e.what());
661 /** @return true if this remove "click" should be ignored */
663 ContentPanel::remove_clicked (bool hotkey)
665 /* If the method was called because Delete was pressed check that our notebook page
666 is visible and that the content list is focused.
668 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
672 for (auto i: selected ()) {
673 _film->remove_content (i);
682 ContentPanel::timeline_clicked ()
688 if (_timeline_dialog) {
689 _timeline_dialog->Destroy ();
690 _timeline_dialog = nullptr;
693 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
694 _timeline_dialog->set_selection (selected());
695 _timeline_dialog->Show ();
700 ContentPanel::right_click (wxListEvent& ev)
702 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
706 /** Set up broad sensitivity based on the type of content that is selected */
708 ContentPanel::setup_sensitivity ()
710 _add_file->Enable (_generally_sensitive);
711 _add_folder->Enable (_generally_sensitive);
712 _add_dcp->Enable (_generally_sensitive);
714 auto selection = selected ();
715 auto video_selection = selected_video ();
716 auto audio_selection = selected_audio ();
718 _remove->Enable (_generally_sensitive && !selection.empty());
719 _earlier->Enable (_generally_sensitive && selection.size() == 1);
720 _later->Enable (_generally_sensitive && selection.size() == 1);
721 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
724 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
727 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
729 for (auto text: _text_panel) {
731 text->Enable(_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
734 _timing_panel->Enable (_generally_sensitive);
739 ContentPanel::set_film (shared_ptr<Film> film)
742 _audio_panel->set_film (film);
747 film_changed (Film::Property::CONTENT);
748 film_changed (Film::Property::AUDIO_CHANNELS);
754 setup_sensitivity ();
759 ContentPanel::set_general_sensitivity (bool s)
761 _generally_sensitive = s;
762 setup_sensitivity ();
767 ContentPanel::earlier_clicked ()
769 auto sel = selected ();
770 if (sel.size() == 1) {
771 _film->move_content_earlier (sel.front ());
778 ContentPanel::later_clicked ()
780 auto sel = selected ();
781 if (sel.size() == 1) {
782 _film->move_content_later (sel.front ());
789 ContentPanel::set_selection (weak_ptr<Content> wc)
791 auto content = _film->content ();
792 for (size_t i = 0; i < content.size(); ++i) {
793 set_selected_state(i, content[i] == wc.lock());
799 ContentPanel::set_selection (ContentList cl)
801 _no_check_selection = true;
803 auto content = _film->content ();
804 for (size_t i = 0; i < content.size(); ++i) {
805 set_selected_state(i, find(cl.begin(), cl.end(), content[i]) != cl.end());
808 _no_check_selection = false;
814 ContentPanel::select_all ()
816 set_selection (_film->content());
821 ContentPanel::film_content_changed (int property)
824 property == ContentProperty::PATH ||
825 property == DCPContentProperty::NEEDS_ASSETS ||
826 property == DCPContentProperty::NEEDS_KDM ||
827 property == DCPContentProperty::NAME
833 for (auto i: panels()) {
834 i->film_content_changed (property);
840 ContentPanel::setup ()
843 _content->DeleteAllItems ();
844 setup_sensitivity ();
848 auto content = _film->content ();
850 Content* selected_content = nullptr;
851 auto const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
855 item.SetMask (wxLIST_MASK_DATA);
856 _content->GetItem (item);
857 selected_content = reinterpret_cast<Content*> (item.GetData ());
860 _content->DeleteAllItems ();
862 for (auto i: content) {
863 int const t = _content->GetItemCount ();
864 bool const valid = i->paths_valid ();
866 auto dcp = dynamic_pointer_cast<DCPContent> (i);
867 bool const needs_kdm = dcp && dcp->needs_kdm ();
868 bool const needs_assets = dcp && dcp->needs_assets ();
870 auto s = std_to_wx (i->summary ());
873 s = _("MISSING: ") + s;
877 s = _("NEEDS KDM: ") + s;
881 s = _("NEEDS OV: ") + s;
887 item.SetData (i.get ());
888 _content->InsertItem (item);
890 if (i.get() == selected_content) {
891 set_selected_state(t, true);
894 if (!valid || needs_kdm || needs_assets) {
895 _content->SetItemTextColour (t, *wxRED);
899 if (!selected_content && !content.empty ()) {
900 /* Select the item of content if none was selected before */
901 set_selected_state(0, true);
904 setup_sensitivity ();
909 ContentPanel::files_dropped (wxDropFilesEvent& event)
915 auto paths = event.GetFiles ();
916 vector<boost::filesystem::path> path_list;
917 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
918 path_list.push_back (wx_to_std(paths[i]));
921 add_files (path_list);
926 ContentPanel::add_files (vector<boost::filesystem::path> paths)
932 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
933 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
934 alphabetical sort is expected here.
937 std::sort (paths.begin(), paths.end(), CaseInsensitiveSorter());
939 /* XXX: check for lots of files here and do something */
942 for (auto i: paths) {
943 for (auto j: content_factory(i)) {
944 _film->examine_and_add_content (j);
947 } catch (exception& e) {
948 error_dialog (_parent, e.what());
953 list<ContentSubPanel*>
954 ContentPanel::panels () const
956 list<ContentSubPanel*> p;
958 p.push_back (_video_panel);
961 p.push_back (_audio_panel);
963 for (auto text: _text_panel) {
968 p.push_back (_timing_panel);
974 ContentPanel::set_selected_state(int item, bool state)
976 _content->SetItemState(item, state ? wxLIST_STATE_SELECTED : 0, wxLIST_STATE_SELECTED);
977 _content->SetItemState(item, state ? wxLIST_STATE_FOCUSED : 0, wxLIST_STATE_FOCUSED);
982 ContentPanel::window() const