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>
53 #include <wx/listctrl.h>
54 #include <wx/notebook.h>
56 LIBDCP_ENABLE_WARNINGS
57 #include <boost/filesystem.hpp>
60 using std::dynamic_pointer_cast;
63 using std::make_shared;
64 using std::shared_ptr;
68 using boost::optional;
69 using namespace dcpomatic;
70 #if BOOST_VERSION >= 106100
71 using namespace boost::placeholders;
75 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
78 , _film_viewer (viewer)
79 , _generally_sensitive (true)
80 , _ignore_deselect (false)
81 , _no_check_selection (false)
83 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
87 _splitter = new LimitedSplitter (n);
88 _top_panel = new wxPanel (_splitter);
90 _menu = new ContentMenu (_splitter, _film_viewer);
93 auto s = new wxBoxSizer (wxHORIZONTAL);
95 _content = new wxListCtrl (_top_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
96 _content->DragAcceptFiles (true);
97 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
99 _content->InsertColumn (0, wxT(""));
100 _content->SetColumnWidth (0, 512);
102 auto b = new wxBoxSizer (wxVERTICAL);
104 _add_file = new Button (_top_panel, _("Add file(s)..."));
105 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
106 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
108 _add_folder = new Button (_top_panel, _("Add folder..."));
109 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
110 b->Add (_add_folder, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
112 _add_dcp = new Button (_top_panel, _("Add DCP..."));
113 _add_dcp->SetToolTip (_("Add a DCP."));
114 b->Add (_add_dcp, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
116 _remove = new Button (_top_panel, _("Remove"));
117 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
118 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
120 _earlier = new Button (_top_panel, _("Earlier"));
121 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
122 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
124 _later = new Button (_top_panel, _("Later"));
125 _later->SetToolTip (_("Move the selected piece of content later in the film."));
126 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
128 _timeline = new Button (_top_panel, _("Timeline..."));
129 _timeline->SetToolTip (_("Open the timeline for the film."));
130 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
132 s->Add (b, 0, wxALL, 4);
133 _top_panel->SetSizer (s);
136 _notebook = new wxNotebook (_splitter, wxID_ANY);
138 _timing_panel = new TimingPanel (this, _film_viewer);
139 _notebook->AddPage (_timing_panel, _("Timing"), false);
140 _timing_panel->create ();
142 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
143 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
144 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
145 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
146 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
147 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
148 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
149 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
150 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
151 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
152 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
157 ContentPanel::first_shown ()
159 _splitter->first_shown (_top_panel, _notebook);
164 ContentPanel::selected ()
169 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
174 auto cl = _film->content();
175 if (s < int (cl.size())) {
176 sel.push_back (cl[s]);
185 ContentPanel::selected_video ()
189 for (auto i: selected()) {
200 ContentPanel::selected_audio ()
204 for (auto i: selected()) {
215 ContentPanel::selected_text ()
219 for (auto i: selected()) {
220 if (!i->text.empty()) {
230 ContentPanel::selected_ffmpeg ()
232 FFmpegContentList sc;
234 for (auto i: selected()) {
235 auto t = dynamic_pointer_cast<FFmpegContent> (i);
246 ContentPanel::film_changed (Film::Property p)
249 case Film::Property::CONTENT:
250 case Film::Property::CONTENT_ORDER:
257 for (auto i: panels()) {
264 ContentPanel::item_deselected ()
266 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
267 false and item_deselected_foo will handle the deselection.
269 _ignore_deselect = false;
270 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
275 ContentPanel::item_deselected_idle ()
277 if (!_ignore_deselect) {
284 ContentPanel::item_selected ()
286 _ignore_deselect = true;
292 ContentPanel::check_selection ()
294 if (_no_check_selection) {
298 setup_sensitivity ();
300 for (auto i: panels()) {
301 i->content_selection_changed ();
304 optional<DCPTime> go_to;
305 for (auto content: selected()) {
306 if (content->paths_valid()) {
307 auto position = content->position();
308 if (auto text_content = dynamic_pointer_cast<StringTextFileContent>(content)) {
309 /* Rather special case; if we select a text subtitle file jump to its
312 StringTextFile ts(text_content);
313 if (auto first = ts.first()) {
314 position += DCPTime(first.get(), _film->active_frame_rate_change(content->position()));
316 } else if (auto dcp_content = dynamic_pointer_cast<DCPSubtitleContent>(content)) {
317 /* Do the same for DCP subtitles */
318 DCPSubtitleDecoder ts(_film, dcp_content);
319 if (auto first = ts.first()) {
320 position += DCPTime(first.get(), _film->active_frame_rate_change(content->position()));
323 if (!go_to || position < go_to.get()) {
329 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
330 auto fv = _film_viewer.lock ();
331 DCPOMATIC_ASSERT (fv);
332 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
335 if (_timeline_dialog) {
336 _timeline_dialog->set_selection (selected());
339 /* Make required tabs visible */
341 if (_notebook->GetPageCount() > 1) {
342 /* There's more than one tab in the notebook so the current selection could be meaningful
343 to the user; store it so that we can try to restore it later.
345 _last_selected_tab = 0;
346 if (_notebook->GetSelection() != wxNOT_FOUND) {
347 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
351 bool have_video = false;
352 bool have_audio = false;
353 bool have_text[static_cast<int>(TextType::COUNT)] = { false, false };
354 for (auto i: selected()) {
361 for (auto j: i->text) {
362 have_text[static_cast<int>(j->original_type())] = true;
368 if (have_video && !_video_panel) {
369 _video_panel = new VideoPanel (this);
370 _notebook->InsertPage (off, _video_panel, _video_panel->name());
371 _video_panel->create ();
372 } else if (!have_video && _video_panel) {
373 _notebook->DeletePage (off);
381 if (have_audio && !_audio_panel) {
382 _audio_panel = new AudioPanel (this);
383 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
384 _audio_panel->create ();
385 } else if (!have_audio && _audio_panel) {
386 _notebook->DeletePage (off);
394 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
395 if (have_text[i] && !_text_panel[i]) {
396 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
397 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
398 _text_panel[i]->create ();
399 } else if (!have_text[i] && _text_panel[i]) {
400 _notebook->DeletePage (off);
408 /* Set up the tab selection */
411 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
412 if (_notebook->GetPage(i) == _last_selected_tab) {
413 _notebook->SetSelection (i);
418 if (!done && _notebook->GetPageCount() > 0) {
419 _notebook->SetSelection (0);
422 setup_sensitivity ();
428 ContentPanel::add_file_clicked ()
430 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
433 if (_parent->GetCurrentPage() != _splitter || !_film) {
437 auto path = Config::instance()->add_files_path();
439 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
440 non-Latin filenames or paths.
442 auto d = new wxFileDialog (
444 _("Choose a file or files"),
445 std_to_wx(path ? path->string() : home_directory().string()),
447 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
448 wxFD_MULTIPLE | wxFD_CHANGE_DIR
451 int const r = d->ShowModal ();
460 vector<boost::filesystem::path> path_list;
461 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
462 path_list.push_back (wx_to_std(paths[i]));
464 add_files (path_list);
466 if (!path_list.empty()) {
467 Config::instance()->set_add_files_path(path_list[0].parent_path());
475 ContentPanel::add_folder_clicked ()
477 auto d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
478 int r = d->ShowModal ();
479 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
486 list<shared_ptr<Content> > content;
489 content = content_factory (path);
490 } catch (exception& e) {
491 error_dialog (_parent, e.what());
495 if (content.empty ()) {
496 error_dialog (_parent, _("No content found in this folder."));
500 for (auto i: content) {
501 auto ic = dynamic_pointer_cast<ImageContent> (i);
503 auto e = new ImageSequenceDialog (_splitter);
505 auto const frame_rate = e->frame_rate ();
512 ic->set_video_frame_rate (frame_rate);
515 _film->examine_and_add_content (i);
521 ContentPanel::add_dcp_clicked ()
523 auto d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
524 int r = d->ShowModal ();
525 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
533 _film->examine_and_add_content (make_shared<DCPContent>(path));
534 } catch (ProjectFolderError &) {
538 "This looks like a DCP-o-matic project folder, which cannot be added to a different project. "
539 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to import."
542 } catch (exception& e) {
543 error_dialog (_parent, e.what());
548 /** @return true if this remove "click" should be ignored */
550 ContentPanel::remove_clicked (bool hotkey)
552 /* If the method was called because Delete was pressed check that our notebook page
553 is visible and that the content list is focussed.
555 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
559 for (auto i: selected ()) {
560 _film->remove_content (i);
569 ContentPanel::timeline_clicked ()
575 if (_timeline_dialog) {
576 _timeline_dialog->Destroy ();
577 _timeline_dialog = nullptr;
580 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
581 _timeline_dialog->set_selection (selected());
582 _timeline_dialog->Show ();
587 ContentPanel::right_click (wxListEvent& ev)
589 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
593 /** Set up broad sensitivity based on the type of content that is selected */
595 ContentPanel::setup_sensitivity ()
597 _add_file->Enable (_generally_sensitive);
598 _add_folder->Enable (_generally_sensitive);
599 _add_dcp->Enable (_generally_sensitive);
601 auto selection = selected ();
602 auto video_selection = selected_video ();
603 auto audio_selection = selected_audio ();
605 _remove->Enable (_generally_sensitive && !selection.empty());
606 _earlier->Enable (_generally_sensitive && selection.size() == 1);
607 _later->Enable (_generally_sensitive && selection.size() == 1);
608 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
611 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
614 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
616 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
617 if (_text_panel[i]) {
618 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
621 _timing_panel->Enable (_generally_sensitive);
626 ContentPanel::set_film (shared_ptr<Film> film)
629 _audio_panel->set_film (film);
634 film_changed (Film::Property::CONTENT);
635 film_changed (Film::Property::AUDIO_CHANNELS);
641 setup_sensitivity ();
646 ContentPanel::set_general_sensitivity (bool s)
648 _generally_sensitive = s;
649 setup_sensitivity ();
654 ContentPanel::earlier_clicked ()
656 auto sel = selected ();
657 if (sel.size() == 1) {
658 _film->move_content_earlier (sel.front ());
665 ContentPanel::later_clicked ()
667 auto sel = selected ();
668 if (sel.size() == 1) {
669 _film->move_content_later (sel.front ());
676 ContentPanel::set_selection (weak_ptr<Content> wc)
678 auto content = _film->content ();
679 for (size_t i = 0; i < content.size(); ++i) {
680 set_selected_state(i, content[i] == wc.lock());
686 ContentPanel::set_selection (ContentList cl)
688 _no_check_selection = true;
690 auto content = _film->content ();
691 for (size_t i = 0; i < content.size(); ++i) {
692 set_selected_state(i, find(cl.begin(), cl.end(), content[i]) != cl.end());
695 _no_check_selection = false;
701 ContentPanel::select_all ()
703 set_selection (_film->content());
708 ContentPanel::film_content_changed (int property)
711 property == ContentProperty::PATH ||
712 property == DCPContentProperty::NEEDS_ASSETS ||
713 property == DCPContentProperty::NEEDS_KDM ||
714 property == DCPContentProperty::NAME
720 for (auto i: panels()) {
721 i->film_content_changed (property);
727 ContentPanel::setup ()
730 _content->DeleteAllItems ();
731 setup_sensitivity ();
735 auto content = _film->content ();
737 Content* selected_content = nullptr;
738 auto const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
742 item.SetMask (wxLIST_MASK_DATA);
743 _content->GetItem (item);
744 selected_content = reinterpret_cast<Content*> (item.GetData ());
747 _content->DeleteAllItems ();
749 for (auto i: content) {
750 int const t = _content->GetItemCount ();
751 bool const valid = i->paths_valid ();
753 auto dcp = dynamic_pointer_cast<DCPContent> (i);
754 bool const needs_kdm = dcp && dcp->needs_kdm ();
755 bool const needs_assets = dcp && dcp->needs_assets ();
757 auto s = std_to_wx (i->summary ());
760 s = _("MISSING: ") + s;
764 s = _("NEEDS KDM: ") + s;
768 s = _("NEEDS OV: ") + s;
774 item.SetData (i.get ());
775 _content->InsertItem (item);
777 if (i.get() == selected_content) {
778 set_selected_state(t, true);
781 if (!valid || needs_kdm || needs_assets) {
782 _content->SetItemTextColour (t, *wxRED);
786 if (!selected_content && !content.empty ()) {
787 /* Select the item of content if none was selected before */
788 set_selected_state(0, true);
791 setup_sensitivity ();
796 ContentPanel::files_dropped (wxDropFilesEvent& event)
802 auto paths = event.GetFiles ();
803 vector<boost::filesystem::path> path_list;
804 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
805 path_list.push_back (wx_to_std(paths[i]));
808 add_files (path_list);
813 ContentPanel::add_files (vector<boost::filesystem::path> paths)
815 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
816 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
817 alphabetical sort is expected here.
820 std::sort (paths.begin(), paths.end(), CaseInsensitiveSorter());
822 /* XXX: check for lots of files here and do something */
825 for (auto i: paths) {
826 for (auto j: content_factory(i)) {
827 _film->examine_and_add_content (j);
830 } catch (exception& e) {
831 error_dialog (_parent, e.what());
836 list<ContentSubPanel*>
837 ContentPanel::panels () const
839 list<ContentSubPanel*> p;
841 p.push_back (_video_panel);
844 p.push_back (_audio_panel);
846 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
847 if (_text_panel[i]) {
848 p.push_back (_text_panel[i]);
851 p.push_back (_timing_panel);
857 ContentPanel::set_selected_state(int item, bool state)
859 _content->SetItemState(item, state ? wxLIST_STATE_SELECTED : 0, wxLIST_STATE_SELECTED);
860 _content->SetItemState(item, state ? wxLIST_STATE_FOCUSED : 0, wxLIST_STATE_FOCUSED);
864 LimitedSplitter::LimitedSplitter (wxWindow* parent)
865 : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
866 , _first_shown (false)
867 , _top_panel_minimum_size (350)
869 /* This value doesn't really mean much but we just want to stop double-click on the
870 divider from shrinking the bottom panel (#1601).
872 SetMinimumPaneSize (64);
874 Bind (wxEVT_SIZE, boost::bind(&LimitedSplitter::sized, this, _1));
879 LimitedSplitter::first_shown (wxWindow* top, wxWindow* bottom)
881 int const sn = wxDisplay::GetFromWindow(this);
883 wxRect const screen = wxDisplay(sn).GetClientArea();
884 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
885 enough on small displays to leave space for the content area.
887 SplitHorizontally (top, bottom, screen.height > 800 ? -600 : -_top_panel_minimum_size);
889 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
890 SplitHorizontally (top, bottom, -600);
897 LimitedSplitter::sized (wxSizeEvent& ev)
899 if (_first_shown && GetSize().GetHeight() > _top_panel_minimum_size && GetSashPosition() < _top_panel_minimum_size) {
900 /* The window is now fairly big but the top panel is small; this happens when the DCP-o-matic window
901 * is shrunk and then made larger again. Try to set a sensible top panel size in this case (#1839).
903 SetSashPosition (_top_panel_minimum_size);