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 #if BOOST_VERSION >= 106100
65 using namespace boost::placeholders;
68 class LimitedSplitter : public wxSplitterWindow
71 LimitedSplitter (wxWindow* parent)
72 : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
74 /* This value doesn't really mean much but we just want to stop double-click on the
75 divider from shrinking the bottom panel (#1601).
77 SetMinimumPaneSize (64);
80 bool OnSashPositionChange (int new_position)
82 /* Try to stop the top bit of the splitter getting so small that buttons disappear */
83 return new_position > 220;
87 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
90 , _timeline_dialog (0)
92 , _last_selected_tab (0)
94 , _film_viewer (viewer)
95 , _generally_sensitive (true)
96 , _ignore_deselect (false)
98 for (int i = 0; i < TEXT_COUNT; ++i) {
102 _splitter = new LimitedSplitter (n);
103 optional<wxRect> screen;
104 int const sn = wxDisplay::GetFromWindow(_splitter);
106 screen = wxDisplay(sn).GetClientArea();
108 wxPanel* top = new wxPanel (_splitter);
110 _menu = new ContentMenu (_splitter);
114 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
116 _content = new wxListCtrl (top, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
117 _content->DragAcceptFiles (true);
118 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
120 _content->InsertColumn (0, wxT(""));
121 _content->SetColumnWidth (0, 512);
123 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
125 _add_file = new Button (top, _("Add file(s)..."));
126 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
127 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
129 _add_folder = new Button (top, _("Add folder..."));
130 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
131 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
133 _add_dcp = new Button (top, _("Add DCP..."));
134 _add_dcp->SetToolTip (_("Add a DCP."));
135 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
137 _remove = new Button (top, _("Remove"));
138 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
139 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
141 _earlier = new Button (top, _("Earlier"));
142 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
143 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
145 _later = new Button (top, _("Later"));
146 _later->SetToolTip (_("Move the selected piece of content later in the film."));
147 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
149 _timeline = new Button (top, _("Timeline..."));
150 _timeline->SetToolTip (_("Open the timeline for the film."));
151 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
153 s->Add (b, 0, wxALL, 4);
157 _notebook = new wxNotebook (_splitter, wxID_ANY);
159 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
160 enough on small displays to leave space for the content area.
161 Big displays: make the bottom half 600 pixels high, so the content list is big and takes up remaining space.
162 Small displays: make the top half 250 pixels high so we can definitely see all the buttons, even at the
163 expense of height in the bottom half.
166 _splitter->SplitHorizontally (top, _notebook, screen->height > 800 ? -600 : 250);
169 _timing_panel = new TimingPanel (this, _film_viewer);
170 _notebook->AddPage (_timing_panel, _("Timing"), false);
172 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
173 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
174 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
175 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
176 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
177 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
178 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
179 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
180 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
181 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
182 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
186 ContentPanel::selected ()
191 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
196 ContentList cl = _film->content();
197 if (s < int (cl.size())) {
198 sel.push_back (cl[s]);
206 ContentPanel::selected_video ()
210 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
220 ContentPanel::selected_audio ()
224 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
234 ContentPanel::selected_text ()
238 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
239 if (!i->text.empty()) {
248 ContentPanel::selected_ffmpeg ()
250 FFmpegContentList sc;
252 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
253 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
263 ContentPanel::film_changed (Film::Property p)
267 case Film::CONTENT_ORDER:
274 BOOST_FOREACH (ContentSubPanel* i, panels()) {
280 ContentPanel::item_deselected ()
282 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
283 false and item_deselected_foo will handle the deselection.
285 _ignore_deselect = false;
286 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
290 ContentPanel::item_deselected_idle ()
292 if (!_ignore_deselect) {
298 ContentPanel::item_selected ()
300 _ignore_deselect = true;
305 ContentPanel::check_selection ()
307 _last_selected = selected ();
309 setup_sensitivity ();
311 BOOST_FOREACH (ContentSubPanel* i, panels()) {
312 i->content_selection_changed ();
315 optional<DCPTime> go_to;
316 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
319 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
320 /* Rather special case; if we select a text subtitle file jump to its
323 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
325 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
328 if (!go_to || p < go_to.get()) {
333 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
334 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
335 DCPOMATIC_ASSERT (fv);
336 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
339 if (_timeline_dialog) {
340 _timeline_dialog->set_selection (selected());
343 /* Make required tabs visible */
345 if (_notebook->GetPageCount() > 1) {
346 /* There's more than one tab in the notebook so the current selection could be meaningful
347 to the user; store it so that we can try to restore it later.
349 _last_selected_tab = 0;
350 if (_notebook->GetSelection() != wxNOT_FOUND) {
351 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
355 bool have_video = false;
356 bool have_audio = false;
357 bool have_text[TEXT_COUNT] = { false, false };
358 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
365 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
366 have_text[j->original_type()] = true;
372 if (have_video && !_video_panel) {
373 _video_panel = new VideoPanel (this);
374 _notebook->InsertPage (off, _video_panel, _video_panel->name());
375 } else if (!have_video && _video_panel) {
376 _notebook->DeletePage (off);
384 if (have_audio && !_audio_panel) {
385 _audio_panel = new AudioPanel (this);
386 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
387 } else if (!have_audio && _audio_panel) {
388 _notebook->DeletePage (off);
396 for (int i = 0; i < TEXT_COUNT; ++i) {
397 if (have_text[i] && !_text_panel[i]) {
398 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
399 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
400 } else if (!have_text[i] && _text_panel[i]) {
401 _notebook->DeletePage (off);
409 /* Set up the tab selection */
412 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
413 if (_notebook->GetPage(i) == _last_selected_tab) {
414 _notebook->SetSelection (i);
419 if (!done && _notebook->GetPageCount() > 0) {
420 _notebook->SetSelection (0);
423 setup_sensitivity ();
428 ContentPanel::add_file_clicked ()
430 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
433 if (_parent->GetCurrentPage() != _splitter || !_film) {
437 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
438 non-Latin filenames or paths.
440 wxFileDialog* d = new wxFileDialog (
442 _("Choose a file or files"),
445 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
446 wxFD_MULTIPLE | wxFD_CHANGE_DIR
449 int const r = d->ShowModal ();
458 list<boost::filesystem::path> path_list;
459 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
460 path_list.push_back (wx_to_std (paths[i]));
462 add_files (path_list);
468 ContentPanel::add_folder_clicked ()
470 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
471 int r = d->ShowModal ();
472 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
479 list<shared_ptr<Content> > content;
482 content = content_factory (path);
483 } catch (exception& e) {
484 error_dialog (_parent, e.what());
488 if (content.empty ()) {
489 error_dialog (_parent, _("No content found in this folder."));
493 BOOST_FOREACH (shared_ptr<Content> i, content) {
494 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
496 ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
498 float const frame_rate = e->frame_rate ();
505 ic->set_video_frame_rate (frame_rate);
508 _film->examine_and_add_content (i);
513 ContentPanel::add_dcp_clicked ()
515 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
516 int r = d->ShowModal ();
517 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
525 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
526 } catch (exception& e) {
527 error_dialog (_parent, e.what());
531 /** @return true if this remove "click" should be ignored */
533 ContentPanel::remove_clicked (bool hotkey)
535 /* If the method was called because Delete was pressed check that our notebook page
536 is visible and that the content list is focussed.
538 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
542 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
543 _film->remove_content (i);
551 ContentPanel::timeline_clicked ()
557 if (_timeline_dialog) {
558 _timeline_dialog->Destroy ();
559 _timeline_dialog = 0;
562 _timeline_dialog = new TimelineDialog (this, _film);
563 _timeline_dialog->set_selection (selected());
564 _timeline_dialog->Show ();
568 ContentPanel::right_click (wxListEvent& ev)
570 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
573 /** Set up broad sensitivity based on the type of content that is selected */
575 ContentPanel::setup_sensitivity ()
577 _add_file->Enable (_generally_sensitive);
578 _add_folder->Enable (_generally_sensitive);
579 _add_dcp->Enable (_generally_sensitive);
581 ContentList selection = selected ();
582 ContentList video_selection = selected_video ();
583 ContentList audio_selection = selected_audio ();
585 _remove->Enable (_generally_sensitive && !selection.empty());
586 _earlier->Enable (_generally_sensitive && selection.size() == 1);
587 _later->Enable (_generally_sensitive && selection.size() == 1);
588 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
591 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
594 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
596 for (int i = 0; i < TEXT_COUNT; ++i) {
597 if (_text_panel[i]) {
598 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
601 _timing_panel->Enable (_generally_sensitive);
605 ContentPanel::set_film (shared_ptr<Film> film)
608 _audio_panel->set_film (film);
613 film_changed (Film::CONTENT);
614 film_changed (Film::AUDIO_CHANNELS);
620 setup_sensitivity ();
624 ContentPanel::set_general_sensitivity (bool s)
626 _generally_sensitive = s;
627 setup_sensitivity ();
631 ContentPanel::earlier_clicked ()
633 ContentList sel = selected ();
634 if (sel.size() == 1) {
635 _film->move_content_earlier (sel.front ());
641 ContentPanel::later_clicked ()
643 ContentList sel = selected ();
644 if (sel.size() == 1) {
645 _film->move_content_later (sel.front ());
651 ContentPanel::set_selection (weak_ptr<Content> wc)
653 ContentList content = _film->content ();
654 for (size_t i = 0; i < content.size(); ++i) {
655 if (content[i] == wc.lock ()) {
656 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
658 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
664 ContentPanel::set_selection (ContentList cl)
666 ContentList content = _film->content ();
667 for (size_t i = 0; i < content.size(); ++i) {
668 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
669 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
671 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
677 ContentPanel::film_content_changed (int property)
680 property == ContentProperty::PATH ||
681 property == DCPContentProperty::NEEDS_ASSETS ||
682 property == DCPContentProperty::NEEDS_KDM ||
683 property == DCPContentProperty::NAME
689 BOOST_FOREACH (ContentSubPanel* i, panels()) {
690 i->film_content_changed (property);
695 ContentPanel::setup ()
698 _content->DeleteAllItems ();
699 setup_sensitivity ();
703 ContentList content = _film->content ();
705 Content* selected_content = 0;
706 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
710 item.SetMask (wxLIST_MASK_DATA);
711 _content->GetItem (item);
712 selected_content = reinterpret_cast<Content*> (item.GetData ());
715 _content->DeleteAllItems ();
717 BOOST_FOREACH (shared_ptr<Content> i, content) {
718 int const t = _content->GetItemCount ();
719 bool const valid = i->paths_valid ();
721 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
722 bool const needs_kdm = dcp && dcp->needs_kdm ();
723 bool const needs_assets = dcp && dcp->needs_assets ();
725 wxString s = std_to_wx (i->summary ());
728 s = _("MISSING: ") + s;
732 s = _("NEEDS KDM: ") + s;
736 s = _("NEEDS OV: ") + s;
742 item.SetData (i.get ());
743 _content->InsertItem (item);
745 if (i.get() == selected_content) {
746 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
749 if (!valid || needs_kdm || needs_assets) {
750 _content->SetItemTextColour (t, *wxRED);
754 if (!selected_content && !content.empty ()) {
755 /* Select the item of content if none was selected before */
756 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
759 setup_sensitivity ();
763 ContentPanel::files_dropped (wxDropFilesEvent& event)
769 wxString* paths = event.GetFiles ();
770 list<boost::filesystem::path> path_list;
771 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
772 path_list.push_back (wx_to_std (paths[i]));
775 add_files (path_list);
779 ContentPanel::add_files (list<boost::filesystem::path> paths)
781 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
782 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
783 alphabetical sort is expected here.
786 paths.sort (CaseInsensitiveSorter ());
788 /* XXX: check for lots of files here and do something */
791 BOOST_FOREACH (boost::filesystem::path i, paths) {
792 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
793 _film->examine_and_add_content (j);
796 } catch (exception& e) {
797 error_dialog (_parent, e.what());
801 list<ContentSubPanel*>
802 ContentPanel::panels () const
804 list<ContentSubPanel*> p;
806 p.push_back (_video_panel);
809 p.push_back (_audio_panel);
811 for (int i = 0; i < TEXT_COUNT; ++i) {
812 if (_text_panel[i]) {
813 p.push_back (_text_panel[i]);
816 p.push_back (_timing_panel);