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"
45 #include <wx/notebook.h>
46 #include <wx/listctrl.h>
47 #include <boost/filesystem.hpp>
48 #include <boost/foreach.hpp>
57 using boost::shared_ptr;
58 using boost::weak_ptr;
59 using boost::dynamic_pointer_cast;
60 using boost::optional;
62 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
64 ContentPanel::ContentPanel (wxNotebook* n, boost::shared_ptr<Film> film, FilmViewer* viewer)
67 , _timeline_dialog (0)
69 , _last_selected_tab (0)
71 , _film_viewer (viewer)
72 , _generally_sensitive (true)
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::selection_changed, this));
136 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::selection_changed, 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::selection_changed ()
245 if (_last_selected == selected()) {
246 /* This was triggered by a re-build of the view but the selection
247 did not really change.
252 _last_selected = selected ();
254 setup_sensitivity ();
256 BOOST_FOREACH (ContentSubPanel* i, panels()) {
257 i->content_selection_changed ();
260 optional<DCPTime> go_to;
261 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
264 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
265 /* Rather special case; if we select a text subtitle file jump to its
268 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
270 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
273 if (!go_to || p < go_to.get()) {
278 if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
279 signal_manager->when_idle(boost::bind(&FilmViewer::set_position, _film_viewer, go_to.get().ceil(_film->video_frame_rate())));
282 if (_timeline_dialog) {
283 _timeline_dialog->set_selection (selected());
286 /* Make required tabs visible */
288 if (_notebook->GetPageCount() > 1) {
289 /* There's more than one tab in the notebook so the current selection could be meaningful
290 to the user; store it so that we can try to restore it later.
292 _last_selected_tab = 0;
293 if (_notebook->GetSelection() != wxNOT_FOUND) {
294 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
298 bool have_video = false;
299 bool have_audio = false;
300 bool have_text[TEXT_COUNT] = { false, false };
301 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
308 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
309 have_text[j->original_type()] = true;
315 if (have_video && !_video_panel) {
316 _video_panel = new VideoPanel (this);
317 _notebook->InsertPage (off, _video_panel, _video_panel->name());
318 } else if (!have_video && _video_panel) {
319 _notebook->DeletePage (off);
327 if (have_audio && !_audio_panel) {
328 _audio_panel = new AudioPanel (this);
329 _audio_panel->set_film (_film);
330 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
331 } else if (!have_audio && _audio_panel) {
332 _notebook->DeletePage (off);
340 for (int i = 0; i < TEXT_COUNT; ++i) {
341 if (have_text[i] && !_text_panel[i]) {
342 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
343 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
344 } else if (!have_text[i] && _text_panel[i]) {
345 _notebook->DeletePage (off);
353 /* Set up the tab selection */
356 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
357 if (_notebook->GetPage(i) == _last_selected_tab) {
358 _notebook->SetSelection (i);
363 if (!done && _notebook->GetPageCount() > 0) {
364 _notebook->SetSelection (0);
367 setup_sensitivity ();
372 ContentPanel::add_file_clicked ()
374 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
377 if (_parent->GetCurrentPage() != _panel || !_film) {
381 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
382 non-Latin filenames or paths.
384 wxFileDialog* d = new wxFileDialog (
386 _("Choose a file or files"),
389 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
390 wxFD_MULTIPLE | wxFD_CHANGE_DIR
393 int const r = d->ShowModal ();
402 list<boost::filesystem::path> path_list;
403 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
404 path_list.push_back (wx_to_std (paths[i]));
406 add_files (path_list);
412 ContentPanel::add_folder_clicked ()
414 wxDirDialog* d = new wxDirDialog (_panel, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
415 int r = d->ShowModal ();
416 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
423 list<shared_ptr<Content> > content;
426 content = content_factory (_film, path);
427 } catch (exception& e) {
428 error_dialog (_parent, e.what());
432 if (content.empty ()) {
433 error_dialog (_parent, _("No content found in this folder."));
437 BOOST_FOREACH (shared_ptr<Content> i, content) {
438 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
440 ImageSequenceDialog* e = new ImageSequenceDialog (_panel);
442 float const frame_rate = e->frame_rate ();
449 ic->set_video_frame_rate (frame_rate);
452 _film->examine_and_add_content (i);
457 ContentPanel::add_dcp_clicked ()
459 wxDirDialog* d = new wxDirDialog (_panel, _("Choose a DCP folder"), wxT (""), wxDD_DIR_MUST_EXIST);
460 int r = d->ShowModal ();
461 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
469 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (_film, path)));
470 } catch (exception& e) {
471 error_dialog (_parent, e.what());
475 /** @return true if this remove "click" should be ignored */
477 ContentPanel::remove_clicked (bool hotkey)
479 /* If the method was called because Delete was pressed check that our notebook page
480 is visible and that the content list is focussed.
482 if (hotkey && (_parent->GetCurrentPage() != _panel || !_content->HasFocus())) {
486 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
487 _film->remove_content (i);
490 selection_changed ();
495 ContentPanel::timeline_clicked ()
501 if (_timeline_dialog) {
502 _timeline_dialog->Destroy ();
503 _timeline_dialog = 0;
506 _timeline_dialog = new TimelineDialog (this, _film);
507 _timeline_dialog->set_selection (selected());
508 _timeline_dialog->Show ();
512 ContentPanel::right_click (wxListEvent& ev)
514 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
517 /** Set up broad sensitivity based on the type of content that is selected */
519 ContentPanel::setup_sensitivity ()
521 _add_file->Enable (_generally_sensitive);
522 _add_folder->Enable (_generally_sensitive);
523 _add_dcp->Enable (_generally_sensitive);
525 ContentList selection = selected ();
526 ContentList video_selection = selected_video ();
527 ContentList audio_selection = selected_audio ();
529 _remove->Enable (_generally_sensitive && !selection.empty());
530 _earlier->Enable (_generally_sensitive && selection.size() == 1);
531 _later->Enable (_generally_sensitive && selection.size() == 1);
532 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
535 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
538 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
540 for (int i = 0; i < TEXT_COUNT; ++i) {
541 if (_text_panel[i]) {
542 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
545 _timing_panel->Enable (_generally_sensitive);
549 ContentPanel::set_film (shared_ptr<Film> film)
552 _audio_panel->set_film (film);
557 film_changed (Film::CONTENT);
558 film_changed (Film::AUDIO_CHANNELS);
559 selection_changed ();
560 setup_sensitivity ();
564 ContentPanel::set_general_sensitivity (bool s)
566 _generally_sensitive = s;
567 setup_sensitivity ();
571 ContentPanel::earlier_clicked ()
573 ContentList sel = selected ();
574 if (sel.size() == 1) {
575 _film->move_content_earlier (sel.front ());
576 selection_changed ();
581 ContentPanel::later_clicked ()
583 ContentList sel = selected ();
584 if (sel.size() == 1) {
585 _film->move_content_later (sel.front ());
586 selection_changed ();
591 ContentPanel::set_selection (weak_ptr<Content> wc)
593 ContentList content = _film->content ();
594 for (size_t i = 0; i < content.size(); ++i) {
595 if (content[i] == wc.lock ()) {
596 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
598 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
604 ContentPanel::set_selection (ContentList cl)
606 ContentList content = _film->content ();
607 for (size_t i = 0; i < content.size(); ++i) {
608 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
609 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
611 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
617 ContentPanel::film_content_changed (int property)
620 property == ContentProperty::PATH ||
621 property == DCPContentProperty::NEEDS_ASSETS ||
622 property == DCPContentProperty::NEEDS_KDM ||
623 property == DCPContentProperty::NAME
629 BOOST_FOREACH (ContentSubPanel* i, panels()) {
630 i->film_content_changed (property);
635 ContentPanel::setup ()
637 ContentList content = _film->content ();
639 Content* selected_content = 0;
640 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
644 item.SetMask (wxLIST_MASK_DATA);
645 _content->GetItem (item);
646 selected_content = reinterpret_cast<Content*> (item.GetData ());
649 _content->DeleteAllItems ();
651 BOOST_FOREACH (shared_ptr<Content> i, content) {
652 int const t = _content->GetItemCount ();
653 bool const valid = i->paths_valid ();
655 /* Temporary debugging for Igor */
656 BOOST_FOREACH (boost::filesystem::path j, i->paths()) {
657 LOG_GENERAL ("Check %1 %2 answer %3", j.string(), boost::filesystem::exists(j) ? "yes" : "no", valid ? "yes" : "no");
660 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
661 bool const needs_kdm = dcp && dcp->needs_kdm ();
662 bool const needs_assets = dcp && dcp->needs_assets ();
664 wxString s = std_to_wx (i->summary ());
667 s = _("MISSING: ") + s;
671 s = _("NEEDS KDM: ") + s;
675 s = _("NEEDS OV: ") + s;
681 item.SetData (i.get ());
682 _content->InsertItem (item);
684 if (i.get() == selected_content) {
685 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
688 if (!valid || needs_kdm || needs_assets) {
689 _content->SetItemTextColour (t, *wxRED);
693 if (!selected_content && !content.empty ()) {
694 /* Select the item of content if none was selected before */
695 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
698 setup_sensitivity ();
702 ContentPanel::files_dropped (wxDropFilesEvent& event)
708 wxString* paths = event.GetFiles ();
709 list<boost::filesystem::path> path_list;
710 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
711 path_list.push_back (wx_to_std (paths[i]));
714 add_files (path_list);
718 ContentPanel::add_files (list<boost::filesystem::path> paths)
720 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
721 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
722 alphabetical sort is expected here.
725 paths.sort (CaseInsensitiveSorter ());
727 /* XXX: check for lots of files here and do something */
730 BOOST_FOREACH (boost::filesystem::path i, paths) {
731 BOOST_FOREACH (shared_ptr<Content> j, content_factory (_film, i)) {
732 _film->examine_and_add_content (j);
735 } catch (exception& e) {
736 error_dialog (_parent, e.what());
740 list<ContentSubPanel*>
741 ContentPanel::panels () const
743 list<ContentSubPanel*> p;
745 p.push_back (_video_panel);
748 p.push_back (_audio_panel);
750 for (int i = 0; i < TEXT_COUNT; ++i) {
751 if (_text_panel[i]) {
752 p.push_back (_text_panel[i]);
755 p.push_back (_timing_panel);