git.sesse.net Git - kdenlive/blob - src/jogshuttle.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Jean-Baptiste Mardelle (jb@kdenlive.org)        *
   3  *   Based on code by Arendt David <admin@prnet.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                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
  19  ***************************************************************************/
  20
  21
  22 #include "jogshuttle.h"
  23
  24 #include <KDebug>
  25 #include <kde_file.h>
  26
  27 #include <QApplication>
  28 #include <QEvent>
  29
  30 #include <stdlib.h>
  31 #include <stdio.h>
  32 #include <unistd.h>
  33 #include <fcntl.h>
  34 #include <errno.h>
  35 #include <string.h>
  36 #include <linux/input.h>
  37
  38 #define DELAY 10
  39
  40 #define KEY 1
  41 #define KEY1 256
  42 #define KEY2 257
  43 #define KEY3 258
  44 #define KEY4 259
  45 #define KEY5 260
  46 #define KEY6 261
  47 #define KEY7 262
  48 #define KEY8 263
  49 #define KEY9 264
  50 #define KEY10 265
  51 #define KEY11 266
  52 #define KEY12 267
  53 #define KEY13 268
  54 #define KEY14 269
  55 #define KEY15 270
  56
  57 // Constants for the returned events when reading them from the device
  58 #define JOGSHUTTLE 2
  59 #define JOG 7
  60 #define SHUTTLE 8
  61
  62 // Constants for the signals sent.
  63 #define JOG_BACK1 10001
  64 #define JOG_FWD1 10002
  65 #define KEY_EVENT_OFFSET 20000
  66
  67 // middle value for shuttle, will be +/-MAX_SHUTTLE_RANGE
  68 #define JOG_STOP 10020
  69 #define MAX_SHUTTLE_RANGE 7
  70
  71 void ShuttleThread::init(QObject *parent, const QString &device)
  72 {
  73     m_parent = parent;
  74     m_device = device;
  75     stop_me = false;
  76     m_isWorking = false;
  77     shuttlevalue = 0xffff;
  78     shuttlecounter = 0;
  79     jogvalue = 0xffff;
  80 }
  81
  82 bool ShuttleThread::isWorking()
  83 {
  84     return m_isWorking;
  85 }
  86
  87 void ShuttleThread::run()
  88 {
  89         kDebug() << "-------  STARTING SHUTTLE: " << m_device;
  90         /* open file descriptor */
  91         const int fd = KDE_open((char *) m_device.toUtf8().data(), O_RDONLY);
  92         if (fd < 0) {
  93                 perror("Can't open Jog Shuttle FILE DESCRIPTOR");
  94                 return;
  95         }
  96
  97         EV ev;
  98
  99         if (ioctl(fd, EVIOCGRAB, 1) < 0) {
 100                 fprintf(stderr, "Can't get exclusive access on  Jog Shuttle FILE DESCRIPTOR\n");
 101                 close(fd);
 102                 return;
 103         }
 104
 105         fd_set             readset;
 106         struct timeval timeout;
 107
 108         int num_warnings = 0, readResult = 0;
 109         int result, iof = -1;
 110
 111         /* get fd settings */
 112     if ((iof = fcntl(fd, F_GETFL, 0)) == -1) {
 113         fprintf(stderr, "Can't get Jog Shuttle file status\n");
 114         close(fd);
 115         return;
 116     } else if (fcntl(fd, F_SETFL, iof | O_NONBLOCK) == -1) {
 117         fprintf(stderr, "Can't set Jog Shuttle FILE DESCRIPTOR to O_NONBLOCK and stop thread\n");
 118         close(fd);
 119         return;
 120     }
 121
 122         /* enter thread loop */
 123         while (!stop_me) {
 124                 /* reset the read set */
 125                 FD_ZERO(&readset);
 126                 FD_SET(fd, &readset);
 127
 128                 /* reinit the timeout structure */
 129                 timeout.tv_sec  = 0;
 130                 timeout.tv_usec = 400000; /* 400 ms */
 131
 132                 /* do select in blocked mode and wake up after timeout for eval stop_me */
 133                 result = select(fd+1, &readset, NULL, NULL, &timeout);
 134
 135                 /* see if there was an error or timeout else process event */
 136                 if (result < 0 && errno == EINTR) {
 137                         /* EINTR event catched. This is not a problem - continue processing */
 138                         kDebug() << strerror(errno) << "\n";
 139                         /* continue processing */
 140                         continue;
 141                 } else if (result < 0) {
 142                         /* stop thread */
 143                         stop_me = true;
 144                         kDebug() << strerror(errno) << "\n";
 145                 } else if (result == 0) {
 146                         /* do nothing. reserved for future purposes */
 147                 } else {
 148                         /* we have input */
 149                         if (FD_ISSET(fd, &readset)) {
 150                                 /* read input */
 151                                 readResult = read(fd, &ev, sizeof(ev));
 152                                 if (readResult < 0) {
 153                                         if (num_warnings % 10000 == 0) {
 154                                                 /* if device is not available anymore - dead or disconnected */
 155                                                 fprintf(stderr, "Failed to read event from Jog Shuttle FILE DESCRIPTOR (repeated %d times)\n", num_warnings + 1);
 156                                         }
 157                                         /* exit if device is not available or the error occurs to long */
 158                                         if (errno == ENODEV) {
 159                                                 perror("Failed to read from Jog Shuttle FILE DESCRIPTOR. Stop thread");
 160                                                 /* stop thread */
 161                                                 stop_me = true;
 162                                         } else if (num_warnings > 1000000) {
 163                                                 perror("Failed to read from Jog Shuttle FILE DESCRIPTOR. Limit reached. Stop thread");
 164                                                 /* stop thread */
 165                                                 stop_me = true;
 166                                         }
 167                                         num_warnings++;
 168                                 } else if (readResult == sizeof(ev)) {
 169                                         /* process event */
 170                                         handle_event(ev);
 171                                 } else {
 172                                         fprintf(stderr, "Read nr of bytes != sizeof(ev)\n");
 173                                 }
 174                         }
 175                 }
 176         }
 177
 178 //      kDebug() << "Close thread" << "\n";
 179         /* close the handle and return thread */
 180         close(fd);
 181 }
 182
 183 void ShuttleThread::handle_event(EV ev)
 184 {
 185     switch (ev.type) {
 186     case KEY :
 187         key(ev.code, ev.value);
 188         break;
 189     case JOGSHUTTLE :
 190         if (ev.code == JOG)
 191             jog(ev.value);
 192         if (ev.code == SHUTTLE)
 193             shuttle(ev.value);
 194         break;
 195     }
 196 }
 197
 198 void ShuttleThread::key(unsigned short code, unsigned int value)
 199 {
 200     if (value == 0) {
 201         // Button release (ignored)
 202         return;
 203     }
 204
 205     // Check key index
 206     code -= KEY1 - 1;
 207     if (code > 16)
 208         return;
 209
 210     //kDebug() << "Button PRESSED: " << code;
 211     QApplication::postEvent(m_parent, new QEvent((QEvent::Type)(KEY_EVENT_OFFSET + code)));
 212
 213 }
 214
 215 void ShuttleThread::shuttle(int value)
 216 {
 217     //gettimeofday( &last_shuttle, 0 );
 218     //need_synthetic_shuttle = value != 0;
 219
 220     if (value == shuttlevalue) {
 221         shuttlecounter = 1;
 222         return;
 223     }
 224
 225     if (value > MAX_SHUTTLE_RANGE || value < -MAX_SHUTTLE_RANGE) {
 226         fprintf(stderr, "Jog Shuttle returned value of %d (should be between -%d ad +%d)", value, MAX_SHUTTLE_RANGE, MAX_SHUTTLE_RANGE);
 227         return;
 228     }
 229     shuttlevalue = value;
 230     shuttlecounter = 1;
 231     QApplication::postEvent(m_parent, new QEvent((QEvent::Type) (JOG_STOP + value)));
 232 }
 233
 234 void ShuttleThread::jog(unsigned int value)
 235 {
 236     // generate a synthetic event for the shuttle going
 237     // to the home position if we have not seen one recently.
 238     //if (shuttlevalue != 0) {
 239     //  QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
 240     //  shuttlevalue = 0;
 241     //}
 242
 243     // This code takes care of wrapping around the limits of the jog dial number (it is represented as a single byte, hence
 244     // wraps at the 0/255 boundary). I used 25 as the difference to make sure that even in heavy load, with the jog dial
 245     // turning fast and we miss some events that we do not mistakenly reverse the direction.
 246     // Note also that at least the Contour ShuttlePRO v2 does not send an event for the value 0, so at the wrap it will
 247     // need 2 events to go forward. But that is nothing we can do about...
 248     if (jogvalue != 0xffff) {
 249         //fprintf(stderr, "value=%d jogvalue=%d\n", value, jogvalue);
 250         bool wrap = abs(value - jogvalue) > 25;
 251         bool rewind = value < jogvalue;
 252         bool forward = value > jogvalue;
 253         if ((rewind && !wrap) || (forward && wrap))
 254             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK1));
 255         else if ((forward && !wrap) || (rewind && wrap))
 256             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD1));
 257         else if (!forward && !rewind && shuttlecounter > 2) {
 258             // An event without changing the jog value is sent after each shuttle change.
 259             // As the shuttle rest position does not get a shuttle event, only a non-position-changing jog event.
 260             // Hence we stop on this when we see 2 non-position-changing jog events in a row.
 261             shuttlecounter = 0;
 262             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
 263         }
 264     }
 265     jogvalue = value;
 266     if (shuttlecounter > 0) shuttlecounter++;
 267 }
 268
 269
 270 JogShuttle::JogShuttle(const QString &device, QObject *parent) :
 271         QObject(parent)
 272 {
 273     initDevice(device);
 274 }
 275
 276 JogShuttle::~JogShuttle()
 277 {
 278         stopDevice();
 279 }
 280
 281 void JogShuttle::initDevice(const QString &device)
 282 {
 283     if (m_shuttleProcess.isRunning()) {
 284         if (device == m_shuttleProcess.m_device) return;
 285         stopDevice();
 286     }
 287     m_shuttleProcess.init(this, device);
 288     m_shuttleProcess.start(QThread::LowestPriority);
 289 }
 290
 291 void JogShuttle::stopDevice()
 292 {
 293     if (m_shuttleProcess.isRunning()) {
 294         /* tell thread to stop */
 295         m_shuttleProcess.stop_me = true;
 296         m_shuttleProcess.exit();
 297         /* give the thread some time (ms) to shutdown */
 298         m_shuttleProcess.wait(600);
 299
 300         /* if still running - do it in the hardcore way */
 301         if (m_shuttleProcess.isRunning()) {
 302                 m_shuttleProcess.terminate();
 303             kDebug() << "/// terminate jogshuttle process\n";
 304         }
 305     }
 306 }
 307
 308 void JogShuttle::customEvent(QEvent* e)
 309 {
 310     int code = e->type();
 311
 312     // Handle simple job events
 313     switch (code) {
 314     case JOG_BACK1:
 315         emit jogBack();
 316         return;
 317     case JOG_FWD1:
 318         emit jogForward();
 319         return;
 320     }
 321
 322     int shuttle_pos = code - JOG_STOP;
 323     if (shuttle_pos >= -MAX_SHUTTLE_RANGE && shuttle_pos <= MAX_SHUTTLE_RANGE) {
 324         emit shuttlePos(shuttle_pos);
 325         return;
 326     }
 327
 328     // we've got a key event.
 329     //fprintf(stderr, "Firing button event for #%d\n", e->type() - KEY_EVENT_OFFSET); // DBG
 330     emit button(e->type() - KEY_EVENT_OFFSET);
 331 }
 332
 333
 334
 335 // #include "jogshuttle.moc"
 336
 337
 338 #include "jogshuttle.moc"