2 Copyright (C) 2012-2019 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/>.
21 #include "content_panel.h"
23 #include "video_panel.h"
24 #include "audio_panel.h"
25 #include "text_panel.h"
26 #include "timing_panel.h"
27 #include "timeline_dialog.h"
28 #include "image_sequence_dialog.h"
29 #include "film_viewer.h"
30 #include "dcpomatic_button.h"
31 #include "lib/audio_content.h"
32 #include "lib/text_content.h"
33 #include "lib/video_content.h"
34 #include "lib/ffmpeg_content.h"
35 #include "lib/content_factory.h"
36 #include "lib/image_content.h"
37 #include "lib/dcp_content.h"
38 #include "lib/case_insensitive_sorter.h"
39 #include "lib/playlist.h"
40 #include "lib/config.h"
42 #include "lib/compose.hpp"
43 #include "lib/string_text_file_content.h"
44 #include "lib/string_text_file.h"
45 #include "lib/dcpomatic_log.h"
47 #include <wx/notebook.h>
48 #include <wx/listctrl.h>
49 #include <wx/display.h>
50 #include <boost/filesystem.hpp>
59 using std::shared_ptr;
61 using std::dynamic_pointer_cast;
62 using boost::optional;
63 using namespace dcpomatic;
64 #if BOOST_VERSION >= 106100
65 using namespace boost::placeholders;
69 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
72 , _timeline_dialog (0)
74 , _last_selected_tab (0)
76 , _film_viewer (viewer)
77 , _generally_sensitive (true)
78 , _ignore_deselect (false)
79 , _no_check_selection (false)
81 for (int i = 0; i < TEXT_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]);
181 ContentPanel::selected_video ()
185 for (auto i: selected()) {
195 ContentPanel::selected_audio ()
199 for (auto i: selected()) {
209 ContentPanel::selected_text ()
213 for (auto i: selected()) {
214 if (!i->text.empty()) {
223 ContentPanel::selected_ffmpeg ()
225 FFmpegContentList sc;
227 for (auto i: selected()) {
228 auto t = dynamic_pointer_cast<FFmpegContent> (i);
238 ContentPanel::film_changed (Film::Property p)
242 case Film::CONTENT_ORDER:
249 for (auto i: panels()) {
255 ContentPanel::item_deselected ()
257 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
258 false and item_deselected_foo will handle the deselection.
260 _ignore_deselect = false;
261 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
265 ContentPanel::item_deselected_idle ()
267 if (!_ignore_deselect) {
273 ContentPanel::item_selected ()
275 _ignore_deselect = true;
280 ContentPanel::check_selection ()
282 if (_no_check_selection) {
286 setup_sensitivity ();
288 for (auto i: panels()) {
289 i->content_selection_changed ();
292 optional<DCPTime> go_to;
293 for (auto i: selected()) {
296 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
297 /* Rather special case; if we select a text subtitle file jump to its
300 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
302 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
305 if (!go_to || p < go_to.get()) {
310 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
311 auto fv = _film_viewer.lock ();
312 DCPOMATIC_ASSERT (fv);
313 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
316 if (_timeline_dialog) {
317 _timeline_dialog->set_selection (selected());
320 /* Make required tabs visible */
322 if (_notebook->GetPageCount() > 1) {
323 /* There's more than one tab in the notebook so the current selection could be meaningful
324 to the user; store it so that we can try to restore it later.
326 _last_selected_tab = 0;
327 if (_notebook->GetSelection() != wxNOT_FOUND) {
328 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
332 bool have_video = false;
333 bool have_audio = false;
334 bool have_text[TEXT_COUNT] = { false, false };
335 for (auto i: selected()) {
342 for (auto j: i->text) {
343 have_text[j->original_type()] = true;
349 if (have_video && !_video_panel) {
350 _video_panel = new VideoPanel (this);
351 _notebook->InsertPage (off, _video_panel, _video_panel->name());
352 } else if (!have_video && _video_panel) {
353 _notebook->DeletePage (off);
361 if (have_audio && !_audio_panel) {
362 _audio_panel = new AudioPanel (this);
363 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
364 } else if (!have_audio && _audio_panel) {
365 _notebook->DeletePage (off);
373 for (int i = 0; i < TEXT_COUNT; ++i) {
374 if (have_text[i] && !_text_panel[i]) {
375 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
376 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
377 } else if (!have_text[i] && _text_panel[i]) {
378 _notebook->DeletePage (off);
386 /* Set up the tab selection */
389 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
390 if (_notebook->GetPage(i) == _last_selected_tab) {
391 _notebook->SetSelection (i);
396 if (!done && _notebook->GetPageCount() > 0) {
397 _notebook->SetSelection (0);
400 setup_sensitivity ();
405 ContentPanel::add_file_clicked ()
407 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
410 if (_parent->GetCurrentPage() != _splitter || !_film) {
414 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
415 non-Latin filenames or paths.
417 auto d = new wxFileDialog (
419 _("Choose a file or files"),
422 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
423 wxFD_MULTIPLE | wxFD_CHANGE_DIR
426 int const r = d->ShowModal ();
435 list<boost::filesystem::path> path_list;
436 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
437 path_list.push_back (wx_to_std (paths[i]));
439 add_files (path_list);
445 ContentPanel::add_folder_clicked ()
447 auto d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
448 int r = d->ShowModal ();
449 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
456 list<shared_ptr<Content> > content;
459 content = content_factory (path);
460 } catch (exception& e) {
461 error_dialog (_parent, e.what());
465 if (content.empty ()) {
466 error_dialog (_parent, _("No content found in this folder."));
470 for (auto i: content) {
471 auto ic = dynamic_pointer_cast<ImageContent> (i);
473 auto e = new ImageSequenceDialog (_splitter);
475 auto const frame_rate = e->frame_rate ();
482 ic->set_video_frame_rate (frame_rate);
485 _film->examine_and_add_content (i);
490 ContentPanel::add_dcp_clicked ()
492 auto d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
493 int r = d->ShowModal ();
494 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
502 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
503 } catch (exception& e) {
504 error_dialog (_parent, e.what());
508 /** @return true if this remove "click" should be ignored */
510 ContentPanel::remove_clicked (bool hotkey)
512 /* If the method was called because Delete was pressed check that our notebook page
513 is visible and that the content list is focussed.
515 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
519 for (auto i: selected ()) {
520 _film->remove_content (i);
528 ContentPanel::timeline_clicked ()
534 if (_timeline_dialog) {
535 _timeline_dialog->Destroy ();
536 _timeline_dialog = nullptr;
539 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
540 _timeline_dialog->set_selection (selected());
541 _timeline_dialog->Show ();
545 ContentPanel::right_click (wxListEvent& ev)
547 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
550 /** Set up broad sensitivity based on the type of content that is selected */
552 ContentPanel::setup_sensitivity ()
554 _add_file->Enable (_generally_sensitive);
555 _add_folder->Enable (_generally_sensitive);
556 _add_dcp->Enable (_generally_sensitive);
558 auto selection = selected ();
559 auto video_selection = selected_video ();
560 auto audio_selection = selected_audio ();
562 _remove->Enable (_generally_sensitive && !selection.empty());
563 _earlier->Enable (_generally_sensitive && selection.size() == 1);
564 _later->Enable (_generally_sensitive && selection.size() == 1);
565 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
568 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
571 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
573 for (int i = 0; i < TEXT_COUNT; ++i) {
574 if (_text_panel[i]) {
575 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
578 _timing_panel->Enable (_generally_sensitive);
582 ContentPanel::set_film (shared_ptr<Film> film)
585 _audio_panel->set_film (film);
590 film_changed (Film::CONTENT);
591 film_changed (Film::AUDIO_CHANNELS);
597 setup_sensitivity ();
601 ContentPanel::set_general_sensitivity (bool s)
603 _generally_sensitive = s;
604 setup_sensitivity ();
608 ContentPanel::earlier_clicked ()
610 auto sel = selected ();
611 if (sel.size() == 1) {
612 _film->move_content_earlier (sel.front ());
618 ContentPanel::later_clicked ()
620 auto sel = selected ();
621 if (sel.size() == 1) {
622 _film->move_content_later (sel.front ());
628 ContentPanel::set_selection (weak_ptr<Content> wc)
630 auto content = _film->content ();
631 for (size_t i = 0; i < content.size(); ++i) {
632 if (content[i] == wc.lock ()) {
633 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
635 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
641 ContentPanel::set_selection (ContentList cl)
643 _no_check_selection = true;
645 auto content = _film->content ();
646 for (size_t i = 0; i < content.size(); ++i) {
647 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
648 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
650 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
654 _no_check_selection = false;
659 ContentPanel::film_content_changed (int property)
662 property == ContentProperty::PATH ||
663 property == DCPContentProperty::NEEDS_ASSETS ||
664 property == DCPContentProperty::NEEDS_KDM ||
665 property == DCPContentProperty::NAME
671 for (auto i: panels()) {
672 i->film_content_changed (property);
677 ContentPanel::setup ()
680 _content->DeleteAllItems ();
681 setup_sensitivity ();
685 auto content = _film->content ();
687 Content* selected_content = nullptr;
688 auto const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
692 item.SetMask (wxLIST_MASK_DATA);
693 _content->GetItem (item);
694 selected_content = reinterpret_cast<Content*> (item.GetData ());
697 _content->DeleteAllItems ();
699 for (auto i: content) {
700 int const t = _content->GetItemCount ();
701 bool const valid = i->paths_valid ();
703 auto dcp = dynamic_pointer_cast<DCPContent> (i);
704 bool const needs_kdm = dcp && dcp->needs_kdm ();
705 bool const needs_assets = dcp && dcp->needs_assets ();
707 auto s = std_to_wx (i->summary ());
710 s = _("MISSING: ") + s;
714 s = _("NEEDS KDM: ") + s;
718 s = _("NEEDS OV: ") + s;
724 item.SetData (i.get ());
725 _content->InsertItem (item);
727 if (i.get() == selected_content) {
728 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
731 if (!valid || needs_kdm || needs_assets) {
732 _content->SetItemTextColour (t, *wxRED);
736 if (!selected_content && !content.empty ()) {
737 /* Select the item of content if none was selected before */
738 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
741 setup_sensitivity ();
745 ContentPanel::files_dropped (wxDropFilesEvent& event)
751 auto paths = event.GetFiles ();
752 list<boost::filesystem::path> path_list;
753 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
754 path_list.push_back (wx_to_std (paths[i]));
757 add_files (path_list);
761 ContentPanel::add_files (list<boost::filesystem::path> paths)
763 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
764 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
765 alphabetical sort is expected here.
768 paths.sort (CaseInsensitiveSorter ());
770 /* XXX: check for lots of files here and do something */
773 for (auto i: paths) {
774 for (auto j: content_factory(i)) {
775 _film->examine_and_add_content (j);
778 } catch (exception& e) {
779 error_dialog (_parent, e.what());
783 list<ContentSubPanel*>
784 ContentPanel::panels () const
786 list<ContentSubPanel*> p;
788 p.push_back (_video_panel);
791 p.push_back (_audio_panel);
793 for (int i = 0; i < TEXT_COUNT; ++i) {
794 if (_text_panel[i]) {
795 p.push_back (_text_panel[i]);
798 p.push_back (_timing_panel);
803 LimitedSplitter::LimitedSplitter (wxWindow* parent)
804 : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
805 , _first_shown (false)
806 , _top_panel_minimum_size (350)
808 /* This value doesn't really mean much but we just want to stop double-click on the
809 divider from shrinking the bottom panel (#1601).
811 SetMinimumPaneSize (64);
813 Bind (wxEVT_SIZE, boost::bind(&LimitedSplitter::sized, this, _1));
818 LimitedSplitter::first_shown (wxWindow* top, wxWindow* bottom)
820 int const sn = wxDisplay::GetFromWindow(this);
822 wxRect const screen = wxDisplay(sn).GetClientArea();
823 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
824 enough on small displays to leave space for the content area.
826 SplitHorizontally (top, bottom, screen.height > 800 ? -600 : -_top_panel_minimum_size);
828 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
829 SplitHorizontally (top, bottom, -600);
836 LimitedSplitter::sized (wxSizeEvent& ev)
838 if (_first_shown && GetSize().GetHeight() > _top_panel_minimum_size && GetSashPosition() < _top_panel_minimum_size) {
839 /* The window is now fairly big but the top panel is small; this happens when the DCP-o-matic window
840 * is shrunk and then made larger again. Try to set a sensible top panel size in this case (#1839).
842 SetSashPosition (_top_panel_minimum_size);