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;
66 class LimitedSplitter : public wxSplitterWindow
69 LimitedSplitter (wxWindow* parent)
70 : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
75 bool OnSashPositionChange (int new_position)
77 /* Try to stop the top bit of the splitter getting so small that buttons disappear */
78 return new_position > 220;
82 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
85 , _timeline_dialog (0)
87 , _last_selected_tab (0)
89 , _film_viewer (viewer)
90 , _generally_sensitive (true)
91 , _ignore_deselect (false)
92 , _no_check_selection (false)
94 for (int i = 0; i < TEXT_COUNT; ++i) {
98 _splitter = new LimitedSplitter (n);
99 optional<wxRect> screen;
100 int const sn = wxDisplay::GetFromWindow(_splitter);
102 screen = wxDisplay(sn).GetClientArea();
104 wxPanel* top = new wxPanel (_splitter);
106 _menu = new ContentMenu (_splitter);
110 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
112 _content = new wxListCtrl (top, 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, _("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, _("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, _("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, _("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, _("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, _("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, _("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);
153 _notebook = new wxNotebook (_splitter, wxID_ANY);
155 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
156 enough on small displays to leave space for the content area.
159 _splitter->SplitHorizontally (top, _notebook, screen->height > 800 ? -600 : -150);
162 _timing_panel = new TimingPanel (this, _film_viewer);
163 _notebook->AddPage (_timing_panel, _("Timing"), false);
165 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
166 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
167 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
168 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
169 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
170 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
171 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
172 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
173 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
174 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
175 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
179 ContentPanel::selected ()
184 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
189 ContentList cl = _film->content();
190 if (s < int (cl.size())) {
191 sel.push_back (cl[s]);
199 ContentPanel::selected_video ()
203 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
213 ContentPanel::selected_audio ()
217 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
227 ContentPanel::selected_text ()
231 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
232 if (!i->text.empty()) {
241 ContentPanel::selected_ffmpeg ()
243 FFmpegContentList sc;
245 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
246 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
256 ContentPanel::film_changed (Film::Property p)
260 case Film::CONTENT_ORDER:
267 BOOST_FOREACH (ContentSubPanel* i, panels()) {
273 ContentPanel::item_deselected ()
275 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
276 false and item_deselected_foo will handle the deselection.
278 _ignore_deselect = false;
279 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
283 ContentPanel::item_deselected_idle ()
285 if (!_ignore_deselect) {
291 ContentPanel::item_selected ()
293 _ignore_deselect = true;
298 ContentPanel::check_selection ()
300 if (_last_selected == selected()) {
301 /* This was triggered by a re-build of the view but the selection
302 did not really change.
307 if (_no_check_selection) {
311 _last_selected = selected ();
313 setup_sensitivity ();
315 BOOST_FOREACH (ContentSubPanel* i, panels()) {
316 i->content_selection_changed ();
319 optional<DCPTime> go_to;
320 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
323 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
324 /* Rather special case; if we select a text subtitle file jump to its
327 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
329 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
332 if (!go_to || p < go_to.get()) {
337 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
338 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
339 DCPOMATIC_ASSERT (fv);
340 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
343 if (_timeline_dialog) {
344 _timeline_dialog->set_selection (selected());
347 /* Make required tabs visible */
349 if (_notebook->GetPageCount() > 1) {
350 /* There's more than one tab in the notebook so the current selection could be meaningful
351 to the user; store it so that we can try to restore it later.
353 _last_selected_tab = 0;
354 if (_notebook->GetSelection() != wxNOT_FOUND) {
355 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
359 bool have_video = false;
360 bool have_audio = false;
361 bool have_text[TEXT_COUNT] = { false, false };
362 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
369 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
370 have_text[j->original_type()] = true;
376 if (have_video && !_video_panel) {
377 _video_panel = new VideoPanel (this);
378 _notebook->InsertPage (off, _video_panel, _video_panel->name());
379 } else if (!have_video && _video_panel) {
380 _notebook->DeletePage (off);
388 if (have_audio && !_audio_panel) {
389 _audio_panel = new AudioPanel (this);
390 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
391 } else if (!have_audio && _audio_panel) {
392 _notebook->DeletePage (off);
400 for (int i = 0; i < TEXT_COUNT; ++i) {
401 if (have_text[i] && !_text_panel[i]) {
402 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
403 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
404 } else if (!have_text[i] && _text_panel[i]) {
405 _notebook->DeletePage (off);
413 /* Set up the tab selection */
416 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
417 if (_notebook->GetPage(i) == _last_selected_tab) {
418 _notebook->SetSelection (i);
423 if (!done && _notebook->GetPageCount() > 0) {
424 _notebook->SetSelection (0);
427 setup_sensitivity ();
432 ContentPanel::add_file_clicked ()
434 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
437 if (_parent->GetCurrentPage() != _splitter || !_film) {
441 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
442 non-Latin filenames or paths.
444 wxFileDialog* d = new wxFileDialog (
446 _("Choose a file or files"),
449 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
450 wxFD_MULTIPLE | wxFD_CHANGE_DIR
453 int const r = d->ShowModal ();
462 list<boost::filesystem::path> path_list;
463 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
464 path_list.push_back (wx_to_std (paths[i]));
466 add_files (path_list);
472 ContentPanel::add_folder_clicked ()
474 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
475 int r = d->ShowModal ();
476 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
483 list<shared_ptr<Content> > content;
486 content = content_factory (path);
487 } catch (exception& e) {
488 error_dialog (_parent, e.what());
492 if (content.empty ()) {
493 error_dialog (_parent, _("No content found in this folder."));
497 BOOST_FOREACH (shared_ptr<Content> i, content) {
498 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
500 ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
502 float const frame_rate = e->frame_rate ();
509 ic->set_video_frame_rate (frame_rate);
512 _film->examine_and_add_content (i);
517 ContentPanel::add_dcp_clicked ()
519 wxDirDialog* 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 (shared_ptr<Content> (new DCPContent (path)));
530 } catch (exception& e) {
531 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 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
547 _film->remove_content (i);
555 ContentPanel::timeline_clicked ()
561 if (_timeline_dialog) {
562 _timeline_dialog->Destroy ();
563 _timeline_dialog = 0;
566 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
567 _timeline_dialog->set_selection (selected());
568 _timeline_dialog->Show ();
572 ContentPanel::right_click (wxListEvent& ev)
574 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
577 /** Set up broad sensitivity based on the type of content that is selected */
579 ContentPanel::setup_sensitivity ()
581 _add_file->Enable (_generally_sensitive);
582 _add_folder->Enable (_generally_sensitive);
583 _add_dcp->Enable (_generally_sensitive);
585 ContentList selection = selected ();
586 ContentList video_selection = selected_video ();
587 ContentList audio_selection = selected_audio ();
589 _remove->Enable (_generally_sensitive && !selection.empty());
590 _earlier->Enable (_generally_sensitive && selection.size() == 1);
591 _later->Enable (_generally_sensitive && selection.size() == 1);
592 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
595 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
598 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
600 for (int i = 0; i < TEXT_COUNT; ++i) {
601 if (_text_panel[i]) {
602 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
605 _timing_panel->Enable (_generally_sensitive);
609 ContentPanel::set_film (shared_ptr<Film> film)
612 _audio_panel->set_film (film);
617 film_changed (Film::CONTENT);
618 film_changed (Film::AUDIO_CHANNELS);
624 setup_sensitivity ();
628 ContentPanel::set_general_sensitivity (bool s)
630 _generally_sensitive = s;
631 setup_sensitivity ();
635 ContentPanel::earlier_clicked ()
637 ContentList sel = selected ();
638 if (sel.size() == 1) {
639 _film->move_content_earlier (sel.front ());
645 ContentPanel::later_clicked ()
647 ContentList sel = selected ();
648 if (sel.size() == 1) {
649 _film->move_content_later (sel.front ());
655 ContentPanel::set_selection (weak_ptr<Content> wc)
657 ContentList content = _film->content ();
658 for (size_t i = 0; i < content.size(); ++i) {
659 if (content[i] == wc.lock ()) {
660 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
662 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
668 ContentPanel::set_selection (ContentList cl)
670 _no_check_selection = true;
672 ContentList content = _film->content ();
673 for (size_t i = 0; i < content.size(); ++i) {
674 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
675 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
677 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
681 _no_check_selection = false;
686 ContentPanel::film_content_changed (int property)
689 property == ContentProperty::PATH ||
690 property == DCPContentProperty::NEEDS_ASSETS ||
691 property == DCPContentProperty::NEEDS_KDM ||
692 property == DCPContentProperty::NAME
698 BOOST_FOREACH (ContentSubPanel* i, panels()) {
699 i->film_content_changed (property);
704 ContentPanel::setup ()
707 _content->DeleteAllItems ();
708 setup_sensitivity ();
712 ContentList content = _film->content ();
714 Content* selected_content = 0;
715 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
719 item.SetMask (wxLIST_MASK_DATA);
720 _content->GetItem (item);
721 selected_content = reinterpret_cast<Content*> (item.GetData ());
724 _content->DeleteAllItems ();
726 BOOST_FOREACH (shared_ptr<Content> i, content) {
727 int const t = _content->GetItemCount ();
728 bool const valid = i->paths_valid ();
730 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
731 bool const needs_kdm = dcp && dcp->needs_kdm ();
732 bool const needs_assets = dcp && dcp->needs_assets ();
734 wxString s = std_to_wx (i->summary ());
737 s = _("MISSING: ") + s;
741 s = _("NEEDS KDM: ") + s;
745 s = _("NEEDS OV: ") + s;
751 item.SetData (i.get ());
752 _content->InsertItem (item);
754 if (i.get() == selected_content) {
755 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
758 if (!valid || needs_kdm || needs_assets) {
759 _content->SetItemTextColour (t, *wxRED);
763 if (!selected_content && !content.empty ()) {
764 /* Select the item of content if none was selected before */
765 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
768 setup_sensitivity ();
772 ContentPanel::files_dropped (wxDropFilesEvent& event)
778 wxString* paths = event.GetFiles ();
779 list<boost::filesystem::path> path_list;
780 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
781 path_list.push_back (wx_to_std (paths[i]));
784 add_files (path_list);
788 ContentPanel::add_files (list<boost::filesystem::path> paths)
790 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
791 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
792 alphabetical sort is expected here.
795 paths.sort (CaseInsensitiveSorter ());
797 /* XXX: check for lots of files here and do something */
800 BOOST_FOREACH (boost::filesystem::path i, paths) {
801 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
802 _film->examine_and_add_content (j);
805 } catch (exception& e) {
806 error_dialog (_parent, e.what());
810 list<ContentSubPanel*>
811 ContentPanel::panels () const
813 list<ContentSubPanel*> p;
815 p.push_back (_video_panel);
818 p.push_back (_audio_panel);
820 for (int i = 0; i < TEXT_COUNT; ++i) {
821 if (_text_panel[i]) {
822 p.push_back (_text_panel[i]);
825 p.push_back (_timing_panel);