]> git.sesse.net Git - kdenlive/blob - src/jogshuttle.cpp
b5dd0e8cbe2f641af58d8a6027f30c8957d7621b
[kdenlive] / 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     shuttlechange = false;
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         return;;
99     }
100
101     int num_warnings = 0;
102     while (!stop_me) {
103         if (read(fd, &ev, sizeof(ev)) < 0) {
104             if (num_warnings % 10000 == 0)
105                 fprintf(stderr, "Failed to read event from Jog Shuttle FILE DESCRIPTOR (repeated %d times)\n", num_warnings + 1);
106             num_warnings++;
107         }
108         handle_event(ev);
109     }
110     close(fd);
111
112 }
113
114 void ShuttleThread::handle_event(EV ev)
115 {
116     switch (ev.type) {
117     case KEY :
118         key(ev.code, ev.value);
119         break;
120     case JOGSHUTTLE :
121         if (ev.code == JOG)
122             jog(ev.value);
123         if (ev.code == SHUTTLE)
124             shuttle(ev.value);
125         break;
126     }
127 }
128
129 void ShuttleThread::key(unsigned short code, unsigned int value)
130 {
131     if (value == 0) {
132         // Button release (ignored)
133         return;
134     }
135
136     // Check key index
137     code -= KEY1 - 1;
138     if (code > 16)
139         return;
140
141     kDebug() << "Button PRESSED: " << code;
142     QApplication::postEvent(m_parent, new QEvent((QEvent::Type)(KEY_EVENT_OFFSET + code)));
143
144 }
145
146 void ShuttleThread::shuttle(int value)
147 {
148     //gettimeofday( &last_shuttle, 0 );
149     //need_synthetic_shuttle = value != 0;
150
151     if (value == shuttlevalue)
152         return;
153
154     if (value > MAX_SHUTTLE_RANGE || value < -MAX_SHUTTLE_RANGE) {
155         fprintf(stderr, "Jog Shuttle returned value of %d (should be between -%d ad +%d)", value, MAX_SHUTTLE_RANGE, MAX_SHUTTLE_RANGE);
156         return;
157     }
158     shuttlevalue = value;
159     shuttlechange = true;
160     QApplication::postEvent(m_parent, new QEvent((QEvent::Type) (JOG_STOP + value)));
161 }
162
163 void ShuttleThread::jog(unsigned int value)
164 {
165     // generate a synthetic event for the shuttle going
166     // to the home position if we have not seen one recently.
167     //if (shuttlevalue != 0) {
168     //  QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
169     //  shuttlevalue = 0;
170     //}
171
172     // This code takes care of wrapping around the limits of the jog dial number (it is represented as a single byte, hence
173     // wraps at the 0/255 boundary). I used 25 as the difference to make sure that even in heavy load, with the jog dial
174     // turning fast and we miss some events that we do not mistakenly reverse the direction.
175     // Note also that at least the Contour ShuttlePRO v2 does not send an event for the value 0, so at the wrap it will
176     // need 2 events to go forward. But that is nothing we can do about...
177     if (jogvalue != 0xffff) {
178         //fprintf(stderr, "value=%d jogvalue=%d\n", value, jogvalue);
179         bool wrap = abs(value - jogvalue) > 25;
180         bool rewind = value < jogvalue;
181         bool forward = value > jogvalue;
182         if ((rewind && !wrap) || (forward && wrap))
183             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK1));
184         else if ((forward && !wrap) || (rewind && wrap))
185             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD1));
186         else if (!forward && !rewind && !shuttlechange)
187             // An event without changing the jog value is sent after each shuttle change.
188             // As the shuttle rest position does not get a shuttle event, only a non-position-changing jog event.
189             // Hence we stop on this when we see 2 non-position-changing jog events in a row.
190             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
191     }
192     jogvalue = value;
193     shuttlechange = false;
194 }
195
196
197 JogShuttle::JogShuttle(QString device, QObject *parent) :
198         QObject(parent)
199 {
200     initDevice(device);
201 }
202
203 JogShuttle::~JogShuttle()
204 {
205     if (m_shuttleProcess.isRunning()) m_shuttleProcess.exit();
206 }
207
208 void JogShuttle::initDevice(QString device)
209 {
210     if (m_shuttleProcess.isRunning()) {
211         if (device == m_shuttleProcess.m_device) return;
212         stopDevice();
213     }
214     m_shuttleProcess.init(this, device);
215     m_shuttleProcess.start(QThread::LowestPriority);
216 }
217
218 void JogShuttle::stopDevice()
219 {
220     if (m_shuttleProcess.isRunning())
221         m_shuttleProcess.stop_me = true;
222 }
223
224 void JogShuttle::customEvent(QEvent* e)
225 {
226     int code = e->type();
227
228     // Handle simple job events
229     switch (code) {
230     case JOG_BACK1:
231         emit jogBack();
232         return;
233     case JOG_FWD1:
234         emit jogForward();
235         return;
236     }
237
238     int shuttle_pos = code - JOG_STOP;
239     if (shuttle_pos >= -MAX_SHUTTLE_RANGE && shuttle_pos <= MAX_SHUTTLE_RANGE) {
240         emit shuttlePos(shuttle_pos);
241         return;
242     }
243
244     // we've got a key event.
245     //fprintf(stderr, "Firing button event for #%d\n", e->type() - KEY_EVENT_OFFSET); // DBG
246     emit button(e->type() - KEY_EVENT_OFFSET);
247 }
248
249
250
251 // #include "jogshuttle.moc"
252