Extract common code out into kdm_for_screen()
[dcpomatic.git] / src / wx / content_panel.cc
index 770015292444f3ca9ce8756af25c46d7c02d2a44..7d854224d232a0b939758cd4094e3951d0604a65 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "wx_util.h"
 #include "video_panel.h"
 #include "audio_panel.h"
-#include "caption_panel.h"
+#include "text_panel.h"
 #include "timing_panel.h"
 #include "timeline_dialog.h"
 #include "image_sequence_dialog.h"
 #include "film_viewer.h"
+#include "dcpomatic_button.h"
 #include "lib/audio_content.h"
 #include "lib/text_content.h"
 #include "lib/video_content.h"
 #include "lib/config.h"
 #include "lib/log.h"
 #include "lib/compose.hpp"
-#include "lib/plain_text_file_content.h"
-#include "lib/plain_text_file.h"
+#include "lib/string_text_file_content.h"
+#include "lib/string_text_file.h"
+#include "lib/dcpomatic_log.h"
 #include <wx/wx.h>
 #include <wx/notebook.h>
 #include <wx/listctrl.h>
+#include <wx/display.h>
 #include <boost/filesystem.hpp>
 #include <boost/foreach.hpp>
 #include <iostream>
@@ -52,31 +55,64 @@ using std::list;
 using std::string;
 using std::cout;
 using std::vector;
+using std::max;
 using std::exception;
 using boost::shared_ptr;
 using boost::weak_ptr;
 using boost::dynamic_pointer_cast;
 using boost::optional;
+using namespace dcpomatic;
 
-#define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
+class LimitedSplitter : public wxSplitterWindow
+{
+public:
+       LimitedSplitter (wxWindow* parent)
+               : wxSplitterWindow (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
+       {
+               /* This value doesn't really mean much but we just want to stop double-click on the
+                  divider from shrinking the bottom panel (#1601).
+               */
+               SetMinimumPaneSize (64);
+       }
 
-ContentPanel::ContentPanel (wxNotebook* n, boost::shared_ptr<Film> film, FilmViewer* viewer)
-       : _timeline_dialog (0)
+       bool OnSashPositionChange (int new_position)
+       {
+               /* Try to stop the top bit of the splitter getting so small that buttons disappear */
+               return new_position > 220;
+       }
+};
+
+ContentPanel::ContentPanel (wxNotebook* n, shared_ptr<Film> film, weak_ptr<FilmViewer> viewer)
+       : _video_panel (0)
+       , _audio_panel (0)
+       , _timeline_dialog (0)
        , _parent (n)
+       , _last_selected_tab (0)
        , _film (film)
        , _film_viewer (viewer)
        , _generally_sensitive (true)
+       , _ignore_deselect (false)
+       , _no_check_selection (false)
 {
-       _panel = new wxPanel (n);
-       _sizer = new wxBoxSizer (wxVERTICAL);
-       _panel->SetSizer (_sizer);
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               _text_panel[i] = 0;
+       }
+
+       _splitter = new LimitedSplitter (n);
+       optional<wxRect> screen;
+       int const sn = wxDisplay::GetFromWindow(_splitter);
+       if (sn >= 0) {
+               screen = wxDisplay(sn).GetClientArea();
+       }
+       wxPanel* top = new wxPanel (_splitter);
+
+       _menu = new ContentMenu (_splitter);
 
-       _menu = new ContentMenu (_panel);
 
        {
                wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
 
-               _content = new wxListCtrl (_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
+               _content = new wxListCtrl (top, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
                _content->DragAcceptFiles (true);
                s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
 
@@ -85,53 +121,52 @@ ContentPanel::ContentPanel (wxNotebook* n, boost::shared_ptr<Film> film, FilmVie
 
                wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
 
-               _add_file = new wxButton (_panel, wxID_ANY, _("Add file(s)..."));
+               _add_file = new Button (top, _("Add file(s)..."));
                _add_file->SetToolTip (_("Add video, image, sound or subtitle files to the film."));
                b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
 
-               _add_folder = new wxButton (_panel, wxID_ANY, _("Add folder..."));
+               _add_folder = new Button (top, _("Add folder..."));
                _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a folder of sound files."));
                b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
 
-               _add_dcp = new wxButton (_panel, wxID_ANY, _("Add DCP..."));
+               _add_dcp = new Button (top, _("Add DCP..."));
                _add_dcp->SetToolTip (_("Add a DCP."));
                b->Add (_add_dcp, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
 
-               _remove = new wxButton (_panel, wxID_ANY, _("Remove"));
+               _remove = new Button (top, _("Remove"));
                _remove->SetToolTip (_("Remove the selected piece of content from the film."));
                b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
 
-               _earlier = new wxButton (_panel, wxID_ANY, _("Earlier"));
+               _earlier = new Button (top, _("Earlier"));
                _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
                b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
 
-               _later = new wxButton (_panel, wxID_ANY, _("Later"));
+               _later = new Button (top, _("Later"));
                _later->SetToolTip (_("Move the selected piece of content later in the film."));
                b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
 
-               _timeline = new wxButton (_panel, wxID_ANY, _("Timeline..."));
+               _timeline = new Button (top, _("Timeline..."));
                _timeline->SetToolTip (_("Open the timeline for the film."));
                b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
 
                s->Add (b, 0, wxALL, 4);
-
-               _sizer->Add (s, 0, wxEXPAND | wxALL, 6);
+               top->SetSizer (s);
        }
 
-       _notebook = new wxNotebook (_panel, wxID_ANY);
-       _sizer->Add (_notebook, 1, wxEXPAND | wxTOP, 6);
+       _notebook = new wxNotebook (_splitter, wxID_ANY);
+
+       /* This is a hack to try and make the content notebook a sensible size; large on big displays but small
+          enough on small displays to leave space for the content area.
+       */
+       if (screen) {
+               _splitter->SplitHorizontally (top, _notebook, screen->height > 800 ? -600 : -150);
+       }
 
-       _video_panel = new VideoPanel (this);
-       _panels.push_back (_video_panel);
-       _audio_panel = new AudioPanel (this);
-       _panels.push_back (_audio_panel);
-       _caption_panel = new CaptionPanel (this);
-       _panels.push_back (_caption_panel);
        _timing_panel = new TimingPanel (this, _film_viewer);
-       _panels.push_back (_timing_panel);
+       _notebook->AddPage (_timing_panel, _("Timing"), false);
 
-       _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::selection_changed, this));
-       _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::selection_changed, this));
+       _content->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::item_selected, this));
+       _content->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::item_deselected, this));
        _content->Bind (wxEVT_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
        _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
        _add_file->Bind (wxEVT_BUTTON, boost::bind (&ContentPanel::add_file_clicked, this));
@@ -154,8 +189,9 @@ ContentPanel::selected ()
                        break;
                }
 
