Separate readable error from technical detail in some places.
[dcpomatic.git] / src / wx / content_menu.cc
1 /*
2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 #include "content_menu.h"
22 #include "repeat_dialog.h"
23 #include "wx_util.h"
24 #include "timeline_video_content_view.h"
25 #include "timeline_audio_content_view.h"
26 #include "content_properties_dialog.h"
27 #include "lib/playlist.h"
28 #include "lib/film.h"
29 #include "lib/image_content.h"
30 #include "lib/content_factory.h"
31 #include "lib/examine_content_job.h"
32 #include "lib/job_manager.h"
33 #include "lib/exceptions.h"
34 #include "lib/dcp_content.h"
35 #include "lib/dcp_examiner.h"
36 #include "lib/ffmpeg_content.h"
37 #include "lib/audio_content.h"
38 #include <dcp/cpl.h>
39 #include <dcp/exceptions.h>
40 #include <wx/wx.h>
41 #include <wx/dirdlg.h>
42 #include <boost/foreach.hpp>
43 #include <iostream>
44
45 using std::cout;
46 using std::vector;
47 using std::exception;
48 using std::list;
49 using boost::shared_ptr;
50 using boost::weak_ptr;
51 using boost::dynamic_pointer_cast;
52
53 enum {
54         /* Start at 256 so we can have IDs on _cpl_menu from 1 to 255 */
55         ID_repeat = 256,
56         ID_join,
57         ID_find_missing,
58         ID_properties,
59         ID_re_examine,
60         ID_kdm,
61         ID_ov,
62         ID_choose_cpl,
63         ID_remove
64 };
65
66 ContentMenu::ContentMenu (wxWindow* p)
67         : _menu (new wxMenu)
68         , _parent (p)
69         , _pop_up_open (false)
70 {
71         _repeat = _menu->Append (ID_repeat, _("Repeat..."));
72         _join = _menu->Append (ID_join, _("Join"));
73         _find_missing = _menu->Append (ID_find_missing, _("Find missing..."));
74         _properties = _menu->Append (ID_properties, _("Properties..."));
75         _re_examine = _menu->Append (ID_re_examine, _("Re-examine..."));
76         _menu->AppendSeparator ();
77         _kdm = _menu->Append (ID_kdm, _("Add KDM..."));
78         _ov = _menu->Append (ID_ov, _("Add OV..."));
79         _cpl_menu = new wxMenu ();
80         _choose_cpl = _menu->Append (ID_choose_cpl, _("Choose CPL..."), _cpl_menu);
81         _menu->AppendSeparator ();
82         _remove = _menu->Append (ID_remove, _("Remove"));
83
84         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::repeat, this), ID_repeat);
85         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::join, this), ID_join);
86         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::find_missing, this), ID_find_missing);
87         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::properties, this), ID_properties);
88         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::re_examine, this), ID_re_examine);
89         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::kdm, this), ID_kdm);
90         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::ov, this), ID_ov);
91         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::remove, this), ID_remove);
92         _parent->Bind (wxEVT_MENU, boost::bind (&ContentMenu::cpl_selected, this, _1), 1, ID_repeat - 1);
93 }
94
95 void
96 ContentMenu::popup (weak_ptr<Film> film, ContentList c, TimelineContentViewList v, wxPoint p)
97 {
98         _film = film;
99         _content = c;
100         _views = v;
101
102         int const N = _cpl_menu->GetMenuItemCount();
103         for (int i = 1; i <= N; ++i) {
104                 _cpl_menu->Delete (i);
105         }
106
107         _repeat->Enable (!_content.empty ());
108
109         int n = 0;
110         BOOST_FOREACH (shared_ptr<Content> i, _content) {
111                 if (dynamic_pointer_cast<FFmpegContent> (i)) {
112                         ++n;
113                 }
114         }
115
116         _join->Enable (n > 1);
117
118         _find_missing->Enable (_content.size() == 1 && !_content.front()->paths_valid ());
119         _properties->Enable (_content.size() == 1);
120         _re_examine->Enable (!_content.empty ());
121
122         if (_content.size() == 1) {
123                 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (_content.front ());
124                 if (dcp) {
125                         _kdm->Enable (dcp->encrypted ());
126                         _ov->Enable (dcp->needs_assets ());
127                         try {
128                                 DCPExaminer ex (dcp);
129                                 list<shared_ptr<dcp::CPL> > cpls = ex.cpls ();
130                                 _choose_cpl->Enable (cpls.size() > 1);
131                                 /* We can't have 0 as a menu item ID on OS X */
132                                 int id = 1;
133                                 BOOST_FOREACH (shared_ptr<dcp::CPL> i, cpls) {
134                                         wxMenuItem* item = _cpl_menu->AppendCheckItem (
135                                                 id++,
136                                                 wxString::Format (
137                                                         "%s (%s)",
138                                                         std_to_wx(i->annotation_text()).data(),
139                                                         std_to_wx(i->id()).data()
140                                                         )
141                                                 );
142                                         item->Check (dcp->cpl() && dcp->cpl() == i->id());
143                                 }
144                         } catch (dcp::DCPReadError) {
145                                 /* The DCP is probably missing */
146                         } catch (dcp::KDMDecryptionError) {
147                                 /* We have an incorrect KDM */
148                         }
149                 } else {
150                         _kdm->Enable (false);
151                         _ov->Enable (false);
152                         _choose_cpl->Enable (false);
153                 }
154         } else {
155                 _kdm->Enable (false);
156         }
157
158         _remove->Enable (!_content.empty ());
159
160         _pop_up_open = true;
161         _parent->PopupMenu (_menu, p);
162         _pop_up_open = false;
163 }
164
165 void
166 ContentMenu::repeat ()
167 {
168         if (_content.empty ()) {
169                 return;
170         }
171
172         RepeatDialog* d = new RepeatDialog (_parent);
173         if (d->ShowModal() != wxID_OK) {
174                 d->Destroy ();
175                 return;
176         }
177
178         shared_ptr<Film> film = _film.lock ();
179         if (!film) {
180                 return;
181         }
182
183         film->repeat_content (_content, d->number ());
184         d->Destroy ();
185
186         _content.clear ();
187         _views.clear ();
188 }
189
190 void
191 ContentMenu::join ()
192 {
193         vector<shared_ptr<Content> > fc;
194         BOOST_FOREACH (shared_ptr<Content> i, _content) {
195                 shared_ptr<FFmpegContent> f = dynamic_pointer_cast<FFmpegContent> (i);
196                 if (f) {
197                         fc.push_back (f);
198                 }
199         }
200
201         DCPOMATIC_ASSERT (fc.size() > 1);
202
203         shared_ptr<Film> film = _film.lock ();
204         if (!film) {
205                 return;
206         }
207
208         try {
209                 shared_ptr<FFmpegContent> joined (new FFmpegContent (film, fc));
210                 film->remove_content (_content);
211                 film->examine_and_add_content (joined);
212         } catch (JoinError& e) {
213                 error_dialog (_parent, std_to_wx (e.what ()));
214         }
215 }
216
217 void
218 ContentMenu::remove ()
219 {
220         if (_content.empty ()) {
221                 return;
222         }
223
224         shared_ptr<Film> film = _film.lock ();
225         if (!film) {
226                 return;
227         }
228
229         /* We are removing from the timeline if _views is not empty */
230         bool handled = false;
231         if (!_views.empty ()) {
232                 /* Special case: we only remove FFmpegContent if its video view is selected;
233                    if not, and its audio view is selected, we unmap the audio.
234                 */
235                 BOOST_FOREACH (shared_ptr<Content> i, _content) {
236                         shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (i);
237                         if (!fc) {
238                                 continue;
239                         }
240
241                         shared_ptr<TimelineVideoContentView> video;
242                         shared_ptr<TimelineAudioContentView> audio;
243
244                         BOOST_FOREACH (shared_ptr<TimelineContentView> j, _views) {
245                                 shared_ptr<TimelineVideoContentView> v = dynamic_pointer_cast<TimelineVideoContentView> (j);
246                                 shared_ptr<TimelineAudioContentView> a = dynamic_pointer_cast<TimelineAudioContentView> (j);
247                                 if (v && v->content() == fc) {
248                                         video = v;
249                                 } else if (a && a->content() == fc) {
250                                         audio = a;
251                                 }
252                         }
253
254                         if (!video && audio) {
255                                 AudioMapping m = fc->audio->mapping ();
256                                 m.unmap_all ();
257                                 fc->audio->set_mapping (m);
258                                 handled = true;
259                         }
260                 }
261         }
262
263         if (!handled) {
264                 film->remove_content (_content);
265         }
266
267         _content.clear ();
268         _views.clear ();
269 }
270
271 void
272 ContentMenu::find_missing ()
273 {
274         if (_content.size() != 1) {
275                 return;
276         }
277
278         shared_ptr<const Film> film = _film.lock ();
279         if (!film) {
280                 return;
281         }
282
283         /* XXX: a bit nasty */
284         shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (_content.front ());
285         shared_ptr<DCPContent> dc = dynamic_pointer_cast<DCPContent> (_content.front ());
286
287         int r = wxID_CANCEL;
288         boost::filesystem::path path;
289
290         if ((ic && !ic->still ()) || dc) {
291                 wxDirDialog* d = new wxDirDialog (0, _("Choose a folder"), wxT (""), wxDD_DIR_MUST_EXIST);
292                 r = d->ShowModal ();
293                 path = wx_to_std (d->GetPath ());
294                 d->Destroy ();
295         } else {
296                 wxFileDialog* d = new wxFileDialog (0, _("Choose a file"), wxT (""), wxT (""), wxT ("*.*"), wxFD_MULTIPLE);
297                 r = d->ShowModal ();
298                 path = wx_to_std (d->GetPath ());
299                 d->Destroy ();
300         }
301
302         list<shared_ptr<Content> > content;
303
304         if (r == wxID_OK) {
305                 if (dc) {
306                         content.push_back (shared_ptr<DCPContent> (new DCPContent (film, path)));
307                 } else {
308                         content = content_factory (film, path);
309                 }
310         }
311
312         if (content.empty ()) {
313                 return;
314         }
315
316         BOOST_FOREACH (shared_ptr<Content> i, content) {
317                 shared_ptr<Job> j (new ExamineContentJob (film, i));
318
319                 j->Finished.connect (
320                         bind (
321                                 &ContentMenu::maybe_found_missing,
322                                 this,
323                                 boost::weak_ptr<Job> (j),
324                                 boost::weak_ptr<Content> (_content.front ()),
325                                 boost::weak_ptr<Content> (i)
326                                 )
327                         );
328
329                 JobManager::instance()->add (j);
330         }
331 }
332
333 void
334 ContentMenu::re_examine ()
335 {
336         shared_ptr<Film> film = _film.lock ();
337         if (!film) {
338                 return;
339         }
340
341         BOOST_FOREACH (shared_ptr<Content> i, _content) {
342                 JobManager::instance()->add (shared_ptr<Job> (new ExamineContentJob (film, i)));
343         }
344 }
345
346 void
347 ContentMenu::maybe_found_missing (weak_ptr<Job> j, weak_ptr<Content> oc, weak_ptr<Content> nc)
348 {
349         shared_ptr<Job> job = j.lock ();
350         if (!job || !job->finished_ok ()) {
351                 return;
352         }
353
354         shared_ptr<Content> old_content = oc.lock ();
355         shared_ptr<Content> new_content = nc.lock ();
356         DCPOMATIC_ASSERT (old_content);
357         DCPOMATIC_ASSERT (new_content);
358
359         if (new_content->digest() != old_content->digest()) {
360                 error_dialog (0, _("The content file(s) you specified are not the same as those that are missing.  Either try again with the correct content file or remove the missing content."));
361                 return;
362         }
363
364         old_content->set_paths (new_content->paths());
365 }
366
367 void
368 ContentMenu::kdm ()
369 {
370         DCPOMATIC_ASSERT (!_content.empty ());
371         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (_content.front ());
372         DCPOMATIC_ASSERT (dcp);
373
374         wxFileDialog* d = new wxFileDialog (_parent, _("Select KDM"));
375
376         if (d->ShowModal() == wxID_OK) {
377                 try {
378                         dcp->add_kdm (dcp::EncryptedKDM (dcp::file_to_string (wx_to_std (d->GetPath ()), MAX_KDM_SIZE)));
379                 } catch (exception& e) {
380                         error_dialog (_parent, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
381                         d->Destroy ();
382                         return;
383                 }
384
385                 shared_ptr<Film> film = _film.lock ();
386                 DCPOMATIC_ASSERT (film);
387                 JobManager::instance()->add (shared_ptr<Job> (new ExamineContentJob (film, dcp)));
388         }
389
390         d->Destroy ();
391 }
392
393 void
394 ContentMenu::ov ()
395 {
396         DCPOMATIC_ASSERT (!_content.empty ());
397         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (_content.front ());
398         DCPOMATIC_ASSERT (dcp);
399
400         wxDirDialog* d = new wxDirDialog (_parent, _("Select OV"));
401
402         if (d->ShowModal() == wxID_OK) {
403                 dcp->add_ov (wx_to_std (d->GetPath ()));
404                 shared_ptr<Film> film = _film.lock ();
405                 DCPOMATIC_ASSERT (film);
406                 JobManager::instance()->add (shared_ptr<Job> (new ExamineContentJob (film, dcp)));
407         }
408
409         d->Destroy ();
410 }
411
412 void
413 ContentMenu::properties ()
414 {
415         ContentPropertiesDialog* d = new ContentPropertiesDialog (_parent, _content.front ());
416         d->ShowModal ();
417         d->Destroy ();
418 }
419
420 void
421 ContentMenu::cpl_selected (wxCommandEvent& ev)
422 {
423         if (!_pop_up_open) {
424                 return;
425         }
426
427         DCPOMATIC_ASSERT (!_content.empty ());
428         shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent> (_content.front ());
429         DCPOMATIC_ASSERT (dcp);
430
431         DCPExaminer ex (dcp);
432         list<shared_ptr<dcp::CPL> > cpls = ex.cpls ();
433         DCPOMATIC_ASSERT (ev.GetId() > 0);
434         DCPOMATIC_ASSERT (ev.GetId() <= int (cpls.size()));
435
436         list<shared_ptr<dcp::CPL> >::const_iterator i = cpls.begin ();
437         for (int j = 0; j < ev.GetId() - 1; ++j) {
438                 ++i;
439         }
440
441         dcp->set_cpl ((*i)->id ());
442         shared_ptr<Film> film = _film.lock ();
443         DCPOMATIC_ASSERT (film);
444         JobManager::instance()->add (shared_ptr<Job> (new ExamineContentJob (film, dcp)));
445 }