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)
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 optional<wxRect> screen;
98 int const sn = wxDisplay::GetFromWindow(_splitter);
100 screen = wxDisplay(sn).GetClientArea();
102 wxPanel* top = new wxPanel (_splitter);
104 _menu = new ContentMenu (_splitter);
108 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
110 _content = new wxListCtrl (top, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
111 _content->DragAcceptFiles (true);
112 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
114 _content->InsertColumn (0, wxT(""));
115 _content->SetColumnWidth (0, 512);
117 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
119 _add_file = new Button (top, _("Add file(s)..."));
120 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
121 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
123 _add_folder = new Button (top, _("Add folder..."));
124 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
125 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
127 _add_dcp = new Button (top, _("Add DCP..."));
128 _add_dcp->SetToolTip (_("Add a DCP."));
129 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
131 _remove = new Button (top, _("Remove"));
132 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
133 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
135 _earlier = new Button (top, _("Earlier"));
136 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
137 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
139 _later = new Button (top, _("Later"));
140 _later->SetToolTip (_("Move the selected piece of content later in the film."));
141 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
143 _timeline = new Button (top, _("Timeline..."));
144 _timeline->SetToolTip (_("Open the timeline for the film."));
145 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
147 s->Add (b, 0, wxALL, 4);
151 _notebook = new wxNotebook (_splitter, wxID_ANY);
153 /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
154 enough on small displays to leave space for the content area.
157 _splitter->SplitHorizontally (top, _notebook, screen->height > 800 ? -600 : -150);
160 _timing_panel = new TimingPanel (this, _film_viewer);
161 _notebook->AddPage (_timing_panel, _("Timing"), false);
163 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
164 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
165 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
166 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
167 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
168 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
169 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
170 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
171 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
172 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
173 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
177 ContentPanel::selected ()
182 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
187 ContentList cl = _film->content();
188 if (s < int (cl.size())) {
189 sel.push_back (cl[s]);
197 ContentPanel::selected_video ()
201 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
211 ContentPanel::selected_audio ()
215 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
225 ContentPanel::selected_text ()
229 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
230 if (!i->text.empty()) {
239 ContentPanel::selected_ffmpeg ()
241 FFmpegContentList sc;
243 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
244 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
254 ContentPanel::film_changed (Film::Property p)
258 case Film::CONTENT_ORDER:
265 BOOST_FOREACH (ContentSubPanel* i, panels()) {
271 ContentPanel::item_deselected ()
273 /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
274 false and item_deselected_foo will handle the deselection.
276 _ignore_deselect = false;
277 signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
281 ContentPanel::item_deselected_idle ()
283 if (!_ignore_deselect) {
289 ContentPanel::item_selected ()
291 _ignore_deselect = true;
296 ContentPanel::check_selection ()
298 if (_last_selected == selected()) {
299 /* This was triggered by a re-build of the view but the selection
300 did not really change.
305 _last_selected = selected ();
307 setup_sensitivity ();
309 BOOST_FOREACH (ContentSubPanel* i, panels()) {
310 i->content_selection_changed ();
313 optional<DCPTime> go_to;
314 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
317 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
318 /* Rather special case; if we select a text subtitle file jump to its
321 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
323 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
326 if (!go_to || p < go_to.get()) {
331 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
332 shared_ptr<FilmViewer> fv = _film_viewer.lock ();
333 DCPOMATIC_ASSERT (fv);
334 signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
337 if (_timeline_dialog) {
338 _timeline_dialog->set_selection (selected());
341 /* Make required tabs visible */
343 if (_notebook->GetPageCount() > 1) {
344 /* There's more than one tab in the notebook so the current selection could be meaningful
345 to the user; store it so that we can try to restore it later.
347 _last_selected_tab = 0;
348 if (_notebook->GetSelection() != wxNOT_FOUND) {
349 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
353 bool have_video = false;
354 bool have_audio = false;
355 bool have_text[TEXT_COUNT] = { false, false };
356 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
363 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
364 have_text[j->original_type()] = true;
370 if (have_video && !_video_panel) {
371 _video_panel = new VideoPanel (this);
372 _notebook->InsertPage (off, _video_panel, _video_panel->name());
373 } else if (!have_video && _video_panel) {
374 _notebook->DeletePage (off);
382 if (have_audio && !_audio_panel) {
383 _audio_panel = new AudioPanel (this);
384 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
385 } else if (!have_audio && _audio_panel) {
386 _notebook->DeletePage (off);
394 for (int i = 0; i < TEXT_COUNT; ++i) {
395 if (have_text[i] && !_text_panel[i]) {
396 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
397 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
398 } else if (!have_text[i] && _text_panel[i]) {
399 _notebook->DeletePage (off);
407 /* Set up the tab selection */
410 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
411 if (_notebook->GetPage(i) == _last_selected_tab) {
412 _notebook->SetSelection (i);
417 if (!done && _notebook->GetPageCount() > 0) {
418 _notebook->SetSelection (0);
421 setup_sensitivity ();
426 ContentPanel::add_file_clicked ()
428 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
431 if (_parent->GetCurrentPage() != _splitter || !_film) {
435 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
436 non-Latin filenames or paths.
438 wxFileDialog* d = new wxFileDialog (
440 _("Choose a file or files"),
443 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
444 wxFD_MULTIPLE | wxFD_CHANGE_DIR
447 int const r = d->ShowModal ();
456 list<boost::filesystem::path> path_list;
457 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
458 path_list.push_back (wx_to_std (paths[i]));
460 add_files (path_list);
466 ContentPanel::add_folder_clicked ()
468 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
469 int r = d->ShowModal ();
470 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
477 list<shared_ptr<Content> > content;
480 content = content_factory (path);
481 } catch (exception& e) {
482 error_dialog (_parent, e.what());
486 if (content.empty ()) {
487 error_dialog (_parent, _("No content found in this folder."));
491 BOOST_FOREACH (shared_ptr<Content> i, content) {
492 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
494 ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
496 float const frame_rate = e->frame_rate ();
503 ic->set_video_frame_rate (frame_rate);
506 _film->examine_and_add_content (i);
511 ContentPanel::add_dcp_clicked ()
513 wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
514 int r = d->ShowModal ();
515 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
523 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
524 } catch (exception& e) {
525 error_dialog (_parent, e.what());
529 /** @return true if this remove "click" should be ignored */
531 ContentPanel::remove_clicked (bool hotkey)
533 /* If the method was called because Delete was pressed check that our notebook page
534 is visible and that the content list is focussed.
536 if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
540 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
541 _film->remove_content (i);
549 ContentPanel::timeline_clicked ()
555 if (_timeline_dialog) {
556 _timeline_dialog->Destroy ();
557 _timeline_dialog = 0;
560 _timeline_dialog = new TimelineDialog (this, _film);
561 _timeline_dialog->set_selection (selected());
562 _timeline_dialog->Show ();
566 ContentPanel::right_click (wxListEvent& ev)
568 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
571 /** Set up broad sensitivity based on the type of content that is selected */
573 ContentPanel::setup_sensitivity ()
575 _add_file->Enable (_generally_sensitive);
576 _add_folder->Enable (_generally_sensitive);
577 _add_dcp->Enable (_generally_sensitive);
579 ContentList selection = selected ();
580 ContentList video_selection = selected_video ();
581 ContentList audio_selection = selected_audio ();
583 _remove->Enable (_generally_sensitive && !selection.empty());
584 _earlier->Enable (_generally_sensitive && selection.size() == 1);
585 _later->Enable (_generally_sensitive && selection.size() == 1);
586 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
589 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
592 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
594 for (int i = 0; i < TEXT_COUNT; ++i) {
595 if (_text_panel[i]) {
596 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
599 _timing_panel->Enable (_generally_sensitive);
603 ContentPanel::set_film (shared_ptr<Film> film)
606 _audio_panel->set_film (film);
611 film_changed (Film::CONTENT);
612 film_changed (Film::AUDIO_CHANNELS);
618 setup_sensitivity ();
622 ContentPanel::set_general_sensitivity (bool s)
624 _generally_sensitive = s;
625 setup_sensitivity ();
629 ContentPanel::earlier_clicked ()
631 ContentList sel = selected ();
632 if (sel.size() == 1) {
633 _film->move_content_earlier (sel.front ());
639 ContentPanel::later_clicked ()
641 ContentList sel = selected ();
642 if (sel.size() == 1) {
643 _film->move_content_later (sel.front ());
649 ContentPanel::set_selection (weak_ptr<Content> wc)
651 ContentList content = _film->content ();
652 for (size_t i = 0; i < content.size(); ++i) {
653 if (content[i] == wc.lock ()) {
654 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
656 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
662 ContentPanel::set_selection (ContentList cl)
664 ContentList content = _film->content ();
665 for (size_t i = 0; i < content.size(); ++i) {
666 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
667 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
669 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
675 ContentPanel::film_content_changed (int property)
678 property == ContentProperty::PATH ||
679 property == DCPContentProperty::NEEDS_ASSETS ||
680 property == DCPContentProperty::NEEDS_KDM ||
681 property == DCPContentProperty::NAME
687 BOOST_FOREACH (ContentSubPanel* i, panels()) {
688 i->film_content_changed (property);
693 ContentPanel::setup ()
696 _content->DeleteAllItems ();
697 setup_sensitivity ();
701 ContentList content = _film->content ();
703 Content* selected_content = 0;
704 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
708 item.SetMask (wxLIST_MASK_DATA);
709 _content->GetItem (item);
710 selected_content = reinterpret_cast<Content*> (item.GetData ());
713 _content->DeleteAllItems ();
715 BOOST_FOREACH (shared_ptr<Content> i, content) {
716 int const t = _content->GetItemCount ();
717 bool const valid = i->paths_valid ();
719 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
720 bool const needs_kdm = dcp && dcp->needs_kdm ();
721 bool const needs_assets = dcp && dcp->needs_assets ();
723 wxString s = std_to_wx (i->summary ());
726 s = _("MISSING: ") + s;
730 s = _("NEEDS KDM: ") + s;
734 s = _("NEEDS OV: ") + s;
740 item.SetData (i.get ());
741 _content->InsertItem (item);
743 if (i.get() == selected_content) {
744 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
747 if (!valid || needs_kdm || needs_assets) {
748 _content->SetItemTextColour (t, *wxRED);
752 if (!selected_content && !content.empty ()) {
753 /* Select the item of content if none was selected before */
754 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
757 setup_sensitivity ();
761 ContentPanel::files_dropped (wxDropFilesEvent& event)
767 wxString* paths = event.GetFiles ();
768 list<boost::filesystem::path> path_list;
769 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
770 path_list.push_back (wx_to_std (paths[i]));
773 add_files (path_list);
777 ContentPanel::add_files (list<boost::filesystem::path> paths)
779 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
780 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
781 alphabetical sort is expected here.
784 paths.sort (CaseInsensitiveSorter ());
786 /* XXX: check for lots of files here and do something */
789 BOOST_FOREACH (boost::filesystem::path i, paths) {
790 BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
791 _film->examine_and_add_content (j);
794 } catch (exception& e) {
795 error_dialog (_parent, e.what());
799 list<ContentSubPanel*>
800 ContentPanel::panels () const
802 list<ContentSubPanel*> p;
804 p.push_back (_video_panel);
807 p.push_back (_audio_panel);
809 for (int i = 0; i < TEXT_COUNT; ++i) {
810 if (_text_panel[i]) {
811 p.push_back (_text_panel[i]);
814 p.push_back (_timing_panel);