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/dcpomatic_log.h"
40 #include "lib/ffmpeg_content.h"
41 #include "lib/image_content.h"
43 #include "lib/playlist.h"
44 #include "lib/string_text_file.h"
45 #include "lib/string_text_file_content.h"
46 #include "lib/text_content.h"
47 #include "lib/video_content.h"
48 #include "lib/warnings.h"
49 DCPOMATIC_DISABLE_WARNINGS
50 #include <wx/display.h>
51 #include <wx/listctrl.h>
52 #include <wx/notebook.h>
54 DCPOMATIC_ENABLE_WARNINGS
55 #include <boost/filesystem.hpp>
58 using std::dynamic_pointer_cast;
61 using std::make_shared;
62 using std::shared_ptr;
66 using boost::optional;
67 using namespace dcpomatic;
68 #if BOOST_VERSION >= 106100
69 using namespace boost::placeholders;
73 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
76 , _film_viewer (viewer)
77 , _generally_sensitive (true)
78 , _ignore_deselect (false)
79 , _no_check_selection (false)
81 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
85 _splitter = new LimitedSplitter (n);
86 _top_panel = new wxPanel (_splitter);
88 _menu = new ContentMenu (_splitter);
91 auto s = new wxBoxSizer (wxHORIZONTAL);
93 _content = new wxListCtrl (_top_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
94 _content->DragAcceptFiles (true);
95 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
97 _content->InsertColumn (0, wxT(""));
98 _content->SetColumnWidth (0, 512);
100 auto b = new wxBoxSizer (wxVERTICAL);
102 _add_file = new Button (_top_panel, _("Add file(s)..."));
103 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
104 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
106 _add_folder = new Button (_top_panel, _("Add folder..."));
107 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
108 b->Add (_add_folder, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
110 _add_dcp = new Button (_top_panel, _("Add DCP..."));
111 _add_dcp->SetToolTip (_("Add a DCP."));
112 b->Add (_add_dcp, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
114 _remove = new Button (_top_panel, _("Remove"));
115 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
116 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
118 _earlier = new Button (_top_panel, _("Earlier"));
119 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
120 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
122 _later = new Button (_top_panel, _("Later"));
123 _later->SetToolTip (_("Move the selected piece of content later in the film."));
124 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
126 _timeline = new Button (_top_panel, _("Timeline..."));
127 _timeline->SetToolTip (_("Open the timeline for the film."));
128 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
130 s->Add (b, 0, wxALL, 4);
131 _top_panel->SetSizer (s);
134 _notebook = new wxNotebook (_splitter, wxID_ANY);
136 _timing_panel = new TimingPanel (this, _film_viewer);
137 _notebook->AddPage (_timing_panel, _("Timing"), false);
138 _timing_panel->create ();
140 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
141 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
142 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
143 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
144 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
145 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
146 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
147 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
148 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
149 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
150 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
155 ContentPanel::first_shown ()
157 _splitter->first_shown (_top_panel, _notebook);
162 ContentPanel::selected ()
167 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
172 auto cl = _film->content();
173 if (s < int (cl.size())) {
174 sel.push_back (cl[s]);
183 ContentPanel::selected_video ()
187 for (auto i: selected()) {
198 ContentPanel::selected_audio ()
202 for (auto i: selected()) {
213 ContentPanel::selected_text ()
217 for (auto i: selected()) {
218 if (!i->text.empty()) {
228 ContentPanel::selected_ffmpeg ()
230 FFmpegContentList sc;
232 for (auto i: selected()) {
233 auto t = dynamic_pointer_cast<FFmpegContent> (i);
244 ContentPanel::film_changed (Film::Property p)
247 case Film::Property::CONTENT:
248 case Film::Property::CONTENT_ORDER:
255 for (auto i: panels()) {
262 ContentPanel::item_deselected ()
264 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
265 false and item_deselected_foo will handle the deselection.
267 _ignore_deselect = false;
268 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
273 ContentPanel::item_deselected_idle ()
275 if (!_ignore_deselect) {
282 ContentPanel::item_selected ()
284 _ignore_deselect = true;
290 ContentPanel::check_selection ()
292 if (_no_check_selection) {
296 setup_sensitivity ();
298 for (auto i: panels()) {
299 i->content_selection_changed ();
302 optional<DCPTime> go_to;
303 for (auto i: selected()) {
306 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
307 /* Rather special case; if we select a text subtitle file jump to its
310 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
312 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
315 if (!go_to || p < go_to.get()) {
320 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
321 auto fv = _film_viewer.lock ();
322 DCPOMATIC_ASSERT (fv);
323 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
326 if (_timeline_dialog) {
327 _timeline_dialog->set_selection (selected());
330 /* Make required tabs visible */
332 if (_notebook->GetPageCount() > 1) {
333 /* There's more than one tab in the notebook so the current selection could be meaningful
334 to the user; store it so that we can try to restore it later.
336 _last_selected_tab = 0;
337 if (_notebook->GetSelection() != wxNOT_FOUND) {
338 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
342 bool have_video = false;
343 bool have_audio = false;
344 bool have_text[static_cast<int>(TextType::COUNT)] = { false, false };
345 for (auto i: selected()) {
352 for (auto j: i->text) {
353 have_text[static_cast<int>(j->original_type())] = true;
359 if (have_video && !_video_panel) {
360 _video_panel = new VideoPanel (this);
361 _notebook->InsertPage (off, _video_panel, _video_panel->name());
362 _video_panel->create ();
363 } else if (!have_video && _video_panel) {
364 _notebook->DeletePage (off);
372 if (have_audio && !_audio_panel) {
373 _audio_panel = new AudioPanel (this);
374 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
375 _audio_panel->create ();
376 } else if (!have_audio && _audio_panel) {
377 _notebook->DeletePage (off);
385 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
386 if (have_text[i] && !_text_panel[i]) {
387 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
388 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
389 _text_panel[i]->create ();
390 } else if (!have_text[i] && _text_panel[i]) {
391 _notebook->DeletePage (off);
399 /* Set up the tab selection */
402 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
403 if (_notebook->GetPage(i) == _last_selected_tab) {
404 _notebook->SetSelection (i);
409 if (!done && _notebook->GetPageCount() > 0) {
410 _notebook->SetSelection (0);
413 setup_sensitivity ();
419 ContentPanel::add_file_clicked ()
421 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
424 if (_parent->GetCurrentPage() != _splitter || !_film) {
428 auto path = Config::instance()->add_files_path();
430 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
431 non-Latin filenames or paths.
433 auto d = new wxFileDialog (
435 _("Choose a file or files"),
436 std_to_wx(path ? path->string() : home_directory().string()),
438 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
439 wxFD_MULTIPLE | wxFD_CHANGE_DIR
442 int const r = d->ShowModal ();
451 vector<boost::filesystem::path> path_list;
452 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
453 path_list.push_back (wx_to_std(paths[i]));
455 add_files (path_list);
457 if (!path_list.empty()) {
458 Config::instance()->set_add_files_path(path_list[0].parent_path());
466 ContentPanel::add_folder_clicked ()
468 auto d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
469 int r = d->ShowModal ();
470 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
477 list<shared_ptr<Content> > content;
480 content = content_factory (path);
481 } catch (exception& e) {
482 error_dialog (_parent, e.what());
486 if (content.empty ()) {
487 error_dialog (_parent, _("No content found in this folder."));
491 for (auto i: content) {
492 auto ic = dynamic_pointer_cast<ImageContent> (i);
494 auto e = new ImageSequenceDialog (_splitter);
496 auto const frame_rate = e->frame_rate ();
503 ic->set_video_frame_rate (frame_rate);
506 _film->examine_and_add_content (i);
512 ContentPanel::add_dcp_clicked ()
514 auto d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
515 int r = d->ShowModal ();
516 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
524 _film->examine_and_add_content (make_shared<DCPContent>(path));
525 } catch (ProjectFolderError &) {
529 "This looks like a DCP-o-matic project folder, which cannot be added to a different project. "
530 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to import."
533 } catch (exception& e) {
534 error_dialog (_parent, e.what());
539 /** @return true if this remove "click" should be ignored */
541 ContentPanel::remove_clicked (bool hotkey)
543 /* If the method was called because Delete was pressed check that our notebook page
544 is visible and that the content list is focussed.
546 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
550 for (auto i: selected ()) {
551 _film->remove_content (i);
560 ContentPanel::timeline_clicked ()
566 if (_timeline_dialog) {
567 _timeline_dialog->Destroy ();
568 _timeline_dialog = nullptr;
571 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
572 _timeline_dialog->set_selection (selected());
573 _timeline_dialog->Show ();
578 ContentPanel::right_click (wxListEvent& ev)
580 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
584 /** Set up broad sensitivity based on the type of content that is selected */
586 ContentPanel::setup_sensitivity ()
588 _add_file->Enable (_generally_sensitive);
589 _add_folder->Enable (_generally_sensitive);
590 _add_dcp->Enable (_generally_sensitive);
592 auto selection = selected ();
593 auto video_selection = selected_video ();
594 auto audio_selection = selected_audio ();
596 _remove->Enable (_generally_sensitive && !selection.empty());
597 _earlier->Enable (_generally_sensitive && selection.size() == 1);
598 _later->Enable (_generally_sensitive && selection.size() == 1);
599 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
602 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
605 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
607 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
608 if (_text_panel[i]) {
609 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
612 _timing_panel->Enable (_generally_sensitive);
617 ContentPanel::set_film (shared_ptr<Film> film)
620 _audio_panel->set_film (film);
625 film_changed (Film::Property::CONTENT);
626 film_changed (Film::Property::AUDIO_CHANNELS);
632 setup_sensitivity ();
637 ContentPanel::set_general_sensitivity (bool s)
639 _generally_sensitive = s;
640 setup_sensitivity ();
645 ContentPanel::earlier_clicked ()
647 auto sel = selected ();
648 if (sel.size() == 1) {
649 _film->move_content_earlier (sel.front ());
656 ContentPanel::later_clicked ()
658 auto sel = selected ();
659 if (sel.size() == 1) {
660 _film->move_content_later (sel.front ());
667 ContentPanel::set_selection (weak_ptr<Content> wc)
669 auto content = _film->content ();
670 for (size_t i = 0; i < content.size(); ++i) {
671 if (content[i] == wc.lock ()) {
672 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
674 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
681 ContentPanel::set_selection (ContentList cl)
683 _no_check_selection = true;
685 auto content = _film->content ();
686 for (size_t i = 0; i < content.size(); ++i) {
687 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
688 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
690 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
694 _no_check_selection = false;
700 ContentPanel::select_all ()
702 set_selection (_film->content());
707 ContentPanel::film_content_changed (int property)
710 property == ContentProperty::PATH ||
711 property == DCPContentProperty::NEEDS_ASSETS ||
712 property == DCPContentProperty::NEEDS_KDM ||
713 property == DCPContentProperty::NAME
719 for (auto i: panels()) {
720 i->film_content_changed (property);
726 ContentPanel::setup ()
729 _content->DeleteAllItems ();
730 setup_sensitivity ();
734 auto content = _film->content ();
736 Content* selected_content = nullptr;
737 auto const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
741 item.SetMask (wxLIST_MASK_DATA);
742 _content->GetItem (item);
743 selected_content = reinterpret_cast<Content*> (item.GetData ());
746 _content->DeleteAllItems ();
748 for (auto i: content) {
749 int const t = _content->GetItemCount ();
750 bool const valid = i->paths_valid ();
752 auto dcp = dynamic_pointer_cast<DCPContent> (i);
753 bool const needs_kdm = dcp && dcp->needs_kdm ();
754 bool const needs_assets = dcp && dcp->needs_assets ();
756 auto s = std_to_wx (i->summary ());
759 s = _("MISSING: ") + s;
763 s = _("NEEDS KDM: ") + s;
767 s = _("NEEDS OV: ") + s;
773 item.SetData (i.get ());
774 _content->InsertItem (item);
776 if (i.get() == selected_content) {
777 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
780 if (!valid || needs_kdm || needs_assets) {
781 _content->SetItemTextColour (t, *wxRED);
785 if (!selected_content && !content.empty ()) {
786 /* Select the item of content if none was selected before */
787 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
790 setup_sensitivity ();
795 ContentPanel::files_dropped (wxDropFilesEvent& event)
801 auto paths = event.GetFiles ();
802 vector<boost::filesystem::path> path_list;
803 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
804 path_list.push_back (wx_to_std(paths[i]));
807 add_files (path_list);
812 ContentPanel::add_files (vector<boost::filesystem::path> paths)
814 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
815 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
816 alphabetical sort is expected here.
819 std::sort (paths.begin(), paths.end(), CaseInsensitiveSorter());
821 /* XXX: check for lots of files here and do something */
824 for (auto i: paths) {
825 for (auto j: content_factory(i)) {
826 _film->examine_and_add_content (j);
829 } catch (exception& e) {
830 error_dialog (_parent, e.what());
835 list<ContentSubPanel*>
836 ContentPanel::panels () const
838 list<ContentSubPanel*> p;
840 p.push_back (_video_panel);
843 p.push_back (_audio_panel);
845 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
846 if (_text_panel[i]) {
847 p.push_back (_text_panel[i]);
850 p.push_back (_timing_panel);
855 LimitedSplitter::LimitedSplitter (wxWindow* parent)
856 : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
857 , _first_shown (false)
858 , _top_panel_minimum_size (350)
860 /* This value doesn't really mean much but we just want to stop double-click on the
861 divider from shrinking the bottom panel (#1601).
863 SetMinimumPaneSize (64);
865 Bind (wxEVT_SIZE, boost::bind(&LimitedSplitter::sized, this, _1));
870 LimitedSplitter::first_shown (wxWindow* top, wxWindow* bottom)
872 int const sn = wxDisplay::GetFromWindow(this);
874 wxRect const screen = wxDisplay(sn).GetClientArea();
875 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
876 enough on small displays to leave space for the content area.
878 SplitHorizontally (top, bottom, screen.height > 800 ? -600 : -_top_panel_minimum_size);
880 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
881 SplitHorizontally (top, bottom, -600);
888 LimitedSplitter::sized (wxSizeEvent& ev)
890 if (_first_shown && GetSize().GetHeight() > _top_panel_minimum_size && GetSashPosition() < _top_panel_minimum_size) {
891 /* The window is now fairly big but the top panel is small; this happens when the DCP-o-matic window
892 * is shrunk and then made larger again. Try to set a sensible top panel size in this case (#1839).
894 SetSashPosition (_top_panel_minimum_size);