gtk2_ardour/video_monitor.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 "pbd/file_utils.h"
  21 #include "pbd/convert.h"
  22 #include "gui_thread.h"
  23 #include "timers.h"
  24 #include "utils.h"
  25
  26 #include <stdio.h>
  27 #include "public_editor.h"
  28 #include "editor.h"
  29 #include "video_monitor.h"
  30
  31 #include "pbd/i18n.h"
  32
  33 using namespace std;
  34 using namespace PBD;
  35 using namespace ARDOUR_UI_UTILS;
  36
  37 VideoMonitor::VideoMonitor (PublicEditor *ed, std::string xjadeo_bin_path)
  38         : editor (ed)
  39 {
  40         manually_seeked_frame = 0;
  41         fps =0.0; // = _session->timecode_frames_per_second();
  42         sync_by_manual_seek = true;
  43         _restore_settings_mask = 0;
  44         clock_connection = sigc::connection();
  45         state_connection = sigc::connection();
  46         debug_enable = false;
  47         state_clk_divide = 0;
  48         starting = 0;
  49         osdmode = 10; // 1: frameno, 2: timecode, 8: box
  50
  51         process = new ARDOUR::SystemExec(xjadeo_bin_path, X_("-R -J"));
  52         process->ReadStdout.connect_same_thread (*this, boost::bind (&VideoMonitor::parse_output, this, _1 ,_2));
  53         process->Terminated.connect (*this, invalidator (*this), boost::bind (&VideoMonitor::terminated, this), gui_context());
  54         XJKeyEvent.connect (*this, invalidator (*this), boost::bind (&VideoMonitor::forward_keyevent, this, _1), gui_context());
  55 }
  56
  57 VideoMonitor::~VideoMonitor ()
  58 {
  59         if (clock_connection.connected()) {
  60                 clock_connection.disconnect();
  61         }
  62         if (state_connection.connected()) {
  63                 state_connection.disconnect();
  64         }
  65         delete process;
  66 }
  67
  68 bool
  69 VideoMonitor::start ()
  70 {
  71         if (is_started()) {
  72                 return true;
  73         }
  74
  75         manually_seeked_frame = 0;
  76         sync_by_manual_seek = false;
  77         if (clock_connection.connected()) { clock_connection.disconnect(); }
  78
  79         if (process->start(debug_enable?2:1)) {
  80                 return false;
  81         }
  82         return true;
  83 }
  84
  85 void
  86 VideoMonitor::query_full_state (bool wait)
  87 {
  88         knownstate = 0;
  89         process->write_to_stdin("get windowsize\n");
  90         process->write_to_stdin("get windowpos\n");
  91         process->write_to_stdin("get letterbox\n");
  92         process->write_to_stdin("get fullscreen\n");
  93         process->write_to_stdin("get ontop\n");
  94         process->write_to_stdin("get offset\n");
  95         process->write_to_stdin("get osdcfg\n");
  96         int timeout = 40;
  97         if (wait && knownstate !=127 && --timeout) {
  98                 Glib::usleep(50000);
  99                 sched_yield();
 100         }
 101 }
 102
 103 void
 104 VideoMonitor::quit ()
 105 {
 106         if (!is_started()) return;
 107         if (state_connection.connected()) { state_connection.disconnect(); }
 108         if (clock_connection.connected()) { clock_connection.disconnect(); }
 109         query_full_state(true);
 110         process->write_to_stdin("quit\n");
 111         /* the 'quit' command should result in process termination
 112          * but in case it fails (communication failure, SIGSTOP, ??)
 113          * here's a timeout..
 114          */
 115         int timeout = 40;
 116         while (is_started() && --timeout) {
 117                 Glib::usleep(50000);
 118                 sched_yield();
 119         }
 120         if (timeout <= 0) {
 121                 process->terminate();
 122         }
 123 }
 124
 125 void
 126 VideoMonitor::open (std::string filename)
 127 {
 128         if (!is_started()) return;
 129         manually_seeked_frame = 0;
 130         osdmode = 10; // 1: frameno, 2: timecode, 8: box
 131         starting = 15;
 132         process->write_to_stdin("load " + filename + "\n");
 133         process->write_to_stdin("set fps -1\n");
 134         process->write_to_stdin("window resize 100%\n");
 135         process->write_to_stdin("window ontop on\n");
 136         process->write_to_stdin("set seekmode 1\n");
 137         /* override bitwise flags -- see xjadeo.h
 138          * 0x0001 : ignore 'q', ESC  / quit
 139          * 0x0002 : ignore "window closed by WM" / quit
 140          * 0x0004 : (osx only) menu-exit / quit
 141          * 0x0008 : ignore mouse-button 1 -- resize
 142          * 0x0010 : no A/V offset control with keyboard
 143          * 0x0020 : don't use jack-session
 144          * 0x0040 : disable jack transport control
 145          * 0x0080 : disallow sync source change (OSX menu)
 146          * 0x0100 : disallow file open (OSX menu, X11 DnD)
 147          */
 148         process->write_to_stdin("set override 504\n");
 149         process->write_to_stdin("notify keyboard\n");
 150         process->write_to_stdin("notify settings\n");
 151         process->write_to_stdin("window letterbox on\n");
 152         process->write_to_stdin("osd mode 10\n");
 153         for(XJSettings::const_iterator it = xjadeo_settings.begin(); it != xjadeo_settings.end(); ++it) {
 154                 if (skip_setting(it->first)) { continue; }
 155                 process->write_to_stdin(it->first + " " + it->second + "\n");
 156         }
 157         if (!state_connection.connected()) {
 158                 starting = 15;
 159                 querystate();
 160                 state_clk_divide = 0;
 161                 /* TODO once every two second or so -- state_clk_divide hack below */
 162                 state_connection = Timers::rapid_connect (sigc::mem_fun (*this, &VideoMonitor::querystate));
 163         }
 164         sync_by_manual_seek = true;
 165         clock_connection = Timers::fps_connect (sigc::mem_fun (*this, &VideoMonitor::srsupdate));
 166         xjadeo_sync_setup();
 167 }
 168
 169 void
 170 VideoMonitor::querystate ()
 171 {
 172         /* clock-divider hack -- RapidScreenUpdate == every_point_one_seconds */
 173         state_clk_divide = (state_clk_divide + 1) % 300; // 30 secs
 174         if (state_clk_divide == 0) {
 175                 // every 30 seconds
 176                 query_full_state(false);
 177                 return;
 178         }
 179         if (state_clk_divide%25 != 0) {
 180                 return;
 181         }
 182         // every 2.5 seconds:
 183         process->write_to_stdin("get fullscreen\n");
 184         process->write_to_stdin("get ontop\n");
 185         process->write_to_stdin("get osdcfg\n");
 186         process->write_to_stdin("get letterbox\n");
 187 }
 188
 189 bool
 190 VideoMonitor::skip_setting (std::string which)
 191 {
 192         if (_restore_settings_mask & XJ_OSD && which == "osd mode") { return true; }
 193         if (_restore_settings_mask & XJ_LETTERBOX && which == "window letterbox") { return true; }
 194         if (_restore_settings_mask & XJ_WINDOW_SIZE && which == "window size") { return true; }
 195         if (_restore_settings_mask & XJ_WINDOW_POS && which == "window xy") { return true; }
 196         if (_restore_settings_mask & XJ_WINDOW_ONTOP && which == "window ontop") { return true; }
 197         if (_restore_settings_mask & XJ_LETTERBOX && which == "window letterbox") { return true; }
 198         if (_restore_settings_mask & XJ_OFFSET && which == "set offset") { return true; }
 199         if (_restore_settings_mask & XJ_FULLSCREEN && which == "window zoom") { return true; }
 200         return false;
 201 }
 202
 203 void
 204 VideoMonitor::send_cmd (int what, int param)
 205 {
 206         bool osd_update = false;
 207         int prev_osdmode = osdmode;
 208         if (!is_started()) return;
 209         switch (what) {
 210                 case 1:
 211                         if (param) process->write_to_stdin("window ontop on\n");
 212                         else process->write_to_stdin("window ontop off\n");
 213                         break;
 214                 case 2:
 215                         if (param) osdmode |= 2;
 216                         else osdmode &= ~2;
 217                         osd_update = (prev_osdmode != osdmode);
 218                         break;
 219                 case 3:
 220                         if (param) osdmode |= 1;
 221                         else osdmode &= ~1;
 222                         osd_update = (prev_osdmode != osdmode);
 223                         break;
 224                 case 4:
 225                         if (param) osdmode |= 8;
 226                         else osdmode &= ~8;
 227                         osd_update = (prev_osdmode != osdmode);
 228                         break;
 229                 case 5:
 230                         if (param) process->write_to_stdin("window zoom on\n");
 231                         else process->write_to_stdin("window zoom off\n");
 232                         break;
 233                 case 6:
 234                         if (param) process->write_to_stdin("window letterbox on\n");
 235                         else process->write_to_stdin("window letterbox off\n");
 236                         break;
 237                 case 7:
 238                         process->write_to_stdin("window resize 100%");
 239                         break;
 240                 default:
 241                         break;
 242         }
 243         if (osd_update) {
 244                 std::ostringstream osstream; osstream << "osd mode " << osdmode << "\n";
 245                 process->write_to_stdin(osstream.str());
 246         }
 247 }
 248
 249 bool
 250 VideoMonitor::is_started ()
 251 {
 252         return process->is_running();
 253 }
 254
 255 void
 256 VideoMonitor::forward_keyevent (unsigned int keyval)
 257 {
 258         emulate_key_event (keyval);
 259 }
 260
 261 void
 262 VideoMonitor::parse_output (std::string d, size_t /*s*/)
 263 {
 264         std::string line = d;
 265         std::string::size_type start = 0;
 266         std::string::size_type end = 0;
 267
 268         while (1) {
 269                 end = d.find('\n', start);
 270                 if (end == std::string::npos) break;
 271                 line = d.substr(start,end-start);
 272                 start=end+1;
 273                 if (line.length() <4 || line.at(0)!='@') continue;
 274 #if 1 /* DEBUG */
 275                 if (debug_enable) {
 276                         printf("xjadeo: '%s'\n", line.c_str());
 277                 }
 278 #endif
 279                 int status = atoi(line.substr(1,3));
 280                 switch(status / 100) {
 281                         case 4: /* errors */
 282                                 if (status == 403) {
 283                                         PBD::warning << _("Video Monitor: File Not Found.") << endmsg;
 284                                         /* check: we should only write from the main thread.
 285                                          * However it should not matter for 'quit'.
 286                                          */
 287                                         process->write_to_stdin("quit\n");
 288                                 }
 289 #ifdef DEBUG_XJCOM
 290                         else
 291                                 printf("xjadeo: error '%s'\n", line.c_str());
 292 #endif
 293                         break;
 294                         case 3: /* async notifications */
 295                         {
 296                                 std::string::size_type equalsign = line.find('=');
 297                                 std::string::size_type comment = line.find('#');
 298                                 if (comment != std::string::npos) { line = line.substr(0,comment); }
 299                                 if (equalsign != std::string::npos) {
 300                                         std::string key = line.substr(5, equalsign - 5);
 301                                         std::string value = line.substr(equalsign + 1);
 302
 303                                         if (status == 310 && key=="keypress") {
 304                                                 /* keyboard event */
 305                                                 XJKeyEvent((unsigned int)atoi(value));
 306                                         }
 307 #ifdef DEBUG_XJCOM
 308                                         else {
 309                                                 std::string msg = line.substr(5);
 310                                                 printf("xjadeo: async '%s' -> '%s'\n", key, value);
 311                                         }
 312 #endif
 313                                 }
 314 #ifdef DEBUG_XJCOM
 315                                 else {
 316                                         std::string msg = line.substr(5);
 317                                         printf("xjadeo: async '%s'\n", msg.c_str());
 318                                 }
 319 #endif
 320                         } break;
 321                         case 1: /* text messages - command reply */
 322                                 break;
 323                         case 8: /* comments / info for humans */
 324                                 break;
 325                         case 2:
 326 /* replies:
 327  * 201: var=<int>
 328  * 202: var=<double>
 329  * 210: var=<int>x<int>
 330  * 220: var=<string>
 331  * 228: var=<smpte-string>
 332  */
 333                         {
 334                                 std::string::size_type equalsign = line.find('=');
 335                                 std::string::size_type comment = line.find('#');
 336                                 if (comment != std::string::npos) { line = line.substr(0,comment); }
 337                                 if (equalsign != std::string::npos) {
 338                                         std::string key = line.substr(5, equalsign - 5);
 339                                         std::string value = line.substr(equalsign + 1);
 340 #if 0 /* DEBUG */
 341                                         std::cout << "parsed: " << key << " => " << value << std::endl;
 342 #endif
 343                                         if       (key ==  "windowpos") {
 344                                                 knownstate |= 16;
 345                                                 if (xjadeo_settings["window xy"] != value) {
 346                                                         if (!starting && _session) _session->set_dirty ();
 347                                                 }
 348                                                 xjadeo_settings["window xy"] = value;
 349                                         } else if(key ==  "windowsize") {
 350                                                 knownstate |= 32;
 351                                                 if (xjadeo_settings["window size"] != value) {
 352                                                         if (!starting && _session) _session->set_dirty ();
 353                                                 }
 354                                                 xjadeo_settings["window size"] = value;
 355                                         } else if(key ==  "windowontop") {
 356                                                 knownstate |= 2;
 357                                                 if (starting || xjadeo_settings["window ontop"] != value) {
 358                                                         if (!starting && _session) _session->set_dirty ();
 359                                                         if (atoi(value)) { UiState("xjadeo-window-ontop-on"); }
 360                                                         else { UiState("xjadeo-window-ontop-off"); }
 361                                                         starting &= ~2;
 362                                                 }
 363                                                 xjadeo_settings["window ontop"] = value;
 364                                         } else if(key ==  "fullscreen") {
 365                                                 knownstate |= 4;
 366                                                 if (starting || xjadeo_settings["window zoom"] != value) {
 367                                                         if (!starting && _session) _session->set_dirty ();
 368                                                         if (atoi(value)) { UiState("xjadeo-window-fullscreen-on"); }
 369                                                         else { UiState("xjadeo-window-fullscreen-off"); }
 370                                                         starting &= ~4;
 371                                                 }
 372                                                 xjadeo_settings["window zoom"] = value;
 373                                         } else if(key ==  "letterbox") {
 374                                                 knownstate |= 8;
 375                                                 if (starting || xjadeo_settings["window letterbox"] != value) {
 376                                                         if (!starting && _session) _session->set_dirty ();
 377                                                         if (atoi(value)) { UiState("xjadeo-window-letterbox-on"); }
 378                                                         else { UiState("xjadeo-window-letterbox-off"); }
 379                                                         starting &= ~8;
 380                                                 }
 381                                                 xjadeo_settings["window letterbox"] = value;
 382                                         } else if(key ==  "osdmode") {
 383                                                 knownstate |= 1;
 384                                                 osdmode = atoi(value);
 385                                                 if (starting || atoi(xjadeo_settings["osd mode"]) != osdmode) {
 386                                                         if (!starting && _session) _session->set_dirty ();
 387                                                         if ((osdmode & 1) == 1) { UiState("xjadeo-window-osd-frame-on"); }
 388                                                         if ((osdmode & 1) == 0) { UiState("xjadeo-window-osd-frame-off"); }
 389                                                         if ((osdmode & 2) == 2) { UiState("xjadeo-window-osd-timecode-on"); }
 390                                                         if ((osdmode & 2) == 0) { UiState("xjadeo-window-osd-timecode-off"); }
 391                                                         if ((osdmode & 8) == 8) { UiState("xjadeo-window-osd-box-on"); }
 392                                                         if ((osdmode & 8) == 0) { UiState("xjadeo-window-osd-box-off"); }
 393                                                 }
 394                                                 starting &= ~1;
 395                                                 xjadeo_settings["osd mode"] = value;
 396                                         } else if(key ==  "offset") {
 397                                                 knownstate |= 64;
 398                                                 if (xjadeo_settings["set offset"] != value) {
 399                                                         if (!starting && _session) _session->set_dirty ();
 400                                                 }
 401                                                 xjadeo_settings["set offset"] = value;
 402 #ifdef DEBUG_XJCOM
 403                                         } else {
 404                                                 printf("xjadeo: '%s' -> '%s'\n", key.c_str(), value.c_str());
 405 #endif
 406                                         }
 407                                 }
 408                         }
 409                                 break;
 410                         default:
 411                                 break;
 412                 }
 413         }
 414 }
 415
 416 void
 417 VideoMonitor::terminated ()
 418 {
 419         process->terminate(); // from gui-context clean up
 420         Terminated();
 421 }
 422
 423 void
 424 VideoMonitor::save_session ()
 425 {
 426         if (!_session) { return; }
 427         XMLNode* node = _session->extra_xml (X_("XJSettings"), true);
 428         if (!node) return;
 429         node->remove_nodes_and_delete("XJSetting");
 430
 431         for(XJSettings::const_iterator it = xjadeo_settings.begin(); it != xjadeo_settings.end(); ++it) {
 432           XMLNode* child = node->add_child (X_("XJSetting"));
 433                 child->add_property (X_("k"), it->first);
 434                 child->add_property (X_("v"), it->second);
 435         }
 436 }
 437
 438
 439 void
 440 VideoMonitor::set_session (ARDOUR::Session *s)
 441 {
 442         SessionHandlePtr::set_session (s);
 443         if (!_session) { return; }
 444         _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoMonitor::parameter_changed, this, _1), gui_context());
 445         XMLNode* node = _session->extra_xml (X_("XJSettings"));
 446         if (!node) { return;}
 447         xjadeo_settings.clear();
 448
 449         XMLNodeList nlist = node->children();
 450         XMLNodeConstIterator niter;
 451         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 452                 xjadeo_settings[(*niter)->property(X_("k"))->value()] = (*niter)->property(X_("v"))->value();
 453   }
 454 }
 455
 456 bool
 457 VideoMonitor::set_custom_setting (const std::string k, const std::string v)
 458 {
 459         xjadeo_settings[k] = v;
 460         return true; /* TODO: check if key is valid */
 461 }
 462
 463 const std::string
 464 VideoMonitor::get_custom_setting (const std::string k)
 465 {
 466         return (xjadeo_settings[k]);
 467 }
 468
 469 #define NO_OFFSET (ARDOUR::max_framepos) //< skip setting or modifying offset
 470 void
 471 VideoMonitor::srsupdate ()
 472 {
 473         if (!_session) { return; }
 474         if (editor->dragging_playhead()) { return ;}
 475         manual_seek(_session->audible_frame(), false, NO_OFFSET);
 476 }
 477
 478 void
 479 VideoMonitor::set_offset (ARDOUR::frameoffset_t offset)
 480 {
 481         if (!is_started()) { return; }
 482         if (!_session) { return; }
 483         if (offset == NO_OFFSET ) { return; }
 484
 485         framecnt_t video_frame_offset;
 486         framecnt_t audio_sample_rate;
 487         if (_session->config.get_videotimeline_pullup()) {
 488                 audio_sample_rate = _session->frame_rate();
 489         } else {
 490                 audio_sample_rate = _session->nominal_frame_rate();
 491         }
 492
 493         /* Note: pull-up/down are applied here: frame_rate() vs. nominal_frame_rate() */
 494         if (_session->config.get_use_video_file_fps()) {
 495                 video_frame_offset = floor(offset * fps / audio_sample_rate);
 496         } else {
 497                 video_frame_offset = floor(offset * _session->timecode_frames_per_second() / audio_sample_rate);
 498         }
 499
 500         if (video_offset == video_frame_offset) { return; }
 501         video_offset = video_frame_offset;
 502
 503         std::ostringstream osstream1; osstream1 << -1 * video_frame_offset;
 504         process->write_to_stdin("set offset " + osstream1.str() + "\n");
 505 }
 506
 507 void
 508 VideoMonitor::manual_seek (framepos_t when, bool /*force*/, ARDOUR::frameoffset_t offset)
 509 {
 510         if (!is_started()) { return; }
 511         if (!_session) { return; }
 512         framecnt_t video_frame;
 513         framecnt_t audio_sample_rate;
 514         if (_session->config.get_videotimeline_pullup()) {
 515                 audio_sample_rate = _session->frame_rate();
 516         } else {
 517                 audio_sample_rate = _session->nominal_frame_rate();
 518         }
 519
 520         /* Note: pull-up/down are applied here: frame_rate() vs. nominal_frame_rate() */
 521         if (_session->config.get_use_video_file_fps()) {
 522                 video_frame = floor(when * fps / audio_sample_rate);
 523         } else {
 524                 video_frame = floor(when * _session->timecode_frames_per_second() / audio_sample_rate);
 525         }
 526         if (video_frame < 0 ) video_frame = 0;
 527
 528         if (video_frame == manually_seeked_frame) { return; }
 529         manually_seeked_frame = video_frame;
 530
 531 #if 0 /* DEBUG */
 532         std::cout <<"seek: " << video_frame << std::endl;
 533 #endif
 534         std::ostringstream osstream; osstream << video_frame;
 535         process->write_to_stdin("seek " + osstream.str() + "\n");
 536
 537         set_offset(offset);
 538 }
 539
 540 void
 541 VideoMonitor::parameter_changed (std::string const & p)
 542 {
 543         if (!is_started()) { return; }
 544         if (!_session) { return; }
 545         if (p != "external-sync" && p != "sync-source") {
 546                 return;
 547         }
 548         xjadeo_sync_setup();
 549 }
 550
 551 void
 552 VideoMonitor::xjadeo_sync_setup ()
 553 {
 554         if (!is_started()) { return; }
 555         if (!_session) { return; }
 556
 557         bool my_manual_seek = true;
 558         if (_session->config.get_external_sync()) {
 559                 if (ARDOUR::Config->get_sync_source() == ARDOUR::Engine)
 560                         my_manual_seek = false;
 561         }
 562
 563         if (my_manual_seek != sync_by_manual_seek) {
 564                 if (sync_by_manual_seek) {
 565                         if (clock_connection.connected()) {
 566                                 clock_connection.disconnect();
 567                         }
 568                         process->write_to_stdin("jack connect\n");
 569                 } else {
 570                         process->write_to_stdin("jack disconnect\n");
 571                         clock_connection = Timers::fps_connect (sigc::mem_fun (*this, &VideoMonitor::srsupdate));
 572                 }
 573                 sync_by_manual_seek = my_manual_seek;
 574         }
 575 }