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
  91         /* open file descriptor */
  92         const int fd = KDE_open((char *) m_device.toUtf8().data(), O_RDONLY);
  93         if (fd < 0) {
  94                 perror("Can't open Jog Shuttle FILE DESCRIPTOR");
  95                 return;
  96         }
  97
  98         EV ev[64];
  99
 100         if (ioctl(fd, EVIOCGRAB, 1) < 0) {
 101                 fprintf(stderr, "Can't get exclusive access on  Jog Shuttle FILE DESCRIPTOR\n");
 102                 close(fd);
 103                 return;
 104         }
 105
 106         fd_set             readset;
 107         struct timeval timeout;
 108
 109         int num_warnings = 0, readResult = 0;
 110         int result, iof = -1;
 111
 112         /* get fd settings */
 113     if ((iof = fcntl(fd, F_GETFL, 0)) == -1) {
 114         fprintf(stderr, "Can't get Jog Shuttle file status\n");
 115         close(fd);
 116         return;
 117     }
 118
 119 #if 0
 120     else if (fcntl(fd, F_SETFL, iof | O_NONBLOCK) == -1) {
 121         fprintf(stderr, "Can't set Jog Shuttle FILE DESCRIPTOR to O_NONBLOCK and stop thread\n");
 122         close(fd);
 123         return;
 124     }
 125 #endif
 126
 127         /* enter thread loop */
 128         while (!stop_me) {
 129                 /* reset the read set */
 130                 FD_ZERO(&readset);
 131                 FD_SET(fd, &readset);
 132
 133                 /* reinit the timeout structure */
 134                 timeout.tv_sec  = 0;
 135                 timeout.tv_usec = 400000; /* 400 ms */
 136
 137                 /* do select in blocked mode and wake up after timeout for eval stop_me */
 138                 result = select(fd+1, &readset, NULL, NULL, &timeout);
 139
 140                 /* see if there was an error or timeout else process event */
 141                 if (result < 0 && errno == EINTR) {
 142                         /* EINTR event catched. This is not a problem - continue processing */
 143                         kDebug() << strerror(errno) << "\n";
 144                         /* continue processing */
 145                         continue;
 146                 } else if (result < 0) {
 147                         /* stop thread */
 148                         stop_me = true;
 149                         kDebug() << strerror(errno) << "\n";
 150                 } else if (result == 0) {
 151                         /* do nothing. reserved for future purposes */
 152                 } else {
 153                         /* we have input */
 154                         if (FD_ISSET(fd, &readset)) {
 155                                 /* read input */
 156                                 readResult = read(fd, ev, sizeof(EV) * 64);
 157                                 if (readResult < 0) {
 158                                         if (num_warnings % 10000 == 0) {
 159                                                 /* if device is not available anymore - dead or disconnected */
 160                                                 fprintf(stderr, "Failed to read event from Jog Shuttle FILE DESCRIPTOR (repeated %d times)\n", num_warnings + 1);
 161                                         }
 162                                         /* exit if device is not available or the error occurs to long */
 163                                         if (errno == ENODEV) {
 164                                                 perror("Failed to read from Jog Shuttle FILE DESCRIPTOR. Stop thread");
 165                                                 /* stop thread */
 166                                                 stop_me = true;
 167                                         } else if (num_warnings > 1000000) {
 168                                                 perror("Failed to read from Jog Shuttle FILE DESCRIPTOR. Limit reached. Stop thread");
 169                                                 /* stop thread */
 170                                                 stop_me = true;
 171                                         }
 172                                         num_warnings++;
 173                                 } else if (readResult < (int)sizeof(EV)) {
 174                                         fprintf(stderr, "readResult < (int)sizeof(EV)\n");
 175                                         /* stop thread */
 176                                         stop_me = true;
 177                                 } else if (readResult % (int)sizeof(EV) != 0) {
 178                                         fprintf(stderr, "readResult mod (int)sizeof(EV) != 0\n");
 179                                         /* stop thread */
 180                                         stop_me = true;
 181                                 } else {
 182                                         for (int i = 0; i < readResult / (int)sizeof(EV); i++) {
 183                                                 /* process event */
 184                                                 handle_event(ev[i]);
 185                                         }
 186                                 }
 187                         }
 188                 }
 189         }
 190
 191     kDebug() << "-------  STOPPING SHUTTLE: ";
 192         /* close the handle and return thread */
 193         close(fd);
 194 }
 195
 196 void ShuttleThread::handle_event(EV ev)
 197 {
 198     switch (ev.type) {
 199     case KEY :
 200         key(ev.code, ev.value);
 201         break;
 202     case JOGSHUTTLE :
 203         if (ev.code == JOG)
 204             jog(ev.value);
 205         if (ev.code == SHUTTLE)
 206             shuttle(ev.value);
 207         break;
 208     }
 209 }
 210
 211 void ShuttleThread::key(unsigned short code, unsigned int value)
 212 {
 213     if (value == 0) {
 214         // Button release (ignored)
 215         return;
 216     }
 217
 218     // Check key index
 219     code -= KEY1 - 1;
 220     if (code > 16)
 221         return;
 222
 223     //kDebug() << "Button PRESSED: " << code;
 224     QApplication::postEvent(m_parent, new QEvent((QEvent::Type)(KEY_EVENT_OFFSET + code)));
 225
 226 }
 227
 228 void ShuttleThread::shuttle(int value)
 229 {
 230     //gettimeofday( &last_shuttle, 0 );
 231     //need_synthetic_shuttle = value != 0;
 232
 233     if (value == shuttlevalue) {
 234         shuttlecounter = 1;
 235         return;
 236     }
 237
 238     if (value > MAX_SHUTTLE_RANGE || value < -MAX_SHUTTLE_RANGE) {
 239         fprintf(stderr, "Jog Shuttle returned value of %d (should be between -%d ad +%d)", value, MAX_SHUTTLE_RANGE, MAX_SHUTTLE_RANGE);
 240         return;
 241     }
 242     shuttlevalue = value;
 243     shuttlecounter = 1;
 244     QApplication::postEvent(m_parent, new QEvent((QEvent::Type) (JOG_STOP + value)));
 245 }
 246
 247 void ShuttleThread::jog(unsigned int value)
 248 {
 249     // generate a synthetic event for the shuttle going
 250     // to the home position if we have not seen one recently.
 251     //if (shuttlevalue != 0) {
 252     //  QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
 253     //  shuttlevalue = 0;
 254     //}
 255
 256     // This code takes care of wrapping around the limits of the jog dial number (it is represented as a single byte, hence
 257     // wraps at the 0/255 boundary). I used 25 as the difference to make sure that even in heavy load, with the jog dial
 258     // turning fast and we miss some events that we do not mistakenly reverse the direction.
 259     // Note also that at least the Contour ShuttlePRO v2 does not send an event for the value 0, so at the wrap it will
 260     // need 2 events to go forward. But that is nothing we can do about...
 261     if (jogvalue != 0xffff) {
 262         //fprintf(stderr, "value=%d jogvalue=%d\n", value, jogvalue);
 263         bool wrap = abs(value - jogvalue) > 25;
 264         bool rewind = value < jogvalue;
 265         bool forward = value > jogvalue;
 266         if ((rewind && !wrap) || (forward && wrap))
 267             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK1));
 268         else if ((forward && !wrap) || (rewind && wrap))
 269             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD1));
 270         else if (!forward && !rewind && shuttlecounter > 2) {
 271             // An event without changing the jog value is sent after each shuttle change.
 272             // As the shuttle rest position does not get a shuttle event, only a non-position-changing jog event.
 273             // Hence we stop on this when we see 2 non-position-changing jog events in a row.
 274             shuttlecounter = 0;
 275             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
 276         }
 277     }
 278     jogvalue = value;
 279     if (shuttlecounter > 0) shuttlecounter++;
 280 }
 281
 282
 283 JogShuttle::JogShuttle(const QString &device, QObject *parent) :
 284         QObject(parent)
 285 {
 286     initDevice(device);
 287 }
 288
 289 JogShuttle::~JogShuttle()
 290 {
 291         stopDevice();
 292 }
 293
 294 void JogShuttle::initDevice(const QString &device)
 295 {
 296     if (m_shuttleProcess.isRunning()) {
 297         if (device == m_shuttleProcess.m_device) return;
 298         stopDevice();
 299     }
 300     m_shuttleProcess.init(this, device);
 301     m_shuttleProcess.start(QThread::LowestPriority);
 302 }
 303
 304 void JogShuttle::stopDevice()
 305 {
 306     if (m_shuttleProcess.isRunning()) {
 307         /* tell thread to stop */
 308         m_shuttleProcess.stop_me = true;
 309         m_shuttleProcess.exit();
 310         /* give the thread some time (ms) to shutdown */
 311         m_shuttleProcess.wait(600);
 312
 313         /* if still running - do it in the hardcore way */
 314         if (m_shuttleProcess.isRunning()) {
 315                 m_shuttleProcess.terminate();
 316             kDebug() << "/// terminate jogshuttle process\n";
 317         }
 318     }
 319 }
 320
 321 void JogShuttle::customEvent(QEvent* e)
 322 {
 323     int code = e->type();
 324
 325     // Handle simple job events
 326     switch (code) {
 327     case JOG_BACK1:
 328         emit jogBack();
 329         return;
 330     case JOG_FWD1:
 331         emit jogForward();
 332         return;
 333     }
 334
 335     int shuttle_pos = code - JOG_STOP;
 336     if (shuttle_pos >= -MAX_SHUTTLE_RANGE && shuttle_pos <= MAX_SHUTTLE_RANGE) {
 337         emit shuttlePos(shuttle_pos);
 338         return;
 339     }
 340
 341     // we've got a key event.
 342     //fprintf(stderr, "Firing button event for #%d\n", e->type() - KEY_EVENT_OFFSET); // DBG
 343     emit button(e->type() - KEY_EVENT_OFFSET);
 344 }
 345
 346
 347
 348 // #include "jogshuttle.moc"
 349
 350
 351 #include "jogshuttle.moc"