2 Copyright (C) 2012-2018 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 "lib/audio_content.h"
31 #include "lib/text_content.h"
32 #include "lib/video_content.h"
33 #include "lib/ffmpeg_content.h"
34 #include "lib/content_factory.h"
35 #include "lib/image_content.h"
36 #include "lib/dcp_content.h"
37 #include "lib/case_insensitive_sorter.h"
38 #include "lib/playlist.h"
39 #include "lib/config.h"
41 #include "lib/compose.hpp"
42 #include "lib/string_text_file_content.h"
43 #include "lib/string_text_file.h"
44 #include "lib/dcpomatic_log.h"
46 #include <wx/notebook.h>
47 #include <wx/listctrl.h>
48 #include <boost/filesystem.hpp>
49 #include <boost/foreach.hpp>
58 using boost::shared_ptr;
59 using boost::weak_ptr;
60 using boost::dynamic_pointer_cast;
61 using boost::optional;
63 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
66 , _timeline_dialog (0)
68 , _last_selected_tab (0)
70 , _film_viewer (viewer)
71 , _generally_sensitive (true)
72 , _ignore_deselect (false)
74 for (int i = 0; i < TEXT_COUNT; ++i) {
78 _panel = new wxPanel (n);
79 _sizer = new wxBoxSizer (wxVERTICAL);
80 _panel->SetSizer (_sizer);
82 _menu = new ContentMenu (_panel);
85 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
87 _content = new wxListCtrl (_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
88 _content->DragAcceptFiles (true);
89 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
91 _content->InsertColumn (0, wxT(""));
92 _content->SetColumnWidth (0, 512);
94 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
96 _add_file = new wxButton (_panel, wxID_ANY, _("Add file(s)..."));
97 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
98 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
100 _add_folder = new wxButton (_panel, wxID_ANY, _("Add folder..."));
101 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
102 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
104 _add_dcp = new wxButton (_panel, wxID_ANY, _("Add DCP..."));
105 _add_dcp->SetToolTip (_("Add a DCP."));
106 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
108 _remove = new wxButton (_panel, wxID_ANY, _("Remove"));
109 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
110 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
112 _earlier = new wxButton (_panel, wxID_ANY, _("Earlier"));
113 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
114 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
116 _later = new wxButton (_panel, wxID_ANY, _("Later"));
117 _later->SetToolTip (_("Move the selected piece of content later in the film."));
118 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
120 _timeline = new wxButton (_panel, wxID_ANY, _("Timeline..."));
121 _timeline->SetToolTip (_("Open the timeline for the film."));
122 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
124 s->Add (b, 0, wxALL, 4);
126 _sizer->Add (s, 0, wxEXPAND | wxALL, 6);
129 _notebook = new wxNotebook (_panel, wxID_ANY);
130 _sizer->Add (_notebook, 1, wxEXPAND | wxTOP, 6);
132 _timing_panel = new TimingPanel (this, _film_viewer);
133 _notebook->AddPage (_timing_panel, _("Timing"), false);
135 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
136 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
137 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
138 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
139 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
140 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
141 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
142 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
143 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
144 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
145 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
149 ContentPanel::selected ()
154 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
159 ContentList cl = _film->content();
160 if (s < int (cl.size())) {
161 sel.push_back (cl[s]);
169 ContentPanel::selected_video ()
173 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
183 ContentPanel::selected_audio ()
187 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
197 ContentPanel::selected_text ()
201 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
202 if (!i->text.empty()) {
211 ContentPanel::selected_ffmpeg ()
213 FFmpegContentList sc;
215 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
216 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
226 ContentPanel::film_changed (Film::Property p)
230 case Film::CONTENT_ORDER:
237 BOOST_FOREACH (ContentSubPanel* i, panels()) {
243 ContentPanel::item_deselected ()
245 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
246 false and item_deselected_foo will handle the deselection.
248 _ignore_deselect = false;
249 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
253 ContentPanel::item_deselected_idle ()
255 if (!_ignore_deselect) {
261 ContentPanel::item_selected ()
263 _ignore_deselect = true;
268 ContentPanel::check_selection ()
270 if (_last_selected == selected()) {
271 /* This was triggered by a re-build of the view but the selection
272 did not really change.
277 _last_selected = selected ();
279 setup_sensitivity ();
281 BOOST_FOREACH (ContentSubPanel* i, panels()) {
282 i->content_selection_changed ();
285 optional<DCPTime> go_to;
286 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
289 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
290 /* Rather special case; if we select a text subtitle file jump to its
293 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
295 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
298 if (!go_to || p < go_to.get()) {
303 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
304 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
305 DCPOMATIC_ASSERT (fv);
306 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
309 if (_timeline_dialog) {
310 _timeline_dialog->set_selection (selected());
313 /* Make required tabs visible */
315 if (_notebook->GetPageCount() > 1) {
316 /* There's more than one tab in the notebook so the current selection could be meaningful
317 to the user; store it so that we can try to restore it later.
319 _last_selected_tab = 0;
320 if (_notebook->GetSelection() != wxNOT_FOUND) {
321 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
325 bool have_video = false;
326 bool have_audio = false;
327 bool have_text[TEXT_COUNT] = { false, false };
328 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
335 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
336 have_text[j->original_type()] = true;
342 if (have_video && !_video_panel) {
343 _video_panel = new VideoPanel (this);
344 _notebook->InsertPage (off, _video_panel, _video_panel->name());
345 } else if (!have_video && _video_panel) {
346 _notebook->DeletePage (off);
354 if (have_audio && !_audio_panel) {
355 _audio_panel = new AudioPanel (this);
356 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
357 } else if (!have_audio && _audio_panel) {
358 _notebook->DeletePage (off);
366 for (int i = 0; i < TEXT_COUNT; ++i) {
367 if (have_text[i] && !_text_panel[i]) {
368 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
369 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
370 } else if (!have_text[i] && _text_panel[i]) {
371 _notebook->DeletePage (off);
379 /* Set up the tab selection */
382 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
383 if (_notebook->GetPage(i) == _last_selected_tab) {
384 _notebook->SetSelection (i);
389 if (!done && _notebook->GetPageCount() > 0) {
390 _notebook->SetSelection (0);
393 setup_sensitivity ();
398 ContentPanel::add_file_clicked ()
400 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
403 if (_parent->GetCurrentPage() != _panel || !_film) {
407 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
408 non-Latin filenames or paths.
410 wxFileDialog* d = new wxFileDialog (
412 _("Choose a file or files"),
415 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
416 wxFD_MULTIPLE | wxFD_CHANGE_DIR
419 int const r = d->ShowModal ();
428 list<boost::filesystem::path> path_list;
429 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
430 path_list.push_back (wx_to_std (paths[i]));
432 add_files (path_list);
438 ContentPanel::add_folder_clicked ()
440 wxDirDialog* d = new wxDirDialog (_panel, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
441 int r = d->ShowModal ();
442 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
449 list<shared_ptr<Content> > content;
452 content = content_factory (path);
453 } catch (exception& e) {
454 error_dialog (_parent, e.what());
458 if (content.empty ()) {
459 error_dialog (_parent, _("No content found in this folder."));
463 BOOST_FOREACH (shared_ptr<Content> i, content) {
464 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
466 ImageSequenceDialog* e = new ImageSequenceDialog (_panel);
468 float const frame_rate = e->frame_rate ();
475 ic->set_video_frame_rate (frame_rate);
478 _film->examine_and_add_content (i);
483 ContentPanel::add_dcp_clicked ()
485 wxDirDialog* d = new wxDirDialog (_panel, _("Choose a DCP folder"), wxT (""), wxDD_DIR_MUST_EXIST);
486 int r = d->ShowModal ();
487 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
495 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
496 } catch (exception& e) {
497 error_dialog (_parent, e.what());
501 /** @return true if this remove "click" should be ignored */
503 ContentPanel::remove_clicked (bool hotkey)
505 /* If the method was called because Delete was pressed check that our notebook page
506 is visible and that the content list is focussed.
508 if (hotkey && (_parent->GetCurrentPage() != _panel || !_content->HasFocus())) {
512 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
513 _film->remove_content (i);
521 ContentPanel::timeline_clicked ()
527 if (_timeline_dialog) {
528 _timeline_dialog->Destroy ();
529 _timeline_dialog = 0;
532 _timeline_dialog = new TimelineDialog (this, _film);
533 _timeline_dialog->set_selection (selected());
534 _timeline_dialog->Show ();
538 ContentPanel::right_click (wxListEvent& ev)
540 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
543 /** Set up broad sensitivity based on the type of content that is selected */
545 ContentPanel::setup_sensitivity ()
547 _add_file->Enable (_generally_sensitive);
548 _add_folder->Enable (_generally_sensitive);
549 _add_dcp->Enable (_generally_sensitive);
551 ContentList selection = selected ();
552 ContentList video_selection = selected_video ();
553 ContentList audio_selection = selected_audio ();
555 _remove->Enable (_generally_sensitive && !selection.empty());
556 _earlier->Enable (_generally_sensitive && selection.size() == 1);
557 _later->Enable (_generally_sensitive && selection.size() == 1);
558 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
561 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
564 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
566 for (int i = 0; i < TEXT_COUNT; ++i) {
567 if (_text_panel[i]) {
568 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
571 _timing_panel->Enable (_generally_sensitive);
575 ContentPanel::set_film (shared_ptr<Film> film)
578 _audio_panel->set_film (film);
583 film_changed (Film::CONTENT);
584 film_changed (Film::AUDIO_CHANNELS);
586 setup_sensitivity ();
590 ContentPanel::set_general_sensitivity (bool s)
592 _generally_sensitive = s;
593 setup_sensitivity ();
597 ContentPanel::earlier_clicked ()
599 ContentList sel = selected ();
600 if (sel.size() == 1) {
601 _film->move_content_earlier (sel.front ());
607 ContentPanel::later_clicked ()
609 ContentList sel = selected ();
610 if (sel.size() == 1) {
611 _film->move_content_later (sel.front ());
617 ContentPanel::set_selection (weak_ptr<Content> wc)
619 ContentList content = _film->content ();
620 for (size_t i = 0; i < content.size(); ++i) {
621 if (content[i] == wc.lock ()) {
622 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
624 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
630 ContentPanel::set_selection (ContentList cl)
632 ContentList content = _film->content ();
633 for (size_t i = 0; i < content.size(); ++i) {
634 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
635 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
637 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
643 ContentPanel::film_content_changed (int property)
646 property == ContentProperty::PATH ||
647 property == DCPContentProperty::NEEDS_ASSETS ||
648 property == DCPContentProperty::NEEDS_KDM ||
649 property == DCPContentProperty::NAME
655 BOOST_FOREACH (ContentSubPanel* i, panels()) {
656 i->film_content_changed (property);
661 ContentPanel::setup ()
663 ContentList content = _film->content ();
665 Content* selected_content = 0;
666 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
670 item.SetMask (wxLIST_MASK_DATA);
671 _content->GetItem (item);
672 selected_content = reinterpret_cast<Content*> (item.GetData ());
675 _content->DeleteAllItems ();
677 BOOST_FOREACH (shared_ptr<Content> i, content) {
678 int const t = _content->GetItemCount ();
679 bool const valid = i->paths_valid ();
681 /* Temporary debugging for Igor */
682 BOOST_FOREACH (boost::filesystem::path j, i->paths()) {
683 LOG_GENERAL ("Check %1 %2 answer %3", j.string(), boost::filesystem::exists(j) ? "yes" : "no", valid ? "yes" : "no");
686 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
687 bool const needs_kdm = dcp && dcp->needs_kdm ();
688 bool const needs_assets = dcp && dcp->needs_assets ();
690 wxString s = std_to_wx (i->summary ());
693 s = _("MISSING: ") + s;
697 s = _("NEEDS KDM: ") + s;
701 s = _("NEEDS OV: ") + s;
707 item.SetData (i.get ());
708 _content->InsertItem (item);
710 if (i.get() == selected_content) {
711 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
714 if (!valid || needs_kdm || needs_assets) {
715 _content->SetItemTextColour (t, *wxRED);
719 if (!selected_content && !content.empty ()) {
720 /* Select the item of content if none was selected before */
721 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
724 setup_sensitivity ();
728 ContentPanel::files_dropped (wxDropFilesEvent& event)
734 wxString* paths = event.GetFiles ();
735 list<boost::filesystem::path> path_list;
736 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
737 path_list.push_back (wx_to_std (paths[i]));
740 add_files (path_list);
744 ContentPanel::add_files (list<boost::filesystem::path> paths)
746 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
747 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
748 alphabetical sort is expected here.
751 paths.sort (CaseInsensitiveSorter ());
753 /* XXX: check for lots of files here and do something */
756 BOOST_FOREACH (boost::filesystem::path i, paths) {
757 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
758 _film->examine_and_add_content (j);
761 } catch (exception& e) {
762 error_dialog (_parent, e.what());
766 list<ContentSubPanel*>
767 ContentPanel::panels () const
769 list<ContentSubPanel*> p;
771 p.push_back (_video_panel);
774 p.push_back (_audio_panel);
776 for (int i = 0; i < TEXT_COUNT; ++i) {
777 if (_text_panel[i]) {
778 p.push_back (_text_panel[i]);
781 p.push_back (_timing_panel);