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