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 AudioContentList
 167 ContentPanel::selected_audio ()
 168 {
 169         AudioContentList ac;
 170
 171         BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
 172                 shared_ptr<AudioContent> t = dynamic_pointer_cast<AudioContent> (i);
 173                 if (t) {
 174                         ac.push_back (t);
 175                 }
 176         }
 177
 178         return ac;
 179 }
 180
 181 SubtitleContentList
 182 ContentPanel::selected_subtitle ()
 183 {
 184         SubtitleContentList sc;
 185
 186         BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
 187                 shared_ptr<SubtitleContent> t = dynamic_pointer_cast<SubtitleContent> (i);
 188                 if (t) {
 189                         sc.push_back (t);
 190                 }
 191         }
 192
 193         return sc;
 194 }
 195
 196 FFmpegContentList
 197 ContentPanel::selected_ffmpeg ()
 198 {
 199         FFmpegContentList sc;
 200
 201         BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
 202                 shared_ptr<FFmpegContent> t = dynamic_pointer_cast<FFmpegContent> (i);
 203                 if (t) {
 204                         sc.push_back (t);
 205                 }
 206         }
 207
 208         return sc;
 209 }
 210
 211 void
 212 ContentPanel::film_changed (Film::Property p)
 213 {
 214         switch (p) {
 215         case Film::CONTENT:
 216         case Film::CONTENT_ORDER:
 217                 setup ();
 218                 break;
 219         default:
 220                 break;
 221         }
 222
 223         BOOST_FOREACH (ContentSubPanel* i, _panels) {
 224                 i->film_changed (p);
 225         }
 226 }
 227
 228 void
 229 ContentPanel::selection_changed ()
 230 {
 231         if (_last_selected == selected()) {
 232                 /* This was triggered by a re-build of the view but the selection
 233                    did not really change.
 234                 */
 235                 return;
 236         }
 237
 238         _last_selected = selected ();
 239
 240         setup_sensitivity ();
 241
 242         BOOST_FOREACH (ContentSubPanel* i, _panels) {
 243                 i->content_selection_changed ();
 244         }
 245
 246         optional<DCPTime> go_to;
 247         BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
 248                 if (!go_to || i->position() < go_to.get()) {
 249                         go_to = i->position ();
 250                 }
 251         }
 252
 253         if (go_to) {
 254                 _film_viewer->set_position (go_to.get ());
 255         }
 256
 257         if (_timeline_dialog) {
 258                 _timeline_dialog->set_selection (selected ());
 259         }
 260 }
 261
 262 void
 263 ContentPanel::add_file_clicked ()
 264 {
 265         /* This method is also called when Ctrl-A is pressed, so check that our notebook page
 266            is visible.
 267         */
 268         if (_parent->GetCurrentPage() != _panel) {
 269                 return;
 270         }
 271
 272         /* The wxFD_CHANGE_DIR here prevents a `could not set working directory' error 123 on Windows when using
 273            non-Latin filenames or paths.
 274         */
 275         wxFileDialog* d = new wxFileDialog (
 276                 _panel,
 277                 _("Choose a file or files"),
 278                 wxT (""),
 279                 wxT (""),
 280                 wxT ("All files|*.*|Subtitle files|*.srt;*.xml|Audio files|*.wav;*.w64;*.flac;*.aif;*.aiff"),
 281                 wxFD_MULTIPLE | wxFD_CHANGE_DIR
 282                 );
 283
 284         int const r = d->ShowModal ();
 285
 286         if (r != wxID_OK) {
 287                 d->Destroy ();
 288                 return;
 289         }
 290
 291         wxArrayString paths;
 292         d->GetPaths (paths);
 293         list<boost::filesystem::path> path_list;
 294         for (unsigned int i = 0; i < paths.GetCount(); ++i) {
 295                 path_list.push_back (wx_to_std (paths[i]));
 296         }
 297         add_files (path_list);
 298
 299         d->Destroy ();
 300 }
 301
 302 void
 303 ContentPanel::add_folder_clicked ()
 304 {
 305         wxDirDialog* d = new wxDirDialog (_panel, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
 306         int r = d->ShowModal ();
 307         boost::filesystem::path const path (wx_to_std (d->GetPath ()));
 308         d->Destroy ();
 309
 310         if (r != wxID_OK) {
 311                 return;
 312         }
 313
 314         shared_ptr<Content> content;
 315
 316         try {
 317                 content = content_factory (_film, path);
 318         } catch (exception& e) {
 319                 error_dialog (_parent, e.what());
 320                 return;
 321         }
 322
 323         if (!content) {
 324                 error_dialog (_parent, _("No content found in this folder."));
 325                 return;
 326         }
 327
 328         shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (content);
 329         if (ic) {
 330                 ImageSequenceDialog* e = new ImageSequenceDialog (_panel);
 331                 r = e->ShowModal ();
 332                 float const frame_rate = e->frame_rate ();
 333                 e->Destroy ();
 334
 335                 if (r != wxID_OK) {
 336                         return;
 337                 }
 338
 339                 ic->video->set_video_frame_rate (frame_rate);
 340         }
 341
 342         _film->examine_and_add_content (content);
 343 }
 344
 345 /** @return true if this remove "click" should be ignored */
 346 bool
 347 ContentPanel::remove_clicked (bool hotkey)
 348 {
 349         /* If the method was called because Delete was pressed check that our notebook page
 350            is visible and that the content list is focussed.
 351         */
 352         if (hotkey && (_parent->GetCurrentPage() != _panel || !_content->HasFocus())) {
 353                 return true;
 354         }
 355
 356         BOOST_FOREACH (shared_ptr<Content> i, selected ()) {
 357                 _film->remove_content (i);
 358         }
 359
 360         selection_changed ();
 361         return false;
 362 }
 363
 364 void
 365 ContentPanel::timeline_clicked ()
 366 {
 367         if (_timeline_dialog) {
 368                 _timeline_dialog->Destroy ();
 369                 _timeline_dialog = 0;
 370         }
 371
 372         _timeline_dialog = new TimelineDialog (this, _film);
 373         _timeline_dialog->Show ();
 374 }
 375
 376 void
 377 ContentPanel::right_click (wxListEvent& ev)
 378 {
 379         _menu->popup (_film, selected (), TimelineContentViewList (), ev.GetPoint ());
 380 }
 381
 382 /** Set up broad sensitivity based on the type of content that is selected */
 383 void
 384 ContentPanel::setup_sensitivity ()
 385 {
 386         _add_file->Enable (_generally_sensitive);
 387         _add_folder->Enable (_generally_sensitive);
 388
 389         ContentList selection = selected ();
 390         ContentList video_selection = selected_video ();
 391         AudioContentList audio_selection = selected_audio ();
 392
 393         _remove->Enable   (!selection.empty() && _generally_sensitive);
 394         _earlier->Enable  (selection.size() == 1 && _generally_sensitive);
 395         _later->Enable    (selection.size() == 1 && _generally_sensitive);
 396         _timeline->Enable (!_film->content().empty() && _generally_sensitive);
 397
 398         _video_panel->Enable    (video_selection.size() > 0 && _generally_sensitive);
 399         _audio_panel->Enable    (audio_selection.size() > 0 && _generally_sensitive);
 400         _subtitle_panel->Enable (selection.size() == 1 && dynamic_pointer_cast<SubtitleContent> (selection.front()) && _generally_sensitive);
 401         _timing_panel->Enable   (selection.size() == 1 && _generally_sensitive);
 402 }
 403
 404 void
 405 ContentPanel::set_film (shared_ptr<Film> film)
 406 {
 407         _film = film;
 408
 409         film_changed (Film::CONTENT);
 410         film_changed (Film::AUDIO_CHANNELS);
 411         selection_changed ();
 412 }
 413
 414 void
 415 ContentPanel::set_general_sensitivity (bool s)
 416 {
 417         _generally_sensitive = s;
 418
 419         _content->Enable (s);
 420         _add_file->Enable (s);
 421         _add_folder->Enable (s);
 422         _remove->Enable (s);
 423         _earlier->Enable (s);
 424         _later->Enable (s);
 425         _timeline->Enable (s);
 426
 427         /* Set the panels in the content notebook */
 428         BOOST_FOREACH (ContentSubPanel* i, _panels) {
 429                 i->Enable (s);
 430         }
 431 }
 432
 433 void
 434 ContentPanel::earlier_clicked ()
 435 {
 436         ContentList sel = selected ();
 437         if (sel.size() == 1) {
 438                 _film->move_content_earlier (sel.front ());
 439                 selection_changed ();
 440         }
 441 }
 442
 443 void
 444 ContentPanel::later_clicked ()
 445 {
 446         ContentList sel = selected ();
 447         if (sel.size() == 1) {
 448                 _film->move_content_later (sel.front ());
 449                 selection_changed ();
 450         }
 451 }
 452
 453 void
 454 ContentPanel::set_selection (weak_ptr<Content> wc)
 455 {
 456         ContentList content = _film->content ();
 457         for (size_t i = 0; i < content.size(); ++i) {
 458                 if (content[i] == wc.lock ()) {
 459                         _content->SetItemState (i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
 460                 } else {
 461                         _content->SetItemState (i, 0, wxLIST_STATE_SELECTED);
 462                 }
 463         }
 464 }
 465
 466 void
 467 ContentPanel::film_content_changed (int property)
 468 {
 469         if (property == ContentProperty::PATH || property == DCPContentProperty::CAN_BE_PLAYED) {
 470                 setup ();
 471         }
 472
 473         BOOST_FOREACH (ContentSubPanel* i, _panels) {
 474                 i->film_content_changed (property);
 475         }
 476 }
 477
 478 void
 479 ContentPanel::setup ()
 480 {
 481         ContentList content = _film->content ();
 482
 483         Content* selected_content = 0;
 484         int const s = _content->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 485         if (s != -1) {
 486                 wxListItem item;
 487                 item.SetId (s);
 488                 item.SetMask (wxLIST_MASK_DATA);
 489                 _content->GetItem (item);
 490                 selected_content = reinterpret_cast<Content*> (item.GetData ());
 491         }
 492
 493         _content->DeleteAllItems ();
 494
 495         BOOST_FOREACH (shared_ptr<Content> i, content) {
 496                 int const t = _content->GetItemCount ();
 497                 bool const valid = i->paths_valid ();
 498                 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (i);
 499                 bool const needs_kdm = dcp && !dcp->can_be_played ();
 500
 501                 string s = i->summary ();
 502
 503                 if (!valid) {
 504                         s = _("MISSING: ") + s;
 505                 }
 506
 507                 if (needs_kdm) {
 508                         s = _("NEEDS KDM: ") + s;
 509                 }
 510
 511                 wxListItem item;
 512                 item.SetId (t);
 513                 item.SetText (std_to_wx (s));
 514                 item.SetData (i.get ());
 515                 _content->InsertItem (item);
 516
 517                 if (i.get() == selected_content) {
 518                         _content->SetItemState (t, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
 519                 }
 520
 521                 if (!valid || needs_kdm) {
 522                         _content->SetItemTextColour (t, *wxRED);
 523                 }
 524         }
 525
 526         if (!selected_content && !content.empty ()) {
 527                 /* Select the item of content if none was selected before */
 528                 _content->SetItemState (0, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
 529         }
 530 }
 531
 532 void
 533 ContentPanel::files_dropped (wxDropFilesEvent& event)
 534 {
 535         if (!_film) {
 536                 return;
 537         }
 538
 539         wxString* paths = event.GetFiles ();
 540         list<boost::filesystem::path> path_list;
 541         for (int i = 0; i < event.GetNumberOfFiles(); i++) {
 542                 path_list.push_back (wx_to_std (paths[i]));
 543         }
 544
 545         add_files (path_list);
 546 }
 547
 548 void
 549 ContentPanel::add_files (list<boost::filesystem::path> paths)
 550 {
 551         /* It has been reported that the paths returned from e.g. wxFileDialog are not always sorted;
 552            I can't reproduce that, but sort them anyway.  Don't use ImageFilenameSorter as a normal
 553            alphabetical sort is expected here.
 554         */
 555
 556         paths.sort (CaseInsensitiveSorter ());
 557
 558         /* XXX: check for lots of files here and do something */
 559
 560         for (list<boost::filesystem::path>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
 561                 _film->examine_and_add_content (content_factory (_film, *i));
 562         }
 563 }