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 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
330 } else if (!have_audio && _audio_panel) {
331 _notebook->DeletePage (off);
339 for (int i = 0; i < TEXT_COUNT; ++i) {
340 if (have_text[i] && !_text_panel[i]) {
341 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
342 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
343 } else if (!have_text[i] && _text_panel[i]) {
344 _notebook->DeletePage (off);
352 /* Set up the tab selection */
355 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
356 if (_notebook->GetPage(i) == _last_selected_tab) {
357 _notebook->SetSelection (i);
362 if (!done && _notebook->GetPageCount() > 0) {
363 _notebook->SetSelection (0);
366 setup_sensitivity ();
371 ContentPanel::add_file_clicked ()
373 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
376 if (_parent->GetCurrentPage() != _panel || !_film) {
380 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
381 non-Latin filenames or paths.
383 wxFileDialog* d = new wxFileDialog (
385 _("Choose a file or files"),
388 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
389 wxFD_MULTIPLE | wxFD_CHANGE_DIR
392 int const r = d->ShowModal ();
401 list<boost::filesystem::path> path_list;
402 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
403 path_list.push_back (wx_to_std (paths[i]));
405 add_files (path_list);
411 ContentPanel::add_folder_clicked ()
413 wxDirDialog* d = new wxDirDialog (_panel, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
414 int r = d->ShowModal ();
415 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
422 list<shared_ptr<Content> > content;
425 content = content_factory (_film, path);
426 } catch (exception& e) {
427 error_dialog (_parent, e.what());
431 if (content.empty ()) {
432 error_dialog (_parent, _("No content found in this folder."));
436 BOOST_FOREACH (shared_ptr<Content> i, content) {
437 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
439 ImageSequenceDialog* e = new ImageSequenceDialog (_panel);
441 float const frame_rate = e->frame_rate ();
448 ic->set_video_frame_rate (frame_rate);
451 _film->examine_and_add_content (i);
456 ContentPanel::add_dcp_clicked ()
458 wxDirDialog* d = new wxDirDialog (_panel, _("Choose a DCP folder"), wxT (""), wxDD_DIR_MUST_EXIST);
459 int r = d->ShowModal ();
460 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
468 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (_film, path)));
469 } catch (exception& e) {
470 error_dialog (_parent, e.what());
474 /** @return true if this remove "click" should be ignored */
476 ContentPanel::remove_clicked (bool hotkey)
478 /* If the method was called because Delete was pressed check that our notebook page
479 is visible and that the content list is focussed.
481 if (hotkey && (_parent->GetCurrentPage() != _panel || !_content->HasFocus())) {
485 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
486 _film->remove_content (i);
489 selection_changed ();
494 ContentPanel::timeline_clicked ()
500 if (_timeline_dialog) {
501 _timeline_dialog->Destroy ();
502 _timeline_dialog = 0;
505 _timeline_dialog = new TimelineDialog (this, _film);
506 _timeline_dialog->set_selection (selected());
507 _timeline_dialog->Show ();
511 ContentPanel::right_click (wxListEvent& ev)
513 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
516 /** Set up broad sensitivity based on the type of content that is selected */
518 ContentPanel::setup_sensitivity ()
520 _add_file->Enable (_generally_sensitive);
521 _add_folder->Enable (_generally_sensitive);
522 _add_dcp->Enable (_generally_sensitive);
524 ContentList selection = selected ();
525 ContentList video_selection = selected_video ();
526 ContentList audio_selection = selected_audio ();
528 _remove->Enable (_generally_sensitive && !selection.empty());
529 _earlier->Enable (_generally_sensitive && selection.size() == 1);
530 _later->Enable (_generally_sensitive && selection.size() == 1);
531 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
534 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
537 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
539 for (int i = 0; i < TEXT_COUNT; ++i) {
540 if (_text_panel[i]) {
541 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
544 _timing_panel->Enable (_generally_sensitive);
548 ContentPanel::set_film (shared_ptr<Film> film)
551 _audio_panel->set_film (film);
556 film_changed (Film::CONTENT);
557 film_changed (Film::AUDIO_CHANNELS);
558 selection_changed ();
559 setup_sensitivity ();
563 ContentPanel::set_general_sensitivity (bool s)
565 _generally_sensitive = s;
566 setup_sensitivity ();
570 ContentPanel::earlier_clicked ()
572 ContentList sel = selected ();
573 if (sel.size() == 1) {
574 _film->move_content_earlier (sel.front ());
575 selection_changed ();
580 ContentPanel::later_clicked ()
582 ContentList sel = selected ();
583 if (sel.size() == 1) {
584 _film->move_content_later (sel.front ());
585 selection_changed ();
590 ContentPanel::set_selection (weak_ptr<Content> wc)
592 ContentList content = _film->content ();
593 for (size_t i = 0; i < content.size(); ++i) {
594 if (content[i] == wc.lock ()) {
595 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
597 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
603 ContentPanel::set_selection (ContentList cl)
605 ContentList content = _film->content ();
606 for (size_t i = 0; i < content.size(); ++i) {
607 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
608 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
610 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
616 ContentPanel::film_content_changed (int property)
619 property == ContentProperty::PATH ||
620 property == DCPContentProperty::NEEDS_ASSETS ||
621 property == DCPContentProperty::NEEDS_KDM ||
622 property == DCPContentProperty::NAME
628 BOOST_FOREACH (ContentSubPanel* i, panels()) {
629 i->film_content_changed (property);
634 ContentPanel::setup ()
636 ContentList content = _film->content ();
638 Content* selected_content = 0;
639 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
643 item.SetMask (wxLIST_MASK_DATA);
644 _content->GetItem (item);
645 selected_content = reinterpret_cast<Content*> (item.GetData ());
648 _content->DeleteAllItems ();
650 BOOST_FOREACH (shared_ptr<Content> i, content) {
651 int const t = _content->GetItemCount ();
652 bool const valid = i->paths_valid ();
654 /* Temporary debugging for Igor */
655 BOOST_FOREACH (boost::filesystem::path j, i->paths()) {
656 LOG_GENERAL ("Check %1 %2 answer %3", j.string(), boost::filesystem::exists(j) ? "yes" : "no", valid ? "yes" : "no");
659 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
660 bool const needs_kdm = dcp && dcp->needs_kdm ();
661 bool const needs_assets = dcp && dcp->needs_assets ();
663 wxString s = std_to_wx (i->summary ());
666 s = _("MISSING: ") + s;
670 s = _("NEEDS KDM: ") + s;
674 s = _("NEEDS OV: ") + s;
680 item.SetData (i.get ());
681 _content->InsertItem (item);
683 if (i.get() == selected_content) {
684 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
687 if (!valid || needs_kdm || needs_assets) {
688 _content->SetItemTextColour (t, *wxRED);
692 if (!selected_content && !content.empty ()) {
693 /* Select the item of content if none was selected before */
694 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
697 setup_sensitivity ();
701 ContentPanel::files_dropped (wxDropFilesEvent& event)
707 wxString* paths = event.GetFiles ();
708 list<boost::filesystem::path> path_list;
709 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
710 path_list.push_back (wx_to_std (paths[i]));
713 add_files (path_list);
717 ContentPanel::add_files (list<boost::filesystem::path> paths)
719 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
720 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
721 alphabetical sort is expected here.
724 paths.sort (CaseInsensitiveSorter ());
726 /* XXX: check for lots of files here and do something */
729 BOOST_FOREACH (boost::filesystem::path i, paths) {
730 BOOST_FOREACH (shared_ptr<Content> j, content_factory (_film, i)) {
731 _film->examine_and_add_content (j);
734 } catch (exception& e) {
735 error_dialog (_parent, e.what());
739 list<ContentSubPanel*>
740 ContentPanel::panels () const
742 list<ContentSubPanel*> p;
744 p.push_back (_video_panel);
747 p.push_back (_audio_panel);
749 for (int i = 0; i < TEXT_COUNT; ++i) {
750 if (_text_panel[i]) {
751 p.push_back (_text_panel[i]);
754 p.push_back (_timing_panel);