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