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>
51 #include <boost/foreach.hpp>
60 using boost::shared_ptr;
61 using boost::weak_ptr;
62 using boost::dynamic_pointer_cast;
63 using boost::optional;
64 using namespace dcpomatic;
65 #if BOOST_VERSION >= 106100
66 using namespace boost::placeholders;
69 class LimitedSplitter : public wxSplitterWindow
72 LimitedSplitter (wxWindow* parent)
73 : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
75 /* This value doesn't really mean much but we just want to stop double-click on the
76 divider from shrinking the bottom panel (#1601).
78 SetMinimumPaneSize (64);
81 bool OnSashPositionChange (int new_position)
83 /* Try to stop the top bit of the splitter getting so small that buttons disappear */
84 return new_position > 220;
88 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
91 , _timeline_dialog (0)
93 , _last_selected_tab (0)
95 , _film_viewer (viewer)
96 , _generally_sensitive (true)
97 , _ignore_deselect (false)
98 , _no_check_selection (false)
100 for (int i = 0; i < TEXT_COUNT; ++i) {
104 _splitter = new LimitedSplitter (n);
105 _top_panel = new wxPanel (_splitter);
107 _menu = new ContentMenu (_splitter);
110 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
112 _content = new wxListCtrl (_top_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
113 _content->DragAcceptFiles (true);
114 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
116 _content->InsertColumn (0, wxT(""));
117 _content->SetColumnWidth (0, 512);
119 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
121 _add_file = new Button (_top_panel, _("Add file(s)..."));
122 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
123 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
125 _add_folder = new Button (_top_panel, _("Add folder..."));
126 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
127 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
129 _add_dcp = new Button (_top_panel, _("Add DCP..."));
130 _add_dcp->SetToolTip (_("Add a DCP."));
131 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
133 _remove = new Button (_top_panel, _("Remove"));
134 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
135 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
137 _earlier = new Button (_top_panel, _("Earlier"));
138 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
139 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
141 _later = new Button (_top_panel, _("Later"));
142 _later->SetToolTip (_("Move the selected piece of content later in the film."));
143 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
145 _timeline = new Button (_top_panel, _("Timeline..."));
146 _timeline->SetToolTip (_("Open the timeline for the film."));
147 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
149 s->Add (b, 0, wxALL, 4);
150 _top_panel->SetSizer (s);
153 _notebook = new wxNotebook (_splitter, wxID_ANY);
155 _timing_panel = new TimingPanel (this, _film_viewer);
156 _notebook->AddPage (_timing_panel, _("Timing"), false);
158 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
159 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
160 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
161 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
162 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
163 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
164 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
165 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
166 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
167 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
168 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
173 ContentPanel::first_shown ()
175 int const sn = wxDisplay::GetFromWindow(_splitter);
177 wxRect const screen = wxDisplay(sn).GetClientArea();
178 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
179 enough on small displays to leave space for the content area.
181 _splitter->SplitHorizontally (_top_panel, _notebook, screen.height > 800 ? -600 : -150);
183 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
184 _splitter->SplitHorizontally (_top_panel, _notebook, -600);
190 ContentPanel::selected ()
195 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
200 ContentList cl = _film->content();
201 if (s < int (cl.size())) {
202 sel.push_back (cl[s]);
210 ContentPanel::selected_video ()
214 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
224 ContentPanel::selected_audio ()
228 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
238 ContentPanel::selected_text ()
242 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
243 if (!i->text.empty()) {
252 ContentPanel::selected_ffmpeg ()
254 FFmpegContentList sc;
256 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
257 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
267 ContentPanel::film_changed (Film::Property p)
271 case Film::CONTENT_ORDER:
278 BOOST_FOREACH (ContentSubPanel* i, panels()) {
284 ContentPanel::item_deselected ()
286 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
287 false and item_deselected_foo will handle the deselection.
289 _ignore_deselect = false;
290 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
294 ContentPanel::item_deselected_idle ()
296 if (!_ignore_deselect) {
302 ContentPanel::item_selected ()
304 _ignore_deselect = true;
309 ContentPanel::check_selection ()
311 if (_no_check_selection) {
315 setup_sensitivity ();
317 BOOST_FOREACH (ContentSubPanel* i, panels()) {
318 i->content_selection_changed ();
321 optional<DCPTime> go_to;
322 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
325 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
326 /* Rather special case; if we select a text subtitle file jump to its
329 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
331 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
334 if (!go_to || p < go_to.get()) {
339 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
340 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
341 DCPOMATIC_ASSERT (fv);
342 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
345 if (_timeline_dialog) {
346 _timeline_dialog->set_selection (selected());
349 /* Make required tabs visible */
351 if (_notebook->GetPageCount() > 1) {
352 /* There's more than one tab in the notebook so the current selection could be meaningful
353 to the user; store it so that we can try to restore it later.
355 _last_selected_tab = 0;
356 if (_notebook->GetSelection() != wxNOT_FOUND) {
357 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
361 bool have_video = false;
362 bool have_audio = false;
363 bool have_text[TEXT_COUNT] = { false, false };
364 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
371 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
372 have_text[j->original_type()] = true;
378 if (have_video && !_video_panel) {
379 _video_panel = new VideoPanel (this);
380 _notebook->InsertPage (off, _video_panel, _video_panel->name());
381 } else if (!have_video && _video_panel) {
382 _notebook->DeletePage (off);
390 if (have_audio && !_audio_panel) {
391 _audio_panel = new AudioPanel (this);
392 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
393 } else if (!have_audio && _audio_panel) {
394 _notebook->DeletePage (off);
402 for (int i = 0; i < TEXT_COUNT; ++i) {
403 if (have_text[i] && !_text_panel[i]) {
404 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
405 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
406 } else if (!have_text[i] && _text_panel[i]) {
407 _notebook->DeletePage (off);
415 /* Set up the tab selection */
418 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
419 if (_notebook->GetPage(i) == _last_selected_tab) {
420 _notebook->SetSelection (i);
425 if (!done && _notebook->GetPageCount() > 0) {
426 _notebook->SetSelection (0);
429 setup_sensitivity ();
434 ContentPanel::add_file_clicked ()
436 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
439 if (_parent->GetCurrentPage() != _splitter || !_film) {
443 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
444 non-Latin filenames or paths.
446 wxFileDialog* d = new wxFileDialog (
448 _("Choose a file or files"),
451 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
452 wxFD_MULTIPLE | wxFD_CHANGE_DIR
455 int const r = d->ShowModal ();
464 list<boost::filesystem::path> path_list;
465 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
466 path_list.push_back (wx_to_std (paths[i]));
468 add_files (path_list);
474 ContentPanel::add_folder_clicked ()
476 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
477 int r = d->ShowModal ();
478 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
485 list<shared_ptr<Content> > content;
488 content = content_factory (path);
489 } catch (exception& e) {
490 error_dialog (_parent, e.what());
494 if (content.empty ()) {
495 error_dialog (_parent, _("No content found in this folder."));
499 BOOST_FOREACH (shared_ptr<Content> i, content) {
500 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
502 ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
504 float const frame_rate = e->frame_rate ();
511 ic->set_video_frame_rate (frame_rate);
514 _film->examine_and_add_content (i);
519 ContentPanel::add_dcp_clicked ()
521 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
522 int r = d->ShowModal ();
523 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
531 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
532 } catch (exception& e) {
533 error_dialog (_parent, e.what());
537 /** @return true if this remove "click" should be ignored */
539 ContentPanel::remove_clicked (bool hotkey)
541 /* If the method was called because Delete was pressed check that our notebook page
542 is visible and that the content list is focussed.
544 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
548 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
549 _film->remove_content (i);
557 ContentPanel::timeline_clicked ()
563 if (_timeline_dialog) {
564 _timeline_dialog->Destroy ();
565 _timeline_dialog = 0;
568 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
569 _timeline_dialog->set_selection (selected());
570 _timeline_dialog->Show ();
574 ContentPanel::right_click (wxListEvent& ev)
576 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
579 /** Set up broad sensitivity based on the type of content that is selected */
581 ContentPanel::setup_sensitivity ()
583 _add_file->Enable (_generally_sensitive);
584 _add_folder->Enable (_generally_sensitive);
585 _add_dcp->Enable (_generally_sensitive);
587 ContentList selection = selected ();
588 ContentList video_selection = selected_video ();
589 ContentList audio_selection = selected_audio ();
591 _remove->Enable (_generally_sensitive && !selection.empty());
592 _earlier->Enable (_generally_sensitive && selection.size() == 1);
593 _later->Enable (_generally_sensitive && selection.size() == 1);
594 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
597 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
600 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
602 for (int i = 0; i < TEXT_COUNT; ++i) {
603 if (_text_panel[i]) {
604 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
607 _timing_panel->Enable (_generally_sensitive);
611 ContentPanel::set_film (shared_ptr<Film> film)
614 _audio_panel->set_film (film);
619 film_changed (Film::CONTENT);
620 film_changed (Film::AUDIO_CHANNELS);
626 setup_sensitivity ();
630 ContentPanel::set_general_sensitivity (bool s)
632 _generally_sensitive = s;
633 setup_sensitivity ();
637 ContentPanel::earlier_clicked ()
639 ContentList sel = selected ();
640 if (sel.size() == 1) {
641 _film->move_content_earlier (sel.front ());
647 ContentPanel::later_clicked ()
649 ContentList sel = selected ();
650 if (sel.size() == 1) {
651 _film->move_content_later (sel.front ());
657 ContentPanel::set_selection (weak_ptr<Content> wc)
659 ContentList content = _film->content ();
660 for (size_t i = 0; i < content.size(); ++i) {
661 if (content[i] == wc.lock ()) {
662 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
664 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
670 ContentPanel::set_selection (ContentList cl)
672 _no_check_selection = true;
674 ContentList content = _film->content ();
675 for (size_t i = 0; i < content.size(); ++i) {
676 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
677 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
679 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
683 _no_check_selection = false;
688 ContentPanel::film_content_changed (int property)
691 property == ContentProperty::PATH ||
692 property == DCPContentProperty::NEEDS_ASSETS ||
693 property == DCPContentProperty::NEEDS_KDM ||
694 property == DCPContentProperty::NAME
700 BOOST_FOREACH (ContentSubPanel* i, panels()) {
701 i->film_content_changed (property);
706 ContentPanel::setup ()
709 _content->DeleteAllItems ();
710 setup_sensitivity ();
714 ContentList content = _film->content ();
716 Content* selected_content = 0;
717 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
721 item.SetMask (wxLIST_MASK_DATA);
722 _content->GetItem (item);
723 selected_content = reinterpret_cast<Content*> (item.GetData ());
726 _content->DeleteAllItems ();
728 BOOST_FOREACH (shared_ptr<Content> i, content) {
729 int const t = _content->GetItemCount ();
730 bool const valid = i->paths_valid ();
732 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
733 bool const needs_kdm = dcp && dcp->needs_kdm ();
734 bool const needs_assets = dcp && dcp->needs_assets ();
736 wxString s = std_to_wx (i->summary ());
739 s = _("MISSING: ") + s;
743 s = _("NEEDS KDM: ") + s;
747 s = _("NEEDS OV: ") + s;
753 item.SetData (i.get ());
754 _content->InsertItem (item);
756 if (i.get() == selected_content) {
757 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
760 if (!valid || needs_kdm || needs_assets) {
761 _content->SetItemTextColour (t, *wxRED);
765 if (!selected_content && !content.empty ()) {
766 /* Select the item of content if none was selected before */
767 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
770 setup_sensitivity ();
774 ContentPanel::files_dropped (wxDropFilesEvent& event)
780 wxString* paths = event.GetFiles ();
781 list<boost::filesystem::path> path_list;
782 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
783 path_list.push_back (wx_to_std (paths[i]));
786 add_files (path_list);
790 ContentPanel::add_files (list<boost::filesystem::path> paths)
792 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
793 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
794 alphabetical sort is expected here.
797 paths.sort (CaseInsensitiveSorter ());
799 /* XXX: check for lots of files here and do something */
802 BOOST_FOREACH (boost::filesystem::path i, paths) {
803 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
804 _film->examine_and_add_content (j);
807 } catch (exception& e) {
808 error_dialog (_parent, e.what());
812 list<ContentSubPanel*>
813 ContentPanel::panels () const
815 list<ContentSubPanel*> p;
817 p.push_back (_video_panel);
820 p.push_back (_audio_panel);
822 for (int i = 0; i < TEXT_COUNT; ++i) {
823 if (_text_panel[i]) {
824 p.push_back (_text_panel[i]);
827 p.push_back (_timing_panel);