No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / wx / content_panel.cc
index 991080e590f059e123ca443333d4dd1e26b03886..d1a00c02122ba354fdfdd4ea03146df1fc53b302 100644 (file)
@@ -1,25 +1,32 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
-#include <wx/wx.h>
-#include <wx/notebook.h>
-#include <wx/listctrl.h>
+#include "content_panel.h"
+#include "wx_util.h"
+#include "video_panel.h"
+#include "audio_panel.h"
+#include "subtitle_panel.h"
+#include "timing_panel.h"
+#include "timeline_dialog.h"
+#include "image_sequence_dialog.h"
+#include "film_viewer.h"
 #include "lib/audio_content.h"
 #include "lib/subtitle_content.h"
 #include "lib/video_content.h"
 #include "lib/content_factory.h"
 #include "lib/image_content.h"
 #include "lib/dcp_content.h"
+#include "lib/case_insensitive_sorter.h"
 #include "lib/playlist.h"
-#include "content_panel.h"
-#include "wx_util.h"
-#include "video_panel.h"
-#include "audio_panel.h"
-#include "subtitle_panel.h"
-#include "timing_panel.h"
-#include "timeline_dialog.h"
+#include <wx/wx.h>
+#include <wx/notebook.h>
+#include <wx/listctrl.h>
+#include <boost/filesystem.hpp>
+#include <boost/foreach.hpp>
+#include <iostream>
 
 using std::list;
 using std::string;
 using std::cout;
+using std::vector;
+using std::exception;
 using boost::shared_ptr;
 using boost::weak_ptr;
 using boost::dynamic_pointer_cast;
+using boost::optional;
 
-ContentPanel::ContentPanel (wxNotebook* n, boost::shared_ptr<Film> f)
+ContentPanel::ContentPanel (wxNotebook* n, boost::shared_ptr<Film> film, FilmViewer* viewer)
        : _timeline_dialog (0)
-       , _film (f)
+       , _parent (n)
+       , _film (film)
+       , _film_viewer (viewer)
        , _generally_sensitive (true)
 {
        _panel = new wxPanel (n);
@@ -56,35 +68,45 @@ ContentPanel::ContentPanel (wxNotebook* n, boost::shared_ptr<Film> f)
 
        {
                wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
-               
+
                _content = new wxListCtrl (_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
+               _content->DragAcceptFiles (true);
                s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
 
                _content->InsertColumn (0, wxT(""));
                _content->SetColumnWidth (0, 512);
 
                wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
+
                _add_file = new wxButton (_panel, wxID_ANY, _("Add file(s)..."));
-               b->Add (_add_file, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
+               _add_file->SetToolTip (_("Add video, image or sound 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->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a DCP."));
                b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
+
                _remove = new wxButton (_panel, wxID_ANY, _("Remove"));
-               b->Add (_remove, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
+               _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, _("Up"));
-               b->Add (_earlier, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
+               _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, _("Down"));
-               b->Add (_later, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
+               _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..."));
-               b->Add (_timeline, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
+               _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);
        }
 
-       _sequence_video = new wxCheckBox (_panel, wxID_ANY, _("Keep video in sequence"));
-       _sizer->Add (_sequence_video);
-
        _notebook = new wxNotebook (_panel, wxID_ANY);
        _sizer->Add (_notebook, 1, wxEXPAND | wxTOP, 6);
 
@@ -94,7 +116,7 @@ ContentPanel::ContentPanel (wxNotebook* n, boost::shared_ptr<Film> f)
        _panels.push_back (_audio_panel);
        _subtitle_panel = new SubtitlePanel (this);
        _panels.push_back (_subtitle_panel);
-       _timing_panel = new TimingPanel (this);
+       _timing_panel = new TimingPanel (this, _film_viewer);
        _panels.push_back (_timing_panel);
 
        _content->Bind (wxEVT_COMMAND_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::selection_changed, this));
@@ -103,11 +125,10 @@ ContentPanel::ContentPanel (wxNotebook* n, boost::shared_ptr<Film> f)
        _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
        _add_file->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::add_file_clicked, this));
        _add_folder->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::add_folder_clicked, this));
-       _remove->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::remove_clicked, this));
+       _remove->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::remove_clicked, this, false));
        _earlier->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::earlier_clicked, this));
        _later->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::later_clicked, this));
        _timeline->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::timeline_clicked, this));
-       _sequence_video->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&ContentPanel::sequence_video_changed, this));
 }
 
 ContentList
@@ -129,48 +150,42 @@ ContentPanel::selected ()
        return sel;
 }
 
