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.
20 #ifdef WITH_VIDEOTIMELINE
23 #include <sigc++/bind.h>
24 #include "ardour/tempo.h"
26 #include "pbd/file_utils.h"
27 #include "ardour/session_directory.h"
29 #include "ardour_ui.h"
30 #include "public_editor.h"
31 #include "gui_thread.h"
33 #include "canvas_impl.h"
34 #include "simpleline.h"
35 #include "utils_videotl.h"
36 #include "rgb_macros.h"
37 #include "video_timeline.h"
39 #include <gtkmm2ext/utils.h>
41 #include <curl/curl.h>
46 using namespace ARDOUR;
48 using namespace Timecode;
50 VideoTimeLine::VideoTimeLine (PublicEditor *ed, ArdourCanvas::Group *vbg, int initial_height)
52 , videotl_bar_group(vbg)
53 , bar_height(initial_height)
55 video_start_offset = 0L;
59 auto_set_session_fps = false;
60 video_offset_lock = false;
61 video_aspect_ratio = 4.0/3.0;
62 Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoTimeLine::parameter_changed, this, _1), gui_context());
63 video_server_url = video_get_server_url(Config);
64 server_docroot = video_get_docroot(Config);
67 video_file_fps = 25.0;
70 reopen_vmonitor=false;
73 VtlUpdate.connect (*this, invalidator (*this), boost::bind (&PublicEditor::queue_visual_videotimeline_update, editor), gui_context());
74 GuiUpdate.connect (*this, invalidator (*this), boost::bind (&VideoTimeLine::gui_update, this, _1), gui_context());
77 VideoTimeLine::~VideoTimeLine ()
82 /* close and save settings */
84 VideoTimeLine::save_session ()
90 LocaleGuard lg (X_("POSIX"));
92 bool is_dirty = false;
94 XMLNode* prev = _session->extra_xml (X_("Videomonitor"));
96 /* remember if vmonitor was open.. */
97 XMLNode* node = new XMLNode(X_("Videomonitor"));
99 node->add_property (X_("active"), (vmonitor && vmonitor->is_started())?"yes":"no");
100 if (!prev || !(prev->property (X_("active")) && prev->property (X_("active"))->value() == node->property(X_("active"))->value()) ){
101 _session->add_extra_xml (*node);
102 is_dirty=true; // TODO not if !prev && value==default
106 node = _session->extra_xml (X_("Videotimeline"));
109 if (!(node->property(X_("id")) && node->property(X_("id"))->value() == id().to_s())) {
110 node->add_property (X_("id"), id().to_s());
115 /* remember timeline height.. */
117 int h = editor->get_videotl_bar_height();
118 if (!(node->property(X_("Height")) && atoi(node->property(X_("Height"))->value().c_str())==h)) {
119 node->add_property (X_("Height"), h);
124 /* save video-offset-lock */
126 if (!(node->property(X_("VideoOffsetLock")) && atoi(node->property(X_("VideoOffsetLock"))->value().c_str())==video_offset_lock)) {
127 node->add_property (X_("VideoOffsetLock"), video_offset_lock?X_("1"):X_("0"));
131 /* save video-offset */
133 if (!(node->property(X_("VideoOffset")) && atoll(node->property(X_("VideoOffset"))->value().c_str())==video_offset)) {
134 node->add_property (X_("VideoOffset"), video_offset);
139 /* save 'auto_set_session_fps' */
141 if (!(node->property(X_("AutoFPS")) && atoi(node->property(X_("AutoFPS"))->value().c_str())==auto_set_session_fps)) {
142 node->add_property (X_("AutoFPS"), auto_set_session_fps?X_("1"):X_("0"));
147 _session->set_dirty ();
151 /* close and save settings */
153 VideoTimeLine::close_session ()
155 if (video_duration == 0) {
158 close_video_monitor();
164 GuiUpdate("set-xjadeo-sensitive-off");
167 /** load settings from session */
169 VideoTimeLine::set_session (ARDOUR::Session *s)
171 SessionHandlePtr::set_session (s);
172 if (!_session) { return ; }
174 LocaleGuard lg (X_("POSIX"));
176 XMLNode* node = _session->extra_xml (X_("Videotimeline"));
178 if (!node || !node->property (X_("Filename"))) {
183 ARDOUR_UI::instance()->start_video_server((Gtk::Window*)0, false);
187 const XMLProperty* proph = node->property (X_("Height"));
189 editor->set_video_timeline_height(atoi(proph->value().c_str()));
191 #if 0 /* TODO THINK: set FPS first time only ?! */
192 const XMLProperty* propasfps = node->property (X_("AutoFPS"));
194 auto_set_session_fps = atoi(propasfps->value().c_str())?true:false;
198 const XMLProperty* propoffset = node->property (X_("VideoOffset"));
200 video_offset = atoll(propoffset->value().c_str());
201 video_offset_p = video_offset;
204 const XMLProperty* proplock = node->property (X_("VideoOffsetLock"));
206 video_offset_lock = atoi(proplock->value().c_str())?true:false;
209 const XMLProperty* localfile = node->property (X_("LocalFile"));
211 local_file = atoi(localfile->value().c_str())?true:false;
214 const XMLProperty* propf = node->property (X_("Filename"));
215 video_file_info(propf->value(), local_file);
218 node = _session->extra_xml (X_("Videomonitor"));
220 const XMLProperty* prop = node->property (X_("active"));
221 if (prop && prop->value() == "yes" && found_xjadeo() && !video_filename.empty() && local_file) {
222 open_video_monitor();
226 _session->register_with_memento_command_factory(id(), this);
227 _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoTimeLine::parameter_changed, this, _1), gui_context());
231 VideoTimeLine::save_undo ()
233 video_offset_p = video_offset;
237 VideoTimeLine::set_state (const XMLNode& node, int /*version*/)
239 LocaleGuard lg (X_("POSIX"));
240 const XMLProperty* propoffset = node.property (X_("VideoOffset"));
242 video_offset = atoll(propoffset->value().c_str());
244 ARDOUR_UI::instance()->flush_videotimeline_cache(true);
249 VideoTimeLine::get_state ()
251 XMLNode* node = new XMLNode (X_("Videotimeline"));
252 LocaleGuard lg (X_("POSIX"));
253 node->add_property (X_("VideoOffset"), video_offset_p);
258 VideoTimeLine::remove_frames ()
260 for (VideoFrames::iterator i = video_frames.begin(); i != video_frames.end(); ++i ) {
261 VideoImageFrame *frame = (*i);
265 video_frames.clear();
269 VideoTimeLine::get_video_frame (framepos_t vfn, int cut, int rightend)
272 for (VideoFrames::iterator i = video_frames.begin(); i != video_frames.end(); ++i) {
273 VideoImageFrame *frame = (*i);
274 if (abs(frame->get_video_frame_number()-vfn)<=cut
275 && frame->get_rightend() == rightend) { return frame; }
281 VideoTimeLine::get_apv()
283 // XXX: dup code - TODO use this fn in update_video_timeline()
284 float apv = -1; /* audio frames per video frame; */
285 if (!_session) return apv;
287 if (_session->config.get_use_video_file_fps()) {
288 if (video_file_fps == 0 ) return apv;
290 if (_session->timecode_frames_per_second() == 0 ) return apv;
293 if (_session->config.get_videotimeline_pullup()) {
294 apv = _session->frame_rate();
296 apv = _session->nominal_frame_rate();
298 if (_session->config.get_use_video_file_fps()) {
299 apv /= video_file_fps;
301 apv /= _session->timecode_frames_per_second();
307 VideoTimeLine::update_video_timeline()
309 if (!_session) return;
311 if (_session->config.get_use_video_file_fps()) {
312 if (video_file_fps == 0 ) return;
314 if (_session->timecode_frames_per_second() == 0 ) return;
317 double frames_per_unit = editor->unit_to_frame(1.0);
318 framepos_t leftmost_frame = editor->leftmost_position();
321 * 1) calculate how many frames there should be in current zoom (plus 1 page on each side)
322 * 2) calculate first frame and distance between video-frames (according to zoom)
323 * 3) destroy/add frames
324 * 4) reposition existing frames
325 * 5) assign framenumber to frames -> request/decode video.
328 /* video-file and session properties */
329 double display_vframe_width; /* unit: pixels ; width of one thumbnail in the timeline */
330 float apv; /* audio frames per video frame; */
331 framepos_t leftmost_video_frame; /* unit: video-frame number ; temporary var -> vtl_start */
333 /* variables needed to render videotimeline -- what needs to computed first */
334 framepos_t vtl_start; /* unit: audio-frames ; first displayed video-frame */
335 framepos_t vtl_dist; /* unit: audio-frames ; distance between displayed video-frames */
336 unsigned int visible_video_frames; /* number of frames that fit on current canvas */
338 if (_session->config.get_videotimeline_pullup()) {
339 apv = _session->frame_rate();
341 apv = _session->nominal_frame_rate();
343 if (_session->config.get_use_video_file_fps()) {
344 apv /= video_file_fps;
346 apv /= _session->timecode_frames_per_second();
349 display_vframe_width = bar_height * video_aspect_ratio;
351 if (apv > frames_per_unit * display_vframe_width) {
352 /* high-zoom: need space between successive video-frames */
353 vtl_dist = rint(apv);
355 /* continous timeline: skip video-frames */
356 vtl_dist = ceil(display_vframe_width * frames_per_unit / apv) * apv;
359 assert (vtl_dist > 0);
362 #define GOFFSET (video_offset)
364 leftmost_video_frame = floor (floor((leftmost_frame - video_start_offset - GOFFSET ) / vtl_dist) * vtl_dist / apv);
366 vtl_start = rint (GOFFSET + video_start_offset + leftmost_video_frame * apv);
367 visible_video_frames = 2 + ceil(editor->current_page_frames() / vtl_dist); /* +2 left+right partial frames */
369 /* expand timeline (cache next/prev page images) */
370 vtl_start -= visible_video_frames * vtl_dist;
371 visible_video_frames *=3;
373 if (vtl_start < GOFFSET ) {
374 visible_video_frames += ceil(vtl_start/vtl_dist);
378 /* apply video-file constraints */
379 if (vtl_start > video_start_offset + video_duration + GOFFSET ) {
380 visible_video_frames = 0;
382 /* TODO optimize: compute rather than iterate */
383 while (visible_video_frames > 0 && vtl_start + (visible_video_frames-1) * vtl_dist >= video_start_offset + video_duration + GOFFSET) {
384 --visible_video_frames;
392 while (video_frames.size() < visible_video_frames) {
393 VideoImageFrame *frame;
394 frame = new VideoImageFrame(*editor, *videotl_bar_group, display_vframe_width, bar_height, video_server_url, translated_filename());
395 frame->ImgChanged.connect (*this, invalidator (*this), boost::bind (&PublicEditor::queue_visual_videotimeline_update, editor), gui_context());
396 video_frames.push_back(frame);
399 VideoFrames outdated_video_frames;
400 std::list<int> remaining;
402 outdated_video_frames = video_frames;
405 /* when zoomed out, ignore shifts by +-1 frame
406 * which can occur due to rounding errors when
407 * scrolling to a new leftmost-audio frame.
410 if (vtl_dist/apv < 3.0) cut =0;
415 for (unsigned int vfcount=0; vfcount < visible_video_frames; ++vfcount){
416 framepos_t vfpos = vtl_start + vfcount * vtl_dist; /* unit: audio-frames */
417 framepos_t vframeno = rint ( (vfpos - GOFFSET) / apv); /* unit: video-frames */
418 vfpos = (vframeno * apv ) + GOFFSET; /* audio-frame corresponding to /rounded/ video-frame */
420 int rightend = -1; /* unit: pixels */
421 if (vfpos + vtl_dist > video_start_offset + video_duration + GOFFSET) {
422 rightend = display_vframe_width * (video_start_offset + video_duration + GOFFSET - vfpos) / vtl_dist;
423 //printf("lf(e): %lu\n", vframeno); // XXX
425 VideoImageFrame * frame = get_video_frame(vframeno, cut, rightend);
427 frame->set_position(vfpos-leftmost_frame);
428 outdated_video_frames.remove(frame);
430 remaining.push_back(vfcount);
434 for (VideoFrames::iterator i = outdated_video_frames.begin(); i != outdated_video_frames.end(); ++i ) {
435 VideoImageFrame *frame = (*i);
436 if (remaining.empty()) {
437 frame->set_position(-2 * vtl_dist); /* move off screen */
439 int vfcount=remaining.front();
440 remaining.pop_front();
441 framepos_t vfpos = vtl_start + vfcount * vtl_dist; /* unit: audio-frames */
442 framepos_t vframeno = rint ((vfpos - GOFFSET) / apv); /* unit: video-frames */
443 int rightend = -1; /* unit: pixels */
444 if (vfpos + vtl_dist > video_start_offset + video_duration + GOFFSET) {
445 rightend = display_vframe_width * (video_start_offset + video_duration + GOFFSET - vfpos) / vtl_dist;
446 //printf("lf(n): %lu\n", vframeno); // XXX
448 frame->set_position(vfpos-leftmost_frame);
449 frame->set_videoframe(vframeno, rightend);
455 VideoTimeLine::translated_filename ()
458 return video_filename;
460 return video_map_path(server_docroot, video_filename);
465 VideoTimeLine::video_file_info (std::string filename, bool local)
469 if (filename.at(0) == G_DIR_SEPARATOR || !local_file) {
470 video_filename = filename;
472 video_filename = Glib::build_filename (_session->session_directory().video_path(), filename);
475 long long int _duration;
476 double _start_offset;
478 if (!video_query_info(
479 video_server_url, translated_filename(),
480 video_file_fps, _duration, _start_offset, video_aspect_ratio)) {
481 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;
484 video_duration = _duration * _session->nominal_frame_rate() / video_file_fps;
485 video_start_offset = _start_offset * _session->nominal_frame_rate();
487 if (auto_set_session_fps && video_file_fps != _session->timecode_frames_per_second()) {
488 switch ((int)floorf(video_file_fps*1000.0)) {
490 _session->config.set_timecode_format(timecode_23976);
493 _session->config.set_timecode_format(timecode_24);
497 _session->config.set_timecode_format(timecode_24976);
500 _session->config.set_timecode_format(timecode_25);
503 _session->config.set_timecode_format(timecode_2997drop);
506 _session->config.set_timecode_format(timecode_30);
509 _session->config.set_timecode_format(timecode_5994);
512 _session->config.set_timecode_format(timecode_60);
515 warning << _("Failed to set session-framerate: ") << video_file_fps << _(" does not have a corresponding option setting in Ardour.") << endmsg; /* TODO: gettext arg */
518 _session->config.set_video_pullup(0); /* TODO only set if set_timecode_format() was successful ?!*/
520 if (video_file_fps != _session->timecode_frames_per_second()) {
521 warning << _("Video file's framerate is not equal to Ardour session timecode's framerate: ")
522 << video_file_fps << _(" vs ") << _session->timecode_frames_per_second() << endmsg;
524 flush_local_cache ();
526 _session->maybe_update_session_range(
527 std::max(get_offset(), (ARDOUR::frameoffset_t) 0),
528 std::max(get_offset() + get_duration(), (ARDOUR::frameoffset_t) 0)
531 if (found_xjadeo() && local_file) {
532 GuiUpdate("set-xjadeo-sensitive-on");
533 if (vmonitor && vmonitor->is_started()) {
535 /* xjadeo <= 0.6.4 has a bug where changing the video-file may segfauls
536 * if the geometry changes to a different line-size alignment
538 reopen_vmonitor = true;
541 vmonitor->set_fps(video_file_fps);
542 vmonitor->open(video_filename);
545 } else if (!local_file) {
546 #if 1 /* temp debug/devel message */
547 // TODO - call xjremote remotely.
548 printf("the given video file can not be accessed on localhost, video monitoring is not currently supported for this case\n");
549 GuiUpdate("set-xjadeo-sensitive-off");
557 VideoTimeLine::check_server ()
561 snprintf(url, sizeof(url), "%s%sstatus"
562 , video_server_url.c_str()
563 , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
565 char *res=curl_http_get(url, NULL);
567 if (strstr(res, "status: ok, online.")) { ok = true; }
574 VideoTimeLine::gui_update(std::string const & t) {
575 /* this is to be called via GuiUpdate() only. */
576 ENSURE_GUI_THREAD (*this, &VideoTimeLine::queue_visual_videotimeline_update)
577 if (t == "videotimeline-update") {
578 editor->queue_visual_videotimeline_update();
579 } else if (t == "set-xjadeo-active-off") {
580 editor->toggle_xjadeo_proc(0);
581 } else if (t == "set-xjadeo-active-on") {
582 editor->toggle_xjadeo_proc(1);
583 } else if (t == "set-xjadeo-sensitive-on") {
584 editor->set_xjadeo_sensitive(true);
585 } else if (t == "set-xjadeo-sensitive-off") {
586 editor->toggle_xjadeo_proc(0);
587 //close_video_monitor();
588 editor->set_xjadeo_sensitive(false);
593 VideoTimeLine::set_height (int height) {
599 VideoTimeLine::vmon_update () {
600 if (vmonitor && vmonitor->is_started()) {
601 vmonitor->set_offset( GOFFSET); // TODO proper re-init xjadeo w/o restart not just offset.
606 VideoTimeLine::flush_local_cache () {
612 VideoTimeLine::flush_cache () {
615 snprintf(url, sizeof(url), "%s%sadmin/flush_cache"
616 , video_server_url.c_str()
617 , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
619 char *res=curl_http_get(url, NULL);
623 if (vmonitor && vmonitor->is_started()) {
624 reopen_vmonitor=true;
627 video_file_info(video_filename, local_file);
632 VideoTimeLine::parameter_changed (std::string const & p)
634 if (p == "video-server-url") {
635 set_video_server_url (video_get_server_url(Config));
636 } else if (p == "video-server-docroot") {
637 set_video_server_docroot (video_get_docroot(Config));
638 } else if (p == "video-advanced-setup") {
639 set_video_server_url (video_get_server_url(Config));
640 set_video_server_docroot (video_get_docroot(Config));
642 if (p == "use-video-file-fps" || p == "videotimeline-pullup" ) { /* session->config parameter */
648 VideoTimeLine::set_video_server_url(std::string vsu) {
649 flush_local_cache ();
650 video_server_url = vsu;
655 VideoTimeLine::set_video_server_docroot(std::string vsr) {
656 flush_local_cache ();
657 server_docroot = vsr;
661 /* video-monitor for this timeline */
663 VideoTimeLine::find_xjadeo () {
664 std::string xjadeo_file_path;
665 if (getenv("XJREMOTE")) {
666 _xjadeo_bin = strdup(getenv("XJREMOTE")); // XXX TODO: free it?!
667 } else if (find_file_in_search_path (SearchPath(Glib::getenv("PATH")), X_("xjremote"), xjadeo_file_path)) {
668 _xjadeo_bin = xjadeo_file_path;
670 else if (Glib::file_test(X_("/Applications/Jadeo.app/Contents/MacOS/xjremote"), Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_EXECUTABLE)) {
671 _xjadeo_bin = X_("/Applications/Jadeo.app/Contents/MacOS/xjremote");
673 /* TODO: win32: allow to configure PATH to xjremote */
674 else if (Glib::file_test(X_("C:\\Program Files\\xjadeo\\xjremote.exe"), Glib::FILE_TEST_EXISTS)) {
675 _xjadeo_bin = X_("C:\\Program Files\\xjadeo\\xjremote.exe");
677 else if (Glib::file_test(X_("C:\\Program Files\\xjadeo\\xjremote.bat"), Glib::FILE_TEST_EXISTS)) {
678 _xjadeo_bin = X_("C:\\Program Files\\xjadeo\\xjremote.bat");
681 _xjadeo_bin = X_("");
682 warning << _("Video-monitor 'xjadeo' was not found. Please install http://xjadeo.sf.net/ "
683 "(a custom path to xjadeo can be specified by setting the XJREMOTE environment variable. "
684 "It should point to an application compatible with xjadeo's remote-control interface 'xjremote').")
690 VideoTimeLine::open_video_monitor() {
691 if (!found_xjadeo()) return;
693 vmonitor = new VideoMonitor(editor, _xjadeo_bin);
694 vmonitor->set_session(_session);
695 vmonitor->Terminated.connect (sigc::mem_fun (*this, &VideoTimeLine::terminated_video_monitor));
696 } else if (vmonitor->is_started()) {
700 int xj_settings_mask = vmonitor->restore_settings_mask();
702 /* load mask from Session */
703 XMLNode* node = _session->extra_xml (X_("XJRestoreSettings"));
705 const XMLProperty* prop = node->property (X_("mask"));
707 xj_settings_mask = atoi(prop->value().c_str());
712 vmonitor->restore_settings_mask(xj_settings_mask);
714 if (!vmonitor->start()) {
715 warning << "launching xjadeo failed.." << endmsg;
716 close_video_monitor();
718 GuiUpdate("set-xjadeo-active-on");
719 vmonitor->set_fps(video_file_fps);
720 vmonitor->open(video_filename);
725 VideoTimeLine::close_video_monitor() {
726 if (vmonitor && vmonitor->is_started()) {
732 VideoTimeLine::terminated_video_monitor () {
736 GuiUpdate("set-xjadeo-active-off");
738 if (reopen_vmonitor) {
739 reopen_vmonitor=false;
740 open_video_monitor();
746 VideoTimeLine::clear_video_monitor_session_state ()
749 vmonitor->clear_session_state();
751 if (!_session) { return; }
752 XMLNode* node = new XMLNode(X_("XJSettings"));
753 _session->add_extra_xml (*node);
754 _session->set_dirty ();
760 VideoTimeLine::manual_seek_video_monitor (framepos_t pos)
762 if (!vmonitor) { return; }
763 if (!vmonitor->is_started()) { return; }
764 if (!vmonitor->synced_by_manual_seeks()) { return; }
765 vmonitor->manual_seek(pos, false, GOFFSET); // XXX -> set offset in xjadeo
768 #endif /* WITH_VIDEOTIMELINE */