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"
49 #include <wx/notebook.h>
50 #include <wx/listctrl.h>
51 #include <wx/display.h>
52 #include <boost/filesystem.hpp>
57 using std::dynamic_pointer_cast;
60 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, 1, 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, 1, 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);
139 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
140 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
141 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
142 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
143 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
144 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
145 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
146 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
147 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
148 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
149 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
154 ContentPanel::first_shown ()
156 _splitter->first_shown (_top_panel, _notebook);
161 ContentPanel::selected ()
166 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
171 auto cl = _film->content();
172 if (s < int (cl.size())) {
173 sel.push_back (cl[s]);
182 ContentPanel::selected_video ()
186 for (auto i: selected()) {
197 ContentPanel::selected_audio ()
201 for (auto i: selected()) {
212 ContentPanel::selected_text ()
216 for (auto i: selected()) {
217 if (!i->text.empty()) {
227 ContentPanel::selected_ffmpeg ()
229 FFmpegContentList sc;
231 for (auto i: selected()) {
232 auto t = dynamic_pointer_cast<FFmpegContent> (i);
243 ContentPanel::film_changed (Film::Property p)
246 case Film::Property::CONTENT:
247 case Film::Property::CONTENT_ORDER:
254 for (auto i: panels()) {
261 ContentPanel::item_deselected ()
263 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
264 false and item_deselected_foo will handle the deselection.
266 _ignore_deselect = false;
267 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
272 ContentPanel::item_deselected_idle ()
274 if (!_ignore_deselect) {
281 ContentPanel::item_selected ()
283 _ignore_deselect = true;
289 ContentPanel::check_selection ()
291 if (_no_check_selection) {
295 setup_sensitivity ();
297 for (auto i: panels()) {
298 i->content_selection_changed ();
301 optional<DCPTime> go_to;
302 for (auto i: selected()) {
305 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
306 /* Rather special case; if we select a text subtitle file jump to its
309 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
311 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
314 if (!go_to || p < go_to.get()) {
319 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
320 auto fv = _film_viewer.lock ();
321 DCPOMATIC_ASSERT (fv);
322 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
325 if (_timeline_dialog) {
326 _timeline_dialog->set_selection (selected());
329 /* Make required tabs visible */
331 if (_notebook->GetPageCount() > 1) {
332 /* There's more than one tab in the notebook so the current selection could be meaningful
333 to the user; store it so that we can try to restore it later.
335 _last_selected_tab = 0;
336 if (_notebook->GetSelection() != wxNOT_FOUND) {
337 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
341 bool have_video = false;
342 bool have_audio = false;
343 bool have_text[static_cast<int>(TextType::COUNT)] = { false, false };
344 for (auto i: selected()) {
351 for (auto j: i->text) {
352 have_text[static_cast<int>(j->original_type())] = true;
358 if (have_video && !_video_panel) {
359 _video_panel = new VideoPanel (this);
360 _notebook->InsertPage (off, _video_panel, _video_panel->name());
361 } else if (!have_video && _video_panel) {
362 _notebook->DeletePage (off);
370 if (have_audio && !_audio_panel) {
371 _audio_panel = new AudioPanel (this);
372 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
373 } else if (!have_audio && _audio_panel) {
374 _notebook->DeletePage (off);
382 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
383 if (have_text[i] && !_text_panel[i]) {
384 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
385 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
386 } else if (!have_text[i] && _text_panel[i]) {
387 _notebook->DeletePage (off);
395 /* Set up the tab selection */
398 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
399 if (_notebook->GetPage(i) == _last_selected_tab) {
400 _notebook->SetSelection (i);
405 if (!done && _notebook->GetPageCount() > 0) {
406 _notebook->SetSelection (0);
409 setup_sensitivity ();
415 ContentPanel::add_file_clicked ()
417 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
420 if (_parent->GetCurrentPage() != _splitter || !_film) {
424 auto path = Config::instance()->add_files_path();
426 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
427 non-Latin filenames or paths.
429 auto d = new wxFileDialog (
431 _("Choose a file or files"),
432 std_to_wx(path ? path->string() : home_directory().string()),
434 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
435 wxFD_MULTIPLE | wxFD_CHANGE_DIR
438 int const r = d->ShowModal ();
447 vector<boost::filesystem::path> path_list;
448 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
449 path_list.push_back (wx_to_std(paths[i]));
451 add_files (path_list);
453 if (!path_list.empty()) {
454 Config::instance()->set_add_files_path(path_list[0].parent_path());
462 ContentPanel::add_folder_clicked ()
464 auto d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
465 int r = d->ShowModal ();
466 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
473 list<shared_ptr<Content> > content;
476 content = content_factory (path);
477 } catch (exception& e) {
478 error_dialog (_parent, e.what());
482 if (content.empty ()) {
483 error_dialog (_parent, _("No content found in this folder."));
487 for (auto i: content) {
488 auto ic = dynamic_pointer_cast<ImageContent> (i);
490 auto e = new ImageSequenceDialog (_splitter);
492 auto const frame_rate = e->frame_rate ();
499 ic->set_video_frame_rate (frame_rate);
502 _film->examine_and_add_content (i);
508 ContentPanel::add_dcp_clicked ()
510 auto d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
511 int r = d->ShowModal ();
512 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
520 _film->examine_and_add_content (make_shared<DCPContent>(path));
521 } catch (ProjectFolderError &) {
525 "This looks like a DCP-o-matic project folder, which cannot be added to a different project. "
526 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to import."
529 } catch (exception& e) {
530 error_dialog (_parent, e.what());
535 /** @return true if this remove "click" should be ignored */
537 ContentPanel::remove_clicked (bool hotkey)
539 /* If the method was called because Delete was pressed check that our notebook page
540 is visible and that the content list is focussed.
542 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
546 for (auto i: selected ()) {
547 _film->remove_content (i);
556 ContentPanel::timeline_clicked ()
562 if (_timeline_dialog) {
563 _timeline_dialog->Destroy ();
564 _timeline_dialog = nullptr;
567 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
568 _timeline_dialog->set_selection (selected());
569 _timeline_dialog->Show ();
574 ContentPanel::right_click (wxListEvent& ev)
576 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
580 /** Set up broad sensitivity based on the type of content that is selected */
582 ContentPanel::setup_sensitivity ()
584 _add_file->Enable (_generally_sensitive);
585 _add_folder->Enable (_generally_sensitive);
586 _add_dcp->Enable (_generally_sensitive);
588 auto selection = selected ();
589 auto video_selection = selected_video ();
590 auto audio_selection = selected_audio ();
592 _remove->Enable (_generally_sensitive && !selection.empty());
593 _earlier->Enable (_generally_sensitive && selection.size() == 1);
594 _later->Enable (_generally_sensitive && selection.size() == 1);
595 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
598 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
601 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
603 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
604 if (_text_panel[i]) {
605 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
608 _timing_panel->Enable (_generally_sensitive);
613 ContentPanel::set_film (shared_ptr<Film> film)
616 _audio_panel->set_film (film);
621 film_changed (Film::Property::CONTENT);
622 film_changed (Film::Property::AUDIO_CHANNELS);
628 setup_sensitivity ();
633 ContentPanel::set_general_sensitivity (bool s)
635 _generally_sensitive = s;
636 setup_sensitivity ();
641 ContentPanel::earlier_clicked ()
643 auto sel = selected ();
644 if (sel.size() == 1) {
645 _film->move_content_earlier (sel.front ());
652 ContentPanel::later_clicked ()
654 auto sel = selected ();
655 if (sel.size() == 1) {
656 _film->move_content_later (sel.front ());
663 ContentPanel::set_selection (weak_ptr<Content> wc)
665 auto content = _film->content ();
666 for (size_t i = 0; i < content.size(); ++i) {
667 if (content[i] == wc.lock ()) {
668 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
670 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
677 ContentPanel::set_selection (ContentList cl)
679 _no_check_selection = true;
681 auto content = _film->content ();
682 for (size_t i = 0; i < content.size(); ++i) {
683 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
684 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
686 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
690 _no_check_selection = false;
696 ContentPanel::select_all ()
698 set_selection (_film->content());
703 ContentPanel::film_content_changed (int property)
706 property == ContentProperty::PATH ||
707 property == DCPContentProperty::NEEDS_ASSETS ||
708 property == DCPContentProperty::NEEDS_KDM ||
709 property == DCPContentProperty::NAME
715 for (auto i: panels()) {
716 i->film_content_changed (property);
722 ContentPanel::setup ()
725 _content->DeleteAllItems ();
726 setup_sensitivity ();
730 auto content = _film->content ();
732 Content* selected_content = nullptr;
733 auto const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
737 item.SetMask (wxLIST_MASK_DATA);
738 _content->GetItem (item);
739 selected_content = reinterpret_cast<Content*> (item.GetData ());
742 _content->DeleteAllItems ();
744 for (auto i: content) {
745 int const t = _content->GetItemCount ();
746 bool const valid = i->paths_valid ();
748 auto dcp = dynamic_pointer_cast<DCPContent> (i);
749 bool const needs_kdm = dcp && dcp->needs_kdm ();
750 bool const needs_assets = dcp && dcp->needs_assets ();
752 auto s = std_to_wx (i->summary ());
755 s = _("MISSING: ") + s;
759 s = _("NEEDS KDM: ") + s;
763 s = _("NEEDS OV: ") + s;
769 item.SetData (i.get ());
770 _content->InsertItem (item);
772 if (i.get() == selected_content) {
773 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
776 if (!valid || needs_kdm || needs_assets) {
777 _content->SetItemTextColour (t, *wxRED);
781 if (!selected_content && !content.empty ()) {
782 /* Select the item of content if none was selected before */
783 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
786 setup_sensitivity ();
791 ContentPanel::files_dropped (wxDropFilesEvent& event)
797 auto paths = event.GetFiles ();
798 vector<boost::filesystem::path> path_list;
799 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
800 path_list.push_back (wx_to_std(paths[i]));
803 add_files (path_list);
808 ContentPanel::add_files (vector<boost::filesystem::path> paths)
810 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
811 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
812 alphabetical sort is expected here.
815 std::sort (paths.begin(), paths.end(), CaseInsensitiveSorter());
817 /* XXX: check for lots of files here and do something */
820 for (auto i: paths) {
821 for (auto j: content_factory(i)) {
822 _film->examine_and_add_content (j);
825 } catch (exception& e) {
826 error_dialog (_parent, e.what());
831 list<ContentSubPanel*>
832 ContentPanel::panels () const
834 list<ContentSubPanel*> p;
836 p.push_back (_video_panel);
839 p.push_back (_audio_panel);
841 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
842 if (_text_panel[i]) {
843 p.push_back (_text_panel[i]);
846 p.push_back (_timing_panel);
851 LimitedSplitter::LimitedSplitter (wxWindow* parent)
852 : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
853 , _first_shown (false)
854 , _top_panel_minimum_size (350)
856 /* This value doesn't really mean much but we just want to stop double-click on the
857 divider from shrinking the bottom panel (#1601).
859 SetMinimumPaneSize (64);
861 Bind (wxEVT_SIZE, boost::bind(&LimitedSplitter::sized, this, _1));
866 LimitedSplitter::first_shown (wxWindow* top, wxWindow* bottom)
868 int const sn = wxDisplay::GetFromWindow(this);
870 wxRect const screen = wxDisplay(sn).GetClientArea();
871 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
872 enough on small displays to leave space for the content area.
874 SplitHorizontally (top, bottom, screen.height > 800 ? -600 : -_top_panel_minimum_size);
876 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
877 SplitHorizontally (top, bottom, -600);
884 LimitedSplitter::sized (wxSizeEvent& ev)
886 if (_first_shown && GetSize().GetHeight() > _top_panel_minimum_size && GetSashPosition() < _top_panel_minimum_size) {
887 /* The window is now fairly big but the top panel is small; this happens when the DCP-o-matic window
888 * is shrunk and then made larger again. Try to set a sensible top panel size in this case (#1839).
890 SetSashPosition (_top_panel_minimum_size);