-VideoContentList
+ContentList
 ContentPanel::selected_video ()
 {
-       ContentList c = selected ();
-       VideoContentList vc;
-       
-       for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
-               shared_ptr<VideoContent> t = dynamic_pointer_cast<VideoContent> (*i);
-               if (t) {
-                       vc.push_back (t);
+       ContentList vc;
+
+       BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
+               if (i->video) {
+                       vc.push_back (i);
                }
        }
 
        return vc;
 }
 
-AudioContentList
+ContentList
 ContentPanel::selected_audio ()
 {
-       ContentList c = selected ();
-       AudioContentList ac;
-       
-       for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
-               shared_ptr<AudioContent> t = dynamic_pointer_cast<AudioContent> (*i);
-               if (t) {
-                       ac.push_back (t);
+       ContentList ac;
+
+       BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
+               if (i->audio) {
+                       ac.push_back (i);
                }
        }
 
        return ac;
 }
 
-SubtitleContentList
+ContentList
 ContentPanel::selected_subtitle ()
 {
-       ContentList c = selected ();
-       SubtitleContentList sc;
-       
-       for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
-               shared_ptr<SubtitleContent> t = dynamic_pointer_cast<SubtitleContent> (*i);
-               if (t) {
-                       sc.push_back (t);
+       ContentList sc;
+
+       BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
+               if (i->subtitle) {
+                       sc.push_back (i);
                }
        }
 
@@ -180,11 +195,10 @@ ContentPanel::selected_subtitle ()
 FFmpegContentList
 ContentPanel::selected_ffmpeg ()
 {
-       ContentList c = selected ();
        FFmpegContentList sc;
-       
-       for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
-               shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (*i);
+
+       BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
+               shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
                if (t) {
                        sc.push_back (t);
                }
@@ -193,52 +207,79 @@ ContentPanel::selected_ffmpeg ()
        return sc;
 }
 
-void
-ContentPanel::sequence_video_changed ()
-{
-       if (!_film) {
-               return;
-       }
-       
-       _film->set_sequence_video (_sequence_video->GetValue ());
-}
-
 void
 ContentPanel::film_changed (Film::Property p)
 {
        switch (p) {
        case Film::CONTENT:
+       case Film::CONTENT_ORDER:
                setup ();
                break;
-       case Film::SEQUENCE_VIDEO:
-               checked_set (_sequence_video, _film->sequence_video ());
-               break;
        default:
                break;
        }
 
-       for (list<ContentSubPanel*>::iterator i = _panels.begin(); i != _panels.end(); ++i) {
-               (*i)->film_changed (p);
+       BOOST_FOREACH (ContentSubPanel* i, _panels) {
+               i->film_changed (p);
        }
-}      
+}
 
 void
 ContentPanel::selection_changed ()
 {
+       if (_last_selected == selected()) {
+               /* This was triggered by a re-build of the view but the selection
+                  did not really change.
+               */
+               return;
+       }
+
+       _last_selected = selected ();
+
        setup_sensitivity ();
 
-       for (list<ContentSubPanel*>::iterator i = _panels.begin(); i != _panels.end(); ++i) {
-               (*i)->content_selection_changed ();
+       BOOST_FOREACH (ContentSubPanel* i, _panels) {
+               i->content_selection_changed ();
+       }
+
+       optional<DCPTime> go_to;
+       BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
+               if (!go_to || i->position() < go_to.get()) {
+                       go_to = i->position ();
+               }
+       }
+
+       if (go_to) {
+               _film_viewer->set_position (go_to.get ());
+       }
+
+       if (_timeline_dialog) {
+               _timeline_dialog->set_selection (selected ());
        }
 }
 
 void
 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) {
+               return;
+       }
+
        /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
           non-Latin filenames or paths.
        */
-       wxFileDialog* d = new wxFileDialog (_panel, _("Choose a file or files"), wxT (""), wxT (""), wxT ("*.*"), wxFD_MULTIPLE | wxFD_CHANGE_DIR);
+       wxFileDialog* d = new wxFileDialog (
+               _panel,
+               _("Choose a file or files"),
+               wxT (""),
+               wxT (""),
+               wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
+               wxFD_MULTIPLE | wxFD_CHANGE_DIR
+               );
+
        int const r = d->ShowModal ();
 
        if (r != wxID_OK) {
@@ -248,12 +289,11 @@ ContentPanel::add_file_clicked ()
 
        wxArrayString paths;
        d->GetPaths (paths);
-
-       /* XXX: check for lots of files here and do something */
-
+       list<boost::filesystem::path> path_list;
        for (unsigned int i = 0; i < paths.GetCount(); ++i) {
-               _film->examine_and_add_content (content_factory (_film, wx_to_std (paths[i])));
+               path_list.push_back (wx_to_std (paths[i]));
        }
+       add_files (path_list);
 
        d->Destroy ();
 }
