gtk2_ardour/video_timeline.cc

   1 /*
   2     Copyright (C) 2010 Paul Davis
   3     Author: Robin Gareus <robin@gareus.org>
   4
   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.
   9
  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.
  14
  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.
  18
  19 */
  20 #include <algorithm>
  21 #include <sigc++/bind.h>
  22 #include "ardour/tempo.h"
  23
  24 #include "pbd/file_utils.h"
  25 #include "pbd/convert.h"
  26 #include "ardour/session_directory.h"
  27
  28 #ifdef PLATFORM_WINDOWS
  29 #include <windows.h>
  30 #include <shlobj.h> // CSIDL_*
  31 #include "pbd/windows_special_dirs.h"
  32 #endif
  33
  34 #include "ardour_ui.h"
  35 #include "public_editor.h"
  36 #include "gui_thread.h"
  37 #include "utils_videotl.h"
  38 #include "rgb_macros.h"
  39 #include "video_timeline.h"
  40
  41 #include <gtkmm2ext/utils.h>
  42 #include <pthread.h>
  43 #include <curl/curl.h>
  44
  45 #include "i18n.h"
  46
  47 using namespace std;
  48 using namespace ARDOUR;
  49 using namespace PBD;
  50 using namespace Timecode;
  51 using namespace VideoUtils;
  52
  53 VideoTimeLine::VideoTimeLine (PublicEditor *ed, ArdourCanvas::Container *vbg, int initial_height)
  54         : editor (ed)
  55                 , videotl_group(vbg)
  56                 , bar_height(initial_height)
  57 {
  58         video_start_offset = 0L;
  59         video_offset = 0L;
  60         video_offset_p = 0L;
  61         video_duration = 0L;
  62         auto_set_session_fps = false;
  63         video_offset_lock = false;
  64         video_aspect_ratio = 4.0/3.0;
  65         Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoTimeLine::parameter_changed, this, _1), gui_context());
  66         video_server_url = video_get_server_url(Config);
  67         server_docroot   = video_get_docroot(Config);
  68         video_filename = "";
  69         local_file = true;
  70         video_file_fps = 25.0;
  71         flush_frames = false;
  72         vmonitor=0;
  73         reopen_vmonitor=false;
  74         find_xjadeo();
  75
  76         VtlUpdate.connect (*this, invalidator (*this), boost::bind (&PublicEditor::queue_visual_videotimeline_update, editor), gui_context());
  77         GuiUpdate.connect (*this, invalidator (*this), boost::bind (&VideoTimeLine::gui_update, this, _1), gui_context());
  78 }
  79
  80 VideoTimeLine::~VideoTimeLine ()
  81 {
  82         close_session();
  83 }
  84
  85 /* close and save settings */
  86 void
  87 VideoTimeLine::save_session ()
  88 {
  89         if (!_session) {
  90                 return;
  91         }
  92
  93         LocaleGuard lg (X_("POSIX"));
  94
  95         XMLNode* node = new XMLNode(X_("Videomonitor"));
  96         if (!node) return;
  97         node->add_property (X_("active"), (vmonitor && vmonitor->is_started())?"yes":"no");
  98         _session->add_extra_xml (*node);
  99
 100         if (vmonitor) {
 101                 if (vmonitor->is_started()) {
 102                         vmonitor->query_full_state(true);
 103                 }
 104                 vmonitor->save_session();
 105         }
 106
 107         /* VTL settings */
 108         node = _session->extra_xml (X_("Videotimeline"));
 109         if (!node) return;
 110         node->add_property (X_("id"), id().to_s());
 111         node->add_property (X_("Height"), editor->get_videotl_bar_height());
 112         node->add_property (X_("VideoOffsetLock"), video_offset_lock?X_("1"):X_("0"));
 113         node->add_property (X_("VideoOffset"), video_offset);
 114         node->add_property (X_("AutoFPS"), auto_set_session_fps?X_("1"):X_("0"));
 115 }
 116
 117 /* close and save settings */
 118 void
 119 VideoTimeLine::close_session ()
 120 {
 121         if (video_duration == 0) {
 122                 return;
 123         }
 124         sessionsave.disconnect();
 125         close_video_monitor();
 126
 127         remove_frames();
 128         video_filename = "";
 129         video_duration = 0;
 130         GuiUpdate("set-xjadeo-sensitive-off");
 131         GuiUpdate("video-unavailable");
 132 }
 133
 134 void
 135 VideoTimeLine::sync_session_state ()
 136 {
 137         if (!_session || !vmonitor || !vmonitor->is_started()) {
 138                 return;
 139         }
 140         save_session();
 141 }
 142
 143 /** load settings from session */
 144 void
 145 VideoTimeLine::set_session (ARDOUR::Session *s)
 146 {
 147         SessionHandlePtr::set_session (s);
 148         if (!_session) { return ; }
 149
 150         _session->SaveSession.connect_same_thread (sessionsave, boost::bind (&VideoTimeLine::save_session, this));
 151         LocaleGuard lg (X_("POSIX"));
 152
 153         XMLNode* node = _session->extra_xml (X_("Videotimeline"));
 154
 155         if (!node || !node->property (X_("Filename"))) {
 156                 return;
 157         }
 158
 159         ARDOUR_UI::instance()->start_video_server((Gtk::Window*)0, false);
 160
 161         set_id(*node);
 162
 163         const XMLProperty* proph = node->property (X_("Height"));
 164         if (proph) {
 165                 editor->set_video_timeline_height(atoi(proph->value()));
 166         }
 167 #if 0 /* TODO THINK: set FPS first time only ?! */
 168         const XMLProperty* propasfps = node->property (X_("AutoFPS"));
 169         if (propasfps) {
 170                 auto_set_session_fps = atoi(propasfps->value())?true:false;
 171         }
 172 #endif
 173
 174         const XMLProperty* propoffset = node->property (X_("VideoOffset"));
 175         if (propoffset) {
 176                 video_offset = atoll(propoffset->value());
 177                 video_offset_p = video_offset;
 178         }
 179
 180         const XMLProperty* proplock = node->property (X_("VideoOffsetLock"));
 181         if (proplock) {
 182                 video_offset_lock = atoi(proplock->value())?true:false;
 183         }
 184
 185         const XMLProperty* localfile = node->property (X_("LocalFile"));
 186         if (localfile) {
 187                 local_file = atoi(localfile->value())?true:false;
 188         }
 189
 190         const XMLProperty* propf = node->property (X_("Filename"));
 191         video_file_info(propf->value(), local_file);
 192
 193         if ((node = _session->extra_xml (X_("Videomonitor")))) {
 194                 const XMLProperty* prop = node->property (X_("active"));
 195                 if (prop && prop->value() == "yes" && found_xjadeo() && !video_filename.empty() && local_file) {
 196                         open_video_monitor();
 197                 }
 198         }
 199
 200         _session->register_with_memento_command_factory(id(), this);
 201         _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoTimeLine::parameter_changed, this, _1), gui_context());
 202 }
 203
 204 void
 205 VideoTimeLine::set_offset_locked (bool v) {
 206         if (_session && v != video_offset_lock) {
 207                 _session->set_dirty ();
 208         }
 209         video_offset_lock = v;
 210 }
 211
 212 void
 213 VideoTimeLine::toggle_offset_locked () {
 214         video_offset_lock = !video_offset_lock;
 215         if (_session) {
 216                 _session->set_dirty ();
 217         }
 218 }
 219
 220 void
 221 VideoTimeLine::save_undo ()
 222 {
 223         if (_session && video_offset_p != video_offset) {
 224                 _session->set_dirty ();
 225         }
 226         video_offset_p = video_offset;
 227 }
 228
 229 int
 230 VideoTimeLine::set_state (const XMLNode& node, int /*version*/)
 231 {
 232         LocaleGuard lg (X_("POSIX"));
 233         const XMLProperty* propoffset = node.property (X_("VideoOffset"));
 234         if (propoffset) {
 235                 video_offset = atoll(propoffset->value());
 236         }
 237         ARDOUR_UI::instance()->flush_videotimeline_cache(true);
 238         return 0;
 239 }
 240
 241 XMLNode&
 242 VideoTimeLine::get_state ()
 243 {
 244         XMLNode* node = new XMLNode (X_("Videotimeline"));
 245         LocaleGuard lg (X_("POSIX"));
 246         node->add_property (X_("VideoOffset"), video_offset_p);
 247         return *node;
 248 }
 249
 250 void
 251 VideoTimeLine::remove_frames ()
 252 {
 253         for (VideoFrames::iterator i = video_frames.begin(); i != video_frames.end(); ++i ) {
 254                 VideoImageFrame *frame = (*i);
 255                 delete frame;
 256                 (*i) = 0;
 257         }
 258         video_frames.clear();
 259 }
 260
 261 VideoImageFrame *
 262 VideoTimeLine::get_video_frame (framepos_t vfn, int cut, int rightend)
 263 {
 264         if (vfn==0) cut=0;
 265         for (VideoFrames::iterator i = video_frames.begin(); i != video_frames.end(); ++i) {
 266                 VideoImageFrame *frame = (*i);
 267                 if (abs(frame->get_video_frame_number()-vfn)<=cut
 268                     && frame->get_rightend() == rightend) { return frame; }
 269         }
 270         return 0;
 271 }
 272
 273 float
 274 VideoTimeLine::get_apv()
 275 {
 276         // XXX: dup code - TODO use this fn in update_video_timeline()
 277         float apv = -1; /* audio samples per video frame; */
 278         if (!_session) return apv;
 279
 280         if (_session->config.get_use_video_file_fps()) {
 281                 if (video_file_fps == 0 ) return apv;
 282         } else {
 283                 if (_session->timecode_frames_per_second() == 0 ) return apv;
 284         }
 285
 286         if (_session->config.get_videotimeline_pullup()) {
 287                 apv = _session->frame_rate();
 288         } else {
 289                 apv = _session->nominal_frame_rate();
 290         }
 291         if (_session->config.get_use_video_file_fps()) {
 292                 apv /= video_file_fps;
 293         } else {
 294                 apv /= _session->timecode_frames_per_second();
 295         }
 296         return apv;
 297 }
 298
 299 void
 300 VideoTimeLine::update_video_timeline()
 301 {
 302         if (!_session) return;
 303
 304         if (_session->config.get_use_video_file_fps()) {
 305                 if (video_file_fps == 0 ) return;
 306         } else {
 307                 if (_session->timecode_frames_per_second() == 0 ) return;
 308         }
 309
 310         const double samples_per_pixel = editor->get_current_zoom();
 311         const framepos_t leftmost_sample =  editor->leftmost_sample();
 312
 313         /* Outline:
 314          * 1) calculate how many frames there should be in current zoom (plus 1 page on each side)
 315          * 2) calculate first frame and distance between video-frames (according to zoom)
 316          * 3) destroy/add frames
 317          * 4) reposition existing frames
 318          * 5) assign framenumber to frames -> request/decode video.
 319          */
 320
 321         /* video-file and session properties */
 322         double display_vframe_width; /* unit: pixels ; width of one thumbnail in the timeline */
 323         float apv; /* audio samples per video frame; */
 324         framepos_t leftmost_video_frame; /* unit: video-frame number ; temporary var -> vtl_start */
 325
 326         /* variables needed to render videotimeline -- what needs to computed first */
 327         framepos_t vtl_start; /* unit: audio-samples ; first displayed video-frame */
 328         framepos_t vtl_dist;  /* unit: audio-samples ; distance between displayed video-frames */
 329         unsigned int visible_video_frames; /* number of frames that fit on current canvas */
 330
 331         if (_session->config.get_videotimeline_pullup()) {
 332                 apv = _session->frame_rate();
 333         } else {
 334                 apv = _session->nominal_frame_rate();
 335         }
 336         if (_session->config.get_use_video_file_fps()) {
 337                 apv /= video_file_fps;
 338         } else {
 339                 apv /= _session->timecode_frames_per_second();
 340         }
 341
 342         display_vframe_width = bar_height * video_aspect_ratio;
 343
 344         if (apv > samples_per_pixel * display_vframe_width) {
 345                 /* high-zoom: need space between successive video-frames */
 346                 vtl_dist = rint(apv);
 347         } else {
 348                 /* continous timeline: skip video-frames */
 349                 vtl_dist = ceil(display_vframe_width * samples_per_pixel / apv) * apv;
 350         }
 351
 352         assert (vtl_dist > 0);
 353         assert (apv > 0);
 354
 355         leftmost_video_frame = floor (floor((long double)(leftmost_sample - video_start_offset - video_offset ) / vtl_dist) * vtl_dist / apv);
 356
 357         vtl_start = rint (video_offset + video_start_offset + leftmost_video_frame * apv);
 358         visible_video_frames = 2 + ceil((double)editor->current_page_samples() / vtl_dist); /* +2 left+right partial frames */
 359
 360         /* expand timeline (cache next/prev page images) */
 361         vtl_start -= visible_video_frames * vtl_dist;
 362         visible_video_frames *=3;
 363
 364         if (vtl_start < video_offset ) {
 365                 visible_video_frames += ceil((double)vtl_start/vtl_dist);
 366                 vtl_start = video_offset;
 367         }
 368
 369         /* apply video-file constraints */
 370         if (vtl_start > video_start_offset + video_duration + video_offset ) {
 371                 visible_video_frames = 0;
 372         }
 373         /* TODO optimize: compute rather than iterate */
 374         while (visible_video_frames > 0 && vtl_start + (visible_video_frames-1) * vtl_dist >= video_start_offset + video_duration + video_offset) {
 375                 --visible_video_frames;
 376         }
 377
 378         if (flush_frames) {
 379                 remove_frames();
 380                 flush_frames=false;
 381         }
 382
 383         while (video_frames.size() < visible_video_frames) {
 384                 VideoImageFrame *frame;
 385                 frame = new VideoImageFrame(*editor, *videotl_group, display_vframe_width, bar_height, video_server_url, translated_filename());
 386                 frame->ImgChanged.connect (*this, invalidator (*this), boost::bind (&PublicEditor::queue_visual_videotimeline_update, editor), gui_context());
 387                 video_frames.push_back(frame);
 388         }
 389
 390         VideoFrames outdated_video_frames;
 391         std::list<int> remaining;
 392
 393         outdated_video_frames = video_frames;
 394
 395 #if 1
 396         /* when zoomed out, ignore shifts by +-1 frame
 397          * which can occur due to rounding errors when
 398          * scrolling to a new leftmost-audio frame.
 399          */
 400         int cut =1;
 401         if (vtl_dist/apv < 3.0) cut =0;
 402 #else
 403         int cut =0;
 404 #endif
 405
 406         for (unsigned int vfcount=0; vfcount < visible_video_frames; ++vfcount){
 407                 framepos_t vfpos = vtl_start + vfcount * vtl_dist; /* unit: audio-frames */
 408                 framepos_t vframeno = rint ( (vfpos - video_offset) / apv); /* unit: video-frames */
 409                 vfpos = (vframeno * apv ) + video_offset; /* audio-frame  corresponding to /rounded/ video-frame */
 410
 411                 int rightend = -1; /* unit: pixels */
 412                 if (vfpos + vtl_dist > video_start_offset + video_duration + video_offset) {
 413                         rightend = display_vframe_width * (video_start_offset + video_duration + video_offset - vfpos) / vtl_dist;
 414                         //printf("lf(e): %lu\n", vframeno); // XXX
 415                 }
 416                 VideoImageFrame * frame = get_video_frame(vframeno, cut, rightend);
 417                 if (frame) {
 418                   frame->set_position(vfpos);
 419                         outdated_video_frames.remove(frame);
 420                 } else {
 421                         remaining.push_back(vfcount);
 422                 }
 423         }
 424
 425         for (VideoFrames::iterator i = outdated_video_frames.begin(); i != outdated_video_frames.end(); ++i ) {
 426                 VideoImageFrame *frame = (*i);
 427                 if (remaining.empty()) {
 428                   frame->set_position(-2 * vtl_dist + leftmost_sample); /* move off screen */
 429                 } else {
 430                         int vfcount=remaining.front();
 431                         remaining.pop_front();
 432                         framepos_t vfpos = vtl_start + vfcount * vtl_dist; /* unit: audio-frames */
 433                         framepos_t vframeno = rint ((vfpos - video_offset) / apv);  /* unit: video-frames */
 434                         int rightend = -1; /* unit: pixels */
 435                         if (vfpos + vtl_dist > video_start_offset + video_duration + video_offset) {
 436                                 rightend = display_vframe_width * (video_start_offset + video_duration + video_offset - vfpos) / vtl_dist;
 437                                 //printf("lf(n): %lu\n", vframeno); // XXX
 438                         }
 439                         frame->set_position(vfpos);
 440                         frame->set_videoframe(vframeno, rightend);
 441                 }
 442         }
 443 }
 444
 445 std::string
 446 VideoTimeLine::translated_filename ()
 447 {
 448         if (!local_file){
 449                 return video_filename;
 450         } else {
 451                 return video_map_path(server_docroot, video_filename);
 452         }
 453 }
 454
 455 bool
 456 VideoTimeLine::video_file_info (std::string filename, bool local)
 457 {
 458
 459         local_file = local;
 460         if (Glib::path_is_absolute(filename) || !local_file)
 461         {
 462                 video_filename = filename;
 463         }  else {
 464                 video_filename = Glib::build_filename (_session->session_directory().video_path(), filename);
 465         }
 466
 467         long long int _duration;
 468         double _start_offset;
 469
 470         if (!video_query_info(
 471                         video_server_url, translated_filename(),
 472                         video_file_fps, _duration, _start_offset, video_aspect_ratio)) {
 473                 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 = 0;
 475                 GuiUpdate("set-xjadeo-sensitive-off");
 476                 GuiUpdate("video-unavailable");
 477                 return false;
 478         }
 479         video_duration = _duration * _session->nominal_frame_rate() / video_file_fps;
 480         video_start_offset = _start_offset * _session->nominal_frame_rate();
 481
 482         if (auto_set_session_fps && video_file_fps != _session->timecode_frames_per_second()) {
 483                 switch ((int)floorf(video_file_fps*1000.0)) {
 484                         case 23976:
 485                                 _session->config.set_timecode_format(timecode_23976);
 486                                 break;
 487                         case 24000:
 488                                 _session->config.set_timecode_format(timecode_24);
 489                                 break;
 490                         case 24975:
 491                         case 24976:
 492                                 _session->config.set_timecode_format(timecode_24976);
 493                                 break;
 494                         case 25000:
 495                                 _session->config.set_timecode_format(timecode_25);
 496                                 break;
 497                         case 29970:
 498                                 _session->config.set_timecode_format(timecode_2997drop);
 499                                 break;
 500                         case 30000:
 501                                 _session->config.set_timecode_format(timecode_30);
 502                                 break;
 503                         case 59940:
 504                                 _session->config.set_timecode_format(timecode_5994);
 505                                 break;
 506                         case 60000:
 507                                 _session->config.set_timecode_format(timecode_60);
 508                                 break;
 509                         default:
 510                                 warning << string_compose (
 511                                                 _("Failed to set session-framerate: '%1' does not have a corresponding option setting in %2."),
 512                                                 video_file_fps, PROGRAM_NAME ) << endmsg;
 513                                 break;
 514                 }
 515                 _session->config.set_video_pullup(0); /* TODO only set if set_timecode_format() was successful ?!*/
 516         }
 517         if (floor(video_file_fps*100) != floor(_session->timecode_frames_per_second()*100)) {
 518                 warning << string_compose(
 519                                 _("Video file's framerate is not equal to %1 session timecode's framerate: '%2' vs '%3'"),
 520                                         PROGRAM_NAME, video_file_fps, _session->timecode_frames_per_second())
 521                                 << endmsg;
 522         }
 523         flush_local_cache ();
 524
 525         if (found_xjadeo() && local_file) {
 526                 GuiUpdate("set-xjadeo-sensitive-on");
 527                 if (vmonitor && vmonitor->is_started()) {
 528 #if 1
 529                         /* xjadeo <= 0.6.4 has a bug where changing the video-file may segfauls
 530                          * if the geometry changes to a different line-size alignment
 531                          */
 532                         reopen_vmonitor = true;
 533                         vmonitor->quit();
 534 #else
 535                         vmonitor->set_fps(video_file_fps);
 536                         vmonitor->open(video_filename);
 537 #endif
 538                 }
 539         } else if (!local_file) {
 540 #if 1 /* temp debug/devel message */
 541                 // TODO - call xjremote remotely.
 542                 printf("the given video file can not be accessed on localhost, video monitoring is not currently supported for this case\n");
 543                 GuiUpdate("set-xjadeo-sensitive-off");
 544 #endif
 545         }
 546         VtlUpdate();
 547         GuiUpdate("video-available");
 548         return true;
 549 }
 550
 551 bool
 552 VideoTimeLine::check_server ()
 553 {
 554         bool ok = false;
 555         char url[1024];
 556         snprintf(url, sizeof(url), "%s%sstatus"
 557                         , video_server_url.c_str()
 558                         , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
 559                         );
 560         char *res=a3_curl_http_get(url, NULL);
 561         if (res) {
 562                 if (strstr(res, "status: ok, online.")) { ok = true; }
 563                 free(res);
 564         }
 565         return ok;
 566 }
 567
 568 bool
 569 VideoTimeLine::check_server_docroot ()
 570 {
 571         bool ok = true;
 572         char url[1024];
 573         std::vector<std::vector<std::string> > lines;
 574
 575         if (video_server_url.find("/localhost:") == string::npos) {
 576                 return true;
 577         }
 578         snprintf(url, sizeof(url), "%s%src?format=csv"
 579                         , video_server_url.c_str()
 580                         , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
 581                         );
 582         char *res=a3_curl_http_get(url, NULL);
 583         if (!res) {
 584                 return false;
 585         }
 586
 587         ParseCSV(std::string(res), lines);
 588         if (   lines.empty()
 589                         || lines.at(0).empty()
 590                         || lines.at(0).at(0) != video_get_docroot(Config)) {
 591                 warning << string_compose(
 592                                 _("Video-server docroot mismatch. %1: '%2', video-server: '%3'. This usually means that the video server was not started by %1 and uses a different document-root."),
 593                                 PROGRAM_NAME, video_get_docroot(Config), lines.at(0).at(0))
 594                 << endmsg;
 595                 ok = false; // TODO allow to override
 596         }
 597         free(res);
 598         return ok;
 599 }
 600
 601 void
 602 VideoTimeLine::gui_update(std::string const & t) {
 603         /* this is to be called via GuiUpdate() only. */
 604         ENSURE_GUI_THREAD (*this, &VideoTimeLine::queue_visual_videotimeline_update)
 605         if (t == "videotimeline-update") {
 606                 editor->queue_visual_videotimeline_update();
 607         } else if (t == "set-xjadeo-active-off") {
 608                 editor->toggle_xjadeo_proc(0);
 609         } else if (t == "set-xjadeo-active-on") {
 610                 editor->toggle_xjadeo_proc(1);
 611         } else if (t == "set-xjadeo-sensitive-on") {
 612                 editor->set_xjadeo_sensitive(true);
 613         } else if (t == "set-xjadeo-sensitive-off") {
 614                 editor->toggle_xjadeo_proc(0);
 615                 //close_video_monitor();
 616                 editor->set_xjadeo_sensitive(false);
 617         } else if (t == "xjadeo-window-ontop-on") {
 618                 editor->toggle_xjadeo_viewoption(1, 1);
 619         } else if (t == "xjadeo-window-ontop-off") {
 620                 editor->toggle_xjadeo_viewoption(1, 0);
 621         } else if (t == "xjadeo-window-osd-timecode-on") {
 622                 editor->toggle_xjadeo_viewoption(2, 1);
 623         } else if (t == "xjadeo-window-osd-timecode-off") {
 624                 editor->toggle_xjadeo_viewoption(2, 0);
 625         } else if (t == "xjadeo-window-osd-frame-on") {
 626                 editor->toggle_xjadeo_viewoption(3, 1);
 627         } else if (t == "xjadeo-window-osd-frame-off") {
 628                 editor->toggle_xjadeo_viewoption(3, 0);
 629         } else if (t == "xjadeo-window-osd-box-on") {
 630                 editor->toggle_xjadeo_viewoption(4, 1);
 631         } else if (t == "xjadeo-window-osd-box-off") {
 632                 editor->toggle_xjadeo_viewoption(4, 0);
 633         } else if (t == "xjadeo-window-fullscreen-on") {
 634                 editor->toggle_xjadeo_viewoption(5, 1);
 635         } else if (t == "xjadeo-window-fullscreen-off") {
 636                 editor->toggle_xjadeo_viewoption(5, 0);
 637         } else if (t == "xjadeo-window-letterbox-on") {
 638                 editor->toggle_xjadeo_viewoption(6, 1);
 639         } else if (t == "xjadeo-window-letterbox-off") {
 640                 editor->toggle_xjadeo_viewoption(6, 0);
 641         } else if (t == "video-available") {
 642                 editor->set_close_video_sensitive(true);
 643         } else if (t == "video-unavailable") {
 644                 editor->set_close_video_sensitive(false);
 645         }
 646 }
 647
 648 void
 649 VideoTimeLine::set_height (int height) {
 650         if (_session && bar_height != height) {
 651                 _session->set_dirty ();
 652         }
 653         bar_height = height;
 654         flush_local_cache();
 655 }
 656
 657 void
 658 VideoTimeLine::vmon_update () {
 659         if (vmonitor && vmonitor->is_started()) {
 660                 vmonitor->set_offset(video_offset); // TODO proper re-init xjadeo w/o restart not just offset.
 661         }
 662 }
 663
 664 void
 665 VideoTimeLine::flush_local_cache () {
 666         flush_frames = true;
 667         vmon_update();
 668 }
 669
 670 void
 671 VideoTimeLine::flush_cache () {
 672         flush_local_cache();
 673         char url[1024];
 674         snprintf(url, sizeof(url), "%s%sadmin/flush_cache"
 675                         , video_server_url.c_str()
 676                         , (video_server_url.length()>0 && video_server_url.at(video_server_url.length()-1) == '/')?"":"/"
 677                         );
 678         char *res=a3_curl_http_get(url, NULL);
 679         if (res) {
 680                 free (res);
 681         }
 682         if (vmonitor && vmonitor->is_started()) {
 683                 reopen_vmonitor=true;
 684                 vmonitor->quit();
 685         }
 686         video_file_info(video_filename, local_file);
 687 }
 688
 689 /* config */
 690 void
 691 VideoTimeLine::parameter_changed (std::string const & p)
 692 {
 693         if (p == "video-server-url") {
 694                 set_video_server_url (video_get_server_url(Config));
 695         } else if (p == "video-server-docroot") {
 696                 set_video_server_docroot (video_get_docroot(Config));
 697         } else if (p == "video-advanced-setup") {
 698                 set_video_server_url (video_get_server_url(Config));
 699                 set_video_server_docroot (video_get_docroot(Config));
 700         }
 701         if (p == "use-video-file-fps" || p == "videotimeline-pullup" ) { /* session->config parameter */
 702                 VtlUpdate();
 703         }
 704 }
 705
 706 void
 707 VideoTimeLine::set_video_server_url(std::string vsu) {
 708         flush_local_cache ();
 709         video_server_url = vsu;
 710         VtlUpdate();
 711 }
 712
 713 void
 714 VideoTimeLine::set_video_server_docroot(std::string vsr) {
 715         flush_local_cache ();
 716         server_docroot = vsr;
 717         VtlUpdate();
 718 }
 719
 720 /* video-monitor for this timeline */
 721 void
 722 VideoTimeLine::xjadeo_readversion (std::string d, size_t /* s */) {
 723         xjadeo_version += d;
 724 }
 725
 726 void
 727 VideoTimeLine::find_xjadeo () {
 728         std::string xjadeo_file_path;
 729 #ifdef PLATFORM_WINDOWS
 730         HKEY key;
 731         DWORD size = PATH_MAX;
 732         char tmp[PATH_MAX+1];
 733         const char *program_files = PBD::get_win_special_folder (CSIDL_PROGRAM_FILES);
 734 #endif
 735         if (getenv("XJREMOTE")) {
 736                 _xjadeo_bin = getenv("XJREMOTE");
 737         } else if (find_file (Searchpath(Glib::getenv("PATH")), X_("xjremote"), xjadeo_file_path)) {
 738                 _xjadeo_bin = xjadeo_file_path;
 739         }
 740 #ifdef PLATFORM_WINDOWS
 741         /* old xjadeo, typo in key <= 0.7.6 */
 742         else if ( (ERROR_SUCCESS == RegOpenKeyExA (HKEY_LOCAL_MACHINE, "Software\\RSSxjadeo", 0, KEY_READ, &key))
 743                         &&  (ERROR_SUCCESS == RegQueryValueExA (key, "Install_Dir", 0, NULL, reinterpret_cast<LPBYTE>(tmp), &size))
 744                         )
 745         {
 746                 _xjadeo_bin = std::string(g_build_filename(Glib::locale_to_utf8(tmp).c_str(), "xjadeo.exe", 0));
 747         }
 748         else if ( (ERROR_SUCCESS == RegOpenKeyExA (HKEY_LOCAL_MACHINE, "Software\\RSS\\xjadeo", 0, KEY_READ, &key))
 749                         &&  (ERROR_SUCCESS == RegQueryValueExA (key, "Install_Dir", 0, NULL, reinterpret_cast<LPBYTE>(tmp), &size))
 750                         )
 751         {
 752                 _xjadeo_bin = std::string(g_build_filename(Glib::locale_to_utf8(tmp).c_str(), "xjadeo.exe", 0));
 753         }
 754         else if (program_files && Glib::file_test(g_build_filename(program_files, "xjadeo", "xjadeo.exe", 0), Glib::FILE_TEST_EXISTS))
 755         {
 756                 _xjadeo_bin = std::string(g_build_filename(program_files, "harvid", "xjadeo.exe", 0));
 757         }
 758 #endif
 759         /* generic fallbacks to try */
 760 #ifdef __APPLE__
 761         else if (Glib::file_test(X_("/Applications/Jadeo.app/Contents/MacOS/xjremote"), Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_EXECUTABLE)) {
 762                 _xjadeo_bin = X_("/Applications/Jadeo.app/Contents/MacOS/xjremote");
 763         }
 764 #endif
 765         else if (Glib::file_test(X_("C:\\Program Files\\xjadeo\\xjadeo.exe"), Glib::FILE_TEST_EXISTS)) {
 766                 _xjadeo_bin = X_("C:\\Program Files\\xjadeo\\xjadeo.exe");
 767         }
 768         else  {
 769                 _xjadeo_bin = X_("");
 770                 warning << _("Video-monitor 'xjadeo' was not found. Please install http://xjadeo.sf.net/ "
 771                                 "(a custom path to xjadeo can be specified by setting the XJREMOTE environment variable. "
 772                                 "It should point to an application compatible with xjadeo's remote-control interface 'xjremote').\n"
 773                                 "\n"
 774                                 "see also http://manual.ardour.org/video-timeline/setup/")
 775                         << endmsg;
 776         }
 777         if (found_xjadeo ()) {
 778                 ARDOUR::SystemExec version_check(_xjadeo_bin, X_("--version"));
 779                 xjadeo_version = "";
 780                 version_check.ReadStdout.connect_same_thread (*this, boost::bind (&VideoTimeLine::xjadeo_readversion, this, _1 ,_2));
 781                 version_check.Terminated.connect_same_thread (*this, boost::bind (&VideoTimeLine::xjadeo_readversion, this, "\n" ,1));
 782                 if (version_check.start(2)) {
 783                         warning << _(
 784                                         "Video-monitor 'xjadeo' cannot be launched."
 785                                         ) << endmsg;
 786                         _xjadeo_bin = X_("");
 787                         return;
 788                 }
 789
 790                 version_check.wait ();
 791                 int timeout = 300;
 792                 while (xjadeo_version.empty() && --timeout) {
 793                         Glib::usleep(10000);
 794                 }
 795
 796                 bool v_ok = false;
 797                 size_t vo = xjadeo_version.find(" version ");
 798                 if (vo != string::npos) {
 799                         int v_major, v_minor, v_micro;
 800                         if(sscanf(xjadeo_version.substr(vo + 9, string::npos).c_str(),"%d.%d.%d",
 801                                                 &v_major, &v_minor, &v_micro) == 3)
 802                         {
 803                                 if (v_major >= 1) v_ok = true;
 804                                 else if (v_major == 0 && v_minor >= 8) v_ok = true;
 805                                 else if (v_major == 0 && v_minor >= 7 && v_micro >= 7) v_ok = true;
 806                         }
 807                 }
 808                 if (!v_ok) {
 809                         _xjadeo_bin = X_("");
 810                         warning << _(
 811                                         "Video-monitor 'xjadeo' is too old. "
 812                                         "Please install xjadeo version 0.7.7 or later. http://xjadeo.sf.net/"
 813                                         ) << endmsg;
 814                 }
 815         }
 816 }
 817
 818 void
 819 VideoTimeLine::open_video_monitor() {
 820         if (!found_xjadeo()) return;
 821         if (!vmonitor) {
 822                 vmonitor = new VideoMonitor(editor, _xjadeo_bin);
 823                 vmonitor->set_session(_session);
 824                 vmonitor->set_offset(video_offset);
 825                 vmonitor->Terminated.connect (sigc::mem_fun (*this, &VideoTimeLine::terminated_video_monitor));
 826                 vmonitor->UiState.connect (*this, invalidator (*this), boost::bind (&VideoTimeLine::gui_update, this, _1), gui_context());
 827         } else if (vmonitor->is_started()) {
 828                 return;
 829         }
 830
 831 #if 0
 832         /* unused for now.
 833          * the idea is to selective ignore certain monitor window
 834          * states if xjadeo is not running on the same host as ardour.
 835          * However with the removal of the video-monitor-startup-dialogue
 836          * (git rev 5a4d0fff0) these settings are currently not accessible.
 837          */
 838         int xj_settings_mask = vmonitor->restore_settings_mask();
 839         if (_session) {
 840                 /* load mask from Session */
 841                 XMLNode* node = _session->extra_xml (X_("XJRestoreSettings"));
 842                 if (node) {
 843                         const XMLProperty* prop = node->property (X_("mask"));
 844                         if (prop) {
 845                                 xj_settings_mask = atoi(prop->value());
 846                         }
 847                 }
 848         }
 849
 850         vmonitor->restore_settings_mask(xj_settings_mask);
 851 #endif
 852
 853         if (!vmonitor->start()) {
 854                 warning << "launching xjadeo failed.." << endmsg;
 855                 close_video_monitor();
 856         } else {
 857                 GuiUpdate("set-xjadeo-active-on");
 858                 vmonitor->set_fps(video_file_fps);
 859                 vmonitor->open(video_filename);
 860
 861                 if (_session) {
 862                         XMLNode* node = _session->extra_xml (X_("Videomonitor"));
 863                         if (node) {
 864                                 const XMLProperty* prop = node->property (X_("active"));
 865                                 if (prop && prop->value() != "yes") _session->set_dirty ();
 866                         } else {
 867                                 _session->set_dirty ();
 868                         }
 869                 }
 870
 871         }
 872 }
 873
 874 void
 875 VideoTimeLine::close_video_monitor() {
 876         if (vmonitor && vmonitor->is_started()) {
 877                 vmonitor->quit();
 878         }
 879 }
 880
 881 void
 882 VideoTimeLine::control_video_monitor(int what, int param) {
 883         if (!vmonitor || !vmonitor->is_started()) {
 884                 return;
 885         }
 886         vmonitor->send_cmd(what, param);
 887 }
 888
 889
 890 void
 891 VideoTimeLine::terminated_video_monitor () {
 892         if (vmonitor) {
 893                 vmonitor->save_session();
 894                 delete vmonitor;
 895         }
 896         vmonitor=0;
 897         GuiUpdate("set-xjadeo-active-off");
 898         if (reopen_vmonitor) {
 899                 reopen_vmonitor=false;
 900                 open_video_monitor();
 901         } else {
 902                 if (_session) {
 903                         _session->set_dirty ();
 904                 }
 905         }
 906 }
 907
 908 void
 909 VideoTimeLine::manual_seek_video_monitor (framepos_t pos)
 910 {
 911         if (!vmonitor) { return; }
 912         if (!vmonitor->is_started()) { return; }
 913         if (!vmonitor->synced_by_manual_seeks()) { return; }
 914         vmonitor->manual_seek(pos, false, video_offset); // XXX -> set offset in xjadeo
 915 }