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>
36 #include <linux/input.h>
57 // Constants for the returned events when reading them from the device
62 // Constants for the signals sent.
63 #define JOG_BACK1 10001
64 #define JOG_FWD1 10002
65 #define KEY_EVENT_OFFSET 20000
67 // middle value for shuttle, will be +/-MAX_SHUTTLE_RANGE
68 #define JOG_STOP 10020
69 #define MAX_SHUTTLE_RANGE 7
71 void ShuttleThread::init(QObject *parent, QString device)
77 shuttlevalue = 0xffff;
82 bool ShuttleThread::isWorking()
87 void ShuttleThread::run()
89 kDebug() << "------- STARTING SHUTTLE: " << m_device;
90 /* open file descriptor */
91 const int fd = KDE_open((char *) m_device.toUtf8().data(), O_RDONLY);
93 perror("Can't open Jog Shuttle FILE DESCRIPTOR");
99 if (ioctl(fd, EVIOCGRAB, 1) < 0) {
100 fprintf(stderr, "Can't get exclusive access on Jog Shuttle FILE DESCRIPTOR\n");
106 struct timeval timeout;
108 int num_warnings, readResult = 0;
109 int result, iof = -1;
111 /* get fd settings */
112 if ((iof = fcntl(fd, F_GETFL, 0)) != -1) {
113 /* set fd non blocking */
114 fcntl(fd, F_SETFL, iof | O_NONBLOCK);
116 fprintf(stderr, "Can't set Jog Shuttle FILE DESCRIPTOR to O_NONBLOCK and stop thread\n");
120 /* enter thread loop */
122 /* reset the read set */
124 FD_SET(fd, &readset);
126 /* reinit the timeout structure */
128 timeout.tv_usec = 400000; /* 400 ms */
130 /* do select in blocked mode and wake up after timeout for eval stop_me */
131 result = select(fd+1, &readset, NULL, NULL, &timeout);
133 /* see if there was an error or timeout else process event */
134 if (result < 0 && errno == EINTR) {
135 /* EINTR event catched. This is not a problem - continue processing */
136 kDebug() << strerror(errno) << "\n";
137 /* continue processing */
139 } else if (result < 0) {
142 kDebug() << strerror(errno) << "\n";
143 } else if (result == 0) {
144 /* do nothing. reserved for future purposes */
147 if (FD_ISSET(fd, &readset)) {
149 readResult = read(fd, &ev, sizeof(ev));
150 if (readResult < 0) {
151 if (num_warnings % 10000 == 0) {
152 /* if device is not available anymore - dead or disconnected */
153 fprintf(stderr, "Failed to read event from Jog Shuttle FILE DESCRIPTOR (repeated %d times)\n", num_warnings + 1);
155 /* exit if device is not available or the error occurs to long */
156 if (errno == ENODEV) {
157 perror("Failed to read from Jog Shuttle FILE DESCRIPTOR. Stop thread");
160 } else if (num_warnings > 1000000) {
161 perror("Failed to read from Jog Shuttle FILE DESCRIPTOR. Limit reached. Stop thread");
166 } else if (readResult == sizeof(ev)) {
170 fprintf(stderr, "Read nr of bytes != sizeof(ev)\n");
176 // kDebug() << "Close thread" << "\n";
177 /* close the handle and return thread */
181 void ShuttleThread::handle_event(EV ev)
185 key(ev.code, ev.value);
190 if (ev.code == SHUTTLE)
196 void ShuttleThread::key(unsigned short code, unsigned int value)
199 // Button release (ignored)
208 //kDebug() << "Button PRESSED: " << code;
209 QApplication::postEvent(m_parent, new QEvent((QEvent::Type)(KEY_EVENT_OFFSET + code)));
213 void ShuttleThread::shuttle(int value)
215 //gettimeofday( &last_shuttle, 0 );
216 //need_synthetic_shuttle = value != 0;
218 if (value == shuttlevalue) {
223 if (value > MAX_SHUTTLE_RANGE || value < -MAX_SHUTTLE_RANGE) {
224 fprintf(stderr, "Jog Shuttle returned value of %d (should be between -%d ad +%d)", value, MAX_SHUTTLE_RANGE, MAX_SHUTTLE_RANGE);
227 shuttlevalue = value;
229 QApplication::postEvent(m_parent, new QEvent((QEvent::Type) (JOG_STOP + value)));
232 void ShuttleThread::jog(unsigned int value)
234 // generate a synthetic event for the shuttle going
235 // to the home position if we have not seen one recently.
236 //if (shuttlevalue != 0) {
237 // QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
241 // This code takes care of wrapping around the limits of the jog dial number (it is represented as a single byte, hence
242 // wraps at the 0/255 boundary). I used 25 as the difference to make sure that even in heavy load, with the jog dial
243 // turning fast and we miss some events that we do not mistakenly reverse the direction.
244 // Note also that at least the Contour ShuttlePRO v2 does not send an event for the value 0, so at the wrap it will
245 // need 2 events to go forward. But that is nothing we can do about...
246 if (jogvalue != 0xffff) {
247 //fprintf(stderr, "value=%d jogvalue=%d\n", value, jogvalue);
248 bool wrap = abs(value - jogvalue) > 25;
249 bool rewind = value < jogvalue;
250 bool forward = value > jogvalue;
251 if ((rewind && !wrap) || (forward && wrap))
252 QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK1));
253 else if ((forward && !wrap) || (rewind && wrap))
254 QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD1));
255 else if (!forward && !rewind && shuttlecounter > 2) {
256 // An event without changing the jog value is sent after each shuttle change.
257 // As the shuttle rest position does not get a shuttle event, only a non-position-changing jog event.
258 // Hence we stop on this when we see 2 non-position-changing jog events in a row.
260 QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
264 if (shuttlecounter > 0) shuttlecounter++;
268 JogShuttle::JogShuttle(QString device, QObject *parent) :
274 JogShuttle::~JogShuttle()
279 void JogShuttle::initDevice(QString device)
281 if (m_shuttleProcess.isRunning()) {
282 if (device == m_shuttleProcess.m_device) return;
285 m_shuttleProcess.init(this, device);
286 m_shuttleProcess.start(QThread::LowestPriority);
289 void JogShuttle::stopDevice()
291 if (m_shuttleProcess.isRunning()) {
292 /* tell thread to stop */
293 m_shuttleProcess.stop_me = true;
294 m_shuttleProcess.exit();
295 /* give the thread some time (ms) to shutdown */
296 m_shuttleProcess.wait(600);
298 /* if still running - do it in the hardcore way */
299 if (m_shuttleProcess.isRunning()) {
300 m_shuttleProcess.terminate();
301 kDebug() << "/// terminate jogshuttle process\n";
306 void JogShuttle::customEvent(QEvent* e)
308 int code = e->type();
310 // Handle simple job events
320 int shuttle_pos = code - JOG_STOP;
321 if (shuttle_pos >= -MAX_SHUTTLE_RANGE && shuttle_pos <= MAX_SHUTTLE_RANGE) {
322 emit shuttlePos(shuttle_pos);
326 // we've got a key event.
327 //fprintf(stderr, "Firing button event for #%d\n", e->type() - KEY_EVENT_OFFSET); // DBG
328 emit button(e->type() - KEY_EVENT_OFFSET);
333 // #include "jogshuttle.moc"