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 "canvas_impl.h"
32 #include "simpleline.h"
33 #include "utils_videotl.h"
34 #include "rgb_macros.h"
35 #include "video_timeline.h"
37 #include <gtkmm2ext/utils.h>
39 #include <curl/curl.h>
44 using namespace ARDOUR;
46 using namespace Timecode;
48 VideoTimeLine::VideoTimeLine (PublicEditor *ed, ArdourCanvas::Group *vbg, int initial_height)
50 , videotl_bar_group(vbg)
51 , bar_height(initial_height)
53 video_start_offset = 0L;
57 auto_set_session_fps = false;
58 video_offset_lock = false;
59 video_aspect_ratio = 4.0/3.0;
60 Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoTimeLine::parameter_changed, this, _1), gui_context());
61 video_server_url = video_get_server_url(Config);
62 server_docroot = video_get_docroot(Config);
65 video_file_fps = 25.0;
68 reopen_vmonitor=false;
71 VtlUpdate.connect (*this, invalidator (*this), boost::bind (&PublicEditor::queue_visual_videotimeline_update, editor), gui_context());
72 GuiUpdate.connect (*this, invalidator (*this), boost::bind (&VideoTimeLine::gui_update, this, _1), gui_context());
75 VideoTimeLine::~VideoTimeLine ()
80 /* close and save settings */
82 VideoTimeLine::save_session ()
88 LocaleGuard lg (X_("POSIX"));
90 XMLNode* node = new XMLNode(X_("Videomonitor"));
92 node->add_property (X_("active"), (vmonitor && vmonitor->is_started())?"yes":"no");
93 _session->add_extra_xml (*node);
96 if (vmonitor->is_started()) {
97 vmonitor->query_full_state(true);
99 vmonitor->save_session();
103 node = _session->extra_xml (X_("Videotimeline"));
105 node->add_property (X_("id"), id().to_s());
106 node->add_property (X_("Height"), editor->get_videotl_bar_height());
107 node->add_property (X_("VideoOffsetLock"), video_offset_lock?X_("1"):X_("0"));
108 node->add_property (X_("VideoOffset"), video_offset);
109 node->add_property (X_("AutoFPS"), auto_set_session_fps?X_("1"):X_("0"));
112 /* close and save settings */
114 VideoTimeLine::close_session ()
116 if (video_duration == 0) {
119 sessionsave.disconnect();
120 close_video_monitor();
125 GuiUpdate("set-xjadeo-sensitive-off");
129 VideoTimeLine::sync_session_state ()
131 if (!_session || !vmonitor || !vmonitor->is_started()) {
137 /** load settings from session */
139 VideoTimeLine::set_session (ARDOUR::Session *s)
141 SessionHandlePtr::set_session (s);
142 if (!_session) { return ; }
144 _session->SaveSession.connect_same_thread (sessionsave, boost::bind (&VideoTimeLine::save_session, this));
145 LocaleGuard lg (X_("POSIX"));
147 XMLNode* node = _session->extra_xml (X_("Videotimeline"));
149 if (!node || !node->property (X_("Filename"))) {
154 ARDOUR_UI::instance()->start_video_server((Gtk::Window*)0, false);
158 const XMLProperty* proph = node->property (X_("Height"));
160 editor->set_video_timeline_height(atoi(proph->value().c_str()));
162 #if 0 /* TODO THINK: set FPS first time only ?! */
163 const XMLProperty* propasfps = node->property (X_("AutoFPS"));
165 auto_set_session_fps = atoi(propasfps->value().c_str())?true:false;
169 const XMLProperty* propoffset = node->property (X_("VideoOffset"));
171 video_offset = atoll(propoffset->value().c_str());
172 video_offset_p = video_offset;
175 const XMLProperty* proplock = node->property (X_("VideoOffsetLock"));
177 video_offset_lock = atoi(proplock->value().c_str())?true:false;
180 const XMLProperty* localfile = node->property (X_("LocalFile"));
182 local_file = atoi(localfile->value().c_str())?true:false;
185 const XMLProperty* propf = node->property (X_("Filename"));
186 video_file_info(propf->value(), local_file);
189 node = _session->extra_xml (X_("Videomonitor"));
191 const XMLProperty* prop = node->property (X_("active"));
192 if (prop && prop->value() == "yes" && found_xjadeo() && !video_filename.empty() && local_file) {
193 open_video_monitor();
197 _session->register_with_memento_command_factory(id(), this);
198 _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoTimeLine::parameter_changed, this, _1), gui_context());
202 VideoTimeLine::set_offset_locked (bool v) {
203 if (_session && v != video_offset_lock) {
204 _session->set_dirty ();
206 video_offset_lock = v;
210 VideoTimeLine::toggle_offset_locked () {
211 video_offset_lock = !video_offset_lock;
213 _session->set_dirty ();
218 VideoTimeLine::save_undo ()
220 if (_session && video_offset_p != video_offset) {
221 _session->set_dirty ();
223 video_offset_p = video_offset;
227 VideoTimeLine::set_state (const XMLNode& node, int /*version*/)
229 LocaleGuard lg (X_("POSIX"));
230 const XMLProperty* propoffset = node.property (X_("VideoOffset"));
232 video_offset = atoll(propoffset->value().c_str());
234 ARDOUR_UI::instance()->flush_videotimeline_cache(true);
239 VideoTimeLine::get_state ()
241 XMLNode* node = new XMLNode (X_("Videotimeline"));
242 LocaleGuard lg (X_("POSIX"));
243 node->add_property (X_("VideoOffset"), video_offset_p);
248 VideoTimeLine::remove_frames ()
250 for (VideoFrames::iterator i = video_frames.begin(); i != video_frames.end(); ++i ) {
251 VideoImageFrame *frame = (*i);
255 video_frames.clear();
259 VideoTimeLine::get_video_frame (framepos_t vfn, int cut, int rightend)
262 for (VideoFrames::iterator i = video_frames.begin(); i != video_frames.end(); ++i) {
263 VideoImageFrame *frame = (*i);
264 if (abs(frame->get_video_frame_number()-vfn)<=cut
265 && frame->get_rightend() == rightend) { return frame; }
271 VideoTimeLine::get_apv()
273 // XXX: dup code - TODO use this fn in update_video_timeline()
274 float apv = -1; /* audio frames per video frame; */
275 if (!_session) return apv;
277 if (_session->config.get_use_video_file_fps()) {
278 if (video_file_fps == 0 ) return apv;
280 if (_session->timecode_frames_per_second() == 0 ) return apv;
283 if (_session->config.get_videotimeline_pullup()) {
284 apv = _session->frame_rate();
286 apv = _session->nominal_frame_rate();
288 if (_session->config.get_use_video_file_fps()) {
289 apv /= video_file_fps;
291 apv /= _session->timecode_frames_per_second();
297 VideoTimeLine::update_video_timeline()
299 if (!_session) return;
301 if (_session->config.get_use_video_file_fps()) {
302 if (video_file_fps == 0 ) return;
304 if (_session->timecode_frames_per_second() == 0 ) return;
307 double frames_per_unit = editor->unit_to_frame(1.0);
308 framepos_t leftmost_frame = editor->leftmost_position();
311 * 1) calculate how many frames there should be in current zoom (plus 1 page on each side)
312 * 2) calculate first frame and distance between video-frames (according to zoom)
313 * 3) destroy/add frames
314 * 4) reposition existing frames
315 * 5) assign framenumber to frames -> request/decode video.
318 /* video-file and session properties */
319 double display_vframe_width; /* unit: pixels ; width of one thumbnail in the timeline */
320 float apv; /* audio frames per video frame; */
321 framepos_t leftmost_video_frame; /* unit: video-frame number ; temporary var -> vtl_start */
323 /* variables needed to render videotimeline -- what needs to computed first */
324 framepos_t vtl_start; /* unit: audio-frames ; first displayed video-frame */
325 framepos_t vtl_dist; /* unit: audio-frames ; distance between displayed video-frames */
326 unsigned int visible_video_frames; /* number of frames that fit on current canvas */
328 if (_session->config.get_videotimeline_pullup()) {
329 apv = _session->frame_rate();
331 apv = _session->nominal_frame_rate();
333 if (_session->config.get_use_video_file_fps()) {
334 apv /= video_file_fps;
336 apv /= _session->timecode_frames_per_second();
339 display_vframe_width = bar_height * video_aspect_ratio;
341 if (apv > frames_per_unit * display_vframe_width) {
342 /* high-zoom: need space between successive video-frames */
343 vtl_dist = rint(apv);
345 /* continous timeline: skip video-frames */
346 vtl_dist = ceil(display_vframe_width * frames_per_unit / apv) * apv;
349 assert (vtl_dist > 0);
352 #define GOFFSET (video_offset)
354 leftmost_video_frame = floor (floor((leftmost_frame - video_start_offset - GOFFSET ) / vtl_dist) * vtl_dist / apv);
356 vtl_start = rint (GOFFSET + video_start_offset + leftmost_video_frame * apv);
357 visible_video_frames = 2 + ceil(editor->current_page_frames() / vtl_dist); /* +2 left+right partial frames */
359 /* expand timeline (cache next/prev page images) */
360 vtl_start -= visible_video_frames * vtl_dist;
361 visible_video_frames *=3;
363 if (vtl_start < GOFFSET ) {
364 visible_video_frames += ceil(vtl_start/vtl_dist);
368 /* apply video-file constraints */
369 if (vtl_start > video_start_offset + video_duration + GOFFSET ) {
370 visible_video_frames = 0;
372 /* TODO optimize: compute rather than iterate */
373 while (visible_video_frames > 0 && vtl_start + (visible_video_frames-1) * vtl_dist >= video_start_offset + video_duration + GOFFSET) {
374 --visible_video_frames;
382 while (video_frames.size() < visible_video_frames) {
383 VideoImageFrame *frame;
384 frame = new VideoImageFrame(*editor, *videotl_bar_group, display_vframe_width, bar_height, video_server_url, translated_filename());
385 frame->ImgChanged.connect (*this, invalidator (*this), boost::bind (&PublicEditor::queue_visual_videotimeline_update, editor), gui_context());
386 video_frames.push_back(frame);
389 VideoFrames outdated_video_frames;
390 std::list<int> remaining;
392 outdated_video_frames = video_frames;
395 /* when zoomed out, ignore shifts by +-1 frame
396 * which can occur due to rounding errors when
397 * scrolling to a new leftmost-audio frame.
400 if (vtl_dist/apv < 3.0) cut =0;
405 for (unsigned int vfcount=0; vfcount < visible_video_frames; ++vfcount){
406 framepos_t vfpos = vtl_start + vfcount * vtl_dist; /* unit: audio-frames */
407 framepos_t vframeno = rint ( (vfpos - GOFFSET) / apv); /* unit: video-frames */
408 vfpos = (vframeno * apv ) + GOFFSET; /* audio-frame corresponding to /rounded/ video-frame */
410 int rightend = -1; /* unit: pixels */
411 if (vfpos + vtl_dist > video_start_offset + video_duration + GOFFSET) {
412 rightend = display_vframe_width * (video_start_offset + video_duration + GOFFSET - vfpos) / vtl_dist;
413 //printf("lf(e): %lu\n", vframeno); // XXX
415 VideoImageFrame * frame = get_video_frame(vframeno, cut, rightend);
417 frame->set_position(vfpos-leftmost_frame);
418 outdated_video_frames.remove(frame);
420 remaining.push_back(vfcount);
424 for (VideoFrames::iterator i = outdated_video_frames.begin(); i != outdated_video_frames.end(); ++i ) {
425 VideoImageFrame *frame = (*i);
426 if (remaining.empty()) {
427 frame->set_position(-2 * vtl_dist); /* move off screen */
429 int vfcount=remaining.front();
430 remaining.pop_front();
431 framepos_t vfpos = vtl_start + vfcount * vtl_dist; /* unit: audio-frames */
432 framepos_t vframeno = rint ((vfpos - GOFFSET) / apv); /* unit: video-frames */
433 int rightend = -1; /* unit: pixels */
434 if (vfpos + vtl_dist > video_start_offset + video_duration + GOFFSET) {
435 rightend = display_vframe_width * (video_start_offset + video_duration + GOFFSET - vfpos) / vtl_dist;
436 //printf("lf(n): %lu\n", vframeno); // XXX
438 frame->set_position(vfpos-leftmost_frame);
439 frame->set_videoframe(vframeno, rightend);
445 VideoTimeLine::translated_filename ()
448 return video_filename;
450 return video_map_path(server_docroot, video_filename);
455 VideoTimeLine::video_file_info (std::string filename, bool local)
459 if (filename.at(0) == G_DIR_SEPARATOR || !local_file) {
460 video_filename = filename;
462 video_filename = Glib::build_filename (_session->session_directory().video_path(), filename);
465 long long int _duration;
466 double _start_offset;
468 if (!video_query_info(
469 video_server_url, translated_filename(),
470 video_file_fps, _duration, _start_offset, video_aspect_ratio)) {
471 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;
474 video_duration = _duration * _session->nominal_frame_rate() / video_file_fps;
475 video_start_offset = _start_offset * _session->nominal_frame_rate();
477 if (auto_set_session_fps && video_file_fps != _session->timecode_frames_per_second()) {
478 switch ((int)floorf(video_file_fps*1000.0)) {
480 _session->config.set_timecode_format(timecode_23976);
483 _session->config.set_timecode_format(timecode_24);
487 _session->config.set_timecode_format(timecode_24976);
490 _session->config.set_timecode_format(timecode_25);
493 _session->config.set_timecode_format(timecode_2997drop);
496 _session->config.set_timecode_format(timecode_30);
499 _session->config.set_timecode_format(timecode_5994);
502 _session->config.set_timecode_format(timecode_60);
505 warning << _("Failed to set session-framerate: ") << video_file_fps << _(" does not have a corresponding option setting in Ardour.") << endmsg; /* TODO: gettext arg */
508 _session->config.set_video_pullup(0); /* TODO only set if set_timecode_format() was successful ?!*/
510 if (video_file_fps != _session->timecode_frames_per_second()) {
511 warning << _("Video file's framerate is not equal to Ardour session timecode's framerate: ")
512 << video_file_fps << _(" vs ") << _session->timecode_frames_per_second() << endmsg;
514 flush_local_cache ();
516 if (found_xjadeo() && local_file) {
517 GuiUpdate("set-xjadeo-sensitive-on");
518 if (vmonitor && vmonitor->is_started()) {
520 /* xjadeo <= 0.6.4 has a bug where changing the video-file may segfauls
521 * if the geometry changes to a different line-size alignment
523 reopen_vmonitor = true;
526 vmonitor->set_fps(video_file_fps);
527 vmonitor->open(video_filename);
530 } else if (!local_file) {
531 #if 1 /* temp debug/devel message */
532 // TODO - call xjremote remotely.
533 printf("the given video file can not be accessed on localhost, video monitoring is not currently supported for this case\n");
534 GuiUpdate("set-xjadeo-sensitive-off");
542 VideoTimeLine::check_server ()
546 snprintf(url, sizeof(url), "%s%sstatus"
547 , video_server_url.c_str()
548 , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
550 char *res=curl_http_get(url, NULL);
552 if (strstr(res, "status: ok, online.")) { ok = true; }
559 VideoTimeLine::gui_update(std::string const & t) {
560 /* this is to be called via GuiUpdate() only. */
561 ENSURE_GUI_THREAD (*this, &VideoTimeLine::queue_visual_videotimeline_update)
562 if (t == "videotimeline-update") {
563 editor->queue_visual_videotimeline_update();
564 } else if (t == "set-xjadeo-active-off") {
565 editor->toggle_xjadeo_proc(0);
566 } else if (t == "set-xjadeo-active-on") {
567 editor->toggle_xjadeo_proc(1);
568 } else if (t == "set-xjadeo-sensitive-on") {
569 editor->set_xjadeo_sensitive(true);
570 } else if (t == "set-xjadeo-sensitive-off") {
571 editor->toggle_xjadeo_proc(0);
572 //close_video_monitor();
573 editor->set_xjadeo_sensitive(false);
574 } else if (t == "xjadeo-window-ontop-on") {
575 editor->toggle_xjadeo_viewoption(1, 1);
576 } else if (t == "xjadeo-window-ontop-off") {
577 editor->toggle_xjadeo_viewoption(1, 0);
578 } else if (t == "xjadeo-window-osd-timecode-on") {
579 editor->toggle_xjadeo_viewoption(2, 1);
580 } else if (t == "xjadeo-window-osd-timecode-off") {
581 editor->toggle_xjadeo_viewoption(2, 0);
582 } else if (t == "xjadeo-window-osd-frame-on") {
583 editor->toggle_xjadeo_viewoption(3, 1);
584 } else if (t == "xjadeo-window-osd-frame-off") {
585 editor->toggle_xjadeo_viewoption(3, 0);
586 } else if (t == "xjadeo-window-osd-box-on") {
587 editor->toggle_xjadeo_viewoption(4, 1);
588 } else if (t == "xjadeo-window-osd-box-off") {
589 editor->toggle_xjadeo_viewoption(4, 0);
590 } else if (t == "xjadeo-window-fullscreen-on") {
591 editor->toggle_xjadeo_viewoption(5, 1);
592 } else if (t == "xjadeo-window-fullscreen-off") {
593 editor->toggle_xjadeo_viewoption(5, 0);
594 } else if (t == "xjadeo-window-letterbox-on") {
595 editor->toggle_xjadeo_viewoption(6, 1);
596 } else if (t == "xjadeo-window-letterbox-off") {
597 editor->toggle_xjadeo_viewoption(6, 0);
602 VideoTimeLine::set_height (int height) {
603 if (_session && bar_height != height) {
604 _session->set_dirty ();
611 VideoTimeLine::vmon_update () {
612 if (vmonitor && vmonitor->is_started()) {
613 vmonitor->set_offset( GOFFSET); // TODO proper re-init xjadeo w/o restart not just offset.
618 VideoTimeLine::flush_local_cache () {
624 VideoTimeLine::flush_cache () {
627 snprintf(url, sizeof(url), "%s%sadmin/flush_cache"
628 , video_server_url.c_str()
629 , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
631 char *res=curl_http_get(url, NULL);
635 if (vmonitor && vmonitor->is_started()) {
636 reopen_vmonitor=true;
639 video_file_info(video_filename, local_file);
644 VideoTimeLine::parameter_changed (std::string const & p)
646 if (p == "video-server-url") {
647 set_video_server_url (video_get_server_url(Config));
648 } else if (p == "video-server-docroot") {
649 set_video_server_docroot (video_get_docroot(Config));
650 } else if (p == "video-advanced-setup") {
651 set_video_server_url (video_get_server_url(Config));
652 set_video_server_docroot (video_get_docroot(Config));
654 if (p == "use-video-file-fps" || p == "videotimeline-pullup" ) { /* session->config parameter */
660 VideoTimeLine::set_video_server_url(std::string vsu) {
661 flush_local_cache ();
662 video_server_url = vsu;
667 VideoTimeLine::set_video_server_docroot(std::string vsr) {
668 flush_local_cache ();
669 server_docroot = vsr;
673 /* video-monitor for this timeline */
675 VideoTimeLine::find_xjadeo () {
676 std::string xjadeo_file_path;
677 if (getenv("XJREMOTE")) {
678 _xjadeo_bin = strdup(getenv("XJREMOTE")); // XXX TODO: free it?!
679 } else if (find_file_in_search_path (SearchPath(Glib::getenv("PATH")), X_("xjremote"), xjadeo_file_path)) {
680 _xjadeo_bin = xjadeo_file_path;
682 else if (Glib::file_test(X_("/Applications/Jadeo.app/Contents/MacOS/xjremote"), Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_EXECUTABLE)) {
683 _xjadeo_bin = X_("/Applications/Jadeo.app/Contents/MacOS/xjremote");
685 /* TODO: win32: allow to configure PATH to xjremote */
686 else if (Glib::file_test(X_("C:\\Program Files\\xjadeo\\xjremote.exe"), Glib::FILE_TEST_EXISTS)) {
687 _xjadeo_bin = X_("C:\\Program Files\\xjadeo\\xjremote.exe");
689 else if (Glib::file_test(X_("C:\\Program Files\\xjadeo\\xjremote.bat"), Glib::FILE_TEST_EXISTS)) {
690 _xjadeo_bin = X_("C:\\Program Files\\xjadeo\\xjremote.bat");
693 _xjadeo_bin = X_("");
694 warning << _("Video-monitor 'xjadeo' was not found. Please install http://xjadeo.sf.net/ "
695 "(a custom path to xjadeo can be specified by setting the XJREMOTE environment variable. "
696 "It should point to an application compatible with xjadeo's remote-control interface 'xjremote').")
702 VideoTimeLine::open_video_monitor() {
703 if (!found_xjadeo()) return;
705 vmonitor = new VideoMonitor(editor, _xjadeo_bin);
706 vmonitor->set_session(_session);
707 vmonitor->Terminated.connect (sigc::mem_fun (*this, &VideoTimeLine::terminated_video_monitor));
708 vmonitor->UiState.connect (*this, invalidator (*this), boost::bind (&VideoTimeLine::gui_update, this, _1), gui_context());
709 } else if (vmonitor->is_started()) {
713 int xj_settings_mask = vmonitor->restore_settings_mask();
715 /* load mask from Session */
716 XMLNode* node = _session->extra_xml (X_("XJRestoreSettings"));
718 const XMLProperty* prop = node->property (X_("mask"));
720 xj_settings_mask = atoi(prop->value().c_str());
725 vmonitor->restore_settings_mask(xj_settings_mask);
727 if (!vmonitor->start()) {
728 warning << "launching xjadeo failed.." << endmsg;
729 close_video_monitor();
731 GuiUpdate("set-xjadeo-active-on");
732 vmonitor->set_fps(video_file_fps);
733 vmonitor->open(video_filename);
736 XMLNode* node = _session->extra_xml (X_("Videomonitor"));
738 const XMLProperty* prop = node->property (X_("active"));
739 if (prop && prop->value() != "yes") _session->set_dirty ();
741 _session->set_dirty ();
749 VideoTimeLine::close_video_monitor() {
750 if (vmonitor && vmonitor->is_started()) {
756 VideoTimeLine::control_video_monitor(int what, int param) {
757 if (!vmonitor || !vmonitor->is_started()) {
760 vmonitor->send_cmd(what, param);
765 VideoTimeLine::terminated_video_monitor () {
769 GuiUpdate("set-xjadeo-active-off");
771 if (reopen_vmonitor) {
772 reopen_vmonitor=false;
773 open_video_monitor();
776 _session->set_dirty ();
783 VideoTimeLine::clear_video_monitor_session_state ()
786 vmonitor->clear_session_state();
788 if (!_session) { return; }
789 XMLNode* node = new XMLNode(X_("XJSettings"));
790 _session->add_extra_xml (*node);
791 _session->set_dirty ();
797 VideoTimeLine::manual_seek_video_monitor (framepos_t pos)
799 if (!vmonitor) { return; }
800 if (!vmonitor->is_started()) { return; }
801 if (!vmonitor->synced_by_manual_seeks()) { return; }
802 vmonitor->manual_seek(pos, false, GOFFSET); // XXX -> set offset in xjadeo