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                 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                 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         if (!is_started()) return;
 204         switch (what) {
 205                 case 1:
 206                         if (param) process->write_to_stdin("window ontop on\n");
 207                         else process->write_to_stdin("window ontop off\n");
 208                         break;
 209                 case 2:
 210                         if (param) osdmode |= 2;
 211                         else osdmode &= ~2;
 212                         osd_update = true;
 213                         break;
 214                 case 3:
 215                         if (param) osdmode |= 1;
 216                         else osdmode &= ~1;
 217                         osd_update = true;
 218                         break;
 219                 case 4:
 220                         if (param) osdmode |= 8;
 221                         else osdmode &= ~8;
 222                         osd_update = true;
 223                         break;
 224                 case 5:
 225                         if (param) process->write_to_stdin("window zoom on\n");
 226                         else process->write_to_stdin("window zoom off\n");
 227                         break;
 228                 case 6:
 229                         if (param) process->write_to_stdin("window letterbox on\n");
 230                         else process->write_to_stdin("window letterbox off\n");
 231                         break;
 232                 case 7:
 233                         process->write_to_stdin("window resize 100%");
 234                         break;
 235                 default:
 236                         break;
 237         }
 238         if (osd_update >= 0) {
 239                 std::ostringstream osstream; osstream << "osd mode " << osdmode << "\n";
 240                 process->write_to_stdin(osstream.str());
 241         }
 242 }
 243
 244 bool
 245 VideoMonitor::is_started ()
 246 {
 247         return process->is_running();
 248 }
 249
 250 void
 251 VideoMonitor::forward_keyevent (unsigned int keyval)
 252 {
 253         Editor* ed = dynamic_cast<Editor*>(&PublicEditor::instance());
 254         if (!ed) return;
 255         emulate_key_event(ed, keyval);
 256 }
 257
 258 void
 259 VideoMonitor::parse_output (std::string d, size_t /*s*/)
 260 {
 261         std::string line = d;
 262         std::string::size_type start = 0;
 263         std::string::size_type end = 0;
 264
 265         while (1) {
 266                 end = d.find('\n', start);
 267                 if (end == std::string::npos) break;
 268                 line = d.substr(start,end-start);
 269                 start=end+1;
 270                 if (line.length() <4 || line.at(0)!='@') continue;
 271 #if 1 /* DEBUG */
 272                 if (debug_enable) {
 273                         printf("xjadeo: '%s'\n", line.c_str());
 274                 }
 275 #endif
 276                 int status = atoi(line.substr(1,3));
 277                 switch(status / 100) {
 278                         case 4: /* errors */
 279                                 if (status == 403) {
 280                                         PBD::warning << _("Video Monitor: File Not Found.") << endmsg;
 281                                         /* check: we should only write from the main thread.
 282                                          * However it should not matter for 'quit'.
 283                                          */
 284                                         process->write_to_stdin("quit\n");
 285                                 }
 286 #ifdef DEBUG_XJCOM
 287                         else
 288                                 printf("xjadeo: error '%s'\n", line.c_str());
 289 #endif
 290                         break;
 291                         case 3: /* async notifications */
 292                         {
 293                                 std::string::size_type equalsign = line.find('=');
 294                                 std::string::size_type comment = line.find('#');
 295                                 if (comment != std::string::npos) { line = line.substr(0,comment); }
 296                                 if (equalsign != std::string::npos) {
 297                                         std::string key = line.substr(5, equalsign - 5);
 298                                         std::string value = line.substr(equalsign + 1);
 299
 300                                         if (status == 310 && key=="keypress") {
 301                                                 /* keyboard event */
 302                                                 XJKeyEvent((unsigned int)atoi(value));
 303                                         }
 304 #ifdef DEBUG_XJCOM
 305                                         else {
 306                                                 std::string msg = line.substr(5);
 307                                                 printf("xjadeo: async '%s' -> '%s'\n", key, value);
 308                                         }
 309 #endif
 310                                 }
 311 #ifdef DEBUG_XJCOM
 312                                 else {
 313                                         std::string msg = line.substr(5);
 314                                         printf("xjadeo: async '%s'\n", msg.c_str());
 315                                 }
 316 #endif
 317                         } break;
 318                         case 1: /* text messages - command reply */
 319                                 break;
 320                         case 8: /* comments / info for humans */
 321                                 break;
 322                         case 2:
 323 /* replies:
 324  * 201: var=<int>
 325  * 202: var=<double>
 326  * 210: var=<int>x<int>
 327  * 220: var=<string>
 328  * 228: var=<smpte-string>
 329  */
 330                         {
 331                                 std::string::size_type equalsign = line.find('=');
 332                                 std::string::size_type comment = line.find('#');
 333                                 if (comment != std::string::npos) { line = line.substr(0,comment); }
 334                                 if (equalsign != std::string::npos) {
 335                                         std::string key = line.substr(5, equalsign - 5);
 336                                         std::string value = line.substr(equalsign + 1);
 337 #if 0 /* DEBUG */
 338                                         std::cout << "parsed: " << key << " => " << value << std::endl;
 339 #endif
 340                                         if       (key ==  "windowpos") {
 341                                                 knownstate |= 16;
 342                                                 if (xjadeo_settings["window xy"] != value) {
 343                                                         if (!starting && _session) _session->set_dirty ();
 344                                                 }
 345                                                 xjadeo_settings["window xy"] = value;
 346                                         } else if(key ==  "windowsize") {
 347                                                 knownstate |= 32;
 348                                                 if (xjadeo_settings["window size"] != value) {
 349                                                         if (!starting && _session) _session->set_dirty ();
 350                                                 }
 351                                                 xjadeo_settings["window size"] = value;
 352                                         } else if(key ==  "windowontop") {
 353                                                 knownstate |= 2;
 354                                                 if (starting || xjadeo_settings["window ontop"] != value) {
 355                                                         if (!starting && _session) _session->set_dirty ();
 356                                                         if (atoi(value)) { UiState("xjadeo-window-ontop-on"); }
 357                                                         else { UiState("xjadeo-window-ontop-off"); }
 358                                                         starting &= ~2;
 359                                                 }
 360                                                 xjadeo_settings["window ontop"] = value;
 361                                         } else if(key ==  "fullscreen") {
 362                                                 knownstate |= 4;
 363                                                 if (starting || xjadeo_settings["window zoom"] != value) {
 364                                                         if (!starting && _session) _session->set_dirty ();
 365                                                         if (atoi(value)) { UiState("xjadeo-window-fullscreen-on"); }
 366                                                         else { UiState("xjadeo-window-fullscreen-off"); }
 367                                                         starting &= ~4;
 368                                                 }
 369                                                 xjadeo_settings["window zoom"] = value;
 370                                         } else if(key ==  "letterbox") {
 371                                                 knownstate |= 8;
 372                                                 if (starting || xjadeo_settings["window letterbox"] != value) {
 373                                                         if (!starting && _session) _session->set_dirty ();
 374                                                         if (atoi(value)) { UiState("xjadeo-window-letterbox-on"); }
 375                                                         else { UiState("xjadeo-window-letterbox-off"); }
 376                                                         starting &= ~8;
 377                                                 }
 378                                                 xjadeo_settings["window letterbox"] = value;
 379                                         } else if(key ==  "osdmode") {
 380                                                 knownstate |= 1;
 381                                                 osdmode = atoi(value);
 382                                                 if (starting || atoi(xjadeo_settings["osd mode"]) != osdmode) {
 383                                                         if (!starting && _session) _session->set_dirty ();
 384                                                         if ((osdmode & 1) == 1) { UiState("xjadeo-window-osd-frame-on"); }
 385                                                         if ((osdmode & 1) == 0) { UiState("xjadeo-window-osd-frame-off"); }
 386                                                         if ((osdmode & 2) == 2) { UiState("xjadeo-window-osd-timecode-on"); }
 387                                                         if ((osdmode & 2) == 0) { UiState("xjadeo-window-osd-timecode-off"); }
 388                                                         if ((osdmode & 8) == 8) { UiState("xjadeo-window-osd-box-on"); }
 389                                                         if ((osdmode & 8) == 0) { UiState("xjadeo-window-osd-box-off"); }
 390                                                 }
 391                                                 starting &= ~1;
 392                                                 xjadeo_settings["osd mode"] = value;
 393                                         } else if(key ==  "offset") {
 394                                                 knownstate |= 64;
 395                                                 if (xjadeo_settings["set offset"] != value) {
 396                                                         if (!starting && _session) _session->set_dirty ();
 397                                                 }
 398                                                 xjadeo_settings["set offset"] = value;
 399 #ifdef DEBUG_XJCOM
 400                                         } else {
 401                                                 printf("xjadeo: '%s' -> '%s'\n", key.c_str(), value.c_str());
 402 #endif
 403                                         }
 404                                 }
 405                         }
 406                                 break;
 407                         default:
 408                                 break;
 409                 }
 410         }
 411 }
 412
 413 void
 414 VideoMonitor::terminated ()
 415 {
 416         process->terminate(); // from gui-context clean up
 417         Terminated();
 418 }
 419
 420 void
 421 VideoMonitor::save_session ()
 422 {
 423         if (!_session) { return; }
 424         XMLNode* node = _session->extra_xml (X_("XJSettings"));
 425         if (!node) return;
 426
 427         for(XJSettings::const_iterator it = xjadeo_settings.begin(); it != xjadeo_settings.end(); ++it) {
 428           XMLNode* child = node->add_child (X_("XJSetting"));
 429                 child->add_property (X_("k"), it->first);
 430                 child->add_property (X_("v"), it->second);
 431         }
 432 }
 433
 434
 435 void
 436 VideoMonitor::set_session (ARDOUR::Session *s)
 437 {
 438         SessionHandlePtr::set_session (s);
 439         if (!_session) { return; }
 440         _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoMonitor::parameter_changed, this, _1), gui_context());
 441         XMLNode* node = _session->extra_xml (X_("XJSettings"));
 442         if (!node) { return;}
 443         xjadeo_settings.clear();
 444
 445         XMLNodeList nlist = node->children();
 446         XMLNodeConstIterator niter;
 447         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 448                 xjadeo_settings[(*niter)->property(X_("k"))->value()] = (*niter)->property(X_("v"))->value();
 449   }
 450 }
 451
 452 void
 453 VideoMonitor::clear_session_state ()
 454 {
 455         xjadeo_settings.clear();
 456         if (!_session) { return; }
 457         XMLNode* node = new XMLNode(X_("XJSettings"));
 458         _session->add_extra_xml (*node);
 459         _session->set_dirty ();
 460 }
 461
 462 bool
 463 VideoMonitor::set_custom_setting (const std::string k, const std::string v)
 464 {
 465         xjadeo_settings[k] = v;
 466         return true; /* TODO: check if key is valid */
 467 }
 468
 469 const std::string
 470 VideoMonitor::get_custom_setting (const std::string k)
 471 {
 472         return (xjadeo_settings[k]);
 473 }
 474
 475 #define NO_OFFSET (1<<31) //< skip setting or modifying offset --  TODO check ARDOUR::frameoffset_t max value.
 476 void
 477 VideoMonitor::srsupdate ()
 478 {
 479         if (!_session) { return; }
 480         if (editor->dragging_playhead()) { return ;}
 481         manual_seek(_session->audible_frame(), false, NO_OFFSET);
 482 }
 483
 484 void
 485 VideoMonitor::set_offset (ARDOUR::frameoffset_t offset)
 486 {
 487         if (!is_started()) { return; }
 488         if (!_session) { return; }
 489         if (offset == NO_OFFSET ) { return; }
 490
 491         framecnt_t video_frame_offset;
 492         framecnt_t audio_frame_rate;
 493         if (_session->config.get_videotimeline_pullup()) {
 494                 audio_frame_rate = _session->frame_rate();
 495         } else {
 496                 audio_frame_rate = _session->nominal_frame_rate();
 497         }
 498
 499         /* Note: pull-up/down are applied here: frame_rate() vs. nominal_frame_rate() */
 500         if (_session->config.get_use_video_file_fps()) {
 501                 video_frame_offset = floor(offset * fps / audio_frame_rate);
 502         } else {
 503                 video_frame_offset = floor(offset * _session->timecode_frames_per_second() / audio_frame_rate);
 504         }
 505
 506         // TODO remember if changed..
 507         std::ostringstream osstream1; osstream1 << -1 * video_frame_offset;
 508         process->write_to_stdin("set offset " + osstream1.str() + "\n");
 509 }
 510
 511 void
 512 VideoMonitor::manual_seek (framepos_t when, bool /*force*/, ARDOUR::frameoffset_t offset)
 513 {
 514         if (!is_started()) { return; }
 515         if (!_session) { return; }
 516         framecnt_t video_frame;
 517         framecnt_t audio_frame_rate;
 518         if (_session->config.get_videotimeline_pullup()) {
 519                 audio_frame_rate = _session->frame_rate();
 520         } else {
 521                 audio_frame_rate = _session->nominal_frame_rate();
 522         }
 523
 524         /* Note: pull-up/down are applied here: frame_rate() vs. nominal_frame_rate() */
 525         if (_session->config.get_use_video_file_fps()) {
 526                 video_frame = floor(when * fps / audio_frame_rate);
 527         } else {
 528                 video_frame = floor(when * _session->timecode_frames_per_second() / audio_frame_rate);
 529         }
 530         if (video_frame < 0 ) video_frame = 0;
 531
 532         if (video_frame == manually_seeked_frame) { return; }
 533         manually_seeked_frame = video_frame;
 534
 535 #if 0 /* DEBUG */
 536         std::cout <<"seek: " << video_frame << std::endl;
 537 #endif
 538         std::ostringstream osstream; osstream << video_frame;
 539         process->write_to_stdin("seek " + osstream.str() + "\n");
 540
 541         set_offset(offset);
 542 }
 543
 544 void
 545 VideoMonitor::parameter_changed (std::string const & p)
 546 {
 547         if (!is_started()) { return; }
 548         if (!_session) { return; }
 549         if (p != "external-sync" && p != "sync-source") {
 550                 return;
 551         }
 552         xjadeo_sync_setup();
 553 }
 554
 555 void
 556 VideoMonitor::xjadeo_sync_setup ()
 557 {
 558         if (!is_started()) { return; }
 559         if (!_session) { return; }
 560
 561         bool my_manual_seek = true;
 562         if (_session->config.get_external_sync()) {
 563                 if (ARDOUR::Config->get_sync_source() == ARDOUR::JACK)
 564                         my_manual_seek = false;
 565         }
 566
 567         if (my_manual_seek != sync_by_manual_seek) {
 568                 if (sync_by_manual_seek) {
 569                         if (clock_connection.connected()) {
 570                                 clock_connection.disconnect();
 571                         }
 572                         process->write_to_stdin("jack connect\n");
 573                 } else {
 574                         process->write_to_stdin("jack disconnect\n");
 575                         clock_connection = ARDOUR_UI::SuperRapidScreenUpdate.connect (sigc::mem_fun (*this, &VideoMonitor::srsupdate));
 576                 }
 577                 sync_by_manual_seek = my_manual_seek;
 578         }
 579 }