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)
72 /* This value doesn't really mean much but we just want to stop double-click on the
73 divider from shrinking the bottom panel (#1601).
75 SetMinimumPaneSize (64);
78 bool OnSashPositionChange (int new_position)
80 /* Try to stop the top bit of the splitter getting so small that buttons disappear */
81 return new_position > 220;
85 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
88 , _timeline_dialog (0)
90 , _last_selected_tab (0)
92 , _film_viewer (viewer)
93 , _generally_sensitive (true)
94 , _ignore_deselect (false)
95 , _no_check_selection (false)
97 for (int i = 0; i < TEXT_COUNT; ++i) {
101 _splitter = new LimitedSplitter (n);
102 _top_panel = new wxPanel (_splitter);
104 _menu = new ContentMenu (_splitter);
107 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
109 _content = new wxListCtrl (_top_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
110 _content->DragAcceptFiles (true);
111 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
113 _content->InsertColumn (0, wxT(""));
114 _content->SetColumnWidth (0, 512);
116 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
118 _add_file = new Button (_top_panel, _("Add file(s)..."));
119 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
120 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
122 _add_folder = new Button (_top_panel, _("Add folder..."));
123 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
124 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
126 _add_dcp = new Button (_top_panel, _("Add DCP..."));
127 _add_dcp->SetToolTip (_("Add a DCP."));
128 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
130 _remove = new Button (_top_panel, _("Remove"));
131 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
132 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
134 _earlier = new Button (_top_panel, _("Earlier"));
135 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
136 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
138 _later = new Button (_top_panel, _("Later"));
139 _later->SetToolTip (_("Move the selected piece of content later in the film."));
140 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
142 _timeline = new Button (_top_panel, _("Timeline..."));
143 _timeline->SetToolTip (_("Open the timeline for the film."));
144 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
146 s->Add (b, 0, wxALL, 4);
147 _top_panel->SetSizer (s);
150 _notebook = new wxNotebook (_splitter, wxID_ANY);
152 _timing_panel = new TimingPanel (this, _film_viewer);
153 _notebook->AddPage (_timing_panel, _("Timing"), false);
155 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
156 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
157 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
158 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
159 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
160 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
161 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
162 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
163 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
164 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
165 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
170 ContentPanel::first_shown ()
172 int const sn = wxDisplay::GetFromWindow(_splitter);
174 wxRect const screen = wxDisplay(sn).GetClientArea();
175 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
176 enough on small displays to leave space for the content area.
178 _splitter->SplitHorizontally (_top_panel, _notebook, screen.height > 800 ? -600 : -150);
180 /* Fallback for when GetFromWindow fails for reasons that aren't clear */
181 _splitter->SplitHorizontally (_top_panel, _notebook, -600);
187 ContentPanel::selected ()
192 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
197 ContentList cl = _film->content();
198 if (s < int (cl.size())) {
199 sel.push_back (cl[s]);
207 ContentPanel::selected_video ()
211 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
221 ContentPanel::selected_audio ()
225 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
235 ContentPanel::selected_text ()
239 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
240 if (!i->text.empty()) {
249 ContentPanel::selected_ffmpeg ()
251 FFmpegContentList sc;
253 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
254 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
264 ContentPanel::film_changed (Film::Property p)
268 case Film::CONTENT_ORDER:
275 BOOST_FOREACH (ContentSubPanel* i, panels()) {
281 ContentPanel::item_deselected ()
283 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
284 false and item_deselected_foo will handle the deselection.
286 _ignore_deselect = false;
287 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
291 ContentPanel::item_deselected_idle ()
293 if (!_ignore_deselect) {
299 ContentPanel::item_selected ()
301 _ignore_deselect = true;
306 ContentPanel::check_selection ()
308 if (_no_check_selection) {
312 setup_sensitivity ();
314 BOOST_FOREACH (ContentSubPanel* i, panels()) {
315 i->content_selection_changed ();
318 optional<DCPTime> go_to;
319 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
322 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
323 /* Rather special case; if we select a text subtitle file jump to its
326 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
328 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
331 if (!go_to || p < go_to.get()) {
336 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
337 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
338 DCPOMATIC_ASSERT (fv);
339 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
342 if (_timeline_dialog) {
343 _timeline_dialog->set_selection (selected());
346 /* Make required tabs visible */
348 if (_notebook->GetPageCount() > 1) {
349 /* There's more than one tab in the notebook so the current selection could be meaningful
350 to the user; store it so that we can try to restore it later.
352 _last_selected_tab = 0;
353 if (_notebook->GetSelection() != wxNOT_FOUND) {
354 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
358 bool have_video = false;
359 bool have_audio = false;
360 bool have_text[TEXT_COUNT] = { false, false };
361 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
368 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
369 have_text[j->original_type()] = true;
375 if (have_video && !_video_panel) {
376 _video_panel = new VideoPanel (this);
377 _notebook->InsertPage (off, _video_panel, _video_panel->name());
378 } else if (!have_video && _video_panel) {
379 _notebook->DeletePage (off);
387 if (have_audio && !_audio_panel) {
388 _audio_panel = new AudioPanel (this);
389 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
390 } else if (!have_audio && _audio_panel) {
391 _notebook->DeletePage (off);
399 for (int i = 0; i < TEXT_COUNT; ++i) {
400 if (have_text[i] && !_text_panel[i]) {
401 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
402 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
403 } else if (!have_text[i] && _text_panel[i]) {
404 _notebook->DeletePage (off);
412 /* Set up the tab selection */
415 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
416 if (_notebook->GetPage(i) == _last_selected_tab) {
417 _notebook->SetSelection (i);
422 if (!done && _notebook->GetPageCount() > 0) {
423 _notebook->SetSelection (0);
426 setup_sensitivity ();
431 ContentPanel::add_file_clicked ()
433 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
436 if (_parent->GetCurrentPage() != _splitter || !_film) {
440 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
441 non-Latin filenames or paths.
443 wxFileDialog* d = new wxFileDialog (
445 _("Choose a file or files"),
448 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
449 wxFD_MULTIPLE | wxFD_CHANGE_DIR
452 int const r = d->ShowModal ();
461 list<boost::filesystem::path> path_list;
462 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
463 path_list.push_back (wx_to_std (paths[i]));
465 add_files (path_list);
471 ContentPanel::add_folder_clicked ()
473 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
474 int r = d->ShowModal ();
475 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
482 list<shared_ptr<Content> > content;
485 content = content_factory (path);
486 } catch (exception& e) {
487 error_dialog (_parent, e.what());
491 if (content.empty ()) {
492 error_dialog (_parent, _("No content found in this folder."));
496 BOOST_FOREACH (shared_ptr<Content> i, content) {
497 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
499 ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
501 float const frame_rate = e->frame_rate ();
508 ic->set_video_frame_rate (frame_rate);
511 _film->examine_and_add_content (i);
516 ContentPanel::add_dcp_clicked ()
518 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
519 int r = d->ShowModal ();
520 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
528 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
529 } catch (exception& e) {
530 error_dialog (_parent, e.what());
534 /** @return true if this remove "click" should be ignored */
536 ContentPanel::remove_clicked (bool hotkey)
538 /* If the method was called because Delete was pressed check that our notebook page
539 is visible and that the content list is focussed.
541 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
545 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
546 _film->remove_content (i);
554 ContentPanel::timeline_clicked ()
560 if (_timeline_dialog) {
561 _timeline_dialog->Destroy ();
562 _timeline_dialog = 0;
565 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
566 _timeline_dialog->set_selection (selected());
567 _timeline_dialog->Show ();
571 ContentPanel::right_click (wxListEvent& ev)
573 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
576 /** Set up broad sensitivity based on the type of content that is selected */
578 ContentPanel::setup_sensitivity ()
580 _add_file->Enable (_generally_sensitive);
581 _add_folder->Enable (_generally_sensitive);
582 _add_dcp->Enable (_generally_sensitive);
584 ContentList selection = selected ();
585 ContentList video_selection = selected_video ();
586 ContentList audio_selection = selected_audio ();
588 _remove->Enable (_generally_sensitive && !selection.empty());
589 _earlier->Enable (_generally_sensitive && selection.size() == 1);
590 _later->Enable (_generally_sensitive && selection.size() == 1);
591 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
594 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
597 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
599 for (int i = 0; i < TEXT_COUNT; ++i) {
600 if (_text_panel[i]) {
601 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
604 _timing_panel->Enable (_generally_sensitive);
608 ContentPanel::set_film (shared_ptr<Film> film)
611 _audio_panel->set_film (film);
616 film_changed (Film::CONTENT);
617 film_changed (Film::AUDIO_CHANNELS);
623 setup_sensitivity ();
627 ContentPanel::set_general_sensitivity (bool s)
629 _generally_sensitive = s;
630 setup_sensitivity ();
634 ContentPanel::earlier_clicked ()
636 ContentList sel = selected ();
637 if (sel.size() == 1) {
638 _film->move_content_earlier (sel.front ());
644 ContentPanel::later_clicked ()
646 ContentList sel = selected ();
647 if (sel.size() == 1) {
648 _film->move_content_later (sel.front ());
654 ContentPanel::set_selection (weak_ptr<Content> wc)
656 ContentList content = _film->content ();
657 for (size_t i = 0; i < content.size(); ++i) {
658 if (content[i] == wc.lock ()) {
659 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
661 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
667 ContentPanel::set_selection (ContentList cl)
669 _no_check_selection = true;
671 ContentList content = _film->content ();
672 for (size_t i = 0; i < content.size(); ++i) {
673 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
674 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
676 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
680 _no_check_selection = false;
685 ContentPanel::film_content_changed (int property)
688 property == ContentProperty::PATH ||
689 property == DCPContentProperty::NEEDS_ASSETS ||
690 property == DCPContentProperty::NEEDS_KDM ||
691 property == DCPContentProperty::NAME
697 BOOST_FOREACH (ContentSubPanel* i, panels()) {
698 i->film_content_changed (property);
703 ContentPanel::setup ()
706 _content->DeleteAllItems ();
707 setup_sensitivity ();
711 ContentList content = _film->content ();
713 Content* selected_content = 0;
714 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
718 item.SetMask (wxLIST_MASK_DATA);
719 _content->GetItem (item);
720 selected_content = reinterpret_cast<Content*> (item.GetData ());
723 _content->DeleteAllItems ();
725 BOOST_FOREACH (shared_ptr<Content> i, content) {
726 int const t = _content->GetItemCount ();
727 bool const valid = i->paths_valid ();
729 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
730 bool const needs_kdm = dcp && dcp->needs_kdm ();
731 bool const needs_assets = dcp && dcp->needs_assets ();
733 wxString s = std_to_wx (i->summary ());
736 s = _("MISSING: ") + s;
740 s = _("NEEDS KDM: ") + s;
744 s = _("NEEDS OV: ") + s;
750 item.SetData (i.get ());
751 _content->InsertItem (item);
753 if (i.get() == selected_content) {
754 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
757 if (!valid || needs_kdm || needs_assets) {
758 _content->SetItemTextColour (t, *wxRED);
762 if (!selected_content && !content.empty ()) {
763 /* Select the item of content if none was selected before */
764 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
767 setup_sensitivity ();
771 ContentPanel::files_dropped (wxDropFilesEvent& event)
777 wxString* paths = event.GetFiles ();
778 list<boost::filesystem::path> path_list;
779 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
780 path_list.push_back (wx_to_std (paths[i]));
783 add_files (path_list);
787 ContentPanel::add_files (list<boost::filesystem::path> paths)
789 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
790 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
791 alphabetical sort is expected here.
794 paths.sort (CaseInsensitiveSorter ());
796 /* XXX: check for lots of files here and do something */
799 BOOST_FOREACH (boost::filesystem::path i, paths) {
800 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
801 _film->examine_and_add_content (j);
804 } catch (exception& e) {
805 error_dialog (_parent, e.what());
809 list<ContentSubPanel*>
810 ContentPanel::panels () const
812 list<ContentSubPanel*> p;
814 p.push_back (_video_panel);
817 p.push_back (_audio_panel);
819 for (int i = 0; i < TEXT_COUNT; ++i) {
820 if (_text_panel[i]) {
821 p.push_back (_text_panel[i]);
824 p.push_back (_timing_panel);