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 _splitter = new LimitedSplitter (n);
84 _top_panel = new wxPanel (_splitter);
86 _menu = new ContentMenu (_splitter, _film_viewer);
89 auto s = new wxBoxSizer (wxHORIZONTAL);
91 _content = new wxListCtrl (_top_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
92 _content->DragAcceptFiles (true);
93 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
95 _content->InsertColumn (0, wxT(""));
96 _content->SetColumnWidth (0, 512);
98 auto b = new wxBoxSizer (wxVERTICAL);
100 _add_file = new Button (_top_panel, _("Add file(s)..."));
101 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
102 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
104 _add_folder = new Button (_top_panel, _("Add folder..."));
105 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
106 b->Add (_add_folder, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
108 _add_dcp = new Button (_top_panel, _("Add DCP..."));
109 _add_dcp->SetToolTip (_("Add a DCP."));
110 b->Add (_add_dcp, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
112 _remove = new Button (_top_panel, _("Remove"));
113 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
114 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
116 _earlier = new Button (_top_panel, _("Earlier"));
117 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
118 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
120 _later = new Button (_top_panel, _("Later"));
121 _later->SetToolTip (_("Move the selected piece of content later in the film."));
122 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
124 _timeline = new Button (_top_panel, _("Timeline..."));
125 _timeline->SetToolTip (_("Open the timeline for the film."));
126 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
128 s->Add (b, 0, wxALL, 4);
129 _top_panel->SetSizer (s);
132 _notebook = new wxNotebook (_splitter, wxID_ANY);
134 _timing_panel = new TimingPanel (this, _film_viewer);
135 _notebook->AddPage (_timing_panel, _("Timing"), false);
136 _timing_panel->create ();
138 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
139 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
140 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
141 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
142 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
143 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
144 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
145 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
146 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
147 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
148 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
153 ContentPanel::first_shown ()
155 _splitter->first_shown (_top_panel, _notebook);
160 ContentPanel::selected ()
165 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
170 auto cl = _film->content();
171 if (s < int (cl.size())) {
172 sel.push_back (cl[s]);
181 ContentPanel::selected_video ()
185 for (auto i: selected()) {
196 ContentPanel::selected_audio ()
200 for (auto i: selected()) {
211 ContentPanel::selected_text ()
215 for (auto i: selected()) {
216 if (!i->text.empty()) {
226 ContentPanel::selected_ffmpeg ()
228 FFmpegContentList sc;
230 for (auto i: selected()) {
231 auto t = dynamic_pointer_cast<FFmpegContent> (i);
242 ContentPanel::film_changed (Film::Property p)
245 case Film::Property::CONTENT:
246 case Film::Property::CONTENT_ORDER:
253 for (auto i: panels()) {
260 ContentPanel::item_deselected ()
262 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
263 false and item_deselected_foo will handle the deselection.
265 _ignore_deselect = false;
266 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
271 ContentPanel::item_deselected_idle ()
273 if (!_ignore_deselect) {
280 ContentPanel::item_selected ()
282 _ignore_deselect = true;
288 ContentPanel::check_selection ()
290 if (_no_check_selection) {
294 setup_sensitivity ();
296 for (auto i: panels()) {
297 i->content_selection_changed ();
300 optional<DCPTime> go_to;
301 for (auto content: selected()) {
302 if (content->paths_valid()) {
303 auto position = content->position();
304 if (auto text_content = dynamic_pointer_cast<StringTextFileContent>(content)) {
305 /* Rather special case; if we select a text subtitle file jump to its
308 StringTextFile ts(text_content);
309 if (auto first = ts.first()) {
310 position += DCPTime(first.get(), _film->active_frame_rate_change(content->position()));
312 } else if (auto dcp_content = dynamic_pointer_cast<DCPSubtitleContent>(content)) {
313 /* Do the same for DCP subtitles */
314 DCPSubtitleDecoder ts(_film, dcp_content);
315 if (auto first = ts.first()) {
316 position += DCPTime(first.get(), _film->active_frame_rate_change(content->position()));
319 if (!go_to || position < go_to.get()) {
325 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
326 auto fv = _film_viewer.lock ();
327 DCPOMATIC_ASSERT (fv);
328 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
331 if (_timeline_dialog) {
332 _timeline_dialog->set_selection (selected());
335 /* Make required tabs visible */
337 if (_notebook->GetPageCount() > 1) {
338 /* There's more than one tab in the notebook so the current selection could be meaningful
339 to the user; store it so that we can try to restore it later.
341 _last_selected_tab = 0;
342 if (_notebook->GetSelection() != wxNOT_FOUND) {
343 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
347 bool have_video = false;
348 bool have_audio = false;
349 EnumIndexedVector<bool, TextType> have_text;
350 for (auto i: selected()) {
357 for (auto j: i->text) {
358 have_text[static_cast<int>(j->original_type())] = true;
364 if (have_video && !_video_panel) {
365 _video_panel = new VideoPanel (this);
366 _notebook->InsertPage (off, _video_panel, _video_panel->name());
367 _video_panel->create ();
368 } else if (!have_video && _video_panel) {
369 _notebook->DeletePage (off);
377 if (have_audio && !_audio_panel) {
378 _audio_panel = new AudioPanel (this);
379 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
380 _audio_panel->create ();
381 } else if (!have_audio && _audio_panel) {
382 _notebook->DeletePage (off);
390 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
391 if (have_text[i] && !_text_panel[i]) {
392 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
393 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
394 _text_panel[i]->create ();
395 } else if (!have_text[i] && _text_panel[i]) {
396 _notebook->DeletePage (off);
397 _text_panel[i] = nullptr;
404 /* Set up the tab selection */
407 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
408 if (_notebook->GetPage(i) == _last_selected_tab) {
409 _notebook->SetSelection (i);
414 if (!done && _notebook->GetPageCount() > 0) {
415 _notebook->SetSelection (0);
418 setup_sensitivity ();
424 ContentPanel::add_file_clicked ()
426 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
429 if (_parent->GetCurrentPage() != _splitter || !_film) {
433 auto path = Config::instance()->add_files_path();
435 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
436 non-Latin filenames or paths.
438 auto d = new wxFileDialog (
440 _("Choose a file or files"),
441 std_to_wx(path ? path->string() : home_directory().string()),
443 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
444 wxFD_MULTIPLE | wxFD_CHANGE_DIR
447 int const r = d->ShowModal ();
456 vector<boost::filesystem::path> path_list;
457 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
458 path_list.push_back (wx_to_std(paths[i]));
460 add_files (path_list);
462 if (!path_list.empty()) {
463 Config::instance()->set_add_files_path(path_list[0].parent_path());
471 ContentPanel::add_folder_clicked ()
473 auto d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
474 int r = d->ShowModal ();
475 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
482 vector<shared_ptr<Content>> content;
485 content = content_factory (path);
486 } catch (exception& e) {
487 error_dialog (_parent, e.what());
491 if (content.empty ()) {
492 error_dialog (_parent, _("No content found in this folder."));
496 for (auto i: content) {
497 auto ic = dynamic_pointer_cast<ImageContent> (i);
499 auto e = new ImageSequenceDialog (_splitter);
501 auto const frame_rate = e->frame_rate ();
508 ic->set_video_frame_rate (frame_rate);
511 _film->examine_and_add_content (i);
517 ContentPanel::add_dcp_clicked ()
519 auto d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
520 int r = d->ShowModal ();
521 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
529 _film->examine_and_add_content (make_shared<DCPContent>(path));
530 } catch (ProjectFolderError &) {
534 "This looks like a DCP-o-matic project folder, which cannot be added to a different project. "
535 "Choose the DCP folder inside the DCP-o-matic project folder if that's what you want to import."
538 } catch (exception& e) {
539 error_dialog (_parent, e.what());
544 /** @return true if this remove "click" should be ignored */
546 ContentPanel::remove_clicked (bool hotkey)
548 /* If the method was called because Delete was pressed check that our notebook page
549 is visible and that the content list is focused.
551 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
555 for (auto i: selected ()) {
556 _film->remove_content (i);
565 ContentPanel::timeline_clicked ()
571 if (_timeline_dialog) {
572 _timeline_dialog->Destroy ();
573 _timeline_dialog = nullptr;
576 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
577 _timeline_dialog->set_selection (selected());
578 _timeline_dialog->Show ();
583 ContentPanel::right_click (wxListEvent& ev)
585 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
589 /** Set up broad sensitivity based on the type of content that is selected */
591 ContentPanel::setup_sensitivity ()
593 _add_file->Enable (_generally_sensitive);
594 _add_folder->Enable (_generally_sensitive);
595 _add_dcp->Enable (_generally_sensitive);
597 auto selection = selected ();
598 auto video_selection = selected_video ();
599 auto audio_selection = selected_audio ();
601 _remove->Enable (_generally_sensitive && !selection.empty());
602 _earlier->Enable (_generally_sensitive && selection.size() == 1);
603 _later->Enable (_generally_sensitive && selection.size() == 1);
604 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
607 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
610 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
612 for (auto text: _text_panel) {
614 text->Enable(_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
617 _timing_panel->Enable (_generally_sensitive);
622 ContentPanel::set_film (shared_ptr<Film> film)
625 _audio_panel->set_film (film);
630 film_changed (Film::Property::CONTENT);
631 film_changed (Film::Property::AUDIO_CHANNELS);
637 setup_sensitivity ();
642 ContentPanel::set_general_sensitivity (bool s)
644 _generally_sensitive = s;
645 setup_sensitivity ();
650 ContentPanel::earlier_clicked ()
652 auto sel = selected ();
653 if (sel.size() == 1) {
654 _film->move_content_earlier (sel.front ());
661 ContentPanel::later_clicked ()
663 auto sel = selected ();
664 if (sel.size() == 1) {
665 _film->move_content_later (sel.front ());
672 ContentPanel::set_selection (weak_ptr<Content> wc)
674 auto content = _film->content ();
675 for (size_t i = 0; i < content.size(); ++i) {
676 set_selected_state(i, content[i] == wc.lock());
682 ContentPanel::set_selection (ContentList cl)
684 _no_check_selection = true;
686 auto content = _film->content ();
687 for (size_t i = 0; i < content.size(); ++i) {
688 set_selected_state(i, find(cl.begin(), cl.end(), content[i]) != cl.end());
691 _no_check_selection = false;
697 ContentPanel::select_all ()
699 set_selection (_film->content());
704 ContentPanel::film_content_changed (int property)
707 property == ContentProperty::PATH ||
708 property == DCPContentProperty::NEEDS_ASSETS ||
709 property == DCPContentProperty::NEEDS_KDM ||
710 property == DCPContentProperty::NAME
716 for (auto i: panels()) {
717 i->film_content_changed (property);
723 ContentPanel::setup ()
726 _content->DeleteAllItems ();
727 setup_sensitivity ();
731 auto content = _film->content ();
733 Content* selected_content = nullptr;
734 auto const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
738 item.SetMask (wxLIST_MASK_DATA);
739 _content->GetItem (item);
740 selected_content = reinterpret_cast<Content*> (item.GetData ());
743 _content->DeleteAllItems ();
745 for (auto i: content) {
746 int const t = _content->GetItemCount ();
747 bool const valid = i->paths_valid ();
749 auto dcp = dynamic_pointer_cast<DCPContent> (i);
750 bool const needs_kdm = dcp && dcp->needs_kdm ();
751 bool const needs_assets = dcp && dcp->needs_assets ();
753 auto s = std_to_wx (i->summary ());
756 s = _("MISSING: ") + s;
760 s = _("NEEDS KDM: ") + s;
764 s = _("NEEDS OV: ") + s;
770 item.SetData (i.get ());
771 _content->InsertItem (item);
773 if (i.get() == selected_content) {
774 set_selected_state(t, true);
777 if (!valid || needs_kdm || needs_assets) {
778 _content->SetItemTextColour (t, *wxRED);
782 if (!selected_content && !content.empty ()) {
783 /* Select the item of content if none was selected before */
784 set_selected_state(0, true);
787 setup_sensitivity ();
792 ContentPanel::files_dropped (wxDropFilesEvent& event)
798 auto paths = event.GetFiles ();
799 vector<boost::filesystem::path> path_list;
800 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
801 path_list.push_back (wx_to_std(paths[i]));
804 add_files (path_list);
809 ContentPanel::add_files (vector<boost::filesystem::path> paths)
811 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
812 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
813 alphabetical sort is expected here.
816 std::sort (paths.begin(), paths.end(), CaseInsensitiveSorter());
818 /* XXX: check for lots of files here and do something */
821 for (auto i: paths) {
822 for (auto j: content_factory(i)) {
823 _film->examine_and_add_content (j);
826 } catch (exception& e) {
827 error_dialog (_parent, e.what());
832 list<ContentSubPanel*>
833 ContentPanel::panels () const
835 list<ContentSubPanel*> p;
837 p.push_back (_video_panel);
840 p.push_back (_audio_panel);
842 for (auto text: _text_panel) {
847 p.push_back (_timing_panel);
853 ContentPanel::set_selected_state(int item, bool state)
855 _content->SetItemState(item, state ? wxLIST_STATE_SELECTED : 0, wxLIST_STATE_SELECTED);
856 _content->SetItemState(item, state ? wxLIST_STATE_FOCUSED : 0, wxLIST_STATE_FOCUSED);
860 LimitedSplitter::LimitedSplitter (wxWindow* parent)
861 : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
862 , _first_shown (false)
863 , _top_panel_minimum_size (350)
865 /* This value doesn't really mean much but we just want to stop double-click on the
866 divider from shrinking the bottom panel (#1601).
868 SetMinimumPaneSize (64);
870 Bind (wxEVT_SIZE, boost::bind(&LimitedSplitter::sized, this, _1));
875 LimitedSplitter::first_shown (wxWindow* top, wxWindow* bottom)
877 int const sn = wxDisplay::GetFromWindow(this);
879 wxRect const screen = wxDisplay(sn).GetClientArea();
880 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
881 enough on small displays to leave space for the content area.
883 SplitHorizontally (top, bottom, screen.height > 800 ? -600 : -_top_panel_minimum_size);
885 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
886 SplitHorizontally (top, bottom, -600);
893 LimitedSplitter::sized (wxSizeEvent& ev)
895 if (_first_shown && GetSize().GetHeight() > _top_panel_minimum_size && GetSashPosition() < _top_panel_minimum_size) {
896 /* The window is now fairly big but the top panel is small; this happens when the DCP-o-matic window
897 * is shrunk and then made larger again. Try to set a sensible top panel size in this case (#1839).
899 SetSashPosition (_top_panel_minimum_size);