-               if (s < int (_film->content().size ())) {
-                       sel.push_back (_film->content()[s]);
+               ContentList cl = _film->content();
+               if (s < int (cl.size())) {
+                       sel.push_back (cl[s]);
                }
        }
 
@@ -191,12 +227,12 @@ ContentPanel::selected_audio ()
 }
 
 ContentList
-ContentPanel::selected_subtitle ()
+ContentPanel::selected_text ()
 {
        ContentList sc;
 
        BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
-               if (i->subtitle) {
+               if (!i->text.empty()) {
                        sc.push_back (i);
                }
        }
@@ -231,38 +267,58 @@ ContentPanel::film_changed (Film::Property p)
                break;
        }
 
-       BOOST_FOREACH (ContentSubPanel* i, _panels) {
+       BOOST_FOREACH (ContentSubPanel* i, panels()) {
                i->film_changed (p);
        }
 }
 
 void
-ContentPanel::selection_changed ()
+ContentPanel::item_deselected ()
 {
-       if (_last_selected == selected()) {
-               /* This was triggered by a re-build of the view but the selection
-                  did not really change.
-               */
-               return;
+       /* Maybe this is just a re-click on the same item; if not, _ignore_deselect will stay
+          false and item_deselected_foo will handle the deselection.
+       */
+       _ignore_deselect = false;
+       signal_manager->when_idle (boost::bind (&ContentPanel::item_deselected_idle, this));
+}
+
+void
+ContentPanel::item_deselected_idle ()
+{
+       if (!_ignore_deselect) {
+               check_selection ();
        }
+}
 
-       _last_selected = selected ();
+void
+ContentPanel::item_selected ()
+{
+       _ignore_deselect = true;
+       check_selection ();
+}
+
+void
+ContentPanel::check_selection ()
+{
+       if (_no_check_selection) {
+               return;
+       }
 
        setup_sensitivity ();
 
-       BOOST_FOREACH (ContentSubPanel* i, _panels) {
+       BOOST_FOREACH (ContentSubPanel* i, panels()) {
                i->content_selection_changed ();
        }
 
        optional<DCPTime> go_to;
-       BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
+       BOOST_FOREACH (shared_ptr<Content> i, selected()) {
                DCPTime p;
                p = i->position();
-               if (dynamic_pointer_cast<PlainTextFileContent>(i) && i->paths_valid()) {
+               if (dynamic_pointer_cast<StringTextFileContent>(i) && i->paths_valid()) {
                        /* Rather special case; if we select a text subtitle file jump to its
                           first subtitle.
                        */
-                       PlainTextFile ts (dynamic_pointer_cast<PlainTextFileContent>(i));
+                       StringTextFile ts (dynamic_pointer_cast<StringTextFileContent>(i));
                        if (ts.first()) {
                                p += DCPTime(ts.first().get(), _film->active_frame_rate_change(i->position()));
                        }
@@ -272,14 +328,97 @@ ContentPanel::selection_changed ()
                }
        }
 
-       if (go_to && Config::instance()->jump_to_selected ()) {
-               _film_viewer->set_position (go_to.get().ceil(_film->video_frame_rate()));
+       if (go_to && Config::instance()->jump_to_selected() && signal_manager) {
+               shared_ptr<FilmViewer> fv = _film_viewer.lock ();
+               DCPOMATIC_ASSERT (fv);
+               signal_manager->when_idle(boost::bind(&FilmViewer::seek, fv.get(), go_to.get().ceil(_film->video_frame_rate()), true));
        }
 
        if (_timeline_dialog) {
-               _timeline_dialog->set_selection (selected ());
+               _timeline_dialog->set_selection (selected());
+       }
+
+       /* Make required tabs visible */
+
+       if (_notebook->GetPageCount() > 1) {
+               /* There's more than one tab in the notebook so the current selection could be meaningful
+                  to the user; store it so that we can try to restore it later.
+               */
+               _last_selected_tab = 0;
+               if (_notebook->GetSelection() != wxNOT_FOUND) {
+                       _last_selected_tab = _notebook->GetPage(_notebook->GetSelection());
+               }
+       }
+
+       bool have_video = false;
+       bool have_audio = false;
+       bool have_text[TEXT_COUNT] = { false, false };
+       BOOST_FOREACH (shared_ptr<Content> i, selected()) {
+               if (i->video) {
+                       have_video = true;
+               }
+               if (i->audio) {
+                       have_audio = true;
+               }
+               BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
+                       have_text[j->original_type()] = true;
+               }
        }
 
+       int off = 0;
+
+       if (have_video && !_video_panel) {
+               _video_panel = new VideoPanel (this);
+               _notebook->InsertPage (off, _video_panel, _video_panel->name());
+       } else if (!have_video && _video_panel) {
+               _notebook->DeletePage (off);
+               _video_panel = 0;
+       }
+
+       if (have_video) {
+               ++off;
+       }
+
+       if (have_audio && !_audio_panel) {
+               _audio_panel = new AudioPanel (this);
+               _notebook->InsertPage (off, _audio_panel, _audio_panel->name());
+       } else if (!have_audio && _audio_panel) {
+               _notebook->DeletePage (off);
+               _audio_panel = 0;
+       }
+
+       if (have_audio) {
+               ++off;
+       }
+
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               if (have_text[i] && !_text_panel[i]) {
+                       _text_panel[i] = new TextPanel (this, static_cast<TextType>(i));
+                       _notebook->InsertPage (off, _text_panel[i], _text_panel[i]->name());
+               } else if (!have_text[i] && _text_panel[i]) {
+                       _notebook->DeletePage (off);
+                       _text_panel[i] = 0;
+               }
+               if (have_text[i]) {
+                       ++off;
+               }
+       }
+
+       /* Set up the tab selection */
+
+       bool done = false;
+       for (size_t i = 0; i < _notebook->GetPageCount(); ++i) {
+               if (_notebook->GetPage(i) == _last_selected_tab) {
+                       _notebook->SetSelection (i);
+                       done = true;
+               }
+       }
+
+       if (!done && _notebook->GetPageCount() > 0) {
+               _notebook->SetSelection (0);
+       }
+
+       setup_sensitivity ();
        SelectionChanged ();
 }
 
@@ -289,7 +428,7 @@ ContentPanel::add_file_clicked ()
        /* This method is also called when Ctrl-A is pressed, so check that our notebook page
           is visible.
        */
-       if (_parent->GetCurrentPage() != _panel || !_film) {
+       if (_parent->GetCurrentPage() != _splitter || !_film) {
                return;
        }
 
@@ -297,7 +436,7 @@ ContentPanel::add_file_clicked ()
           non-Latin filenames or paths.
        */
        wxFileDialog* d = new wxFileDialog (
-               _panel,
+               _splitter,
                _("Choose a file or files"),
                wxT (""),
                wxT (""),
@@ -326,7 +465,7 @@ ContentPanel::add_file_clicked ()
 void
 ContentPanel::add_folder_clicked ()
 {
-       wxDirDialog* d = new wxDirDialog (_panel, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
+       wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a folder"), wxT(""), wxDD_DIR_MUST_EXIST);
        int r = d->ShowModal ();
        boost::filesystem::path const path (wx_to_std (d->GetPath ()));
        d->Destroy ();
@@ -338,7 +477,7 @@ ContentPanel::add_folder_clicked ()
        list<shared_ptr<Content> > content;
 
        try {
-               content = content_factory (_film, path);
+               content = content_factory (path);
        } catch (exception& e) {
                error_dialog (_parent, e.what());
                return;
@@ -352,7 +491,7 @@ ContentPanel::add_folder_clicked ()
        BOOST_FOREACH (shared_ptr<Content> i, content) {
                shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
                if (ic) {
-                       ImageSequenceDialog* e = new ImageSequenceDialog (_panel);
+                       ImageSequenceDialog* e = new ImageSequenceDialog (_splitter);
                        r = e->ShowModal ();
                        float const frame_rate = e->frame_rate ();
                        e->Destroy ();
@@ -371,7 +510,7 @@ ContentPanel::add_folder_clicked ()
 void
 ContentPanel::add_dcp_clicked ()
 {
-       wxDirDialog* d = new wxDirDialog (_panel, _("Choose a DCP folder"), wxT (""), wxDD_DIR_MUST_EXIST);
+       wxDirDialog* d = new wxDirDialog (_splitter, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
        int r = d->ShowModal ();
        boost::filesystem::path const path (wx_to_std (d->GetPath ()));
        d->Destroy ();
@@ -381,7 +520,7 @@ ContentPanel::add_dcp_clicked ()
        }
 
        try {
-               _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (_film, path)));
+               _film->examine_and_add_content (shared_ptr<Content> (new DCPContent (path)));
        } catch (exception& e) {
                error_dialog (_parent, e.what());
        }
@@ -394,7 +533,7 @@ ContentPanel::remove_clicked (bool hotkey)
        /* If the method was called because Delete was pressed check that our notebook page
           is visible and that the content list is focussed.
        */
-       if (hotkey && (_parent->GetCurrentPage() != _panel || !_content->HasFocus())) {
+       if (hotkey && (_parent->GetCurrentPage() != _splitter || !_content->HasFocus())) {
                return true;
        }
 
@@ -402,7 +541,7 @@ ContentPanel::remove_clicked (bool hotkey)
                _film->remove_content (i);
        }
 
-       selection_changed ();
+       check_selection ();
        return false;
 }
 
@@ -418,7 +557,8 @@ ContentPanel::timeline_clicked ()
                _timeline_dialog = 0;
        }
 
-       _timeline_dialog = new TimelineDialog (this, _film);
+       _timeline_dialog = new TimelineDialog (this, _film, _film_viewer);
+       _timeline_dialog->set_selection (selected());
        _timeline_dialog->Show ();
 }
 
@@ -445,22 +585,36 @@ ContentPanel::setup_sensitivity ()
        _later->Enable    (_generally_sensitive && selection.size() == 1);
        _timeline->Enable (_generally_sensitive && _film && !_film->content().empty());
 
-       _video_panel->Enable    (_generally_sensitive && video_selection.size() > 0);
-       _audio_panel->Enable    (_generally_sensitive && audio_selection.size() > 0);
-       _caption_panel->Enable  (_generally_sensitive && selection.size() == 1 && selection.front()->subtitle);
-       _timing_panel->Enable   (_generally_sensitive);
+       if (_video_panel) {
+               _video_panel->Enable (_generally_sensitive && video_selection.size() > 0);
+       }
+       if (_audio_panel) {
+               _audio_panel->Enable (_generally_sensitive && audio_selection.size() > 0);
+       }
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               if (_text_panel[i]) {
+                       _text_panel[i]->Enable (_generally_sensitive && selection.size() == 1 && !selection.front()->text.empty());
+               }
+       }
+       _timing_panel->Enable (_generally_sensitive);
 }
 
 void
 ContentPanel::set_film (shared_ptr<Film> film)
 {
-       _audio_panel->set_film (film);
+       if (_audio_panel) {
+               _audio_panel->set_film (film);
+       }
 
        _film = film;
 
        film_changed (Film::CONTENT);
        film_changed (Film::AUDIO_CHANNELS);
-       selection_changed ();
+
+       if (_film) {
+               check_selection ();
+       }
+
        setup_sensitivity ();
 }
 
@@ -477,7 +631,7 @@ ContentPanel::earlier_clicked ()
        ContentList sel = selected ();
        if (sel.size() == 1) {
                _film->move_content_earlier (sel.front ());
-               selection_changed ();
+               check_selection ();
        }
 }
 
@@ -487,7 +641,7 @@ ContentPanel::later_clicked ()
        ContentList sel = selected ();
        if (sel.size() == 1) {
                _film->move_content_later (sel.front ());
-               selection_changed ();
+               check_selection ();
        }
 }
 
@@ -507,6 +661,8 @@ ContentPanel::set_selection (weak_ptr<Content> wc)
 void
 ContentPanel::set_selection (ContentList cl)
 {
+       _no_check_selection = true;
+
        ContentList content = _film->content ();
        for (size_t i = 0; i < content.size(); ++i) {
                if (find(cl.begin(), cl.end(), content[i]) != cl.end()) {
@@ -515,6 +671,9 @@ ContentPanel::set_selection (ContentList cl)
                        _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
                }
        }
+
+       _no_check_selection = false;
+       check_selection ();
 }
 
 void
@@ -530,7 +689,7 @@ ContentPanel::film_content_changed (int property)
                setup ();
        }
 
