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_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
71 /* This value doesn't really mean much but we just want to stop double-click on the
72 divider from shrinking the bottom panel (#1601).
74 SetMinimumPaneSize (64);
77 bool OnSashPositionChange (int new_position)
79 /* Try to stop the top bit of the splitter getting so small that buttons disappear */
80 return new_position > 220;
84 ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
87 , _timeline_dialog (0)
89 , _last_selected_tab (0)
91 , _film_viewer (viewer)
92 , _generally_sensitive (true)
93 , _ignore_deselect (false)
95 for (int i = 0; i < TEXT_COUNT; ++i) {
99 _splitter = new LimitedSplitter (n);
100 optional<wxRect> screen;
101 int const sn = wxDisplay::GetFromWindow(_splitter);
103 screen = wxDisplay(sn).GetClientArea();
105 wxPanel* top = new wxPanel (_splitter);
107 _menu = new ContentMenu (_splitter);
111 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
113 _content = new wxListCtrl (top, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
114 _content->DragAcceptFiles (true);
115 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
117 _content->InsertColumn (0, wxT(""));
118 _content->SetColumnWidth (0, 512);
120 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
122 _add_file = new Button (top, _("Add file(s)..."));
123 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
124 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
126 _add_folder = new Button (top, _("Add folder..."));
127 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
128 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
130 _add_dcp = new Button (top, _("Add DCP..."));
131 _add_dcp->SetToolTip (_("Add a DCP."));
132 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
134 _remove = new Button (top, _("Remove"));
135 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
136 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
138 _earlier = new Button (top, _("Earlier"));
139 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
140 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
142 _later = new Button (top, _("Later"));
143 _later->SetToolTip (_("Move the selected piece of content later in the film."));
144 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
146 _timeline = new Button (top, _("Timeline..."));
147 _timeline->SetToolTip (_("Open the timeline for the film."));
148 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
150 s->Add (b, 0, wxALL, 4);
154 _notebook = new wxNotebook (_splitter, wxID_ANY);
156 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
157 enough on small displays to leave space for the content area.
160 _splitter->SplitHorizontally (top, _notebook, screen->height > 800 ? -600 : -150);
163 _timing_panel = new TimingPanel (this, _film_viewer);
164 _notebook->AddPage (_timing_panel, _("Timing"), false);
166 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
167 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
168 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
169 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
170 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
171 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
172 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
173 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
174 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
175 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
176 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
180 ContentPanel::selected ()
185 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
190 ContentList cl = _film->content();
191 if (s < int (cl.size())) {
192 sel.push_back (cl[s]);
200 ContentPanel::selected_video ()
204 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
214 ContentPanel::selected_audio ()
218 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
228 ContentPanel::selected_text ()
232 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
233 if (!i->text.empty()) {
242 ContentPanel::selected_ffmpeg ()
244 FFmpegContentList sc;
246 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
247 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
257 ContentPanel::film_changed (Film::Property p)
261 case Film::CONTENT_ORDER:
268 BOOST_FOREACH (ContentSubPanel* i, panels()) {
274 ContentPanel::item_deselected ()
276 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
277 false and item_deselected_foo will handle the deselection.
279 _ignore_deselect = false;
280 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
284 ContentPanel::item_deselected_idle ()
286 if (!_ignore_deselect) {
292 ContentPanel::item_selected ()
294 _ignore_deselect = true;
299 ContentPanel::check_selection ()
301 if (_last_selected == selected()) {
302 /* This was triggered by a re-build of the view but the selection
303 did not really change.
308 _last_selected = selected ();
310 setup_sensitivity ();
312 BOOST_FOREACH (ContentSubPanel* i, panels()) {
313 i->content_selection_changed ();
316 optional<DCPTime> go_to;
317 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
320 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
321 /* Rather special case; if we select a text subtitle file jump to its
324 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
326 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
329 if (!go_to || p < go_to.get()) {
334 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
335 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
336 DCPOMATIC_ASSERT (fv);
337 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
340 if (_timeline_dialog) {
341 _timeline_dialog->set_selection (selected());
344 /* Make required tabs visible */
346 if (_notebook->GetPageCount() > 1) {
347 /* There's more than one tab in the notebook so the current selection could be meaningful
348 to the user; store it so that we can try to restore it later.
350 _last_selected_tab = 0;
351 if (_notebook->GetSelection() != wxNOT_FOUND) {
352 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
356 bool have_video = false;
357 bool have_audio = false;
358 bool have_text[TEXT_COUNT] = { false, false };
359 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
366 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
367 have_text[j->original_type()] = true;
373 if (have_video && !_video_panel) {
374 _video_panel = new VideoPanel (this);
375 _notebook->InsertPage (off, _video_panel, _video_panel->name());
376 } else if (!have_video && _video_panel) {
377 _notebook->DeletePage (off);
385 if (have_audio && !_audio_panel) {
386 _audio_panel = new AudioPanel (this);
387 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
388 } else if (!have_audio && _audio_panel) {
389 _notebook->DeletePage (off);
397 for (int i = 0; i < TEXT_COUNT; ++i) {
398 if (have_text[i] && !_text_panel[i]) {
399 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
400 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
401 } else if (!have_text[i] && _text_panel[i]) {
402 _notebook->DeletePage (off);
410 /* Set up the tab selection */
413 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
414 if (_notebook->GetPage(i) == _last_selected_tab) {
415 _notebook->SetSelection (i);
420 if (!done && _notebook->GetPageCount() > 0) {
421 _notebook->SetSelection (0);
424 setup_sensitivity ();
429 ContentPanel::add_file_clicked ()
431 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
434 if (_parent->GetCurrentPage() != _splitter || !_film) {
438 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
439 non-Latin filenames or paths.
441 wxFileDialog* d = new wxFileDialog (
443 _("Choose a file or files"),
446 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
447 wxFD_MULTIPLE | wxFD_CHANGE_DIR
450 int const r = d->ShowModal ();
459 list<boost::filesystem::path> path_list;
460 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
461 path_list.push_back (wx_to_std (paths[i]));
463 add_files (path_list);
469 ContentPanel::add_folder_clicked ()
471 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
472 int r = d->ShowModal ();
473 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
480 list<shared_ptr<Content> > content;
483 content = content_factory (path);
484 } catch (exception& e) {
485 error_dialog (_parent, e.what());
489 if (content.empty ()) {
490 error_dialog (_parent, _("No content found in this folder."));
494 BOOST_FOREACH (shared_ptr<Content> i, content) {
495 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
497 ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
499 float const frame_rate = e->frame_rate ();
506 ic->set_video_frame_rate (frame_rate);
509 _film->examine_and_add_content (i);
514 ContentPanel::add_dcp_clicked ()
516 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
517 int r = d->ShowModal ();
518 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
526 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
527 } catch (exception& e) {
528 error_dialog (_parent, e.what());
532 /** @return true if this remove "click" should be ignored */
534 ContentPanel::remove_clicked (bool hotkey)
536 /* If the method was called because Delete was pressed check that our notebook page
537 is visible and that the content list is focussed.
539 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
543 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
544 _film->remove_content (i);
552 ContentPanel::timeline_clicked ()
558 if (_timeline_dialog) {
559 _timeline_dialog->Destroy ();
560 _timeline_dialog = 0;
563 _timeline_dialog = new TimelineDialog (this, _film);
564 _timeline_dialog->set_selection (selected());
565 _timeline_dialog->Show ();
569 ContentPanel::right_click (wxListEvent& ev)
571 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
574 /** Set up broad sensitivity based on the type of content that is selected */
576 ContentPanel::setup_sensitivity ()
578 _add_file->Enable (_generally_sensitive);
579 _add_folder->Enable (_generally_sensitive);
580 _add_dcp->Enable (_generally_sensitive);
582 ContentList selection = selected ();
583 ContentList video_selection = selected_video ();
584 ContentList audio_selection = selected_audio ();
586 _remove->Enable (_generally_sensitive && !selection.empty());
587 _earlier->Enable (_generally_sensitive && selection.size() == 1);
588 _later->Enable (_generally_sensitive && selection.size() == 1);
589 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
592 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
595 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
597 for (int i = 0; i < TEXT_COUNT; ++i) {
598 if (_text_panel[i]) {
599 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
602 _timing_panel->Enable (_generally_sensitive);
606 ContentPanel::set_film (shared_ptr<Film> film)
609 _audio_panel->set_film (film);
614 film_changed (Film::CONTENT);
615 film_changed (Film::AUDIO_CHANNELS);
621 setup_sensitivity ();
625 ContentPanel::set_general_sensitivity (bool s)
627 _generally_sensitive = s;
628 setup_sensitivity ();
632 ContentPanel::earlier_clicked ()
634 ContentList sel = selected ();
635 if (sel.size() == 1) {
636 _film->move_content_earlier (sel.front ());
642 ContentPanel::later_clicked ()
644 ContentList sel = selected ();
645 if (sel.size() == 1) {
646 _film->move_content_later (sel.front ());
652 ContentPanel::set_selection (weak_ptr<Content> wc)
654 ContentList content = _film->content ();
655 for (size_t i = 0; i < content.size(); ++i) {
656 if (content[i] == wc.lock ()) {
657 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
659 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
665 ContentPanel::set_selection (ContentList cl)
667 ContentList content = _film->content ();
668 for (size_t i = 0; i < content.size(); ++i) {
669 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
670 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
672 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
678 ContentPanel::film_content_changed (int property)
681 property == ContentProperty::PATH ||
682 property == DCPContentProperty::NEEDS_ASSETS ||
683 property == DCPContentProperty::NEEDS_KDM ||
684 property == DCPContentProperty::NAME
690 BOOST_FOREACH (ContentSubPanel* i, panels()) {
691 i->film_content_changed (property);
696 ContentPanel::setup ()
699 _content->DeleteAllItems ();
700 setup_sensitivity ();
704 ContentList content = _film->content ();
706 Content* selected_content = 0;
707 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
711 item.SetMask (wxLIST_MASK_DATA);
712 _content->GetItem (item);
713 selected_content = reinterpret_cast<Content*> (item.GetData ());
716 _content->DeleteAllItems ();
718 BOOST_FOREACH (shared_ptr<Content> i, content) {
719 int const t = _content->GetItemCount ();
720 bool const valid = i->paths_valid ();
722 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
723 bool const needs_kdm = dcp && dcp->needs_kdm ();
724 bool const needs_assets = dcp && dcp->needs_assets ();
726 wxString s = std_to_wx (i->summary ());
729 s = _("MISSING: ") + s;
733 s = _("NEEDS KDM: ") + s;
737 s = _("NEEDS OV: ") + s;
743 item.SetData (i.get ());
744 _content->InsertItem (item);
746 if (i.get() == selected_content) {
747 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
750 if (!valid || needs_kdm || needs_assets) {
751 _content->SetItemTextColour (t, *wxRED);
755 if (!selected_content && !content.empty ()) {
756 /* Select the item of content if none was selected before */
757 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
760 setup_sensitivity ();
764 ContentPanel::files_dropped (wxDropFilesEvent& event)
770 wxString* paths = event.GetFiles ();
771 list<boost::filesystem::path> path_list;
772 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
773 path_list.push_back (wx_to_std (paths[i]));
776 add_files (path_list);
780 ContentPanel::add_files (list<boost::filesystem::path> paths)
782 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
783 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
784 alphabetical sort is expected here.
787 paths.sort (CaseInsensitiveSorter ());
789 /* XXX: check for lots of files here and do something */
792 BOOST_FOREACH (boost::filesystem::path i, paths) {
793 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
794 _film->examine_and_add_content (j);
797 } catch (exception& e) {
798 error_dialog (_parent, e.what());
802 list<ContentSubPanel*>
803 ContentPanel::panels () const
805 list<ContentSubPanel*> p;
807 p.push_back (_video_panel);
810 p.push_back (_audio_panel);
812 for (int i = 0; i < TEXT_COUNT; ++i) {
813 if (_text_panel[i]) {
814 p.push_back (_text_panel[i]);
817 p.push_back (_timing_panel);