2 Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 #include "timing_panel.h"
23 #include "film_viewer.h"
25 #include "content_panel.h"
26 #include "move_to_dialog.h"
27 #include "static_text.h"
28 #include "dcpomatic_button.h"
29 #include "lib/content.h"
30 #include "lib/image_content.h"
31 #include "lib/text_content.h"
32 #include "lib/dcp_subtitle_content.h"
33 #include "lib/audio_content.h"
34 #include "lib/string_text_file_content.h"
35 #include "lib/video_content.h"
36 #include "lib/dcp_content.h"
37 #include "lib/ffmpeg_content.h"
38 #include <dcp/locale_convert.h>
39 #include <boost/foreach.hpp>
46 using boost::shared_ptr;
47 using boost::weak_ptr;
48 using boost::dynamic_pointer_cast;
49 using boost::optional;
50 using dcp::locale_convert;
52 TimingPanel::TimingPanel (ContentPanel* p, weak_ptr<FilmViewer> viewer)
53 /* horrid hack for apparent lack of context support with wxWidgets i18n code */
54 /// TRANSLATORS: translate the word "Timing" here; do not include the "Timing|" prefix
55 : ContentSubPanel (p, S_("Timing|Timing"))
57 , _film_content_changed_suspender (boost::bind(&TimingPanel::film_content_changed, this, _1))
59 wxSize size = TimecodeBase::size (this);
61 for (int i = 0; i < 3; ++i) {
62 _colon[i] = create_label (this, wxT(":"), false);
65 //// TRANSLATORS: this is an abbreviation for "hours"
66 _h_label = new StaticText (this, _("h"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
67 #ifdef DCPOMATIC_LINUX
68 /* Hack to work around failure to centre text on GTK */
69 gtk_label_set_line_wrap (GTK_LABEL(_h_label->GetHandle()), FALSE);
71 //// TRANSLATORS: this is an abbreviation for "minutes"
72 _m_label = new StaticText (this, _("m"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
73 #ifdef DCPOMATIC_LINUX
74 gtk_label_set_line_wrap (GTK_LABEL (_m_label->GetHandle()), FALSE);
76 //// TRANSLATORS: this is an abbreviation for "seconds"
77 _s_label = new StaticText (this, _("s"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
78 #ifdef DCPOMATIC_LINUX
79 gtk_label_set_line_wrap (GTK_LABEL(_s_label->GetHandle()), FALSE);
81 //// TRANSLATORS: this is an abbreviation for "frames"
82 _f_label = new StaticText (this, _("f"), wxDefaultPosition, size, wxALIGN_CENTRE_HORIZONTAL);
83 #ifdef DCPOMATIC_LINUX
84 gtk_label_set_line_wrap (GTK_LABEL(_f_label->GetHandle()), FALSE);
87 _position_label = create_label (this, _("Position"), true);
88 _position = new Timecode<DCPTime> (this);
89 _move_to_start_of_reel = new Button (this, _("Move to start of reel"));
90 _full_length_label = create_label (this, _("Full length"), true);
91 _full_length = new Timecode<DCPTime> (this);
92 _trim_start_label = create_label (this, _("Trim from start"), true);
93 _trim_start = new Timecode<ContentTime> (this);
94 _trim_start_to_playhead = new Button (this, _("Trim up to current position"));
95 _trim_end_label = create_label (this, _("Trim from end"), true);
96 _trim_end = new Timecode<ContentTime> (this);
97 _trim_end_to_playhead = new Button (this, _("Trim after current position"));
98 _play_length_label = create_label (this, _("Play length"), true);
99 _play_length = new Timecode<DCPTime> (this);
101 _video_frame_rate_label = create_label (this, _("Video frame rate"), true);
102 _video_frame_rate = new wxTextCtrl (this, wxID_ANY);
103 _set_video_frame_rate = new Button (this, _("Set"));
104 _set_video_frame_rate->Enable (false);
106 /* We can't use Wrap() here as it doesn't work with markup:
107 * http://trac.wxwidgets.org/ticket/13389
110 wxString in = _("<i>Only change this if the content's frame rate has been read incorrectly.</i>");
112 int const width = 20;
114 for (size_t i = 0; i < in.Length(); ++i) {
115 if (in[i] == ' ' && current >= width) {
124 _tip = new StaticText (this, wxT (""));
125 _tip->SetLabelMarkup (out);
127 /* Hack to stop hidden text on some versions of OS X */
128 _tip->SetMinSize (wxSize (-1, 256));
131 _position->Changed.connect (boost::bind (&TimingPanel::position_changed, this));
132 _move_to_start_of_reel->Bind (wxEVT_BUTTON, boost::bind (&TimingPanel::move_to_start_of_reel_clicked, this));
133 _full_length->Changed.connect (boost::bind (&TimingPanel::full_length_changed, this));
134 _trim_start->Changed.connect (boost::bind (&TimingPanel::trim_start_changed, this));
135 _trim_start_to_playhead->Bind (wxEVT_BUTTON, boost::bind (&TimingPanel::trim_start_to_playhead_clicked, this));
136 _trim_end->Changed.connect (boost::bind (&TimingPanel::trim_end_changed, this));
137 _trim_end_to_playhead->Bind (wxEVT_BUTTON, boost::bind (&TimingPanel::trim_end_to_playhead_clicked, this));
138 _play_length->Changed.connect (boost::bind (&TimingPanel::play_length_changed, this));
139 _video_frame_rate->Bind (wxEVT_TEXT, boost::bind (&TimingPanel::video_frame_rate_changed, this));
140 _set_video_frame_rate->Bind (wxEVT_BUTTON, boost::bind (&TimingPanel::set_video_frame_rate, this));
142 shared_ptr<FilmViewer> fv = _viewer.lock ();
143 DCPOMATIC_ASSERT (fv);
144 fv->ImageChanged.connect (boost::bind (&TimingPanel::setup_sensitivity, this));
146 setup_sensitivity ();
151 TimingPanel::add_to_grid ()
153 bool const full = Config::instance()->interface_complexity() == Config::INTERFACE_FULL;
157 wxSizer* labels = new wxBoxSizer (wxHORIZONTAL);
158 labels->Add (_h_label, 1, wxEXPAND);
159 add_label_to_sizer (labels, _colon[0], false);
160 labels->Add (_m_label, 1, wxEXPAND);
161 add_label_to_sizer (labels, _colon[1], false);
162 labels->Add (_s_label, 1, wxEXPAND);
163 add_label_to_sizer (labels, _colon[2], false);
164 labels->Add (_f_label, 1, wxEXPAND);
165 _grid->Add (labels, wxGBPosition(r, 1));
168 add_label_to_sizer (_grid, _position_label, true, wxGBPosition(r, 0));
169 _grid->Add (_position, wxGBPosition(r, 1));
172 _move_to_start_of_reel->Show (full);
173 _full_length_label->Show (full);
174 _full_length->Show (full);
175 _play_length_label->Show (full);
176 _play_length->Show (full);
177 _video_frame_rate_label->Show (full);
178 _video_frame_rate->Show (full);
179 _set_video_frame_rate->Show (full);
183 _grid->Add (_move_to_start_of_reel, wxGBPosition(r, 1));
186 add_label_to_sizer (_grid, _full_length_label, true, wxGBPosition(r, 0));
187 _grid->Add (_full_length, wxGBPosition(r, 1));
191 add_label_to_sizer (_grid, _trim_start_label, true, wxGBPosition(r, 0));
192 _grid->Add (_trim_start, wxGBPosition(r, 1));
195 _grid->Add (_trim_start_to_playhead, wxGBPosition(r, 1));
198 add_label_to_sizer (_grid, _trim_end_label, true, wxGBPosition(r, 0));
199 _grid->Add (_trim_end, wxGBPosition(r, 1));
202 _grid->Add (_trim_end_to_playhead, wxGBPosition(r, 1));
206 add_label_to_sizer (_grid, _play_length_label, true, wxGBPosition(r, 0));
207 _grid->Add (_play_length, wxGBPosition(r, 1));
211 add_label_to_sizer (_grid, _video_frame_rate_label, true, wxGBPosition(r, 0));
212 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
213 s->Add (_video_frame_rate, 1, wxEXPAND);
214 s->Add (_set_video_frame_rate, 0, wxLEFT | wxRIGHT, 8);
215 _grid->Add (s, wxGBPosition(r, 1), wxGBSpan(1, 2));
219 _grid->Add (_tip, wxGBPosition(r, 1), wxGBSpan(1, 2));
222 /* Completely speculative fix for #891 */
227 TimingPanel::update_full_length ()
230 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
231 check.insert (i->full_length(_parent->film()));
234 if (check.size() == 1) {
235 _full_length->set (_parent->selected().front()->full_length(_parent->film()), _parent->film()->video_frame_rate());
237 _full_length->clear ();
242 TimingPanel::update_play_length ()
245 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
246 check.insert (i->length_after_trim(_parent->film()));
249 if (check.size() == 1) {
250 _play_length->set (_parent->selected().front()->length_after_trim(_parent->film()), _parent->film()->video_frame_rate());
252 _play_length->clear ();
257 TimingPanel::film_content_changed (int property)
259 if (_film_content_changed_suspender.check(property)) {
263 int const film_video_frame_rate = _parent->film()->video_frame_rate ();
265 /* Here we check to see if we have exactly one different value of various
266 properties, and fill the controls with that value if so.
269 if (property == ContentProperty::POSITION) {
272 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
273 check.insert (i->position ());
276 if (check.size() == 1) {
277 _position->set (_parent->selected().front()->position(), film_video_frame_rate);
283 property == ContentProperty::LENGTH ||
284 property == ContentProperty::VIDEO_FRAME_RATE ||
285 property == VideoContentProperty::FRAME_TYPE
288 update_full_length ();
290 } else if (property == ContentProperty::TRIM_START) {
292 set<ContentTime> check;
293 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
294 check.insert (i->trim_start ());
297 if (check.size() == 1) {
298 _trim_start->set (_parent->selected().front()->trim_start (), film_video_frame_rate);
300 _trim_start->clear ();
303 } else if (property == ContentProperty::TRIM_END) {
305 set<ContentTime> check;
306 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
307 check.insert (i->trim_end ());
310 if (check.size() == 1) {
311 _trim_end->set (_parent->selected().front()->trim_end (), film_video_frame_rate);
318 property == ContentProperty::LENGTH ||
319 property == ContentProperty::TRIM_START ||
320 property == ContentProperty::TRIM_END ||
321 property == ContentProperty::VIDEO_FRAME_RATE ||
322 property == VideoContentProperty::FRAME_TYPE
325 update_play_length ();
328 if (property == ContentProperty::VIDEO_FRAME_RATE) {
329 set<double> check_vc;
330 shared_ptr<const Content> content;
333 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
334 if (i->video && i->video_frame_rate()) {
335 check_vc.insert (i->video_frame_rate().get());
338 if (i->audio && i->video_frame_rate()) {
342 if (!i->text.empty() && i->video_frame_rate()) {
349 bool const single_frame_image_content = content && dynamic_pointer_cast<const ImageContent> (content) && content->number_of_paths() == 1;
351 if ((check_vc.size() == 1 || count_ac == 1 || count_sc == 1) && !single_frame_image_content) {
352 checked_set (_video_frame_rate, locale_convert<string> (content->video_frame_rate().get(), 5));
353 _video_frame_rate->Enable (true);
355 checked_set (_video_frame_rate, wxT (""));
356 _video_frame_rate->Enable (false);
360 bool have_still = false;
361 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
362 shared_ptr<const ImageContent> ic = dynamic_pointer_cast<const ImageContent> (i);
363 if (ic && ic->still ()) {
368 _full_length->set_editable (have_still);
369 _play_length->set_editable (!have_still);
370 _set_video_frame_rate->Enable (false);
371 setup_sensitivity ();
375 TimingPanel::position_changed ()
377 DCPTime const pos = _position->get (_parent->film()->video_frame_rate ());
378 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
379 i->set_position (_parent->film(), pos);
384 TimingPanel::full_length_changed ()
386 int const vfr = _parent->film()->video_frame_rate ();
387 Frame const len = _full_length->get (vfr).frames_round (vfr);
388 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
389 shared_ptr<ImageContent> ic = dynamic_pointer_cast<ImageContent> (i);
390 if (ic && ic->still ()) {
391 ic->video->set_length (len);
397 TimingPanel::trim_start_changed ()
399 shared_ptr<FilmViewer> fv = _viewer.lock ();
404 DCPTime const ph = fv->position ();
406 fv->set_coalesce_player_changes (true);
408 shared_ptr<Content> ref;
409 optional<FrameRateChange> ref_frc;
410 optional<DCPTime> ref_ph;
412 Suspender::Block bl = _film_content_changed_suspender.block ();
413 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
414 if (i->position() <= ph && ph < i->end(_parent->film())) {
415 /* The playhead is in i. Use it as a reference to work out
416 where to put the playhead post-trim; we're trying to keep the playhead
417 at the same frame of content that we're looking at pre-trim.
420 ref_frc = _parent->film()->active_frame_rate_change (i->position ());
421 ref_ph = ph - i->position() + DCPTime (i->trim_start(), ref_frc.get());
424 ContentTime const trim = _trim_start->get (i->video_frame_rate().get_value_or(_parent->film()->video_frame_rate()));
425 i->set_trim_start (trim);
429 fv->seek (max(DCPTime(), ref_ph.get() + ref->position() - DCPTime(ref->trim_start(), ref_frc.get())), true);
432 fv->set_coalesce_player_changes (false);
436 TimingPanel::trim_end_changed ()
438 shared_ptr<FilmViewer> fv = _viewer.lock ();
443 fv->set_coalesce_player_changes (true);
445 Suspender::Block bl = _film_content_changed_suspender.block ();
446 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
447 ContentTime const trim = _trim_end->get (i->video_frame_rate().get_value_or(_parent->film()->video_frame_rate()));
448 i->set_trim_end (trim);
451 /* XXX: maybe playhead-off-the-end-of-the-film should be handled elsewhere */
452 if (fv->position() >= _parent->film()->length()) {
453 fv->seek (_parent->film()->length() - DCPTime::from_frames(1, _parent->film()->video_frame_rate()), true);
456 fv->set_coalesce_player_changes (false);
460 TimingPanel::play_length_changed ()
462 DCPTime const play_length = _play_length->get (_parent->film()->video_frame_rate());
463 Suspender::Block bl = _film_content_changed_suspender.block ();
464 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
465 FrameRateChange const frc = _parent->film()->active_frame_rate_change (i->position ());
467 ContentTime (max(DCPTime(), i->full_length(_parent->film()) - play_length), frc) - i->trim_start()
473 TimingPanel::video_frame_rate_changed ()
476 if (_video_frame_rate->GetValue() == wxT("")) {
477 /* No frame rate has been entered; if the user clicks "set" now it would unset the video
478 frame rate in the selected content. This can't be allowed for some content types.
480 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected()) {
482 dynamic_pointer_cast<DCPContent>(i) ||
483 dynamic_pointer_cast<FFmpegContent>(i)
490 _set_video_frame_rate->Enable (enable);
494 TimingPanel::set_video_frame_rate ()
497 if (_video_frame_rate->GetValue() != wxT("")) {
498 fr = locale_convert<double> (wx_to_std (_video_frame_rate->GetValue ()));
500 Suspender::Block bl = _film_content_changed_suspender.block ();
501 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
503 i->set_video_frame_rate (*fr);
505 i->unset_video_frame_rate ();
509 _set_video_frame_rate->Enable (false);
513 TimingPanel::content_selection_changed ()
515 setup_sensitivity ();
517 film_content_changed (ContentProperty::POSITION);
518 film_content_changed (ContentProperty::LENGTH);
519 film_content_changed (ContentProperty::TRIM_START);
520 film_content_changed (ContentProperty::TRIM_END);
521 film_content_changed (ContentProperty::VIDEO_FRAME_RATE);
525 TimingPanel::film_changed (Film::Property p)
527 if (p == Film::VIDEO_FRAME_RATE) {
528 update_full_length ();
529 update_play_length ();
534 TimingPanel::trim_start_to_playhead_clicked ()
536 shared_ptr<FilmViewer> fv = _viewer.lock ();
541 shared_ptr<const Film> film = _parent->film ();
542 DCPTime const ph = fv->position().floor (film->video_frame_rate ());
543 optional<DCPTime> new_ph;
545 fv->set_coalesce_player_changes (true);
547 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
548 if (i->position() < ph && ph < i->end(film)) {
549 FrameRateChange const frc = film->active_frame_rate_change (i->position());
550 i->set_trim_start (i->trim_start() + ContentTime (ph - i->position(), frc));
551 new_ph = i->position ();
556 fv->seek (new_ph.get(), true);
559 fv->set_coalesce_player_changes (false);
563 TimingPanel::trim_end_to_playhead_clicked ()
565 shared_ptr<FilmViewer> fv = _viewer.lock ();
570 shared_ptr<const Film> film = _parent->film ();
571 DCPTime const ph = fv->position().floor (film->video_frame_rate ());
572 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
573 if (i->position() < ph && ph < i->end(film)) {
574 FrameRateChange const frc = film->active_frame_rate_change (i->position ());
575 i->set_trim_end (ContentTime(i->position() + i->full_length(film) - ph - DCPTime::from_frames(1, frc.dcp), frc) - i->trim_start());
581 TimingPanel::setup_sensitivity ()
583 bool const e = !_parent->selected().empty ();
585 _position->Enable (e);
586 _move_to_start_of_reel->Enable (e);
587 _full_length->Enable (e);
588 _trim_start->Enable (e);
589 _trim_end->Enable (e);
590 _play_length->Enable (e);
591 _video_frame_rate->Enable (e);
593 shared_ptr<FilmViewer> fv = _viewer.lock ();
594 DCPOMATIC_ASSERT (fv);
595 DCPTime const ph = fv->position ();
596 bool any_over_ph = false;
597 BOOST_FOREACH (shared_ptr<const Content> i, _parent->selected ()) {
598 if (i->position() <= ph && ph < i->end(_parent->film())) {
603 _trim_start_to_playhead->Enable (any_over_ph);
604 _trim_end_to_playhead->Enable (any_over_ph);
608 TimingPanel::move_to_start_of_reel_clicked ()
610 /* Find common position of all selected content, if it exists */
612 optional<DCPTime> position;
613 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected ()) {
615 position = i->position();
617 if (position.get() != i->position()) {
624 MoveToDialog* d = new MoveToDialog (this, position, _parent->film());
626 if (d->ShowModal() == wxID_OK) {
627 BOOST_FOREACH (shared_ptr<Content> i, _parent->selected()) {
628 i->set_position (_parent->film(), d->position());