@@ -262,40 +302,62 @@ void
 ContentPanel::add_folder_clicked ()
 {
        wxDirDialog* d = new wxDirDialog (_panel, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
-       int const r = d->ShowModal ();
+       int r = d->ShowModal ();
+       boost::filesystem::path const path (wx_to_std (d->GetPath ()));
        d->Destroy ();
-       
+
        if (r != wxID_OK) {
                return;
        }
 
        shared_ptr<Content> content;
-       
+
        try {
-               content.reset (new ImageContent (_film, boost::filesystem::path (wx_to_std (d->GetPath ()))));
-       } catch (...) {
-               try {
-                       content.reset (new DCPContent (_film, boost::filesystem::path (wx_to_std (d->GetPath ()))));
-               } catch (...) {
-                       error_dialog (_panel, _("Could not find any images nor a DCP in that folder"));
+               content = content_factory (_film, path);
+       } catch (exception& e) {
+               error_dialog (_parent, e.what());
+               return;
+       }
+
+       if (!content) {
+               error_dialog (_parent, _("No content found in this folder."));
+               return;
+       }
+
+       shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (content);
+       if (ic) {
+               ImageSequenceDialog* e = new ImageSequenceDialog (_panel);
+               r = e->ShowModal ();
+               float const frame_rate = e->frame_rate ();
+               e->Destroy ();
+
+               if (r != wxID_OK) {
                        return;
                }
-       }
 
-       if (content) {
-               _film->examine_and_add_content (content);
+               ic->set_video_frame_rate (frame_rate);
        }
+
+       _film->examine_and_add_content (content);
 }
 
-void
-ContentPanel::remove_clicked ()
+/** @return true if this remove "click" should be ignored */
+bool
+ContentPanel::remove_clicked (bool hotkey)
 {
-       ContentList c = selected ();
-       if (c.size() == 1) {
-               _film->remove_content (c.front ());
+       /* 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())) {
+               return true;
+       }
+
+       BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
+               _film->remove_content (i);
        }
 
        selection_changed ();
+       return false;
 }
 
 void
@@ -305,7 +367,7 @@ ContentPanel::timeline_clicked ()
                _timeline_dialog->Destroy ();
                _timeline_dialog = 0;
        }
-       
+
        _timeline_dialog = new TimelineDialog (this, _film);
        _timeline_dialog->Show ();
 }
@@ -313,7 +375,7 @@ ContentPanel::timeline_clicked ()
 void
 ContentPanel::right_click (wxListEvent& ev)
 {
-       _menu->popup (_film, selected (), ev.GetPoint ());
+       _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
 }
 
 /** Set up broad sensitivity based on the type of content that is selected */
@@ -324,24 +386,27 @@ ContentPanel::setup_sensitivity ()
        _add_folder->Enable (_generally_sensitive);
 
        ContentList selection = selected ();
-       VideoContentList video_selection = selected_video ();
-       AudioContentList audio_selection = selected_audio ();
+       ContentList video_selection = selected_video ();
+       ContentList audio_selection = selected_audio ();
 
-       _remove->Enable   (selection.size() == 1 && _generally_sensitive);
+       _remove->Enable   (!selection.empty() && _generally_sensitive);
        _earlier->Enable  (selection.size() == 1 && _generally_sensitive);
        _later->Enable    (selection.size() == 1 && _generally_sensitive);
        _timeline->Enable (!_film->content().empty() && _generally_sensitive);
 
        _video_panel->Enable    (video_selection.size() > 0 && _generally_sensitive);
        _audio_panel->Enable    (audio_selection.size() > 0 && _generally_sensitive);
-       _subtitle_panel->Enable (selection.size() == 1 && dynamic_pointer_cast<SubtitleContent> (selection.front()) && _generally_sensitive);
+       _subtitle_panel->Enable (selection.size() == 1 && selection.front()->subtitle && _generally_sensitive);
        _timing_panel->Enable   (selection.size() == 1 && _generally_sensitive);
 }
 
 void
-ContentPanel::set_film (shared_ptr<Film> f)
+ContentPanel::set_film (shared_ptr<Film> film)
 {
-       _film = f;
+       _film = film;
+
+       film_changed (Film::CONTENT);
+       film_changed (Film::AUDIO_CHANNELS);
        selection_changed ();
 }
 
@@ -357,11 +422,10 @@ ContentPanel::set_general_sensitivity (bool s)
        _earlier->Enable (s);
        _later->Enable (s);
        _timeline->Enable (s);
-       _sequence_video->Enable (s);
 
        /* Set the panels in the content notebook */
-       for (list<ContentSubPanel*>::iterator i = _panels.begin(); i != _panels.end(); ++i) {
-               (*i)->Enable (s);
+       BOOST_FOREACH (ContentSubPanel* i, _panels) {
+               i->Enable (s);
        }
 }
 
@@ -393,7 +457,7 @@ ContentPanel::set_selection (weak_ptr<Content> wc)
                if (content[i] == wc.lock ()) {
                        _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
                } else {
-                       _content->SetItemState (i, 0, wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED);
+                       _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
                }
        }
 }
@@ -401,37 +465,40 @@ ContentPanel::set_selection (weak_ptr<Content> wc)
 void
 ContentPanel::film_content_changed (int property)
 {
-       if (property == ContentProperty::PATH || property == ContentProperty::POSITION || property == DCPContentProperty::CAN_BE_PLAYED) {
+       if (property == ContentProperty::PATH || property == DCPContentProperty::CAN_BE_PLAYED) {
                setup ();
        }
-               
-       for (list<ContentSubPanel*>::iterator i = _panels.begin(); i != _panels.end(); ++i) {
-               (*i)->film_content_changed (property);
+
+       BOOST_FOREACH (ContentSubPanel* i, _panels) {
+               i->film_content_changed (property);
        }
 }
 
 void
 ContentPanel::setup ()
 {
-       string selected_summary;
+       ContentList content = _film->content ();
+
+       Content* selected_content = 0;
        int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
        if (s != -1) {
-               selected_summary = wx_to_std (_content->GetItemText (s));
+               wxListItem item;
+               item.SetId (s);
+               item.SetMask (wxLIST_MASK_DATA);
+               _content->GetItem (item);
+               selected_content = reinterpret_cast<Content*> (item.GetData ());
        }
-       
+
        _content->DeleteAllItems ();
 
-       ContentList content = _film->content ();
-       sort (content.begin(), content.end(), ContentSorter ());
-       
-       for (ContentList::iterator i = content.begin(); i != content.end(); ++i) {
+       BOOST_FOREACH (shared_ptr<Content> i, content) {
                int const t = _content->GetItemCount ();
-               bool const valid = (*i)->paths_valid ();
-               shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (*i);
+               bool const valid = i->paths_valid ();
+               shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
                bool const needs_kdm = dcp && !dcp->can_be_played ();
 
-               string s = (*i)->summary ();
-               
+               string s = i->summary ();
+
                if (!valid) {
                        s = _("MISSING: ") + s;
                }
@@ -440,9 +507,13 @@ ContentPanel::setup ()
                        s = _("NEEDS KDM: ") + s;
                }
 
-               _content->InsertItem (t, std_to_wx (s));
+               wxListItem item;
+               item.SetId (t);
+               item.SetText (std_to_wx (s));
+               item.SetData (i.get ());
+               _content->InsertItem (item);
 
-               if ((*i)->summary() == selected_summary) {
+               if (i.get() == selected_content) {
                        _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
                }
 
@@ -451,7 +522,7 @@ ContentPanel::setup ()
                }
        }
 
-       if (selected_summary.empty () && !content.empty ()) {
+       if (!selected_content && !content.empty ()) {
                /* Select the item of content if none was selected before */
                _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
        }
@@ -463,9 +534,29 @@ ContentPanel::files_dropped (wxDropFilesEvent& event)
        if (!_film) {
                return;
        }
-       
+
        wxString* paths = event.GetFiles ();
+       list<boost::filesystem::path> path_list;
        for (int i = 0; i < event.GetNumberOfFiles(); i++) {
-               _film->examine_and_add_content (content_factory (_film, wx_to_std (paths[i])));
+               path_list.push_back (wx_to_std (paths[i]));
+       }
+
+       add_files (path_list);
+}
+
+void
+ContentPanel::add_files (list<boost::filesystem::path> paths)
+{
+       /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
+          I can't reproduce that, but sort them anyway.  Don't use ImageFilenameSorter as a normal
+          alphabetical sort is expected here.
+       */
+
+       paths.sort (CaseInsensitiveSorter ());
+
+       /* XXX: check for lots of files here and do something */
+
+       for (list<boost::filesystem::path>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
+               _film->examine_and_add_content (content_factory (_film, *i));
        }
 }