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)
75 bool OnSashPositionChange (int new_position)
77 /* Try to stop the top bit of the splitter getting so small that buttons disappear */
78 return new_position > 220;
82 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
85 , _timeline_dialog (0)
87 , _last_selected_tab (0)
89 , _film_viewer (viewer)
90 , _generally_sensitive (true)
91 , _ignore_deselect (false)
93 for (int i = 0; i < TEXT_COUNT; ++i) {
97 _splitter = new LimitedSplitter (n);
98 optional<wxRect> screen;
99 int const sn = wxDisplay::GetFromWindow(_splitter);
101 screen = wxDisplay(sn).GetClientArea();
103 wxPanel* top = new wxPanel (_splitter);
105 _menu = new ContentMenu (_splitter);
109 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
111 _content = new wxListCtrl (top, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
112 _content->DragAcceptFiles (true);
113 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
115 _content->InsertColumn (0, wxT(""));
116 _content->SetColumnWidth (0, 512);
118 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
120 _add_file = new Button (top, _("Add file(s)..."));
121 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
122 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
124 _add_folder = new Button (top, _("Add folder..."));
125 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
126 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
128 _add_dcp = new Button (top, _("Add DCP..."));
129 _add_dcp->SetToolTip (_("Add a DCP."));
130 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
132 _remove = new Button (top, _("Remove"));
133 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
134 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
136 _earlier = new Button (top, _("Earlier"));
137 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
138 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
140 _later = new Button (top, _("Later"));
141 _later->SetToolTip (_("Move the selected piece of content later in the film."));
142 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
144 _timeline = new Button (top, _("Timeline..."));
145 _timeline->SetToolTip (_("Open the timeline for the film."));
146 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
148 s->Add (b, 0, wxALL, 4);
152 _notebook = new wxNotebook (_splitter, wxID_ANY);
154 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
155 enough on small displays to leave space for the content area.
158 _splitter->SplitHorizontally (top, _notebook, screen->height > 800 ? -600 : -150);
161 _timing_panel = new TimingPanel (this, _film_viewer);
162 _notebook->AddPage (_timing_panel, _("Timing"), false);
164 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
165 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
166 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
167 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
168 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
169 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
170 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
171 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
172 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
173 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
174 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
178 ContentPanel::selected ()
183 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
188 ContentList cl = _film->content();
189 if (s < int (cl.size())) {
190 sel.push_back (cl[s]);
198 ContentPanel::selected_video ()
202 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
212 ContentPanel::selected_audio ()
216 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
226 ContentPanel::selected_text ()
230 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
231 if (!i->text.empty()) {
240 ContentPanel::selected_ffmpeg ()
242 FFmpegContentList sc;
244 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
245 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
255 ContentPanel::film_changed (Film::Property p)
259 case Film::CONTENT_ORDER:
266 BOOST_FOREACH (ContentSubPanel* i, panels()) {
272 ContentPanel::item_deselected ()
274 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
275 false and item_deselected_foo will handle the deselection.
277 _ignore_deselect = false;
278 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
282 ContentPanel::item_deselected_idle ()
284 if (!_ignore_deselect) {
290 ContentPanel::item_selected ()
292 _ignore_deselect = true;
297 ContentPanel::check_selection ()
299 if (_last_selected == selected()) {
300 /* This was triggered by a re-build of the view but the selection
301 did not really change.
306 _last_selected = selected ();
308 setup_sensitivity ();
310 BOOST_FOREACH (ContentSubPanel* i, panels()) {
311 i->content_selection_changed ();
314 optional<DCPTime> go_to;
315 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
318 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
319 /* Rather special case; if we select a text subtitle file jump to its
322 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
324 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
327 if (!go_to || p < go_to.get()) {
332 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
333 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
334 DCPOMATIC_ASSERT (fv);
335 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
338 if (_timeline_dialog) {
339 _timeline_dialog->set_selection (selected());
342 /* Make required tabs visible */
344 if (_notebook->GetPageCount() > 1) {
345 /* There's more than one tab in the notebook so the current selection could be meaningful
346 to the user; store it so that we can try to restore it later.
348 _last_selected_tab = 0;
349 if (_notebook->GetSelection() != wxNOT_FOUND) {
350 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
354 bool have_video = false;
355 bool have_audio = false;
356 bool have_text[TEXT_COUNT] = { false, false };
357 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
364 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
365 have_text[j->original_type()] = true;
371 if (have_video && !_video_panel) {
372 _video_panel = new VideoPanel (this);
373 _notebook->InsertPage (off, _video_panel, _video_panel->name());
374 } else if (!have_video && _video_panel) {
375 _notebook->DeletePage (off);
383 if (have_audio && !_audio_panel) {
384 _audio_panel = new AudioPanel (this);
385 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
386 } else if (!have_audio && _audio_panel) {
387 _notebook->DeletePage (off);
395 for (int i = 0; i < TEXT_COUNT; ++i) {
396 if (have_text[i] && !_text_panel[i]) {
397 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
398 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
399 } else if (!have_text[i] && _text_panel[i]) {
400 _notebook->DeletePage (off);
408 /* Set up the tab selection */
411 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
412 if (_notebook->GetPage(i) == _last_selected_tab) {
413 _notebook->SetSelection (i);
418 if (!done && _notebook->GetPageCount() > 0) {
419 _notebook->SetSelection (0);
422 setup_sensitivity ();
427 ContentPanel::add_file_clicked ()
429 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
432 if (_parent->GetCurrentPage() != _splitter || !_film) {
436 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
437 non-Latin filenames or paths.
439 wxFileDialog* d = new wxFileDialog (
441 _("Choose a file or files"),
444 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
445 wxFD_MULTIPLE | wxFD_CHANGE_DIR
448 int const r = d->ShowModal ();
457 list<boost::filesystem::path> path_list;
458 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
459 path_list.push_back (wx_to_std (paths[i]));
461 add_files (path_list);
467 ContentPanel::add_folder_clicked ()
469 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
470 int r = d->ShowModal ();
471 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
478 list<shared_ptr<Content> > content;
481 content = content_factory (path);
482 } catch (exception& e) {
483 error_dialog (_parent, e.what());
487 if (content.empty ()) {
488 error_dialog (_parent, _("No content found in this folder."));
492 BOOST_FOREACH (shared_ptr<Content> i, content) {
493 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
495 ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
497 float const frame_rate = e->frame_rate ();
504 ic->set_video_frame_rate (frame_rate);
507 _film->examine_and_add_content (i);
512 ContentPanel::add_dcp_clicked ()
514 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
515 int r = d->ShowModal ();
516 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
524 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
525 } catch (exception& e) {
526 error_dialog (_parent, e.what());
530 /** @return true if this remove "click" should be ignored */
532 ContentPanel::remove_clicked (bool hotkey)
534 /* If the method was called because Delete was pressed check that our notebook page
535 is visible and that the content list is focussed.
537 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
541 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
542 _film->remove_content (i);
550 ContentPanel::timeline_clicked ()
556 if (_timeline_dialog) {
557 _timeline_dialog->Destroy ();
558 _timeline_dialog = 0;
561 _timeline_dialog = new TimelineDialog (this, _film);
562 _timeline_dialog->set_selection (selected());
563 _timeline_dialog->Show ();
567 ContentPanel::right_click (wxListEvent& ev)
569 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
572 /** Set up broad sensitivity based on the type of content that is selected */
574 ContentPanel::setup_sensitivity ()
576 _add_file->Enable (_generally_sensitive);
577 _add_folder->Enable (_generally_sensitive);
578 _add_dcp->Enable (_generally_sensitive);
580 ContentList selection = selected ();
581 ContentList video_selection = selected_video ();
582 ContentList audio_selection = selected_audio ();
584 _remove->Enable (_generally_sensitive && !selection.empty());
585 _earlier->Enable (_generally_sensitive && selection.size() == 1);
586 _later->Enable (_generally_sensitive && selection.size() == 1);
587 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
590 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
593 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
595 for (int i = 0; i < TEXT_COUNT; ++i) {
596 if (_text_panel[i]) {
597 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
600 _timing_panel->Enable (_generally_sensitive);
604 ContentPanel::set_film (shared_ptr<Film> film)
607 _audio_panel->set_film (film);
612 film_changed (Film::CONTENT);
613 film_changed (Film::AUDIO_CHANNELS);
619 setup_sensitivity ();
623 ContentPanel::set_general_sensitivity (bool s)
625 _generally_sensitive = s;
626 setup_sensitivity ();
630 ContentPanel::earlier_clicked ()
632 ContentList sel = selected ();
633 if (sel.size() == 1) {
634 _film->move_content_earlier (sel.front ());
640 ContentPanel::later_clicked ()
642 ContentList sel = selected ();
643 if (sel.size() == 1) {
644 _film->move_content_later (sel.front ());
650 ContentPanel::set_selection (weak_ptr<Content> wc)
652 ContentList content = _film->content ();
653 for (size_t i = 0; i < content.size(); ++i) {
654 if (content[i] == wc.lock ()) {
655 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
657 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
663 ContentPanel::set_selection (ContentList cl)
665 ContentList content = _film->content ();
666 for (size_t i = 0; i < content.size(); ++i) {
667 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
668 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
670 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
676 ContentPanel::film_content_changed (int property)
679 property == ContentProperty::PATH ||
680 property == DCPContentProperty::NEEDS_ASSETS ||
681 property == DCPContentProperty::NEEDS_KDM ||
682 property == DCPContentProperty::NAME
688 BOOST_FOREACH (ContentSubPanel* i, panels()) {
689 i->film_content_changed (property);
694 ContentPanel::setup ()
697 _content->DeleteAllItems ();
698 setup_sensitivity ();
702 ContentList content = _film->content ();
704 Content* selected_content = 0;
705 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
709 item.SetMask (wxLIST_MASK_DATA);
710 _content->GetItem (item);
711 selected_content = reinterpret_cast<Content*> (item.GetData ());
714 _content->DeleteAllItems ();
716 BOOST_FOREACH (shared_ptr<Content> i, content) {
717 int const t = _content->GetItemCount ();
718 bool const valid = i->paths_valid ();
720 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
721 bool const needs_kdm = dcp && dcp->needs_kdm ();
722 bool const needs_assets = dcp && dcp->needs_assets ();
724 wxString s = std_to_wx (i->summary ());
727 s = _("MISSING: ") + s;
731 s = _("NEEDS KDM: ") + s;
735 s = _("NEEDS OV: ") + s;
741 item.SetData (i.get ());
742 _content->InsertItem (item);
744 if (i.get() == selected_content) {
745 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
748 if (!valid || needs_kdm || needs_assets) {
749 _content->SetItemTextColour (t, *wxRED);
753 if (!selected_content && !content.empty ()) {
754 /* Select the item of content if none was selected before */
755 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
758 setup_sensitivity ();
762 ContentPanel::files_dropped (wxDropFilesEvent& event)
768 wxString* paths = event.GetFiles ();
769 list<boost::filesystem::path> path_list;
770 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
771 path_list.push_back (wx_to_std (paths[i]));
774 add_files (path_list);
778 ContentPanel::add_files (list<boost::filesystem::path> paths)
780 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
781 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
782 alphabetical sort is expected here.
785 paths.sort (CaseInsensitiveSorter ());
787 /* XXX: check for lots of files here and do something */
790 BOOST_FOREACH (boost::filesystem::path i, paths) {
791 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
792 _film->examine_and_add_content (j);
795 } catch (exception& e) {
796 error_dialog (_parent, e.what());
800 list<ContentSubPanel*>
801 ContentPanel::panels () const
803 list<ContentSubPanel*> p;
805 p.push_back (_video_panel);
808 p.push_back (_audio_panel);
810 for (int i = 0; i < TEXT_COUNT; ++i) {
811 if (_text_panel[i]) {
812 p.push_back (_text_panel[i]);
815 p.push_back (_timing_panel);