src/wx/content_panel.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "content_panel.h"
  21 #include "wx_util.h"
  22 #include "video_panel.h"
  23 #include "audio_panel.h"
  24 #include "subtitle_panel.h"
  25 #include "timing_panel.h"
  26 #include "timeline_dialog.h"
  27 #include "image_sequence_dialog.h"
  28 #include "lib/audio_content.h"
  29 #include "lib/subtitle_content.h"
  30 #include "lib/video_content.h"
  31 #include "lib/ffmpeg_content.h"
  32 #include "lib/content_factory.h"
  33 #include "lib/image_content.h"
  34 #include "lib/dcp_content.h"
  35 #include "lib/case_insensitive_sorter.h"
  36 #include "lib/playlist.h"
  37 #include <wx/wx.h>
  38 #include <wx/notebook.h>
  39 #include <wx/listctrl.h>
  40 #include <boost/filesystem.hpp>
  41 #include <boost/foreach.hpp>
  42 #include <iostream>
  43
  44 using std::list;
  45 using std::string;
  46 using std::cout;
  47 using std::vector;
  48 using boost::shared_ptr;
  49 using boost::weak_ptr;
  50 using boost::dynamic_pointer_cast;
  51
  52 ContentPanel::ContentPanel (wxNotebook* n, boost::shared_ptr<Film> film, FilmViewer* viewer)
  53         : _timeline_dialog (0)
  54         , _parent (n)
  55         , _film (film)
  56         , _generally_sensitive (true)
  57 {
  58         _panel = new wxPanel (n);
  59         _sizer = new wxBoxSizer (wxVERTICAL);
  60         _panel->SetSizer (_sizer);
  61
  62         _menu = new ContentMenu (_panel);
  63
  64         {
  65                 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
  66
  67                 _content = new wxListCtrl (_panel, wxID_ANY, wxDefaultPosition, wxSize (320, 160), wxLC_REPORT | wxLC_NO_HEADER);
  68                 _content->DragAcceptFiles (true);
  69                 s->Add (_content, 1, wxEXPAND | wxTOP | wxBOTTOM, 6);
  70
  71                 _content->InsertColumn (0, wxT(""));
  72                 _content->SetColumnWidth (0, 512);
  73
  74                 wxBoxSizer* b = new wxBoxSizer (wxVERTICAL);
  75
  76                 _add_file = new wxButton (_panel, wxID_ANY, _("Add file(s)..."));
  77                 _add_file->SetToolTip (_("Add video, image or sound files to the film."));
  78                 b->Add (_add_file, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
  79
  80                 _add_folder = new wxButton (_panel, wxID_ANY, _("Add folder..."));
  81                 _add_folder->SetToolTip (_("Add a folder of image files (which will be used as a moving image sequence) or a DCP."));
  82                 b->Add (_add_folder, 1, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
  83
  84                 _remove = new wxButton (_panel, wxID_ANY, _("Remove"));
  85                 _remove->SetToolTip (_("Remove the selected piece of content from the film."));
  86                 b->Add (_remove, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
  87
  88                 _earlier = new wxButton (_panel, wxID_ANY, _("Up"));
  89                 _earlier->SetToolTip (_("Move the selected piece of content earlier in the film."));
  90                 b->Add (_earlier, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
  91
  92                 _later = new wxButton (_panel, wxID_ANY, _("Down"));
  93                 _later->SetToolTip (_("Move the selected piece of content later in the film."));
  94                 b->Add (_later, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
  95
  96                 _timeline = new wxButton (_panel, wxID_ANY, _("Timeline..."));
  97                 _timeline->SetToolTip (_("Open the timeline for the film."));
  98                 b->Add (_timeline, 0, wxEXPAND | wxALL, DCPOMATIC_BUTTON_STACK_GAP);
  99
 100                 s->Add (b, 0, wxALL, 4);
 101
 102                 _sizer->Add (s, 0, wxEXPAND | wxALL, 6);
 103         }
 104
 105         _notebook = new wxNotebook (_panel, wxID_ANY);
 106         _sizer->Add (_notebook, 1, wxEXPAND | wxTOP, 6);
 107
 108         _video_panel = new VideoPanel (this);
 109         _panels.push_back (_video_panel);
 110         _audio_panel = new AudioPanel (this);
 111         _panels.push_back (_audio_panel);
 112         _subtitle_panel = new SubtitlePanel (this);
 113         _panels.push_back (_subtitle_panel);
 114         _timing_panel = new TimingPanel (this, viewer);
 115         _panels.push_back (_timing_panel);
 116
 117         _content->Bind (wxEVT_COMMAND_LIST_ITEM_SELECTED, boost::bind (&ContentPanel::selection_changed, this));
 118         _content->Bind (wxEVT_COMMAND_LIST_ITEM_DESELECTED, boost::bind (&ContentPanel::selection_changed, this));
 119         _content->Bind (wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, boost::bind (&ContentPanel::right_click, this, _1));
 120         _content->Bind (wxEVT_DROP_FILES, boost::bind (&ContentPanel::files_dropped, this, _1));
 121         _add_file->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::add_file_clicked, this));
 122         _add_folder->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::add_folder_clicked, this));
 123         _remove->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::remove_clicked, this));
 124         _earlier->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::earlier_clicked, this));
 125         _later->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::later_clicked, this));
 126         _timeline->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentPanel::timeline_clicked, this));
 127 }
 128
 129 ContentList
 130 ContentPanel::selected ()
 131 {
 132         ContentList sel;
 133         long int s = -1;
 134         while (true) {
 135                 s = _content->GetNextItem (s, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 136                 if (s == -1) {
 137                         break;
 138                 }
 139
 140                 if (s < int (_film->content().size ())) {
 141                         sel.push_back (_film->content()[s]);
 142                 }
 143         }
 144
 145         return sel;
 146 }
 147
 148 VideoContentList
 149 ContentPanel::selected_video ()
 150 {
 151         VideoContentList vc;
 152
 153         BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
 154                 shared_ptr<VideoContent> t = dynamic_pointer_cast<VideoContent> (i);
 155                 if (t) {
 156                         vc.push_back (t);
 157                 }
 158         }
 159
 160         return vc;
 161 }
 162
 163 AudioContentList
 164 ContentPanel::selected_audio ()
 165 {
 166         AudioContentList ac;
 167
 168         BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
 169                 shared_ptr<AudioContent> t = dynamic_pointer_cast<AudioContent> (i);
 170                 if (t) {
 171                         ac.push_back (t);
 172                 }
 173         }
 174
 175         return ac;
 176 }
 177
 178 SubtitleContentList
 179 ContentPanel::selected_subtitle ()
 180 {
 181         SubtitleContentList sc;
 182
 183         BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
 184                 shared_ptr<SubtitleContent> t = dynamic_pointer_cast<SubtitleContent> (i);
 185                 if (t) {
 186                         sc.push_back (t);
 187                 }
 188         }
 189
 190         return sc;
 191 }
 192
 193 FFmpegContentList
 194 ContentPanel::selected_ffmpeg ()
 195 {
 196         FFmpegContentList sc;
 197
 198         BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
 199                 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
 200                 if (t) {
 201                         sc.push_back (t);
 202                 }
 203         }
 204
 205         return sc;
 206 }
 207
 208 void
 209 ContentPanel::film_changed (Film::Property p)
 210 {
 211         switch (p) {
 212         case Film::CONTENT:
 213                 setup ();
 214                 break;
 215         default:
 216                 break;
 217         }
 218
 219         BOOST_FOREACH (ContentSubPanel* i, _panels) {
 220                 i->film_changed (p);
 221         }
 222 }
 223
 224 void
 225 ContentPanel::selection_changed ()
 226 {
 227         setup_sensitivity ();
 228
 229         BOOST_FOREACH (ContentSubPanel* i, _panels) {
 230                 i->content_selection_changed ();
 231         }
 232 }
 233
 234 void
 235 ContentPanel::add_file_clicked ()
 236 {
 237         /* This method is also called when Ctrl-A is pressed, so check that our notebook page
 238            is visible.
 239         */
 240         if (_parent->GetCurrentPage() != _panel) {
 241                 return;
 242         }
 243
 244         /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
 245            non-Latin filenames or paths.
 246         */
 247         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);
 248         int const r = d->ShowModal ();
 249
 250         if (r != wxID_OK) {
 251                 d->Destroy ();
 252                 return;
 253         }
 254
 255         wxArrayString paths;
 256         d->GetPaths (paths);
 257         list<boost::filesystem::path> path_list;
 258         for (unsigned int i = 0; i < paths.GetCount(); ++i) {
 259                 path_list.push_back (wx_to_std (paths[i]));
 260         }
 261         add_files (path_list);
 262
 263         d->Destroy ();
 264 }
 265
 266 void
 267 ContentPanel::add_folder_clicked ()
 268 {
 269         wxDirDialog* d = new wxDirDialog (_panel, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
 270         int r = d->ShowModal ();
 271         boost::filesystem::path const path (wx_to_std (d->GetPath ()));
 272         d->Destroy ();
 273
 274         if (r != wxID_OK) {
 275                 return;
 276         }
 277
 278         shared_ptr<Content> content = content_factory (_film, path);
 279         if (!content) {
 280                 error_dialog (_parent, _("No content found in this folder."));
 281                 return;
 282         }
 283
 284         shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (content);
 285         if (ic) {
 286                 ImageSequenceDialog* e = new ImageSequenceDialog (_panel);
 287                 r = e->ShowModal ();
 288                 float const frame_rate = e->frame_rate ();
 289                 e->Destroy ();
 290
 291                 if (r != wxID_OK) {
 292                         return;
 293                 }
 294
 295                 ic->set_video_frame_rate (frame_rate);
 296         }
 297
 298         _film->examine_and_add_content (content);
 299 }
 300
 301 void
 302 ContentPanel::remove_clicked ()
 303 {
 304         ContentList c = selected ();
 305         if (c.size() == 1) {
 306                 _film->remove_content (c.front ());
 307         }
 308
 309         selection_changed ();
 310 }
 311
 312 void
 313 ContentPanel::timeline_clicked ()
 314 {
 315         if (_timeline_dialog) {
 316                 _timeline_dialog->Destroy ();
 317                 _timeline_dialog = 0;
 318         }
 319
 320         _timeline_dialog = new TimelineDialog (this, _film);
 321         _timeline_dialog->Show ();
 322 }
 323
 324 void
 325 ContentPanel::right_click (wxListEvent& ev)
 326 {
 327         _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
 328 }
 329
 330 /** Set up broad sensitivity based on the type of content that is selected */
 331 void
 332 ContentPanel::setup_sensitivity ()
 333 {
 334         _add_file->Enable (_generally_sensitive);
 335         _add_folder->Enable (_generally_sensitive);
 336
 337         ContentList selection = selected ();
 338         VideoContentList video_selection = selected_video ();
 339         AudioContentList audio_selection = selected_audio ();
 340
 341         _remove->Enable   (selection.size() == 1 && _generally_sensitive);
 342         _earlier->Enable  (selection.size() == 1 && _generally_sensitive);
 343         _later->Enable    (selection.size() == 1 && _generally_sensitive);
 344         _timeline->Enable (!_film->content().empty() && _generally_sensitive);
 345
 346         _video_panel->Enable    (video_selection.size() > 0 && _generally_sensitive);
 347         _audio_panel->Enable    (audio_selection.size() > 0 && _generally_sensitive);
 348         _subtitle_panel->Enable (selection.size() == 1 && dynamic_pointer_cast<SubtitleContent> (selection.front()) && _generally_sensitive);
 349         _timing_panel->Enable   (selection.size() == 1 && _generally_sensitive);
 350 }
 351
 352 void
 353 ContentPanel::set_film (shared_ptr<Film> film)
 354 {
 355         _film = film;
 356
 357         film_changed (Film::CONTENT);
 358         film_changed (Film::AUDIO_CHANNELS);
 359         selection_changed ();
 360 }
 361
 362 void
 363 ContentPanel::set_general_sensitivity (bool s)
 364 {
 365         _generally_sensitive = s;
 366
 367         _content->Enable (s);
 368         _add_file->Enable (s);
 369         _add_folder->Enable (s);
 370         _remove->Enable (s);
 371         _earlier->Enable (s);
 372         _later->Enable (s);
 373         _timeline->Enable (s);
 374
 375         /* Set the panels in the content notebook */
 376         BOOST_FOREACH (ContentSubPanel* i, _panels) {
 377                 i->Enable (s);
 378         }
 379 }
 380
 381 void
 382 ContentPanel::earlier_clicked ()
 383 {
 384         ContentList sel = selected ();
 385         if (sel.size() == 1) {
 386                 _film->move_content_earlier (sel.front ());
 387                 selection_changed ();
 388         }
 389 }
 390
 391 void
 392 ContentPanel::later_clicked ()
 393 {
 394         ContentList sel = selected ();
 395         if (sel.size() == 1) {
 396                 _film->move_content_later (sel.front ());
 397                 selection_changed ();
 398         }
 399 }
 400
 401 void
 402 ContentPanel::set_selection (weak_ptr<Content> wc)
 403 {
 404         ContentList content = _film->content ();
 405         for (size_t i = 0; i < content.size(); ++i) {
 406                 if (content[i] == wc.lock ()) {
 407                         _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
 408                 } else {
 409                         _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
 410                 }
 411         }
 412 }
 413
 414 void
 415 ContentPanel::film_content_changed (int property)
 416 {
 417         if (property == ContentProperty::PATH || property == ContentProperty::POSITION || property == DCPContentProperty::CAN_BE_PLAYED) {
 418                 setup ();
 419         }
 420
 421         BOOST_FOREACH (ContentSubPanel* i, _panels) {
 422                 i->film_content_changed (property);
 423         }
 424 }
 425
 426 void
 427 ContentPanel::setup ()
 428 {
 429         ContentList content = _film->content ();
 430         sort (content.begin(), content.end(), ContentSorter ());
 431
 432         /* First, check to see if anything has changed and bail if not; this avoids
 433            flickering on OS X.
 434         */
 435
 436         vector<string> existing;
 437         for (int i = 0; i < _content->GetItemCount(); ++i) {
 438                 existing.push_back (wx_to_std (_content->GetItemText (i)));
 439         }
 440
 441         vector<string> proposed;
 442         BOOST_FOREACH (shared_ptr<Content> i, content) {
 443                bool const valid = i->paths_valid ();
 444
 445                string s = i->summary ();
 446                if (!valid) {
 447                        s = _("MISSING: ") + s;
 448                }
 449
 450                proposed.push_back (s);
 451         }
 452
 453         if (existing == proposed) {
 454                 return;
 455         }
 456
 457         /* Something has changed: set up the control */
 458
 459         string selected_summary;
 460         int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 461         if (s != -1) {
 462                 selected_summary = wx_to_std (_content->GetItemText (s));
 463         }
 464
 465         _content->DeleteAllItems ();
 466
 467         BOOST_FOREACH (shared_ptr<Content> i, content) {
 468                 int const t = _content->GetItemCount ();
 469                 bool const valid = i->paths_valid ();
 470                 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
 471                 bool const needs_kdm = dcp && !dcp->can_be_played ();
 472
 473                 string s = i->summary ();
 474
 475                 if (!valid) {
 476                         s = _("MISSING: ") + s;
 477                 }
 478
 479                 if (needs_kdm) {
 480                         s = _("NEEDS KDM: ") + s;
 481                 }
 482
 483                 _content->InsertItem (t, std_to_wx (s));
 484
 485                 if (i->summary() == selected_summary) {
 486                         _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
 487                 }
 488
 489                 if (!valid || needs_kdm) {
 490                         _content->SetItemTextColour (t, *wxRED);
 491                 }
 492         }
 493
 494         if (selected_summary.empty () && !content.empty ()) {
 495                 /* Select the item of content if none was selected before */
 496                 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
 497         }
 498 }
 499
 500 void
 501 ContentPanel::files_dropped (wxDropFilesEvent& event)
 502 {
 503         if (!_film) {
 504                 return;
 505         }
 506
 507         wxString* paths = event.GetFiles ();
 508         list<boost::filesystem::path> path_list;
 509         for (int i = 0; i < event.GetNumberOfFiles(); i++) {
 510                 path_list.push_back (wx_to_std (paths[i]));
 511         }
 512
 513         add_files (path_list);
 514 }
 515
 516 void
 517 ContentPanel::add_files (list<boost::filesystem::path> paths)
 518 {
 519         /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
 520            I can't reproduce that, but sort them anyway.  Don't use ImageFilenameSorter as a normal
 521            alphabetical sort is expected here.
 522         */
 523
 524         paths.sort (CaseInsensitiveSorter ());
 525
 526         /* XXX: check for lots of files here and do something */
 527
 528         for (list<boost::filesystem::path>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
 529                 _film->examine_and_add_content (content_factory (_film, *i));
 530         }
 531 }