1 /***************************************************************************
2 * Copyright (C) 2008 by Jean-Baptiste Mardelle (jb@kdenlive.org) *
3 * Based on code by Arendt David <admin@prnet.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 *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
19 ***************************************************************************/
22 #include "jogshuttle.h"
27 #include <QApplication>
34 #include <linux/input.h>
55 // Constants for the returned events when reading them from the device
60 // Constants for the signals sent.
61 #define JOG_BACK1 10001
62 #define JOG_FWD1 10002
63 #define KEY_EVENT_OFFSET 20000
65 // middle value for shuttle, will be +/-MAX_SHUTTLE_RANGE
66 #define JOG_STOP 10020
67 #define MAX_SHUTTLE_RANGE 7
69 void ShuttleThread::init(QObject *parent, QString device)
75 shuttlevalue = 0xffff;
80 bool ShuttleThread::isWorking()
85 void ShuttleThread::run()
87 kDebug() << "------- STARTING SHUTTLE: " << m_device;
88 /* open file descriptor */
89 const int fd = KDE_open((char *) m_device.toUtf8().data(), O_RDONLY);
91 fprintf(stderr, "Can't open Jog Shuttle FILE DESCRIPTOR\n");
97 if (ioctl(fd, EVIOCGRAB, 1) < 0) {
98 fprintf(stderr, "Can't get exclusive access on Jog Shuttle FILE DESCRIPTOR\n");
104 struct timeval timeout;
106 int num_warnings = 0;
107 int result, iof = -1;
109 /* enter thread loop */
111 /* reset the read set */
113 FD_SET(fd, &readset);
115 /* reinit the timeout structure */
117 timeout.tv_usec = 300000; /* 300 ms */
120 result = select(fd+1, &readset, NULL, NULL, &timeout);
122 /* see if there was an error or timeout */
124 // perror("select failed");
125 } else if (result == 0) {
129 if (FD_ISSET(fd, &readset)) {
130 /* get fd settings */
131 if ((iof = fcntl(fd, F_GETFL, 0)) != -1) {
132 /* set fd non blocking */
133 fcntl(fd, F_SETFL, iof | O_NONBLOCK);
135 if (read(fd, &ev, sizeof(ev)) < 0) {
136 if (num_warnings % 10000 == 0)
137 /* should not happen cause select called before */
138 fprintf(stderr, "Failed to read event from Jog Shuttle FILE DESCRIPTOR (repeated %d times)\n", num_warnings + 1);
142 /* restore settings */
144 fcntl(fd, F_SETFL, iof);
149 fprintf(stderr, "Can't set Jog Shuttle FILE DESCRIPTOR to O_NONBLOCK\n");
156 /* close the handle and return thread */
160 void ShuttleThread::handle_event(EV ev)
164 key(ev.code, ev.value);
169 if (ev.code == SHUTTLE)
175 void ShuttleThread::key(unsigned short code, unsigned int value)
178 // Button release (ignored)
187 kDebug() << "Button PRESSED: " << code;
188 QApplication::postEvent(m_parent, new QEvent((QEvent::Type)(KEY_EVENT_OFFSET + code)));
192 void ShuttleThread::shuttle(int value)
194 //gettimeofday( &last_shuttle, 0 );
195 //need_synthetic_shuttle = value != 0;
197 if (value == shuttlevalue) {
202 if (value > MAX_SHUTTLE_RANGE || value < -MAX_SHUTTLE_RANGE) {
203 fprintf(stderr, "Jog Shuttle returned value of %d (should be between -%d ad +%d)", value, MAX_SHUTTLE_RANGE, MAX_SHUTTLE_RANGE);
206 shuttlevalue = value;
208 QApplication::postEvent(m_parent, new QEvent((QEvent::Type) (JOG_STOP + value)));
211 void ShuttleThread::jog(unsigned int value)
213 // generate a synthetic event for the shuttle going
214 // to the home position if we have not seen one recently.
215 //if (shuttlevalue != 0) {
216 // QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
220 // This code takes care of wrapping around the limits of the jog dial number (it is represented as a single byte, hence
221 // wraps at the 0/255 boundary). I used 25 as the difference to make sure that even in heavy load, with the jog dial
222 // turning fast and we miss some events that we do not mistakenly reverse the direction.
223 // Note also that at least the Contour ShuttlePRO v2 does not send an event for the value 0, so at the wrap it will
224 // need 2 events to go forward. But that is nothing we can do about...
225 if (jogvalue != 0xffff) {
226 //fprintf(stderr, "value=%d jogvalue=%d\n", value, jogvalue);
227 bool wrap = abs(value - jogvalue) > 25;
228 bool rewind = value < jogvalue;
229 bool forward = value > jogvalue;
230 if ((rewind && !wrap) || (forward && wrap))
231 QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK1));
232 else if ((forward && !wrap) || (rewind && wrap))
233 QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD1));
234 else if (!forward && !rewind && shuttlecounter > 2) {
235 // An event without changing the jog value is sent after each shuttle change.
236 // As the shuttle rest position does not get a shuttle event, only a non-position-changing jog event.
237 // Hence we stop on this when we see 2 non-position-changing jog events in a row.
239 QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
243 if (shuttlecounter > 0) shuttlecounter++;
247 JogShuttle::JogShuttle(QString device, QObject *parent) :
253 JogShuttle::~JogShuttle()
258 void JogShuttle::initDevice(QString device)
260 if (m_shuttleProcess.isRunning()) {
261 if (device == m_shuttleProcess.m_device) return;
264 m_shuttleProcess.init(this, device);
265 m_shuttleProcess.start(QThread::LowestPriority);
268 void JogShuttle::stopDevice()
270 if (m_shuttleProcess.isRunning()) {
271 /* tell thread to stop */
272 m_shuttleProcess.stop_me = true;
273 m_shuttleProcess.exit();
274 /* give the thread some time (ms) to shutdown */
275 m_shuttleProcess.wait(600);
277 /* if still running - do it in the hardcore way */
278 if (m_shuttleProcess.isRunning()) {
279 m_shuttleProcess.terminate();
280 kDebug() << "/// terminate jogshuttle process\n";
285 void JogShuttle::customEvent(QEvent* e)
287 int code = e->type();
289 // Handle simple job events
299 int shuttle_pos = code - JOG_STOP;
300 if (shuttle_pos >= -MAX_SHUTTLE_RANGE && shuttle_pos <= MAX_SHUTTLE_RANGE) {
301 emit shuttlePos(shuttle_pos);
305 // we've got a key event.
306 //fprintf(stderr, "Firing button event for #%d\n", e->type() - KEY_EVENT_OFFSET); // DBG
307 emit button(e->type() - KEY_EVENT_OFFSET);
312 // #include "jogshuttle.moc"