2 Copyright (C) 2010 Paul Davis
3 Author: Robin Gareus <robin@gareus.org>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include <sigc++/bind.h>
22 #include "ardour/tempo.h"
24 #include "pbd/file_utils.h"
25 #include "ardour/session_directory.h"
27 #include "ardour_ui.h"
28 #include "public_editor.h"
29 #include "gui_thread.h"
31 #include "utils_videotl.h"
32 #include "rgb_macros.h"
33 #include "video_timeline.h"
35 #include <gtkmm2ext/utils.h>
37 #include <curl/curl.h>
42 using namespace ARDOUR;
44 using namespace Timecode;
46 VideoTimeLine::VideoTimeLine (PublicEditor *ed, ArdourCanvas::Group *vbg, int initial_height)
49 , bar_height(initial_height)
51 video_start_offset = 0L;
55 auto_set_session_fps = false;
56 video_offset_lock = false;
57 video_aspect_ratio = 4.0/3.0;
58 Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoTimeLine::parameter_changed, this, _1), gui_context());
59 video_server_url = video_get_server_url(Config);
60 server_docroot = video_get_docroot(Config);
63 video_file_fps = 25.0;
66 reopen_vmonitor=false;
69 VtlUpdate.connect (*this, invalidator (*this), boost::bind (&PublicEditor::queue_visual_videotimeline_update, editor), gui_context());
70 GuiUpdate.connect (*this, invalidator (*this), boost::bind (&VideoTimeLine::gui_update, this, _1), gui_context());
73 VideoTimeLine::~VideoTimeLine ()
78 /* close and save settings */
80 VideoTimeLine::save_session ()
86 LocaleGuard lg (X_("POSIX"));
88 XMLNode* node = new XMLNode(X_("Videomonitor"));
90 node->add_property (X_("active"), (vmonitor && vmonitor->is_started())?"yes":"no");
91 _session->add_extra_xml (*node);
94 if (vmonitor->is_started()) {
95 vmonitor->query_full_state(true);
97 vmonitor->save_session();
101 node = _session->extra_xml (X_("Videotimeline"));
103 node->add_property (X_("id"), id().to_s());
104 node->add_property (X_("Height"), editor->get_videotl_bar_height());
105 node->add_property (X_("VideoOffsetLock"), video_offset_lock?X_("1"):X_("0"));
106 node->add_property (X_("VideoOffset"), video_offset);
107 node->add_property (X_("AutoFPS"), auto_set_session_fps?X_("1"):X_("0"));
110 /* close and save settings */
112 VideoTimeLine::close_session ()
114 if (video_duration == 0) {
117 sessionsave.disconnect();
118 close_video_monitor();
123 GuiUpdate("set-xjadeo-sensitive-off");
127 VideoTimeLine::sync_session_state ()
129 if (!_session || !vmonitor || !vmonitor->is_started()) {
135 /** load settings from session */
137 VideoTimeLine::set_session (ARDOUR::Session *s)
139 SessionHandlePtr::set_session (s);
140 if (!_session) { return ; }
142 _session->SaveSession.connect_same_thread (sessionsave, boost::bind (&VideoTimeLine::save_session, this));
143 LocaleGuard lg (X_("POSIX"));
145 XMLNode* node = _session->extra_xml (X_("Videotimeline"));
147 if (!node || !node->property (X_("Filename"))) {
152 ARDOUR_UI::instance()->start_video_server((Gtk::Window*)0, false);
156 const XMLProperty* proph = node->property (X_("Height"));
158 editor->set_video_timeline_height(atoi(proph->value().c_str()));
160 #if 0 /* TODO THINK: set FPS first time only ?! */
161 const XMLProperty* propasfps = node->property (X_("AutoFPS"));
163 auto_set_session_fps = atoi(propasfps->value().c_str())?true:false;
167 const XMLProperty* propoffset = node->property (X_("VideoOffset"));
169 video_offset = atoll(propoffset->value().c_str());
170 video_offset_p = video_offset;
173 const XMLProperty* proplock = node->property (X_("VideoOffsetLock"));
175 video_offset_lock = atoi(proplock->value().c_str())?true:false;
178 const XMLProperty* localfile = node->property (X_("LocalFile"));
180 local_file = atoi(localfile->value().c_str())?true:false;
183 const XMLProperty* propf = node->property (X_("Filename"));
184 video_file_info(propf->value(), local_file);
187 node = _session->extra_xml (X_("Videomonitor"));
189 const XMLProperty* prop = node->property (X_("active"));
190 if (prop && prop->value() == "yes" && found_xjadeo() && !video_filename.empty() && local_file) {
191 open_video_monitor();
195 _session->register_with_memento_command_factory(id(), this);
196 _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoTimeLine::parameter_changed, this, _1), gui_context());
200 VideoTimeLine::set_offset_locked (bool v) {
201 if (_session && v != video_offset_lock) {
202 _session->set_dirty ();
204 video_offset_lock = v;
208 VideoTimeLine::toggle_offset_locked () {
209 video_offset_lock = !video_offset_lock;
211 _session->set_dirty ();
216 VideoTimeLine::save_undo ()
218 if (_session && video_offset_p != video_offset) {
219 _session->set_dirty ();
221 video_offset_p = video_offset;
225 VideoTimeLine::set_state (const XMLNode& node, int /*version*/)
227 LocaleGuard lg (X_("POSIX"));
228 const XMLProperty* propoffset = node.property (X_("VideoOffset"));
230 video_offset = atoll(propoffset->value().c_str());
232 ARDOUR_UI::instance()->flush_videotimeline_cache(true);
237 VideoTimeLine::get_state ()
239 XMLNode* node = new XMLNode (X_("Videotimeline"));
240 LocaleGuard lg (X_("POSIX"));
241 node->add_property (X_("VideoOffset"), video_offset_p);
246 VideoTimeLine::remove_frames ()
248 for (VideoFrames::iterator i = video_frames.begin(); i != video_frames.end(); ++i ) {
249 VideoImageFrame *frame = (*i);
253 video_frames.clear();
257 VideoTimeLine::get_video_frame (framepos_t vfn, int cut, int rightend)
260 for (VideoFrames::iterator i = video_frames.begin(); i != video_frames.end(); ++i) {
261 VideoImageFrame *frame = (*i);
262 if (abs(frame->get_video_frame_number()-vfn)<=cut
263 && frame->get_rightend() == rightend) { return frame; }
269 VideoTimeLine::get_apv()
271 // XXX: dup code - TODO use this fn in update_video_timeline()
272 float apv = -1; /* audio samples per video frame; */
273 if (!_session) return apv;
275 if (_session->config.get_use_video_file_fps()) {
276 if (video_file_fps == 0 ) return apv;
278 if (_session->timecode_frames_per_second() == 0 ) return apv;
281 if (_session->config.get_videotimeline_pullup()) {
282 apv = _session->frame_rate();
284 apv = _session->nominal_frame_rate();
286 if (_session->config.get_use_video_file_fps()) {
287 apv /= video_file_fps;
289 apv /= _session->timecode_frames_per_second();
295 VideoTimeLine::update_video_timeline()
297 if (!_session) return;
299 if (_session->config.get_use_video_file_fps()) {
300 if (video_file_fps == 0 ) return;
302 if (_session->timecode_frames_per_second() == 0 ) return;
305 const double samples_per_pixel = editor->get_current_zoom();
306 const framepos_t leftmost_sample = editor->leftmost_sample();
309 * 1) calculate how many frames there should be in current zoom (plus 1 page on each side)
310 * 2) calculate first frame and distance between video-frames (according to zoom)
311 * 3) destroy/add frames
312 * 4) reposition existing frames
313 * 5) assign framenumber to frames -> request/decode video.
316 /* video-file and session properties */
317 double display_vframe_width; /* unit: pixels ; width of one thumbnail in the timeline */
318 float apv; /* audio samples per video frame; */
319 framepos_t leftmost_video_frame; /* unit: video-frame number ; temporary var -> vtl_start */
321 /* variables needed to render videotimeline -- what needs to computed first */
322 framepos_t vtl_start; /* unit: audio-samples ; first displayed video-frame */
323 framepos_t vtl_dist; /* unit: audio-samples ; distance between displayed video-frames */
324 unsigned int visible_video_frames; /* number of frames that fit on current canvas */
326 if (_session->config.get_videotimeline_pullup()) {
327 apv = _session->frame_rate();
329 apv = _session->nominal_frame_rate();
331 if (_session->config.get_use_video_file_fps()) {
332 apv /= video_file_fps;
334 apv /= _session->timecode_frames_per_second();
337 display_vframe_width = bar_height * video_aspect_ratio;
339 if (apv > samples_per_pixel * display_vframe_width) {
340 /* high-zoom: need space between successive video-frames */
341 vtl_dist = rint(apv);
343 /* continous timeline: skip video-frames */
344 vtl_dist = ceil(display_vframe_width * samples_per_pixel / apv) * apv;
347 assert (vtl_dist > 0);
350 #define GOFFSET (video_offset)
352 leftmost_video_frame = floor (floor((leftmost_sample - video_start_offset - GOFFSET ) / vtl_dist) * vtl_dist / apv);
354 vtl_start = rint (GOFFSET + video_start_offset + leftmost_video_frame * apv);
355 visible_video_frames = 2 + ceil(editor->current_page_samples() / vtl_dist); /* +2 left+right partial frames */
357 /* expand timeline (cache next/prev page images) */
358 vtl_start -= visible_video_frames * vtl_dist;
359 visible_video_frames *=3;
361 if (vtl_start < GOFFSET ) {
362 visible_video_frames += ceil(vtl_start/vtl_dist);
366 /* apply video-file constraints */
367 if (vtl_start > video_start_offset + video_duration + GOFFSET ) {
368 visible_video_frames = 0;
370 /* TODO optimize: compute rather than iterate */
371 while (visible_video_frames > 0 && vtl_start + (visible_video_frames-1) * vtl_dist >= video_start_offset + video_duration + GOFFSET) {
372 --visible_video_frames;
380 while (video_frames.size() < visible_video_frames) {
381 VideoImageFrame *frame;
382 frame = new VideoImageFrame(*editor, *videotl_group, display_vframe_width, bar_height, video_server_url, translated_filename());
383 frame->ImgChanged.connect (*this, invalidator (*this), boost::bind (&PublicEditor::queue_visual_videotimeline_update, editor), gui_context());
384 video_frames.push_back(frame);
387 VideoFrames outdated_video_frames;
388 std::list<int> remaining;
390 outdated_video_frames = video_frames;
393 /* when zoomed out, ignore shifts by +-1 frame
394 * which can occur due to rounding errors when
395 * scrolling to a new leftmost-audio frame.
398 if (vtl_dist/apv < 3.0) cut =0;
403 for (unsigned int vfcount=0; vfcount < visible_video_frames; ++vfcount){
404 framepos_t vfpos = vtl_start + vfcount * vtl_dist; /* unit: audio-samples */
405 framepos_t vframeno = rint ( (vfpos - GOFFSET) / apv); /* unit: video-frames */
406 vfpos = (vframeno * apv ) + GOFFSET; /* audio-frame corresponding to /rounded/ video-frame */
408 int rightend = -1; /* unit: pixels */
409 if (vfpos + vtl_dist > video_start_offset + video_duration + GOFFSET) {
410 rightend = display_vframe_width * (video_start_offset + video_duration + GOFFSET - vfpos) / vtl_dist;
411 //printf("lf(e): %lu\n", vframeno); // XXX
413 VideoImageFrame * frame = get_video_frame(vframeno, cut, rightend);
415 frame->set_position(vfpos);
416 outdated_video_frames.remove(frame);
418 remaining.push_back(vfcount);
422 for (VideoFrames::iterator i = outdated_video_frames.begin(); i != outdated_video_frames.end(); ++i ) {
423 VideoImageFrame *frame = (*i);
424 if (remaining.empty()) {
425 frame->set_position(-2 * vtl_dist + leftmost_sample); /* move off screen */
427 int vfcount=remaining.front();
428 remaining.pop_front();
429 framepos_t vfpos = vtl_start + vfcount * vtl_dist; /* unit: audio-samples */
430 framepos_t vframeno = rint ((vfpos - GOFFSET) / apv); /* unit: video-frames */
431 int rightend = -1; /* unit: pixels */
432 if (vfpos + vtl_dist > video_start_offset + video_duration + GOFFSET) {
433 rightend = display_vframe_width * (video_start_offset + video_duration + GOFFSET - vfpos) / vtl_dist;
435 frame->set_position(vfpos);
436 frame->set_videoframe(vframeno, rightend);
442 VideoTimeLine::translated_filename ()
445 return video_filename;
447 return video_map_path(server_docroot, video_filename);
452 VideoTimeLine::video_file_info (std::string filename, bool local)
456 if (filename.at(0) == G_DIR_SEPARATOR || !local_file) {
457 video_filename = filename;
459 video_filename = Glib::build_filename (_session->session_directory().video_path(), filename);
462 long long int _duration;
463 double _start_offset;
465 if (!video_query_info(
466 video_server_url, translated_filename(),
467 video_file_fps, _duration, _start_offset, video_aspect_ratio)) {
468 warning << _("Parsing video file info failed. Is the Video Server running? Is the file readable by the Video Server? Does the docroot match? Is it a video file?") << endmsg;
471 video_duration = _duration * _session->nominal_frame_rate() / video_file_fps;
472 video_start_offset = _start_offset * _session->nominal_frame_rate();
474 if (auto_set_session_fps && video_file_fps != _session->timecode_frames_per_second()) {
475 switch ((int)floorf(video_file_fps*1000.0)) {
477 _session->config.set_timecode_format(timecode_23976);
480 _session->config.set_timecode_format(timecode_24);
484 _session->config.set_timecode_format(timecode_24976);
487 _session->config.set_timecode_format(timecode_25);
490 _session->config.set_timecode_format(timecode_2997drop);
493 _session->config.set_timecode_format(timecode_30);
496 _session->config.set_timecode_format(timecode_5994);
499 _session->config.set_timecode_format(timecode_60);
502 warning << _("Failed to set session-fps: ") << video_file_fps << _(" does not have a corresponding option setting in Ardour.") << endmsg; /* TODO: gettext arg */
505 _session->config.set_video_pullup(0); /* TODO only set if set_timecode_format() was successful ?!*/
507 if (video_file_fps != _session->timecode_frames_per_second()) {
508 warning << _("Video file's framerate is not equal to Ardour session timecode's framerate: ")
509 << video_file_fps << _(" vs ") << _session->timecode_frames_per_second() << endmsg;
511 flush_local_cache ();
513 if (found_xjadeo() && local_file) {
514 GuiUpdate("set-xjadeo-sensitive-on");
515 if (vmonitor && vmonitor->is_started()) {
517 /* xjadeo <= 0.6.4 has a bug where changing the video-file may segfauls
518 * if the geometry changes to a different line-size alignment
520 reopen_vmonitor = true;
523 vmonitor->set_fps(video_file_fps);
524 vmonitor->open(video_filename);
527 } else if (!local_file) {
528 #if 1 /* temp debug/devel message */
529 // TODO - call xjremote remotely.
530 printf("the given video file can not be accessed on localhost, video monitoring is not currently supported for this case\n");
531 GuiUpdate("set-xjadeo-sensitive-off");
539 VideoTimeLine::check_server ()
543 snprintf(url, sizeof(url), "%s%sstatus"
544 , video_server_url.c_str()
545 , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
547 char *res=curl_http_get(url, NULL);
549 if (strstr(res, "status: ok, online.")) { ok = true; }
556 VideoTimeLine::gui_update(std::string const & t) {
557 /* this is to be called via GuiUpdate() only. */
558 ENSURE_GUI_THREAD (*this, &VideoTimeLine::queue_visual_videotimeline_update)
559 if (t == "videotimeline-update") {
560 editor->queue_visual_videotimeline_update();
561 } else if (t == "set-xjadeo-active-off") {
562 editor->toggle_xjadeo_proc(0);
563 } else if (t == "set-xjadeo-active-on") {
564 editor->toggle_xjadeo_proc(1);
565 } else if (t == "set-xjadeo-sensitive-on") {
566 editor->set_xjadeo_sensitive(true);
567 } else if (t == "set-xjadeo-sensitive-off") {
568 editor->toggle_xjadeo_proc(0);
569 //close_video_monitor();
570 editor->set_xjadeo_sensitive(false);
571 } else if (t == "xjadeo-window-ontop-on") {
572 editor->toggle_xjadeo_viewoption(1, 1);
573 } else if (t == "xjadeo-window-ontop-off") {
574 editor->toggle_xjadeo_viewoption(1, 0);
575 } else if (t == "xjadeo-window-osd-timecode-on") {
576 editor->toggle_xjadeo_viewoption(2, 1);
577 } else if (t == "xjadeo-window-osd-timecode-off") {
578 editor->toggle_xjadeo_viewoption(2, 0);
579 } else if (t == "xjadeo-window-osd-frame-on") {
580 editor->toggle_xjadeo_viewoption(3, 1);
581 } else if (t == "xjadeo-window-osd-frame-off") {
582 editor->toggle_xjadeo_viewoption(3, 0);
583 } else if (t == "xjadeo-window-osd-box-on") {
584 editor->toggle_xjadeo_viewoption(4, 1);
585 } else if (t == "xjadeo-window-osd-box-off") {
586 editor->toggle_xjadeo_viewoption(4, 0);
587 } else if (t == "xjadeo-window-fullscreen-on") {
588 editor->toggle_xjadeo_viewoption(5, 1);
589 } else if (t == "xjadeo-window-fullscreen-off") {
590 editor->toggle_xjadeo_viewoption(5, 0);
591 } else if (t == "xjadeo-window-letterbox-on") {
592 editor->toggle_xjadeo_viewoption(6, 1);
593 } else if (t == "xjadeo-window-letterbox-off") {
594 editor->toggle_xjadeo_viewoption(6, 0);
599 VideoTimeLine::set_height (int height) {
600 if (_session && bar_height != height) {
601 _session->set_dirty ();
608 VideoTimeLine::vmon_update () {
609 if (vmonitor && vmonitor->is_started()) {
610 vmonitor->set_offset( GOFFSET); // TODO proper re-init xjadeo w/o restart not just offset.
615 VideoTimeLine::flush_local_cache () {
621 VideoTimeLine::flush_cache () {
624 snprintf(url, sizeof(url), "%s%sadmin/flush_cache"
625 , video_server_url.c_str()
626 , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
628 char *res=curl_http_get(url, NULL);
632 if (vmonitor && vmonitor->is_started()) {
633 reopen_vmonitor=true;
636 video_file_info(video_filename, local_file);
641 VideoTimeLine::parameter_changed (std::string const & p)
643 if (p == "video-server-url") {
644 set_video_server_url (video_get_server_url(Config));
645 } else if (p == "video-server-docroot") {
646 set_video_server_docroot (video_get_docroot(Config));
647 } else if (p == "video-advanced-setup") {
648 set_video_server_url (video_get_server_url(Config));
649 set_video_server_docroot (video_get_docroot(Config));
651 if (p == "use-video-file-fps" || p == "videotimeline-pullup" ) { /* session->config parameter */
657 VideoTimeLine::set_video_server_url(std::string vsu) {
658 flush_local_cache ();
659 video_server_url = vsu;
664 VideoTimeLine::set_video_server_docroot(std::string vsr) {
665 flush_local_cache ();
666 server_docroot = vsr;
670 /* video-monitor for this timeline */
672 VideoTimeLine::find_xjadeo () {
673 std::string xjadeo_file_path;
674 if (getenv("XJREMOTE")) {
675 _xjadeo_bin = strdup(getenv("XJREMOTE")); // XXX TODO: free it?!
676 } else if (find_file_in_search_path (SearchPath(Glib::getenv("PATH")), X_("xjremote"), xjadeo_file_path)) {
677 _xjadeo_bin = xjadeo_file_path;
679 else if (Glib::file_test(X_("/Applications/Jadeo.app/Contents/MacOS/xjremote"), Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_EXECUTABLE)) {
680 _xjadeo_bin = X_("/Applications/Jadeo.app/Contents/MacOS/xjremote");
682 /* TODO: win32: allow to configure PATH to xjremote */
683 else if (Glib::file_test(X_("C:\\Program Files\\xjadeo\\xjremote.exe"), Glib::FILE_TEST_EXISTS)) {
684 _xjadeo_bin = X_("C:\\Program Files\\xjadeo\\xjremote.exe");
686 else if (Glib::file_test(X_("C:\\Program Files\\xjadeo\\xjremote.bat"), Glib::FILE_TEST_EXISTS)) {
687 _xjadeo_bin = X_("C:\\Program Files\\xjadeo\\xjremote.bat");
690 _xjadeo_bin = X_("");
691 warning << _("Video-monitor 'xjadeo' was not found. Please install http://xjadeo.sf.net/ "
692 "(a custom path to xjadeo can be specified by setting the XJREMOTE environment variable. "
693 "It should point to an application compatible with xjadeo's remote-control interface 'xjremote').")
699 VideoTimeLine::open_video_monitor() {
700 if (!found_xjadeo()) return;
702 vmonitor = new VideoMonitor(editor, _xjadeo_bin);
703 vmonitor->set_session(_session);
704 vmonitor->Terminated.connect (sigc::mem_fun (*this, &VideoTimeLine::terminated_video_monitor));
705 vmonitor->UiState.connect (*this, invalidator (*this), boost::bind (&VideoTimeLine::gui_update, this, _1), gui_context());
706 } else if (vmonitor->is_started()) {
710 int xj_settings_mask = vmonitor->restore_settings_mask();
712 /* load mask from Session */
713 XMLNode* node = _session->extra_xml (X_("XJRestoreSettings"));
715 const XMLProperty* prop = node->property (X_("mask"));
717 xj_settings_mask = atoi(prop->value().c_str());
722 vmonitor->restore_settings_mask(xj_settings_mask);
724 if (!vmonitor->start()) {
725 warning << "launching xjadeo failed.." << endmsg;
726 close_video_monitor();
728 GuiUpdate("set-xjadeo-active-on");
729 vmonitor->set_fps(video_file_fps);
730 vmonitor->open(video_filename);
733 XMLNode* node = _session->extra_xml (X_("Videomonitor"));
735 const XMLProperty* prop = node->property (X_("active"));
736 if (prop && prop->value() != "yes") _session->set_dirty ();
738 _session->set_dirty ();
746 VideoTimeLine::close_video_monitor() {
747 if (vmonitor && vmonitor->is_started()) {
753 VideoTimeLine::control_video_monitor(int what, int param) {
754 if (!vmonitor || !vmonitor->is_started()) {
757 vmonitor->send_cmd(what, param);
762 VideoTimeLine::terminated_video_monitor () {
766 GuiUpdate("set-xjadeo-active-off");
768 if (reopen_vmonitor) {
769 reopen_vmonitor=false;
770 open_video_monitor();
773 _session->set_dirty ();
780 VideoTimeLine::clear_video_monitor_session_state ()
783 vmonitor->clear_session_state();
785 if (!_session) { return; }
786 XMLNode* node = new XMLNode(X_("XJSettings"));
787 _session->add_extra_xml (*node);
788 _session->set_dirty ();
794 VideoTimeLine::manual_seek_video_monitor (framepos_t pos)
796 if (!vmonitor) { return; }
797 if (!vmonitor->is_started()) { return; }
798 if (!vmonitor->synced_by_manual_seeks()) { return; }
799 vmonitor->manual_seek(pos, false, GOFFSET); // XXX -> set offset in xjadeo