2 Copyright (C) 2010 Paul Davis
3 Author: Robin Gareus <robin@gareus.org>
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.
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.
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.
20 #include "pbd/file_utils.h"
21 #include "pbd/convert.h"
22 #include "gui_thread.h"
23 #include "ardour_ui.h"
27 #include "public_editor.h"
29 #include "video_monitor.h"
36 VideoMonitor::VideoMonitor (PublicEditor *ed, std::string xjadeo_bin_path)
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();
48 osdmode = 10; // 1: frameno, 2: timecode, 8: box
50 process = new ARDOUR::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());
56 VideoMonitor::~VideoMonitor ()
58 if (clock_connection.connected()) {
59 clock_connection.disconnect();
61 if (state_connection.connected()) {
62 state_connection.disconnect();
68 VideoMonitor::start ()
74 manually_seeked_frame = 0;
75 sync_by_manual_seek = false;
76 if (clock_connection.connected()) { clock_connection.disconnect(); }
78 if (process->start(debug_enable?2:1)) {
85 VideoMonitor::query_full_state (bool wait)
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");
96 if (wait && knownstate !=127 && --timeout) {
103 VideoMonitor::quit ()
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, ??)
115 while (is_started() && --timeout) {
120 process->terminate();
125 VideoMonitor::open (std::string filename)
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;
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
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");
155 if (!state_connection.connected()) {
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));
166 VideoMonitor::querystate ()
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) {
172 query_full_state(false);
175 if (state_clk_divide%25 != 0) {
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");
186 VideoMonitor::skip_setting (std::string which)
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; }
200 VideoMonitor::send_cmd (int what, int param)
202 bool osd_update = false;
203 int prev_osdmode = osdmode;
204 if (!is_started()) return;
207 if (param) process->write_to_stdin("window ontop on\n");
208 else process->write_to_stdin("window ontop off\n");
211 if (param) osdmode |= 2;
213 osd_update = (prev_osdmode != osdmode);
216 if (param) osdmode |= 1;
218 osd_update = (prev_osdmode != osdmode);
221 if (param) osdmode |= 8;
223 osd_update = (prev_osdmode != osdmode);
226 if (param) process->write_to_stdin("window zoom on\n");
227 else process->write_to_stdin("window zoom off\n");
230 if (param) process->write_to_stdin("window letterbox on\n");
231 else process->write_to_stdin("window letterbox off\n");
234 process->write_to_stdin("window resize 100%");
240 std::ostringstream osstream; osstream << "osd mode " << osdmode << "\n";
241 process->write_to_stdin(osstream.str());
246 VideoMonitor::is_started ()
248 return process->is_running();
252 VideoMonitor::forward_keyevent (unsigned int keyval)
254 Editor* ed = dynamic_cast<Editor*>(&PublicEditor::instance());
256 emulate_key_event(ed, keyval);
260 VideoMonitor::parse_output (std::string d, size_t /*s*/)
262 std::string line = d;
263 std::string::size_type start = 0;
264 std::string::size_type end = 0;
267 end = d.find('\n', start);
268 if (end == std::string::npos) break;
269 line = d.substr(start,end-start);
271 if (line.length() <4 || line.at(0)!='@') continue;
274 printf("xjadeo: '%s'\n", line.c_str());
277 int status = atoi(line.substr(1,3));
278 switch(status / 100) {
281 PBD::warning << _("Video Monitor: File Not Found.") << endmsg;
282 /* check: we should only write from the main thread.
283 * However it should not matter for 'quit'.
285 process->write_to_stdin("quit\n");
289 printf("xjadeo: error '%s'\n", line.c_str());
292 case 3: /* async notifications */
294 std::string::size_type equalsign = line.find('=');
295 std::string::size_type comment = line.find('#');
296 if (comment != std::string::npos) { line = line.substr(0,comment); }
297 if (equalsign != std::string::npos) {
298 std::string key = line.substr(5, equalsign - 5);
299 std::string value = line.substr(equalsign + 1);
301 if (status == 310 && key=="keypress") {
303 XJKeyEvent((unsigned int)atoi(value));
307 std::string msg = line.substr(5);
308 printf("xjadeo: async '%s' -> '%s'\n", key, value);
314 std::string msg = line.substr(5);
315 printf("xjadeo: async '%s'\n", msg.c_str());
319 case 1: /* text messages - command reply */
321 case 8: /* comments / info for humans */
327 * 210: var=<int>x<int>
329 * 228: var=<smpte-string>
332 std::string::size_type equalsign = line.find('=');
333 std::string::size_type comment = line.find('#');
334 if (comment != std::string::npos) { line = line.substr(0,comment); }
335 if (equalsign != std::string::npos) {
336 std::string key = line.substr(5, equalsign - 5);
337 std::string value = line.substr(equalsign + 1);
339 std::cout << "parsed: " << key << " => " << value << std::endl;
341 if (key == "windowpos") {
343 if (xjadeo_settings["window xy"] != value) {
344 if (!starting && _session) _session->set_dirty ();
346 xjadeo_settings["window xy"] = value;
347 } else if(key == "windowsize") {
349 if (xjadeo_settings["window size"] != value) {
350 if (!starting && _session) _session->set_dirty ();
352 xjadeo_settings["window size"] = value;
353 } else if(key == "windowontop") {
355 if (starting || xjadeo_settings["window ontop"] != value) {
356 if (!starting && _session) _session->set_dirty ();
357 if (atoi(value)) { UiState("xjadeo-window-ontop-on"); }
358 else { UiState("xjadeo-window-ontop-off"); }
361 xjadeo_settings["window ontop"] = value;
362 } else if(key == "fullscreen") {
364 if (starting || xjadeo_settings["window zoom"] != value) {
365 if (!starting && _session) _session->set_dirty ();
366 if (atoi(value)) { UiState("xjadeo-window-fullscreen-on"); }
367 else { UiState("xjadeo-window-fullscreen-off"); }
370 xjadeo_settings["window zoom"] = value;
371 } else if(key == "letterbox") {
373 if (starting || xjadeo_settings["window letterbox"] != value) {
374 if (!starting && _session) _session->set_dirty ();
375 if (atoi(value)) { UiState("xjadeo-window-letterbox-on"); }
376 else { UiState("xjadeo-window-letterbox-off"); }
379 xjadeo_settings["window letterbox"] = value;
380 } else if(key == "osdmode") {
382 osdmode = atoi(value);
383 if (starting || atoi(xjadeo_settings["osd mode"]) != osdmode) {
384 if (!starting && _session) _session->set_dirty ();
385 if ((osdmode & 1) == 1) { UiState("xjadeo-window-osd-frame-on"); }
386 if ((osdmode & 1) == 0) { UiState("xjadeo-window-osd-frame-off"); }
387 if ((osdmode & 2) == 2) { UiState("xjadeo-window-osd-timecode-on"); }
388 if ((osdmode & 2) == 0) { UiState("xjadeo-window-osd-timecode-off"); }
389 if ((osdmode & 8) == 8) { UiState("xjadeo-window-osd-box-on"); }
390 if ((osdmode & 8) == 0) { UiState("xjadeo-window-osd-box-off"); }
393 xjadeo_settings["osd mode"] = value;
394 } else if(key == "offset") {
396 if (xjadeo_settings["set offset"] != value) {
397 if (!starting && _session) _session->set_dirty ();
399 xjadeo_settings["set offset"] = value;
402 printf("xjadeo: '%s' -> '%s'\n", key.c_str(), value.c_str());
415 VideoMonitor::terminated ()
417 process->terminate(); // from gui-context clean up
422 VideoMonitor::save_session ()
424 if (!_session) { return; }
425 XMLNode* node = _session->extra_xml (X_("XJSettings"), true);
427 node->remove_nodes_and_delete("XJSetting");
429 for(XJSettings::const_iterator it = xjadeo_settings.begin(); it != xjadeo_settings.end(); ++it) {
430 XMLNode* child = node->add_child (X_("XJSetting"));
431 child->add_property (X_("k"), it->first);
432 child->add_property (X_("v"), it->second);
438 VideoMonitor::set_session (ARDOUR::Session *s)
440 SessionHandlePtr::set_session (s);
441 if (!_session) { return; }
442 _session->config.ParameterChanged.connect (*this, invalidator (*this), ui_bind (&VideoMonitor::parameter_changed, this, _1), gui_context());
443 XMLNode* node = _session->extra_xml (X_("XJSettings"));
444 if (!node) { return;}
445 xjadeo_settings.clear();
447 XMLNodeList nlist = node->children();
448 XMLNodeConstIterator niter;
449 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
450 xjadeo_settings[(*niter)->property(X_("k"))->value()] = (*niter)->property(X_("v"))->value();
455 VideoMonitor::set_custom_setting (const std::string k, const std::string v)
457 xjadeo_settings[k] = v;
458 return true; /* TODO: check if key is valid */
462 VideoMonitor::get_custom_setting (const std::string k)
464 return (xjadeo_settings[k]);
467 #define NO_OFFSET (1<<31) //< skip setting or modifying offset -- TODO check ARDOUR::frameoffset_t max value.
469 VideoMonitor::srsupdate ()
471 if (!_session) { return; }
472 if (editor->dragging_playhead()) { return ;}
473 manual_seek(_session->audible_frame(), false, NO_OFFSET);
477 VideoMonitor::set_offset (ARDOUR::frameoffset_t offset)
479 if (!is_started()) { return; }
480 if (!_session) { return; }
481 if (offset == NO_OFFSET ) { return; }
483 framecnt_t video_frame_offset;
484 framecnt_t audio_sample_rate;
485 if (_session->config.get_videotimeline_pullup()) {
486 audio_sample_rate = _session->frame_rate();
488 audio_sample_rate = _session->nominal_frame_rate();
491 /* Note: pull-up/down are applied here: frame_rate() vs. nominal_frame_rate() */
492 if (_session->config.get_use_video_file_fps()) {
493 video_frame_offset = floor(offset * fps / audio_sample_rate);
495 video_frame_offset = floor(offset * _session->timecode_frames_per_second() / audio_sample_rate);
498 if (video_offset == video_frame_offset) { return; }
499 video_offset = video_frame_offset;
501 std::ostringstream osstream1; osstream1 << -1 * video_frame_offset;
502 process->write_to_stdin("set offset " + osstream1.str() + "\n");
506 VideoMonitor::manual_seek (framepos_t when, bool /*force*/, ARDOUR::frameoffset_t offset)
508 if (!is_started()) { return; }
509 if (!_session) { return; }
510 framecnt_t video_frame;
511 framecnt_t audio_sample_rate;
512 if (_session->config.get_videotimeline_pullup()) {
513 audio_sample_rate = _session->frame_rate();
515 audio_sample_rate = _session->nominal_frame_rate();
518 /* Note: pull-up/down are applied here: frame_rate() vs. nominal_frame_rate() */
519 if (_session->config.get_use_video_file_fps()) {
520 video_frame = floor(when * fps / audio_sample_rate);
522 video_frame = floor(when * _session->timecode_frames_per_second() / audio_sample_rate);
524 if (video_frame < 0 ) video_frame = 0;
526 if (video_frame == manually_seeked_frame) { return; }
527 manually_seeked_frame = video_frame;
530 std::cout <<"seek: " << video_frame << std::endl;
532 std::ostringstream osstream; osstream << video_frame;
533 process->write_to_stdin("seek " + osstream.str() + "\n");
539 VideoMonitor::parameter_changed (std::string const & p)
541 if (!is_started()) { return; }
542 if (!_session) { return; }
543 if (p != "external-sync" && p != "sync-source") {
550 VideoMonitor::xjadeo_sync_setup ()
552 if (!is_started()) { return; }
553 if (!_session) { return; }
555 bool my_manual_seek = true;
556 if (_session->config.get_external_sync()) {
557 if (ARDOUR::Config->get_sync_source() == ARDOUR::Engine)
558 my_manual_seek = false;
561 if (my_manual_seek != sync_by_manual_seek) {
562 if (sync_by_manual_seek) {
563 if (clock_connection.connected()) {
564 clock_connection.disconnect();
566 process->write_to_stdin("jack connect\n");
568 process->write_to_stdin("jack disconnect\n");
569 clock_connection = ARDOUR_UI::SuperRapidScreenUpdate.connect (sigc::mem_fun (*this, &VideoMonitor::srsupdate));
571 sync_by_manual_seek = my_manual_seek;