src/wx/content_panel.cc

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