2 * Copyright (C) 2013-2016 Tim Mayberry <mojofunk@gmail.com>
3 * Copyright (C) 2013-2018 Paul Davis <paul@linuxaudiosystems.com>
4 * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
5 * Copyright (C) 2013 John Emmas <john@creativepost.co.uk>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include "pbd/file_utils.h"
22 #include "pbd/convert.h"
23 #include "gui_thread.h"
28 #include "public_editor.h"
30 #include "video_monitor.h"
36 using namespace ARDOUR_UI_UTILS;
38 VideoMonitor::VideoMonitor (PublicEditor *ed, std::string xjadeo_bin_path)
41 manually_seeked_frame = 0;
42 fps =0.0; // = _session->timecode_frames_per_second();
43 sync_by_manual_seek = true;
44 _restore_settings_mask = 0;
45 clock_connection = sigc::connection();
46 state_connection = sigc::connection();
50 osdmode = 10; // 1: frameno, 2: timecode, 8: box
52 process = new ARDOUR::SystemExec(xjadeo_bin_path, X_("-R -J"));
53 process->ReadStdout.connect_same_thread (*this, boost::bind (&VideoMonitor::parse_output, this, _1 ,_2));
54 process->Terminated.connect (*this, invalidator (*this), boost::bind (&VideoMonitor::terminated, this), gui_context());
55 XJKeyEvent.connect (*this, invalidator (*this), boost::bind (&VideoMonitor::forward_keyevent, this, _1), gui_context());
58 VideoMonitor::~VideoMonitor ()
60 if (clock_connection.connected()) {
61 clock_connection.disconnect();
63 if (state_connection.connected()) {
64 state_connection.disconnect();
70 VideoMonitor::start ()
76 manually_seeked_frame = 0;
77 sync_by_manual_seek = false;
78 if (clock_connection.connected()) { clock_connection.disconnect(); }
80 if (process->start (debug_enable ? SystemExec::MergeWithStdin : SystemExec::IgnoreAndClose)) {
87 VideoMonitor::query_full_state (bool wait)
90 process->write_to_stdin("get windowsize\n");
91 process->write_to_stdin("get windowpos\n");
92 process->write_to_stdin("get letterbox\n");
93 process->write_to_stdin("get fullscreen\n");
94 process->write_to_stdin("get ontop\n");
95 process->write_to_stdin("get offset\n");
96 process->write_to_stdin("get osdcfg\n");
98 if (wait && knownstate !=127 && --timeout) {
105 VideoMonitor::quit ()
107 if (!is_started()) return;
108 if (state_connection.connected()) { state_connection.disconnect(); }
109 if (clock_connection.connected()) { clock_connection.disconnect(); }
110 query_full_state(true);
111 process->write_to_stdin("quit\n");
112 /* the 'quit' command should result in process termination
113 * but in case it fails (communication failure, SIGSTOP, ??)
117 while (is_started() && --timeout) {
122 process->terminate();
127 VideoMonitor::open (std::string filename)
129 if (!is_started()) return;
130 manually_seeked_frame = 0;
131 osdmode = 10; // 1: frameno, 2: timecode, 8: box
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)
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");
158 if (!state_connection.connected()) {
161 state_clk_divide = 0;
162 /* TODO once every two second or so -- state_clk_divide hack below */
163 state_connection = Timers::rapid_connect (sigc::mem_fun (*this, &VideoMonitor::querystate));
165 sync_by_manual_seek = true;
166 clock_connection = Timers::fps_connect (sigc::mem_fun (*this, &VideoMonitor::srsupdate));
171 VideoMonitor::querystate ()
173 /* clock-divider hack -- RapidScreenUpdate == every_point_one_seconds */
174 state_clk_divide = (state_clk_divide + 1) % 300; // 30 secs
175 if (state_clk_divide == 0) {
177 query_full_state(false);
180 if (state_clk_divide%25 != 0) {
183 // every 2.5 seconds:
184 process->write_to_stdin("get fullscreen\n");
185 process->write_to_stdin("get ontop\n");
186 process->write_to_stdin("get osdcfg\n");
187 process->write_to_stdin("get letterbox\n");
191 VideoMonitor::skip_setting (std::string which)
193 if (_restore_settings_mask & XJ_OSD && which == "osd mode") { return true; }
194 if (_restore_settings_mask & XJ_LETTERBOX && which == "window letterbox") { return true; }
195 if (_restore_settings_mask & XJ_WINDOW_SIZE && which == "window size") { return true; }
196 if (_restore_settings_mask & XJ_WINDOW_POS && which == "window xy") { return true; }
197 if (_restore_settings_mask & XJ_WINDOW_ONTOP && which == "window ontop") { return true; }
198 if (_restore_settings_mask & XJ_LETTERBOX && which == "window letterbox") { return true; }
199 if (_restore_settings_mask & XJ_OFFSET && which == "set offset") { return true; }
200 if (_restore_settings_mask & XJ_FULLSCREEN && which == "window zoom") { return true; }
205 VideoMonitor::send_cmd (int what, int param)
207 bool osd_update = false;
208 int prev_osdmode = osdmode;
209 if (!is_started()) return;
212 if (param) process->write_to_stdin("window ontop on\n");
213 else process->write_to_stdin("window ontop off\n");
216 if (param) osdmode |= 2;
218 osd_update = (prev_osdmode != osdmode);
221 if (param) osdmode |= 1;
223 osd_update = (prev_osdmode != osdmode);
226 if (param) osdmode |= 8;
228 osd_update = (prev_osdmode != osdmode);
231 if (param) process->write_to_stdin("window zoom on\n");
232 else process->write_to_stdin("window zoom off\n");
235 if (param) process->write_to_stdin("window letterbox on\n");
236 else process->write_to_stdin("window letterbox off\n");
239 process->write_to_stdin("window resize 100%");
245 std::ostringstream osstream; osstream << "osd mode " << osdmode << "\n";
246 process->write_to_stdin(osstream.str());
251 VideoMonitor::is_started ()
253 return process->is_running();
257 VideoMonitor::forward_keyevent (unsigned int keyval)
259 emulate_key_event (keyval);
263 VideoMonitor::parse_output (std::string d, size_t /*s*/)
265 std::string line = d;
266 std::string::size_type start = 0;
267 std::string::size_type end = 0;
270 end = d.find('\n', start);
271 if (end == std::string::npos) break;
272 line = d.substr(start,end-start);
274 if (line.length() <4 || line.at(0)!='@') continue;
277 printf("xjadeo: '%s'\n", line.c_str());
280 int status = atoi(line.substr(1,3));
281 switch(status / 100) {
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'.
288 process->write_to_stdin("quit\n");
292 printf("xjadeo: error '%s'\n", line.c_str());
295 case 3: /* async notifications */
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);
304 if (status == 310 && key=="keypress") {
306 XJKeyEvent((unsigned int)atoi(value));
310 std::string msg = line.substr(5);
311 printf("xjadeo: async '%s' -> '%s'\n", key, value);
317 std::string msg = line.substr(5);
318 printf("xjadeo: async '%s'\n", msg.c_str());
322 case 1: /* text messages - command reply */
324 case 8: /* comments / info for humans */
330 * 210: var=<int>x<int>
332 * 228: var=<smpte-string>
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);
342 std::cout << "parsed: " << key << " => " << value << std::endl;
344 if (key == "windowpos") {
346 if (xjadeo_settings["window xy"] != value) {
347 if (!starting && _session) _session->set_dirty ();
349 xjadeo_settings["window xy"] = value;
350 } else if(key == "windowsize") {
352 if (xjadeo_settings["window size"] != value) {
353 if (!starting && _session) _session->set_dirty ();
355 xjadeo_settings["window size"] = value;
356 } else if(key == "windowontop") {
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"); }
364 xjadeo_settings["window ontop"] = value;
365 } else if(key == "fullscreen") {
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"); }
373 xjadeo_settings["window zoom"] = value;
374 } else if(key == "letterbox") {
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"); }
382 xjadeo_settings["window letterbox"] = value;
383 } else if(key == "osdmode") {
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"); }
396 xjadeo_settings["osd mode"] = value;
397 } else if(key == "offset") {
399 if (xjadeo_settings["set offset"] != value) {
400 if (!starting && _session) _session->set_dirty ();
402 xjadeo_settings["set offset"] = value;
405 printf("xjadeo: '%s' -> '%s'\n", key.c_str(), value.c_str());
418 VideoMonitor::terminated ()
420 process->terminate(); // from gui-context clean up
425 VideoMonitor::save_session ()
427 if (!_session) { return; }
428 XMLNode* node = _session->extra_xml (X_("XJSettings"), true);
430 node->remove_nodes_and_delete("XJSetting");
432 for(XJSettings::const_iterator it = xjadeo_settings.begin(); it != xjadeo_settings.end(); ++it) {
433 XMLNode* child = node->add_child (X_("XJSetting"));
434 child->set_property (X_("k"), it->first);
435 child->set_property (X_("v"), it->second);
441 VideoMonitor::set_session (ARDOUR::Session *s)
443 SessionHandlePtr::set_session (s);
444 if (!_session) { return; }
445 ARDOUR::Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoMonitor::parameter_changed, this, _1), gui_context());
446 _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoMonitor::parameter_changed, this, _1), gui_context());
447 XMLNode* node = _session->extra_xml (X_("XJSettings"));
448 if (!node) { return;}
449 xjadeo_settings.clear();
451 XMLNodeList nlist = node->children();
452 XMLNodeConstIterator niter;
453 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
454 xjadeo_settings[(*niter)->property(X_("k"))->value()] = (*niter)->property(X_("v"))->value();
459 VideoMonitor::set_custom_setting (const std::string k, const std::string v)
461 xjadeo_settings[k] = v;
462 return true; /* TODO: check if key is valid */
466 VideoMonitor::get_custom_setting (const std::string k)
468 return (xjadeo_settings[k]);
471 #define NO_OFFSET (Temporal::max_samplepos) //< skip setting or modifying offset
473 VideoMonitor::srsupdate ()
475 if (!_session) { return; }
476 if (editor->dragging_playhead()) { return ;}
477 manual_seek(_session->audible_sample(), false, NO_OFFSET);
481 VideoMonitor::set_offset (ARDOUR::sampleoffset_t offset)
483 if (!is_started()) { return; }
484 if (!_session) { return; }
485 if (offset == NO_OFFSET ) { return; }
487 samplecnt_t video_frame_offset;
488 samplecnt_t audio_sample_rate;
489 if (_session->config.get_videotimeline_pullup()) {
490 audio_sample_rate = _session->sample_rate();
492 audio_sample_rate = _session->nominal_sample_rate();
495 /* Note: pull-up/down are applied here: sample_rate() vs. nominal_sample_rate() */
496 if (_session->config.get_use_video_file_fps()) {
497 video_frame_offset = floor(offset * fps / audio_sample_rate);
499 video_frame_offset = floor(offset * _session->timecode_frames_per_second() / audio_sample_rate);
502 if (video_offset == video_frame_offset) { return; }
503 video_offset = video_frame_offset;
505 std::ostringstream osstream1; osstream1 << -1 * video_frame_offset;
506 process->write_to_stdin("set offset " + osstream1.str() + "\n");
510 VideoMonitor::manual_seek (samplepos_t when, bool /*force*/, ARDOUR::sampleoffset_t offset)
512 if (!is_started()) { return; }
513 if (!_session) { return; }
514 samplecnt_t video_frame;
515 samplecnt_t audio_sample_rate;
516 if (_session->config.get_videotimeline_pullup()) {
517 audio_sample_rate = _session->sample_rate();
519 audio_sample_rate = _session->nominal_sample_rate();
522 /* Note: pull-up/down are applied here: sample_rate() vs. nominal_sample_rate() */
523 if (_session->config.get_use_video_file_fps()) {
524 video_frame = floor(when * fps / audio_sample_rate);
526 video_frame = floor(when * _session->timecode_frames_per_second() / audio_sample_rate);
528 if (video_frame < 0 ) video_frame = 0;
530 if (video_frame == manually_seeked_frame) { return; }
531 manually_seeked_frame = video_frame;
534 std::cout <<"seek: " << video_frame << std::endl;
536 std::ostringstream osstream; osstream << video_frame;
537 process->write_to_stdin("seek " + osstream.str() + "\n");
543 VideoMonitor::parameter_changed (std::string const & p)
545 if (!is_started()) { return; }
546 if (!_session) { return; }
547 if (p != "external-sync" && p != "sync-source") {
554 VideoMonitor::xjadeo_sync_setup ()
556 if (!is_started()) { return; }
557 if (!_session) { return; }
559 bool my_manual_seek = true;
560 if (_session->synced_to_engine ()) {
561 my_manual_seek = false;
564 if (my_manual_seek != sync_by_manual_seek) {
565 if (sync_by_manual_seek) {
566 if (clock_connection.connected()) {
567 clock_connection.disconnect();
569 process->write_to_stdin("jack connect\n");
571 process->write_to_stdin("jack disconnect\n");
572 clock_connection = Timers::fps_connect (sigc::mem_fun (*this, &VideoMonitor::srsupdate));
574 sync_by_manual_seek = my_manual_seek;