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 <linux/input.h>
  35
  36 #define DELAY 10
  37
  38 #define KEY 1
  39 #define KEY1 256
  40 #define KEY2 257
  41 #define KEY3 258
  42 #define KEY4 259
  43 #define KEY5 260
  44 #define KEY6 261
  45 #define KEY7 262
  46 #define KEY8 263
  47 #define KEY9 264
  48 #define KEY10 265
  49 #define KEY11 266
  50 #define KEY12 267
  51 #define KEY13 268
  52 #define KEY14 269
  53 #define KEY15 270
  54
  55 // Constants for the returned events when reading them from the device
  56 #define JOGSHUTTLE 2
  57 #define JOG 7
  58 #define SHUTTLE 8
  59
  60 // Constants for the signals sent.
  61 #define JOG_BACK1 10001
  62 #define JOG_FWD1 10002
  63 #define KEY_EVENT_OFFSET 20000
  64
  65 // middle value for shuttle, will be +/-MAX_SHUTTLE_RANGE
  66 #define JOG_STOP 10020
  67 #define MAX_SHUTTLE_RANGE 7
  68
  69 void ShuttleThread::init(QObject *parent, QString device)
  70 {
  71     m_parent = parent;
  72     m_device = device;
  73     stop_me = false;
  74     m_isWorking = false;
  75     shuttlevalue = 0xffff;
  76     shuttlecounter = 0;
  77     jogvalue = 0xffff;
  78 }
  79
  80 bool ShuttleThread::isWorking()
  81 {
  82     return m_isWorking;
  83 }
  84
  85 void ShuttleThread::run()
  86 {
  87     kDebug() << "-------  STARTING SHUTTLE: " << m_device;
  88
  89     const int fd = KDE_open((char *) m_device.toUtf8().data(), O_RDONLY);
  90     if (fd < 0) {
  91         fprintf(stderr, "Can't open Jog Shuttle FILE DESCRIPTOR\n");
  92         return;;
  93     }
  94     EV ev;
  95
  96     if (ioctl(fd, EVIOCGRAB, 1) < 0) {
  97         fprintf(stderr, "Can't get exclusive access on  Jog Shuttle FILE DESCRIPTOR\n");
  98         close(fd);
  99         return;;
 100     }
 101
 102     int num_warnings = 0;
 103     while (!stop_me) {
 104         if (read(fd, &ev, sizeof(ev)) < 0) {
 105             if (num_warnings % 10000 == 0)
 106                 fprintf(stderr, "Failed to read event from Jog Shuttle FILE DESCRIPTOR (repeated %d times)\n", num_warnings + 1);
 107             num_warnings++;
 108         }
 109         handle_event(ev);
 110     }
 111     close(fd);
 112
 113 }
 114
 115 void ShuttleThread::handle_event(EV ev)
 116 {
 117     switch (ev.type) {
 118     case KEY :
 119         key(ev.code, ev.value);
 120         break;
 121     case JOGSHUTTLE :
 122         if (ev.code == JOG)
 123             jog(ev.value);
 124         if (ev.code == SHUTTLE)
 125             shuttle(ev.value);
 126         break;
 127     }
 128 }
 129
 130 void ShuttleThread::key(unsigned short code, unsigned int value)
 131 {
 132     if (value == 0) {
 133         // Button release (ignored)
 134         return;
 135     }
 136
 137     // Check key index
 138     code -= KEY1 - 1;
 139     if (code > 16)
 140         return;
 141
 142     kDebug() << "Button PRESSED: " << code;
 143     QApplication::postEvent(m_parent, new QEvent((QEvent::Type)(KEY_EVENT_OFFSET + code)));
 144
 145 }
 146
 147 void ShuttleThread::shuttle(int value)
 148 {
 149     //gettimeofday( &last_shuttle, 0 );
 150     //need_synthetic_shuttle = value != 0;
 151
 152     if (value == shuttlevalue) {
 153         shuttlecounter = 1;
 154         return;
 155     }
 156
 157     if (value > MAX_SHUTTLE_RANGE || value < -MAX_SHUTTLE_RANGE) {
 158         fprintf(stderr, "Jog Shuttle returned value of %d (should be between -%d ad +%d)", value, MAX_SHUTTLE_RANGE, MAX_SHUTTLE_RANGE);
 159         return;
 160     }
 161     shuttlevalue = value;
 162     shuttlecounter = 1;
 163     QApplication::postEvent(m_parent, new QEvent((QEvent::Type) (JOG_STOP + value)));
 164 }
 165
 166 void ShuttleThread::jog(unsigned int value)
 167 {
 168     // generate a synthetic event for the shuttle going
 169     // to the home position if we have not seen one recently.
 170     //if (shuttlevalue != 0) {
 171     //  QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
 172     //  shuttlevalue = 0;
 173     //}
 174
 175     // This code takes care of wrapping around the limits of the jog dial number (it is represented as a single byte, hence
 176     // wraps at the 0/255 boundary). I used 25 as the difference to make sure that even in heavy load, with the jog dial
 177     // turning fast and we miss some events that we do not mistakenly reverse the direction.
 178     // Note also that at least the Contour ShuttlePRO v2 does not send an event for the value 0, so at the wrap it will
 179     // need 2 events to go forward. But that is nothing we can do about...
 180     if (jogvalue != 0xffff) {
 181         //fprintf(stderr, "value=%d jogvalue=%d\n", value, jogvalue);
 182         bool wrap = abs(value - jogvalue) > 25;
 183         bool rewind = value < jogvalue;
 184         bool forward = value > jogvalue;
 185         if ((rewind && !wrap) || (forward && wrap))
 186             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK1));
 187         else if ((forward && !wrap) || (rewind && wrap))
 188             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD1));
 189         else if (!forward && !rewind && shuttlecounter > 2) {
 190             // An event without changing the jog value is sent after each shuttle change.
 191             // As the shuttle rest position does not get a shuttle event, only a non-position-changing jog event.
 192             // Hence we stop on this when we see 2 non-position-changing jog events in a row.
 193             shuttlecounter = 0;
 194             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
 195         }
 196     }
 197     jogvalue = value;
 198     if (shuttlecounter > 0) shuttlecounter++;
 199 }
 200
 201
 202 JogShuttle::JogShuttle(QString device, QObject *parent) :
 203         QObject(parent)
 204 {
 205     initDevice(device);
 206 }
 207
 208 JogShuttle::~JogShuttle()
 209 {
 210     if (m_shuttleProcess.isRunning()) m_shuttleProcess.exit();
 211 }
 212
 213 void JogShuttle::initDevice(QString device)
 214 {
 215     if (m_shuttleProcess.isRunning()) {
 216         if (device == m_shuttleProcess.m_device) return;
 217         stopDevice();
 218     }
 219     m_shuttleProcess.init(this, device);
 220     m_shuttleProcess.start(QThread::LowestPriority);
 221 }
 222
 223 void JogShuttle::stopDevice()
 224 {
 225     if (m_shuttleProcess.isRunning())
 226         m_shuttleProcess.stop_me = true;
 227 }
 228
 229 void JogShuttle::customEvent(QEvent* e)
 230 {
 231     int code = e->type();
 232
 233     // Handle simple job events
 234     switch (code) {
 235     case JOG_BACK1:
 236         emit jogBack();
 237         return;
 238     case JOG_FWD1:
 239         emit jogForward();
 240         return;
 241     }
 242
 243     int shuttle_pos = code - JOG_STOP;
 244     if (shuttle_pos >= -MAX_SHUTTLE_RANGE && shuttle_pos <= MAX_SHUTTLE_RANGE) {
 245         emit shuttlePos(shuttle_pos);
 246         return;
 247     }
 248
 249     // we've got a key event.
 250     //fprintf(stderr, "Firing button event for #%d\n", e->type() - KEY_EVENT_OFFSET); // DBG
 251     emit button(e->type() - KEY_EVENT_OFFSET);
 252 }
 253
 254
 255
 256 // #include "jogshuttle.moc"
 257