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