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 optional<wxRect> screen;
103 int const sn = wxDisplay::GetFromWindow(_splitter);
105 screen = wxDisplay(sn).GetClientArea();
107 wxPanel* top = new wxPanel (_splitter);
109 _menu = new ContentMenu (_splitter);
113 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
115 _content = new wxListCtrl (top, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
116 _content->DragAcceptFiles (true);
117 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
119 _content->InsertColumn (0, wxT(""));
120 _content->SetColumnWidth (0, 512);
122 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
124 _add_file = new Button (top, _("Add file(s)..."));
125 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
126 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
128 _add_folder = new Button (top, _("Add folder..."));
129 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
130 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
132 _add_dcp = new Button (top, _("Add DCP..."));
133 _add_dcp->SetToolTip (_("Add a DCP."));
134 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
136 _remove = new Button (top, _("Remove"));
137 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
138 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
140 _earlier = new Button (top, _("Earlier"));
141 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
142 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
144 _later = new Button (top, _("Later"));
145 _later->SetToolTip (_("Move the selected piece of content later in the film."));
146 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
148 _timeline = new Button (top, _("Timeline..."));
149 _timeline->SetToolTip (_("Open the timeline for the film."));
150 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
152 s->Add (b, 0, wxALL, 4);
156 _notebook = new wxNotebook (_splitter, wxID_ANY);
158 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
159 enough on small displays to leave space for the content area.
162 _splitter->SplitHorizontally (top, _notebook, screen->height > 800 ? -600 : -150);
165 _timing_panel = new TimingPanel (this, _film_viewer);
166 _notebook->AddPage (_timing_panel, _("Timing"), false);
168 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
169 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
170 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
171 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
172 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
173 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
174 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
175 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
176 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
177 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
178 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
182 ContentPanel::selected ()
187 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
192 ContentList cl = _film->content();
193 if (s < int (cl.size())) {
194 sel.push_back (cl[s]);
202 ContentPanel::selected_video ()
206 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
216 ContentPanel::selected_audio ()
220 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
230 ContentPanel::selected_text ()
234 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
235 if (!i->text.empty()) {
244 ContentPanel::selected_ffmpeg ()
246 FFmpegContentList sc;
248 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
249 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
259 ContentPanel::film_changed (Film::Property p)
263 case Film::CONTENT_ORDER:
270 BOOST_FOREACH (ContentSubPanel* i, panels()) {
276 ContentPanel::item_deselected ()
278 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
279 false and item_deselected_foo will handle the deselection.
281 _ignore_deselect = false;
282 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
286 ContentPanel::item_deselected_idle ()
288 if (!_ignore_deselect) {
294 ContentPanel::item_selected ()
296 _ignore_deselect = true;
301 ContentPanel::check_selection ()
303 if (_last_selected == selected()) {
304 /* This was triggered by a re-build of the view but the selection
305 did not really change.
310 if (_no_check_selection) {
314 _last_selected = selected ();
316 setup_sensitivity ();
318 BOOST_FOREACH (ContentSubPanel* i, panels()) {
319 i->content_selection_changed ();
322 optional<DCPTime> go_to;
323 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
326 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
327 /* Rather special case; if we select a text subtitle file jump to its
330 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
332 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
335 if (!go_to || p < go_to.get()) {
340 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
341 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
342 DCPOMATIC_ASSERT (fv);
343 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
346 if (_timeline_dialog) {
347 _timeline_dialog->set_selection (selected());
350 /* Make required tabs visible */
352 if (_notebook->GetPageCount() > 1) {
353 /* There's more than one tab in the notebook so the current selection could be meaningful
354 to the user; store it so that we can try to restore it later.
356 _last_selected_tab = 0;
357 if (_notebook->GetSelection() != wxNOT_FOUND) {
358 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
362 bool have_video = false;
363 bool have_audio = false;
364 bool have_text[TEXT_COUNT] = { false, false };
365 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
372 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
373 have_text[j->original_type()] = true;
379 if (have_video && !_video_panel) {
380 _video_panel = new VideoPanel (this);
381 _notebook->InsertPage (off, _video_panel, _video_panel->name());
382 } else if (!have_video && _video_panel) {
383 _notebook->DeletePage (off);
391 if (have_audio && !_audio_panel) {
392 _audio_panel = new AudioPanel (this);
393 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
394 } else if (!have_audio && _audio_panel) {
395 _notebook->DeletePage (off);
403 for (int i = 0; i < TEXT_COUNT; ++i) {
404 if (have_text[i] && !_text_panel[i]) {
405 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
406 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
407 } else if (!have_text[i] && _text_panel[i]) {
408 _notebook->DeletePage (off);
416 /* Set up the tab selection */
419 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
420 if (_notebook->GetPage(i) == _last_selected_tab) {
421 _notebook->SetSelection (i);
426 if (!done && _notebook->GetPageCount() > 0) {
427 _notebook->SetSelection (0);
430 setup_sensitivity ();
435 ContentPanel::add_file_clicked ()
437 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
440 if (_parent->GetCurrentPage() != _splitter || !_film) {
444 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
445 non-Latin filenames or paths.
447 wxFileDialog* d = new wxFileDialog (
449 _("Choose a file or files"),
452 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
453 wxFD_MULTIPLE | wxFD_CHANGE_DIR
456 int const r = d->ShowModal ();
465 list<boost::filesystem::path> path_list;
466 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
467 path_list.push_back (wx_to_std (paths[i]));
469 add_files (path_list);
475 ContentPanel::add_folder_clicked ()
477 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
478 int r = d->ShowModal ();
479 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
486 list<shared_ptr<Content> > content;
489 content = content_factory (path);
490 } catch (exception& e) {
491 error_dialog (_parent, e.what());
495 if (content.empty ()) {
496 error_dialog (_parent, _("No content found in this folder."));
500 BOOST_FOREACH (shared_ptr<Content> i, content) {
501 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
503 ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
505 float const frame_rate = e->frame_rate ();
512 ic->set_video_frame_rate (frame_rate);
515 _film->examine_and_add_content (i);
520 ContentPanel::add_dcp_clicked ()
522 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
523 int r = d->ShowModal ();
524 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
532 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
533 } catch (exception& e) {
534 error_dialog (_parent, e.what());
538 /** @return true if this remove "click" should be ignored */
540 ContentPanel::remove_clicked (bool hotkey)
542 /* If the method was called because Delete was pressed check that our notebook page
543 is visible and that the content list is focussed.
545 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
549 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
550 _film->remove_content (i);
558 ContentPanel::timeline_clicked ()
564 if (_timeline_dialog) {
565 _timeline_dialog->Destroy ();
566 _timeline_dialog = 0;
569 _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
570 _timeline_dialog->set_selection (selected());
571 _timeline_dialog->Show ();
575 ContentPanel::right_click (wxListEvent& ev)
577 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
580 /** Set up broad sensitivity based on the type of content that is selected */
582 ContentPanel::setup_sensitivity ()
584 _add_file->Enable (_generally_sensitive);
585 _add_folder->Enable (_generally_sensitive);
586 _add_dcp->Enable (_generally_sensitive);
588 ContentList selection = selected ();
589 ContentList video_selection = selected_video ();
590 ContentList audio_selection = selected_audio ();
592 _remove->Enable (_generally_sensitive && !selection.empty());
593 _earlier->Enable (_generally_sensitive && selection.size() == 1);
594 _later->Enable (_generally_sensitive && selection.size() == 1);
595 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
598 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
601 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
603 for (int i = 0; i < TEXT_COUNT; ++i) {
604 if (_text_panel[i]) {
605 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
608 _timing_panel->Enable (_generally_sensitive);
612 ContentPanel::set_film (shared_ptr<Film> film)
615 _audio_panel->set_film (film);
620 film_changed (Film::CONTENT);
621 film_changed (Film::AUDIO_CHANNELS);
627 setup_sensitivity ();
631 ContentPanel::set_general_sensitivity (bool s)
633 _generally_sensitive = s;
634 setup_sensitivity ();
638 ContentPanel::earlier_clicked ()
640 ContentList sel = selected ();
641 if (sel.size() == 1) {
642 _film->move_content_earlier (sel.front ());
648 ContentPanel::later_clicked ()
650 ContentList sel = selected ();
651 if (sel.size() == 1) {
652 _film->move_content_later (sel.front ());
658 ContentPanel::set_selection (weak_ptr<Content> wc)
660 ContentList content = _film->content ();
661 for (size_t i = 0; i < content.size(); ++i) {
662 if (content[i] == wc.lock ()) {
663 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
665 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
671 ContentPanel::set_selection (ContentList cl)
673 _no_check_selection = true;
675 ContentList content = _film->content ();
676 for (size_t i = 0; i < content.size(); ++i) {
677 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
678 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
680 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
684 _no_check_selection = false;
689 ContentPanel::film_content_changed (int property)
692 property == ContentProperty::PATH ||
693 property == DCPContentProperty::NEEDS_ASSETS ||
694 property == DCPContentProperty::NEEDS_KDM ||
695 property == DCPContentProperty::NAME
701 BOOST_FOREACH (ContentSubPanel* i, panels()) {
702 i->film_content_changed (property);
707 ContentPanel::setup ()
710 _content->DeleteAllItems ();
711 setup_sensitivity ();
715 ContentList content = _film->content ();
717 Content* selected_content = 0;
718 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
722 item.SetMask (wxLIST_MASK_DATA);
723 _content->GetItem (item);
724 selected_content = reinterpret_cast<Content*> (item.GetData ());
727 _content->DeleteAllItems ();
729 BOOST_FOREACH (shared_ptr<Content> i, content) {
730 int const t = _content->GetItemCount ();
731 bool const valid = i->paths_valid ();
733 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
734 bool const needs_kdm = dcp && dcp->needs_kdm ();
735 bool const needs_assets = dcp && dcp->needs_assets ();
737 wxString s = std_to_wx (i->summary ());
740 s = _("MISSING: ") + s;
744 s = _("NEEDS KDM: ") + s;
748 s = _("NEEDS OV: ") + s;
754 item.SetData (i.get ());
755 _content->InsertItem (item);
757 if (i.get() == selected_content) {
758 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
761 if (!valid || needs_kdm || needs_assets) {
762 _content->SetItemTextColour (t, *wxRED);
766 if (!selected_content && !content.empty ()) {
767 /* Select the item of content if none was selected before */
768 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
771 setup_sensitivity ();
775 ContentPanel::files_dropped (wxDropFilesEvent& event)
781 wxString* paths = event.GetFiles ();
782 list<boost::filesystem::path> path_list;
783 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
784 path_list.push_back (wx_to_std (paths[i]));
787 add_files (path_list);
791 ContentPanel::add_files (list<boost::filesystem::path> paths)
793 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
794 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
795 alphabetical sort is expected here.
798 paths.sort (CaseInsensitiveSorter ());
800 /* XXX: check for lots of files here and do something */
803 BOOST_FOREACH (boost::filesystem::path i, paths) {
804 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
805 _film->examine_and_add_content (j);
808 } catch (exception& e) {
809 error_dialog (_parent, e.what());
813 list<ContentSubPanel*>
814 ContentPanel::panels () const
816 list<ContentSubPanel*> p;
818 p.push_back (_video_panel);
821 p.push_back (_audio_panel);
823 for (int i = 0; i < TEXT_COUNT; ++i) {
824 if (_text_panel[i]) {
825 p.push_back (_text_panel[i]);
828 p.push_back (_timing_panel);