-       BOOST_FOREACH (ContentSubPanel* i, _panels) {
+       BOOST_FOREACH (ContentSubPanel* i, panels()) {
                i->film_content_changed (property);
        }
 }
@@ -538,6 +697,12 @@ ContentPanel::film_content_changed (int property)
 void
 ContentPanel::setup ()
 {
+       if (!_film) {
+               _content->DeleteAllItems ();
+               setup_sensitivity ();
+               return;
+       }
+
        ContentList content = _film->content ();
 
        Content* selected_content = 0;
@@ -556,11 +721,6 @@ ContentPanel::setup ()
                int const t = _content->GetItemCount ();
                bool const valid = i->paths_valid ();
 
-               /* Temporary debugging for Igor */
-               BOOST_FOREACH (boost::filesystem::path j, i->paths()) {
-                       LOG_GENERAL ("Check %1 %2 answer %3", j.string(), boost::filesystem::exists(j) ? "yes" : "no", valid ? "yes" : "no");
-               }
-
                shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
                bool const needs_kdm = dcp && dcp->needs_kdm ();
                bool const needs_assets = dcp && dcp->needs_assets ();
@@ -632,7 +792,7 @@ ContentPanel::add_files (list<boost::filesystem::path> paths)
 
        try {
                BOOST_FOREACH (boost::filesystem::path i, paths) {
-                       BOOST_FOREACH (shared_ptr<Content> j, content_factory (_film, i)) {
+                       BOOST_FOREACH (shared_ptr<Content> j, content_factory(i)) {
                                _film->examine_and_add_content (j);
                        }
                }
@@ -640,3 +800,22 @@ ContentPanel::add_files (list<boost::filesystem::path> paths)
                error_dialog (_parent, e.what());
        }
 }
+
+list<ContentSubPanel*>
+ContentPanel::panels () const
+{
+       list<ContentSubPanel*> p;
+       if (_video_panel) {
+               p.push_back (_video_panel);
+       }
+       if (_audio_panel) {
+               p.push_back (_audio_panel);
+       }
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               if (_text_panel[i]) {
+                       p.push_back (_text_panel[i]);
+               }
+       }
+       p.push_back (_timing_panel);
+       return p;
+}