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)
65 : _timeline_dialog (0)
67 , _last_selected_tab (0)
69 , _film_viewer (viewer)
70 , _generally_sensitive (true)
72 _panel = new wxPanel (n);
73 _sizer = new wxBoxSizer (wxVERTICAL);
74 _panel->SetSizer (_sizer);
76 _menu = new ContentMenu (_panel);
79 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
81 _content = new wxListCtrl (_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
82 _content->DragAcceptFiles (true);
83 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
85 _content->InsertColumn (0, wxT(""));
86 _content->SetColumnWidth (0, 512);
88 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
90 _add_file = new wxButton (_panel, wxID_ANY, _("Add file(s)..."));
91 _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
92 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
94 _add_folder = new wxButton (_panel, wxID_ANY, _("Add folder..."));
95 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
96 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
98 _add_dcp = new wxButton (_panel, wxID_ANY, _("Add DCP..."));
99 _add_dcp->SetToolTip (_("Add a DCP."));
100 b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
102 _remove = new wxButton (_panel, wxID_ANY, _("Remove"));
103 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
104 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
106 _earlier = new wxButton (_panel, wxID_ANY, _("Earlier"));
107 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
108 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
110 _later = new wxButton (_panel, wxID_ANY, _("Later"));
111 _later->SetToolTip (_("Move the selected piece of content later in the film."));
112 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
114 _timeline = new wxButton (_panel, wxID_ANY, _("Timeline..."));
115 _timeline->SetToolTip (_("Open the timeline for the film."));
116 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
118 s->Add (b, 0, wxALL, 4);
120 _sizer->Add (s, 0, wxEXPAND | wxALL, 6);
123 _notebook = new wxNotebook (_panel, wxID_ANY);
124 _sizer->Add (_notebook, 1, wxEXPAND | wxTOP, 6);
126 _video_panel = new VideoPanel (this);
127 _panels.push_back (_video_panel);
128 _audio_panel = new AudioPanel (this);
129 _panels.push_back (_audio_panel);
130 for (int i = 0; i < TEXT_COUNT; ++i) {
131 _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
132 _panels.push_back (_text_panel[i]);
134 _timing_panel = new TimingPanel (this, _film_viewer);
135 _panels.push_back (_timing_panel);
137 _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::selection_changed, this));
138 _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::selection_changed, this));
139 _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
140 _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
141 _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
142 _add_folder->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_folder_clicked, this));
143 _add_dcp->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_dcp_clicked, this));
144 _remove->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::remove_clicked, this, false));
145 _earlier->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::earlier_clicked, this));
146 _later->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::later_clicked, this));
147 _timeline->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::timeline_clicked, this));
151 ContentPanel::selected ()
156 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
161 if (s < int (_film->content().size ())) {
162 sel.push_back (_film->content()[s]);
170 ContentPanel::selected_video ()
174 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
184 ContentPanel::selected_audio ()
188 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
198 ContentPanel::selected_text ()
202 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
203 if (!i->text.empty()) {
212 ContentPanel::selected_ffmpeg ()
214 FFmpegContentList sc;
216 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
217 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
227 ContentPanel::film_changed (Film::Property p)
231 case Film::CONTENT_ORDER:
238 BOOST_FOREACH (ContentSubPanel* i, _panels) {
244 ContentPanel::selection_changed ()
246 if (_last_selected == selected()) {
247 /* This was triggered by a re-build of the view but the selection
248 did not really change.
253 _last_selected = selected ();
255 setup_sensitivity ();
257 BOOST_FOREACH (ContentSubPanel* i, _panels) {
258 i->content_selection_changed ();
261 optional<DCPTime> go_to;
262 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
265 if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
266 /* Rather special case; if we select a text subtitle file jump to its
269 StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
271 p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
274 if (!go_to || p < go_to.get()) {
279 if (go_to && Config::instance()->jump_to_selected ()) {
280 _film_viewer->set_position (go_to.get().ceil(_film->video_frame_rate()));
283 if (_timeline_dialog) {
284 _timeline_dialog->set_selection (selected());
287 /* Make required tabs visible */
289 if (_notebook->GetPageCount() > 1) {
290 /* There's more than one tab in the notebook so the current selection could be meaningful
291 to the user; store it so that we can try to restore it later.
293 _last_selected_tab = 0;
294 if (_notebook->GetSelection() != wxNOT_FOUND) {
295 _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
299 bool have_video = false;
300 bool have_audio = false;
301 bool have_text[TEXT_COUNT] = { false, false };
302 BOOST_FOREACH (shared_ptr<Content> i, selected()) {
309 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
310 have_text[j->original_type()] = true;
314 bool video_panel = false;
315 bool audio_panel = false;
316 bool text_panel[TEXT_COUNT] = { false, false };
317 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
318 if (_notebook->GetPage(i) == _video_panel) {
320 } else if (_notebook->GetPage(i) == _audio_panel) {
323 for (int j = 0; j < TEXT_COUNT; ++j) {
324 if (_notebook->GetPage(i) == _text_panel[j]) {
325 text_panel[j] = true;
332 if (have_video != video_panel) {
334 _notebook->RemovePage (off);
337 _notebook->InsertPage (off, _video_panel, _video_panel->name());
345 if (have_audio != audio_panel) {
347 _notebook->RemovePage (off);
350 _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
358 for (int i = 0; i < TEXT_COUNT; ++i) {
359 if (have_text[i] != text_panel[i]) {
361 _notebook->RemovePage (off);
364 _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
372 /* Set up the tab selection */
375 for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
376 if (_notebook->GetPage(i) == _last_selected_tab) {
377 _notebook->SetSelection (i);
382 if (!done && _notebook->GetPageCount() > 0) {
383 _notebook->SetSelection (0);
390 ContentPanel::add_file_clicked ()
392 /* This method is also called when Ctrl-A is pressed, so check that our notebook page
395 if (_parent->GetCurrentPage() != _panel || !_film) {
399 /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
400 non-Latin filenames or paths.
402 wxFileDialog* d = new wxFileDialog (
404 _("Choose a file or files"),
407 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
408 wxFD_MULTIPLE | wxFD_CHANGE_DIR
411 int const r = d->ShowModal ();
420 list<boost::filesystem::path> path_list;
421 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
422 path_list.push_back (wx_to_std (paths[i]));
424 add_files (path_list);
430 ContentPanel::add_folder_clicked ()
432 wxDirDialog* d = new wxDirDialog (_panel, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
433 int r = d->ShowModal ();
434 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
441 list<shared_ptr<Content> > content;
444 content = content_factory (_film, path);
445 } catch (exception& e) {
446 error_dialog (_parent, e.what());
450 if (content.empty ()) {
451 error_dialog (_parent, _("No content found in this folder."));
455 BOOST_FOREACH (shared_ptr<Content> i, content) {
456 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
458 ImageSequenceDialog* e = new ImageSequenceDialog (_panel);
460 float const frame_rate = e->frame_rate ();
467 ic->set_video_frame_rate (frame_rate);
470 _film->examine_and_add_content (i);
475 ContentPanel::add_dcp_clicked ()
477 wxDirDialog* d = new wxDirDialog (_panel, _("Choose a DCP folder"), wxT (""), wxDD_DIR_MUST_EXIST);
478 int r = d->ShowModal ();
479 boost::filesystem::path const path (wx_to_std (d->GetPath ()));
487 _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (_film, path)));
488 } catch (exception& e) {
489 error_dialog (_parent, e.what());
493 /** @return true if this remove "click" should be ignored */
495 ContentPanel::remove_clicked (bool hotkey)
497 /* If the method was called because Delete was pressed check that our notebook page
498 is visible and that the content list is focussed.
500 if (hotkey && (_parent->GetCurrentPage() != _panel || !_content->HasFocus())) {
504 BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
505 _film->remove_content (i);
508 selection_changed ();
513 ContentPanel::timeline_clicked ()
519 if (_timeline_dialog) {
520 _timeline_dialog->Destroy ();
521 _timeline_dialog = 0;
524 _timeline_dialog = new TimelineDialog (this, _film);
525 _timeline_dialog->Show ();
529 ContentPanel::right_click (wxListEvent& ev)
531 _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
534 /** Set up broad sensitivity based on the type of content that is selected */
536 ContentPanel::setup_sensitivity ()
538 _add_file->Enable (_generally_sensitive);
539 _add_folder->Enable (_generally_sensitive);
540 _add_dcp->Enable (_generally_sensitive);
542 ContentList selection = selected ();
543 ContentList video_selection = selected_video ();
544 ContentList audio_selection = selected_audio ();
546 _remove->Enable (_generally_sensitive && !selection.empty());
547 _earlier->Enable (_generally_sensitive && selection.size() == 1);
548 _later->Enable (_generally_sensitive && selection.size() == 1);
549 _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
551 _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
552 _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
553 for (int i = 0; i < TEXT_COUNT; ++i) {
554 _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
556 _timing_panel->Enable (_generally_sensitive);
560 ContentPanel::set_film (shared_ptr<Film> film)
562 _audio_panel->set_film (film);
566 film_changed (Film::CONTENT);
567 film_changed (Film::AUDIO_CHANNELS);
568 selection_changed ();
569 setup_sensitivity ();
573 ContentPanel::set_general_sensitivity (bool s)
575 _generally_sensitive = s;
576 setup_sensitivity ();
580 ContentPanel::earlier_clicked ()
582 ContentList sel = selected ();
583 if (sel.size() == 1) {
584 _film->move_content_earlier (sel.front ());
585 selection_changed ();
590 ContentPanel::later_clicked ()
592 ContentList sel = selected ();
593 if (sel.size() == 1) {
594 _film->move_content_later (sel.front ());
595 selection_changed ();
600 ContentPanel::set_selection (weak_ptr<Content> wc)
602 ContentList content = _film->content ();
603 for (size_t i = 0; i < content.size(); ++i) {
604 if (content[i] == wc.lock ()) {
605 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
607 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
613 ContentPanel::set_selection (ContentList cl)
615 ContentList content = _film->content ();
616 for (size_t i = 0; i < content.size(); ++i) {
617 if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
618 _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
620 _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
626 ContentPanel::film_content_changed (int property)
629 property == ContentProperty::PATH ||
630 property == DCPContentProperty::NEEDS_ASSETS ||
631 property == DCPContentProperty::NEEDS_KDM ||
632 property == DCPContentProperty::NAME
638 BOOST_FOREACH (ContentSubPanel* i, _panels) {
639 i->film_content_changed (property);
644 ContentPanel::setup ()
646 ContentList content = _film->content ();
648 Content* selected_content = 0;
649 int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
653 item.SetMask (wxLIST_MASK_DATA);
654 _content->GetItem (item);
655 selected_content = reinterpret_cast<Content*> (item.GetData ());
658 _content->DeleteAllItems ();
660 BOOST_FOREACH (shared_ptr<Content> i, content) {
661 int const t = _content->GetItemCount ();
662 bool const valid = i->paths_valid ();
664 /* Temporary debugging for Igor */
665 BOOST_FOREACH (boost::filesystem::path j, i->paths()) {
666 LOG_GENERAL ("Check %1 %2 answer %3", j.string(), boost::filesystem::exists(j) ? "yes" : "no", valid ? "yes" : "no");
669 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
670 bool const needs_kdm = dcp && dcp->needs_kdm ();
671 bool const needs_assets = dcp && dcp->needs_assets ();
673 wxString s = std_to_wx (i->summary ());
676 s = _("MISSING: ") + s;
680 s = _("NEEDS KDM: ") + s;
684 s = _("NEEDS OV: ") + s;
690 item.SetData (i.get ());
691 _content->InsertItem (item);
693 if (i.get() == selected_content) {
694 _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
697 if (!valid || needs_kdm || needs_assets) {
698 _content->SetItemTextColour (t, *wxRED);
702 if (!selected_content && !content.empty ()) {
703 /* Select the item of content if none was selected before */
704 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
707 setup_sensitivity ();
711 ContentPanel::files_dropped (wxDropFilesEvent& event)
717 wxString* paths = event.GetFiles ();
718 list<boost::filesystem::path> path_list;
719 for (int i = 0; i < event.GetNumberOfFiles(); i++) {
720 path_list.push_back (wx_to_std (paths[i]));
723 add_files (path_list);
727 ContentPanel::add_files (list<boost::filesystem::path> paths)
729 /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
730 I can't reproduce that, but sort them anyway. Don't use ImageFilenameSorter as a normal
731 alphabetical sort is expected here.
734 paths.sort (CaseInsensitiveSorter ());
736 /* XXX: check for lots of files here and do something */
739 BOOST_FOREACH (boost::filesystem::path i, paths) {
740 BOOST_FOREACH (shared_ptr<Content> j, content_factory (_film, i)) {
741 _film->examine_and_add_content (j);
744 } catch (exception& e) {
745 error_dialog (_parent, e.what());