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 std::shared_ptr;
62 using std::dynamic_pointer_cast;
63 using boost::optional;
64 using namespace dcpomatic;
65 #if BOOST_VERSION >= 106100
66 using namespace boost::placeholders;
70 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
73 , _timeline_dialog (0)
75 , _last_selected_tab (0)
77 , _film_viewer (viewer)
78 , _generally_sensitive (true)
79 , _ignore_deselect (false)
80 , _no_check_selection (false)
82 for (int i = 0; i < TEXT_COUNT; ++i) {
86 _splitter = new LimitedSplitter (n);
87 _top_panel = new wxPanel (_splitter);
89 _menu = new ContentMenu (_splitter);
92 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
94 _content = new wxListCtrl (_top_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
95 _content->DragAcceptFiles (true);
96 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
98 _content->InsertColumn (0, wxT(""));
99 _content->SetColumnWidth (0, 512);
101 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
103 _add_file = new Button (_top_panel, _("Add file(s)..."));
104 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
105 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
107 _add_folder = new Button (_top_panel, _("Add folder..."));
108 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
109 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
111 _add_dcp = new Button (_top_panel, _("Add DCP..."));
112 _add_dcp->SetToolTip (_("Add a DCP."));
113 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
115 _remove = new Button (_top_panel, _("Remove"));
116 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
117 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
119 _earlier = new Button (_top_panel, _("Earlier"));
120 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
121 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
123 _later = new Button (_top_panel, _("Later"));
124 _later->SetToolTip (_("Move the selected piece of content later in the film."));
125 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
127 _timeline = new Button (_top_panel, _("Timeline..."));
128 _timeline->SetToolTip (_("Open the timeline for the film."));
129 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
131 s->Add (b, 0, wxALL, 4);
132 _top_panel->SetSizer (s);
135 _notebook = new wxNotebook (_splitter, wxID_ANY);
137 _timing_panel = new TimingPanel (this, _film_viewer);
138 _notebook->AddPage (_timing_panel, _("Timing"), false);
140 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
141 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
142 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
143 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
144 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
145 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
146 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
147 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
148 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
149 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
150 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
155 ContentPanel::first_shown ()
157 _splitter->first_shown (_top_panel, _notebook);
162 ContentPanel::selected ()
167 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
172 ContentList cl = _film->content();
173 if (s < int (cl.size())) {
174 sel.push_back (cl[s]);
182 ContentPanel::selected_video ()
186 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
196 ContentPanel::selected_audio ()
200 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
210 ContentPanel::selected_text ()
214 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
215 if (!i->text.empty()) {
224 ContentPanel::selected_ffmpeg ()
226 FFmpegContentList sc;
228 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
229 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
239 ContentPanel::film_changed (Film::Property p)
243 case Film::CONTENT_ORDER:
250 BOOST_FOREACH (ContentSubPanel* i, panels()) {
256 ContentPanel::item_deselected ()
258 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
259 false and item_deselected_foo will handle the deselection.
261 _ignore_deselect = false;
262 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
266 ContentPanel::item_deselected_idle ()
268 if (!_ignore_deselect) {
274 ContentPanel::item_selected ()
276 _ignore_deselect = true;
281 ContentPanel::check_selection ()
283 if (_no_check_selection) {
287 setup_sensitivity ();
289 BOOST_FOREACH (ContentSubPanel* i, panels()) {
290 i->content_selection_changed ();
293 optional<DCPTime> go_to;
294 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
297 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
298 /* Rather special case; if we select a text subtitle file jump to its
301 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
303 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
306 if (!go_to || p < go_to.get()) {
311 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
312 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
313 DCPOMATIC_ASSERT (fv);
314 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
317 if (_timeline_dialog) {
318 _timeline_dialog->set_selection (selected());
321 /* Make required tabs visible */
323 if (_notebook->GetPageCount() > 1) {
324 /* There's more than one tab in the notebook so the current selection could be meaningful
325 to the user; store it so that we can try to restore it later.
327 _last_selected_tab = 0;
328 if (_notebook->GetSelection() != wxNOT_FOUND) {
329 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
333 bool have_video = false;
334 bool have_audio = false;
335 bool have_text[TEXT_COUNT] = { false, false };
336 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
343 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
344 have_text[j->original_type()] = true;
350 if (have_video && !_video_panel) {
351 _video_panel = new VideoPanel (this);
352 _notebook->InsertPage (off, _video_panel, _video_panel->name());
353 } else if (!have_video && _video_panel) {
354 _notebook->DeletePage (off);
362 if (have_audio && !_audio_panel) {
363 _audio_panel = new AudioPanel (this);
364 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
365 } else if (!have_audio && _audio_panel) {
366 _notebook->DeletePage (off);
374 for (int i = 0; i < TEXT_COUNT; ++i) {
375 if (have_text[i] && !_text_panel[i]) {
376 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
377 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
378 } else if (!have_text[i] && _text_panel[i]) {
379 _notebook->DeletePage (off);
387 /* Set up the tab selection */
390 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
391 if (_notebook->GetPage(i) == _last_selected_tab) {
392 _notebook->SetSelection (i);
397 if (!done && _notebook->GetPageCount() > 0) {
398 _notebook->SetSelection (0);
401 setup_sensitivity ();
406 ContentPanel::add_file_clicked ()
408 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
411 if (_parent->GetCurrentPage() != _splitter || !_film) {
415 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
416 non-Latin filenames or paths.
418 wxFileDialog* d = new wxFileDialog (
420 _("Choose a file or files"),
423 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
424 wxFD_MULTIPLE | wxFD_CHANGE_DIR
427 int const r = d->ShowModal ();
436 list<boost::filesystem::path> path_list;
437 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
438 path_list.push_back (wx_to_std (paths[i]));
440 add_files (path_list);
446 ContentPanel::add_folder_clicked ()
448 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
449 int r = d->ShowModal ();
450 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
457 list<shared_ptr<Content> > content;
460 content = content_factory (path);
461 } catch (exception& e) {
462 error_dialog (_parent, e.what());
466 if (content.empty ()) {
467 error_dialog (_parent, _("No content found in this folder."));
471 BOOST_FOREACH (shared_ptr<Content> i, content) {
472 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
474 ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
476 float const frame_rate = e->frame_rate ();
483 ic->set_video_frame_rate (frame_rate);
486 _film->examine_and_add_content (i);
491 ContentPanel::add_dcp_clicked ()
493 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
494 int r = d->ShowModal ();
495 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
503 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
504 } catch (exception& e) {
505 error_dialog (_parent, e.what());
509 /** @return true if this remove "click" should be ignored */
511 ContentPanel::remove_clicked (bool hotkey)
513 /* If the method was called because Delete was pressed check that our notebook page
514 is visible and that the content list is focussed.
516 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
520 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
521 _film->remove_content (i);
529 ContentPanel::timeline_clicked ()
535 if (_timeline_dialog) {
536 _timeline_dialog->Destroy ();
537 _timeline_dialog = 0;
540 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
541 _timeline_dialog->set_selection (selected());
542 _timeline_dialog->Show ();
546 ContentPanel::right_click (wxListEvent& ev)
548 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
551 /** Set up broad sensitivity based on the type of content that is selected */
553 ContentPanel::setup_sensitivity ()
555 _add_file->Enable (_generally_sensitive);
556 _add_folder->Enable (_generally_sensitive);
557 _add_dcp->Enable (_generally_sensitive);
559 ContentList selection = selected ();
560 ContentList video_selection = selected_video ();
561 ContentList audio_selection = selected_audio ();
563 _remove->Enable (_generally_sensitive && !selection.empty());
564 _earlier->Enable (_generally_sensitive && selection.size() == 1);
565 _later->Enable (_generally_sensitive && selection.size() == 1);
566 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
569 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
572 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
574 for (int i = 0; i < TEXT_COUNT; ++i) {
575 if (_text_panel[i]) {
576 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
579 _timing_panel->Enable (_generally_sensitive);
583 ContentPanel::set_film (shared_ptr<Film> film)
586 _audio_panel->set_film (film);
591 film_changed (Film::CONTENT);
592 film_changed (Film::AUDIO_CHANNELS);
598 setup_sensitivity ();
602 ContentPanel::set_general_sensitivity (bool s)
604 _generally_sensitive = s;
605 setup_sensitivity ();
609 ContentPanel::earlier_clicked ()
611 ContentList sel = selected ();
612 if (sel.size() == 1) {
613 _film->move_content_earlier (sel.front ());
619 ContentPanel::later_clicked ()
621 ContentList sel = selected ();
622 if (sel.size() == 1) {
623 _film->move_content_later (sel.front ());
629 ContentPanel::set_selection (weak_ptr<Content> wc)
631 ContentList content = _film->content ();
632 for (size_t i = 0; i < content.size(); ++i) {
633 if (content[i] == wc.lock ()) {
634 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
636 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
642 ContentPanel::set_selection (ContentList cl)
644 _no_check_selection = true;
646 ContentList content = _film->content ();
647 for (size_t i = 0; i < content.size(); ++i) {
648 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
649 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
651 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
655 _no_check_selection = false;
660 ContentPanel::film_content_changed (int property)
663 property == ContentProperty::PATH ||
664 property == DCPContentProperty::NEEDS_ASSETS ||
665 property == DCPContentProperty::NEEDS_KDM ||
666 property == DCPContentProperty::NAME
672 BOOST_FOREACH (ContentSubPanel* i, panels()) {
673 i->film_content_changed (property);
678 ContentPanel::setup ()
681 _content->DeleteAllItems ();
682 setup_sensitivity ();
686 ContentList content = _film->content ();
688 Content* selected_content = 0;
689 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
693 item.SetMask (wxLIST_MASK_DATA);
694 _content->GetItem (item);
695 selected_content = reinterpret_cast<Content*> (item.GetData ());
698 _content->DeleteAllItems ();
700 BOOST_FOREACH (shared_ptr<Content> i, content) {
701 int const t = _content->GetItemCount ();
702 bool const valid = i->paths_valid ();
704 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
705 bool const needs_kdm = dcp && dcp->needs_kdm ();
706 bool const needs_assets = dcp && dcp->needs_assets ();
708 wxString s = std_to_wx (i->summary ());
711 s = _("MISSING: ") + s;
715 s = _("NEEDS KDM: ") + s;
719 s = _("NEEDS OV: ") + s;
725 item.SetData (i.get ());
726 _content->InsertItem (item);
728 if (i.get() == selected_content) {
729 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
732 if (!valid || needs_kdm || needs_assets) {
733 _content->SetItemTextColour (t, *wxRED);
737 if (!selected_content && !content.empty ()) {
738 /* Select the item of content if none was selected before */
739 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
742 setup_sensitivity ();
746 ContentPanel::files_dropped (wxDropFilesEvent& event)
752 wxString* paths = event.GetFiles ();
753 list<boost::filesystem::path> path_list;
754 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
755 path_list.push_back (wx_to_std (paths[i]));
758 add_files (path_list);
762 ContentPanel::add_files (list<boost::filesystem::path> paths)
764 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
765 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
766 alphabetical sort is expected here.
769 paths.sort (CaseInsensitiveSorter ());
771 /* XXX: check for lots of files here and do something */
774 BOOST_FOREACH (boost::filesystem::path i, paths) {
775 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
776 _film->examine_and_add_content (j);
779 } catch (exception& e) {
780 error_dialog (_parent, e.what());
784 list<ContentSubPanel*>
785 ContentPanel::panels () const
787 list<ContentSubPanel*> p;
789 p.push_back (_video_panel);
792 p.push_back (_audio_panel);
794 for (int i = 0; i < TEXT_COUNT; ++i) {
795 if (_text_panel[i]) {
796 p.push_back (_text_panel[i]);
799 p.push_back (_timing_panel);
804 LimitedSplitter::LimitedSplitter (wxWindow* parent)
805 : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
806 , _first_shown (false)
807 , _top_panel_minimum_size (350)
809 /* This value doesn't really mean much but we just want to stop double-click on the
810 divider from shrinking the bottom panel (#1601).
812 SetMinimumPaneSize (64);
814 Bind (wxEVT_SIZE, boost::bind(&LimitedSplitter::sized, this, _1));
819 LimitedSplitter::first_shown (wxWindow* top, wxWindow* bottom)
821 int const sn = wxDisplay::GetFromWindow(this);
823 wxRect const screen = wxDisplay(sn).GetClientArea();
824 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
825 enough on small displays to leave space for the content area.
827 SplitHorizontally (top, bottom, screen.height > 800 ? -600 : -_top_panel_minimum_size);
829 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
830 SplitHorizontally (top, bottom, -600);
837 LimitedSplitter::sized (wxSizeEvent& ev)
839 if (_first_shown && GetSize().GetHeight() > _top_panel_minimum_size && GetSashPosition() < _top_panel_minimum_size) {
840 /* The window is now fairly big but the top panel is small; this happens when the DCP-o-matic window
841 * is shrunk and then made larger again. Try to set a sensible top panel size in this case (#1839).
843 SetSashPosition (_top_panel_minimum_size);