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