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;
65 class LimitedSplitter : public wxSplitterWindow
68 LimitedSplitter (wxWindow* parent)
69 : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_3D | wxSP_LIVE_UPDATE)
74 bool OnSashPositionChange (int new_position)
76 /* Try to stop the top bit of the splitter getting so small that buttons disappear */
77 return new_position > 220;
81 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
84 , _timeline_dialog (0)
86 , _last_selected_tab (0)
88 , _film_viewer (viewer)
89 , _generally_sensitive (true)
90 , _ignore_deselect (false)
92 for (int i = 0; i < TEXT_COUNT; ++i) {
96 _splitter = new LimitedSplitter (n);
97 wxDisplay display (wxDisplay::GetFromWindow(_splitter));
98 wxRect screen = display.GetClientArea();
99 wxPanel* top = new wxPanel (_splitter);
101 _menu = new ContentMenu (_splitter);
105 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
107 _content = new wxListCtrl (top, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
108 _content->DragAcceptFiles (true);
109 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
111 _content->InsertColumn (0, wxT(""));
112 _content->SetColumnWidth (0, 512);
114 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
116 _add_file = new Button (top, _("Add file(s)..."));
117 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
118 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
120 _add_folder = new Button (top, _("Add folder..."));
121 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
122 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
124 _add_dcp = new Button (top, _("Add DCP..."));
125 _add_dcp->SetToolTip (_("Add a DCP."));
126 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
128 _remove = new Button (top, _("Remove"));
129 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
130 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
132 _earlier = new Button (top, _("Earlier"));
133 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
134 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
136 _later = new Button (top, _("Later"));
137 _later->SetToolTip (_("Move the selected piece of content later in the film."));
138 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
140 _timeline = new Button (top, _("Timeline..."));
141 _timeline->SetToolTip (_("Open the timeline for the film."));
142 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
144 s->Add (b, 0, wxALL, 4);
148 _notebook = new wxNotebook (_splitter, wxID_ANY);
150 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
151 enough on small displays to leave space for the content area.
153 _splitter->SplitHorizontally (top, _notebook, screen.height > 800 ? -600 : -150);
155 _timing_panel = new TimingPanel (this, _film_viewer);
156 _notebook->AddPage (_timing_panel, _("Timing"), false);
158 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
159 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
160 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
161 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
162 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
163 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
164 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
165 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
166 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
167 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
168 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
172 ContentPanel::selected ()
177 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
182 ContentList cl = _film->content();
183 if (s < int (cl.size())) {
184 sel.push_back (cl[s]);
192 ContentPanel::selected_video ()
196 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
206 ContentPanel::selected_audio ()
210 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
220 ContentPanel::selected_text ()
224 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
225 if (!i->text.empty()) {
234 ContentPanel::selected_ffmpeg ()
236 FFmpegContentList sc;
238 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
239 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
249 ContentPanel::film_changed (Film::Property p)
253 case Film::CONTENT_ORDER:
260 BOOST_FOREACH (ContentSubPanel* i, panels()) {
266 ContentPanel::item_deselected ()
268 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
269 false and item_deselected_foo will handle the deselection.
271 _ignore_deselect = false;
272 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
276 ContentPanel::item_deselected_idle ()
278 if (!_ignore_deselect) {
284 ContentPanel::item_selected ()
286 _ignore_deselect = true;
291 ContentPanel::check_selection ()
293 if (_last_selected == selected()) {
294 /* This was triggered by a re-build of the view but the selection
295 did not really change.
300 _last_selected = selected ();
302 setup_sensitivity ();
304 BOOST_FOREACH (ContentSubPanel* i, panels()) {
305 i->content_selection_changed ();
308 optional<DCPTime> go_to;
309 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
312 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
313 /* Rather special case; if we select a text subtitle file jump to its
316 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
318 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
321 if (!go_to || p < go_to.get()) {
326 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
327 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
328 DCPOMATIC_ASSERT (fv);
329 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
332 if (_timeline_dialog) {
333 _timeline_dialog->set_selection (selected());
336 /* Make required tabs visible */
338 if (_notebook->GetPageCount() > 1) {
339 /* There's more than one tab in the notebook so the current selection could be meaningful
340 to the user; store it so that we can try to restore it later.
342 _last_selected_tab = 0;
343 if (_notebook->GetSelection() != wxNOT_FOUND) {
344 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
348 bool have_video = false;
349 bool have_audio = false;
350 bool have_text[TEXT_COUNT] = { false, false };
351 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
358 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
359 have_text[j->original_type()] = true;
365 if (have_video && !_video_panel) {
366 _video_panel = new VideoPanel (this);
367 _notebook->InsertPage (off, _video_panel, _video_panel->name());
368 } else if (!have_video && _video_panel) {
369 _notebook->DeletePage (off);
377 if (have_audio && !_audio_panel) {
378 _audio_panel = new AudioPanel (this);
379 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
380 } else if (!have_audio && _audio_panel) {
381 _notebook->DeletePage (off);
389 for (int i = 0; i < TEXT_COUNT; ++i) {
390 if (have_text[i] && !_text_panel[i]) {
391 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
392 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
393 } else if (!have_text[i] && _text_panel[i]) {
394 _notebook->DeletePage (off);
402 /* Set up the tab selection */
405 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
406 if (_notebook->GetPage(i) == _last_selected_tab) {
407 _notebook->SetSelection (i);
412 if (!done && _notebook->GetPageCount() > 0) {
413 _notebook->SetSelection (0);
416 setup_sensitivity ();
421 ContentPanel::add_file_clicked ()
423 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
426 if (_parent->GetCurrentPage() != _splitter || !_film) {
430 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
431 non-Latin filenames or paths.
433 wxFileDialog* d = new wxFileDialog (
435 _("Choose a file or files"),
438 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
439 wxFD_MULTIPLE | wxFD_CHANGE_DIR
442 int const r = d->ShowModal ();
451 list<boost::filesystem::path> path_list;
452 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
453 path_list.push_back (wx_to_std (paths[i]));
455 add_files (path_list);
461 ContentPanel::add_folder_clicked ()
463 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
464 int r = d->ShowModal ();
465 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
472 list<shared_ptr<Content> > content;
475 content = content_factory (path);
476 } catch (exception& e) {
477 error_dialog (_parent, e.what());
481 if (content.empty ()) {
482 error_dialog (_parent, _("No content found in this folder."));
486 BOOST_FOREACH (shared_ptr<Content> i, content) {
487 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
489 ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
491 float const frame_rate = e->frame_rate ();
498 ic->set_video_frame_rate (frame_rate);
501 _film->examine_and_add_content (i);
506 ContentPanel::add_dcp_clicked ()
508 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
509 int r = d->ShowModal ();
510 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
518 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
519 } catch (exception& e) {
520 error_dialog (_parent, e.what());
524 /** @return true if this remove "click" should be ignored */
526 ContentPanel::remove_clicked (bool hotkey)
528 /* If the method was called because Delete was pressed check that our notebook page
529 is visible and that the content list is focussed.
531 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
535 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
536 _film->remove_content (i);
544 ContentPanel::timeline_clicked ()
550 if (_timeline_dialog) {
551 _timeline_dialog->Destroy ();
552 _timeline_dialog = 0;
555 _timeline_dialog = new TimelineDialog (this, _film);
556 _timeline_dialog->set_selection (selected());
557 _timeline_dialog->Show ();
561 ContentPanel::right_click (wxListEvent& ev)
563 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
566 /** Set up broad sensitivity based on the type of content that is selected */
568 ContentPanel::setup_sensitivity ()
570 _add_file->Enable (_generally_sensitive);
571 _add_folder->Enable (_generally_sensitive);
572 _add_dcp->Enable (_generally_sensitive);
574 ContentList selection = selected ();
575 ContentList video_selection = selected_video ();
576 ContentList audio_selection = selected_audio ();
578 _remove->Enable (_generally_sensitive && !selection.empty());
579 _earlier->Enable (_generally_sensitive && selection.size() == 1);
580 _later->Enable (_generally_sensitive && selection.size() == 1);
581 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
584 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
587 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
589 for (int i = 0; i < TEXT_COUNT; ++i) {
590 if (_text_panel[i]) {
591 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
594 _timing_panel->Enable (_generally_sensitive);
598 ContentPanel::set_film (shared_ptr<Film> film)
601 _audio_panel->set_film (film);
606 film_changed (Film::CONTENT);
607 film_changed (Film::AUDIO_CHANNELS);
613 setup_sensitivity ();
617 ContentPanel::set_general_sensitivity (bool s)
619 _generally_sensitive = s;
620 setup_sensitivity ();
624 ContentPanel::earlier_clicked ()
626 ContentList sel = selected ();
627 if (sel.size() == 1) {
628 _film->move_content_earlier (sel.front ());
634 ContentPanel::later_clicked ()
636 ContentList sel = selected ();
637 if (sel.size() == 1) {
638 _film->move_content_later (sel.front ());
644 ContentPanel::set_selection (weak_ptr<Content> wc)
646 ContentList content = _film->content ();
647 for (size_t i = 0; i < content.size(); ++i) {
648 if (content[i] == wc.lock ()) {
649 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
651 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
657 ContentPanel::set_selection (ContentList cl)
659 ContentList content = _film->content ();
660 for (size_t i = 0; i < content.size(); ++i) {
661 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
662 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
664 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
670 ContentPanel::film_content_changed (int property)
673 property == ContentProperty::PATH ||
674 property == DCPContentProperty::NEEDS_ASSETS ||
675 property == DCPContentProperty::NEEDS_KDM ||
676 property == DCPContentProperty::NAME
682 BOOST_FOREACH (ContentSubPanel* i, panels()) {
683 i->film_content_changed (property);
688 ContentPanel::setup ()
691 _content->DeleteAllItems ();
692 setup_sensitivity ();
696 ContentList content = _film->content ();
698 Content* selected_content = 0;
699 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
703 item.SetMask (wxLIST_MASK_DATA);
704 _content->GetItem (item);
705 selected_content = reinterpret_cast<Content*> (item.GetData ());
708 _content->DeleteAllItems ();
710 BOOST_FOREACH (shared_ptr<Content> i, content) {
711 int const t = _content->GetItemCount ();
712 bool const valid = i->paths_valid ();
714 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
715 bool const needs_kdm = dcp && dcp->needs_kdm ();
716 bool const needs_assets = dcp && dcp->needs_assets ();
718 wxString s = std_to_wx (i->summary ());
721 s = _("MISSING: ") + s;
725 s = _("NEEDS KDM: ") + s;
729 s = _("NEEDS OV: ") + s;
735 item.SetData (i.get ());
736 _content->InsertItem (item);
738 if (i.get() == selected_content) {
739 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
742 if (!valid || needs_kdm || needs_assets) {
743 _content->SetItemTextColour (t, *wxRED);
747 if (!selected_content && !content.empty ()) {
748 /* Select the item of content if none was selected before */
749 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
752 setup_sensitivity ();
756 ContentPanel::files_dropped (wxDropFilesEvent& event)
762 wxString* paths = event.GetFiles ();
763 list<boost::filesystem::path> path_list;
764 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
765 path_list.push_back (wx_to_std (paths[i]));
768 add_files (path_list);
772 ContentPanel::add_files (list<boost::filesystem::path> paths)
774 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
775 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
776 alphabetical sort is expected here.
779 paths.sort (CaseInsensitiveSorter ());
781 /* XXX: check for lots of files here and do something */
784 BOOST_FOREACH (boost::filesystem::path i, paths) {
785 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
786 _film->examine_and_add_content (j);
789 } catch (exception& e) {
790 error_dialog (_parent, e.what());
794 list<ContentSubPanel*>
795 ContentPanel::panels () const
797 list<ContentSubPanel*> p;
799 p.push_back (_video_panel);
802 p.push_back (_audio_panel);
804 for (int i = 0; i < TEXT_COUNT; ++i) {
805 if (_text_panel[i]) {
806 p.push_back (_text_panel[i]);
809 p.push_back (_timing_panel);