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