]> git.sesse.net Git - kdenlive/blobdiff - src/jogshuttle.cpp
jogshuttle: enumerate devices using mediactrl
[kdenlive] / src / jogshuttle.cpp
index 208706cc4a744c5a0f7d9458372543cfc15acbd3..c846e9c96e4a10eada03cc6f80943d056bcc0b6d 100644 (file)
  ***************************************************************************/
 
 
+#include "jogshuttle.h"
+
+#include <KDebug>
+#include <kde_file.h>
+
+#include <QApplication>
+#include <QEvent>
+#include <QDir>
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <errno.h>
+#include <string.h>
+#include <linux/input.h>
 
 #define DELAY 10
 
 #define KEY14 269
 #define KEY15 270
 
+// Constants for the returned events when reading them from the device
 #define JOGSHUTTLE 2
 #define JOG 7
 #define SHUTTLE 8
 
+// Constants for the signals sent.
 #define JOG_BACK1 10001
 #define JOG_FWD1 10002
-#define JOG_FWD 10003
-#define JOG_FWD_SLOW 10004
-#define JOG_FWD_FAST 10005
-#define JOG_BACK 10006
-#define JOG_BACK_SLOW 10007
-#define JOG_BACK_FAST 10008
-#define JOG_STOP 10009
-
-
-#include <QApplication>
-#include <QEvent>
-
-#include <KDebug>
-#include <kde_file.h>
-
-#include <stdlib.h>
-#include <stdio.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <linux/input.h>
-
+#define KEY_EVENT_OFFSET 20000
 
+// middle value for shuttle, will be +/-MAX_SHUTTLE_RANGE
+#define JOG_STOP 10020
+#define MAX_SHUTTLE_RANGE 7
 
-#include "jogshuttle.h"
-
-
-void ShuttleThread::init(QObject *parent, QString device) {
+void ShuttleThread::init(QObject *parent, const QString &device)
+{
     m_parent = parent;
     m_device = device;
     stop_me = false;
     m_isWorking = false;
     shuttlevalue = 0xffff;
+    shuttlecounter = 0;
     jogvalue = 0xffff;
 }
 
-bool ShuttleThread::isWorking() {
+bool ShuttleThread::isWorking()
+{
     return m_isWorking;
 }
 
-void ShuttleThread::run() {
-    kDebug() << "-------  STARTING SHUTTLE: " << m_device;
-
-    const int fd = KDE_open((char *) m_device.toUtf8().data(), O_RDONLY);
-    if (fd < 0) {
-        fprintf(stderr, "Can't open Jog Shuttle FILE DESCRIPTOR\n");
-        return;;
-    }
-    EV ev;
-
-    if (ioctl(fd, EVIOCGRAB, 1) < 0) {
-        fprintf(stderr, "Can't get exclusive access on  Jog Shuttle FILE DESCRIPTOR\n");
-        return;;
+void ShuttleThread::run()
+{
+       kDebug() << "-------  STARTING SHUTTLE: " << m_device;
+       struct media_ctrl mc;
+    media_ctrl_open2(&mc, m_device.toUtf8().data());
+
+    /* open file descriptor */
+       //const int fd = KDE_open((char *) m_device.toUtf8().data(), O_RDONLY);
+       if (mc.fd < 0) {
+               perror("Can't open Jog Shuttle FILE DESCRIPTOR");
+               return;
+       }
+
+       EV ev[64];
+#if 0
+       if (ioctl(fd, EVIOCGRAB, 1) < 0) {
+               fprintf(stderr, "Can't get exclusive access on  Jog Shuttle FILE DESCRIPTOR\n");
+               close(fd);
+               return;
+       }
+#endif
+
+       fd_set             readset;
+       struct timeval timeout;
+
+       int num_warnings = 0, readResult = 0;
+       int result, iof = -1;
+#if 0
+       /* get fd settings */
+    if ((iof = fcntl(fd, F_GETFL, 0)) == -1) {
+        fprintf(stderr, "Can't get Jog Shuttle file status\n");
+        close(fd);
+        return;
     }
-
-    while (!stop_me) {
-        read(fd, &ev, sizeof(ev));
-        handle_event(ev);
+#endif
+#if 0
+    else if (fcntl(fd, F_SETFL, iof | O_NONBLOCK) == -1) {
+        fprintf(stderr, "Can't set Jog Shuttle FILE DESCRIPTOR to O_NONBLOCK and stop thread\n");
+        close(fd);
+        return;
     }
-    close(fd);
+#endif
+    struct media_ctrl_event mev;
+
+       /* enter thread loop */
+       while (!stop_me) {
+               /* reset the read set */
+               FD_ZERO(&readset);
+               FD_SET(mc.fd, &readset);
+
+               /* reinit the timeout structure */
+               timeout.tv_sec  = 0;
+               timeout.tv_usec = 400000; /* 400 ms */
+
+               /* do select in blocked mode and wake up after timeout for eval stop_me */
+               result = select(mc.fd+1, &readset, NULL, NULL, &timeout);
+
+               /* see if there was an error or timeout else process event */
+               if (result < 0 && errno == EINTR) {
+                       /* EINTR event catched. This is not a problem - continue processing */
+                       kDebug() << strerror(errno) << "\n";
+                       /* continue processing */
+                       continue;
+               } else if (result < 0) {
+                       /* stop thread */
+                       stop_me = true;
+                       kDebug() << strerror(errno) << "\n";
+               } else if (result == 0) {
+                       /* do nothing. reserved for future purposes */
+               } else {
+                       /* we have input */
+                       if (FD_ISSET(mc.fd, &readset)) {
+                               /* read input */
+                           mev.type = MEDIA_CTRL_EVENT_NONE;
+                               //readResult = read(fd, ev, sizeof(EV) * 64);
+                               media_ctrl_read_event(&mc, &mev);
+                /* process event */
+                handle_event(mev);
+#if 0
+                               if (readResult < 0) {
+                                       if (num_warnings % 10000 == 0) {
+                                               /* if device is not available anymore - dead or disconnected */
+                                               fprintf(stderr, "Failed to read event from Jog Shuttle FILE DESCRIPTOR (repeated %d times)\n", num_warnings + 1);
+                                       }
+                                       /* exit if device is not available or the error occurs to long */
+                                       if (errno == ENODEV) {
+                                               perror("Failed to read from Jog Shuttle FILE DESCRIPTOR. Stop thread");
+                                               /* stop thread */
+                                               stop_me = true;
+                                       } else if (num_warnings > 1000000) {
+                                               perror("Failed to read from Jog Shuttle FILE DESCRIPTOR. Limit reached. Stop thread");
+                                               /* stop thread */
+                                               stop_me = true;
+                                       }
+                                       num_warnings++;
+                               } else if (readResult < (int)sizeof(EV)) {
+                                       fprintf(stderr, "readResult < (int)sizeof(EV)\n");
+                                       /* stop thread */
+                                       stop_me = true;
+                               } else if (readResult % (int)sizeof(EV) != 0) {
+                                       fprintf(stderr, "readResult mod (int)sizeof(EV) != 0\n");
+                                       /* stop thread */
+                                       stop_me = true;
+                               } else {
+                                       for (int i = 0; i < readResult / (int)sizeof(EV); i++) {
+                                               /* process event */
+                                               handle_event(ev[i]);
+                                       }
+                               }
+#endif
+                       }
+               }
+       }
+
+    kDebug() << "-------  STOPPING SHUTTLE: ";
+       /* close the handle and return thread */
+       //close(fd);
+    media_ctrl_close(&mc);
+}
 
+void ShuttleThread::handle_event(struct media_ctrl_event ev)
+{
+    if (ev.type == MEDIA_CTRL_EVENT_KEY)
+        key(ev);
+    else if (ev.type == MEDIA_CTRL_EVENT_JOG)
+        jog(ev);
+    else if (ev.type == MEDIA_CTRL_EVENT_SHUTTLE)
+        shuttle(ev);
 }
 
-void ShuttleThread::handle_event(EV ev) {
+void ShuttleThread::handle_event(EV ev)
+{
     switch (ev.type) {
     case KEY :
         key(ev.code, ev.value);
         break;
     case JOGSHUTTLE :
-        jogshuttle(ev.code, ev.value);
+        if (ev.code == JOG)
+            jog(ev.value);
+        if (ev.code == SHUTTLE)
+            shuttle(ev.value);
         break;
     }
 }
 
-void ShuttleThread::key(unsigned short code, unsigned int value) {
+void ShuttleThread::key(struct media_ctrl_event ev)
+{
+    if (ev.value == KEY_PRESS) {
+        int code = ev.index + 1;
+        QApplication::postEvent(m_parent, new QEvent((QEvent::Type)(KEY_EVENT_OFFSET + code)));
+    }
+}
+
+void ShuttleThread::key(unsigned short code, unsigned int value)
+{
     if (value == 0) {
         // Button release (ignored)
         return;
     }
 
+    // Check key index
     code -= KEY1 - 1;
-
-    // Bound check!
     if (code > 16)
         return;
 
-    kDebug() << "Button PRESSED: " << code;
-    QApplication::postEvent(m_parent, new QEvent((QEvent::Type)(20000 + code)));
+    //kDebug() << "Button PRESSED: " << code;
+    QApplication::postEvent(m_parent, new QEvent((QEvent::Type)(KEY_EVENT_OFFSET + code)));
 
 }
 
-void ShuttleThread::shuttle(int value) {
+void ShuttleThread::shuttle(struct media_ctrl_event ev)
+{
+    QApplication::postEvent(m_parent, new QEvent((QEvent::Type) (JOG_STOP + (ev.value/2))));
+}
+
+void ShuttleThread::shuttle(int value)
+{
     //gettimeofday( &last_shuttle, 0 );
     //need_synthetic_shuttle = value != 0;
 
-    if (value == shuttlevalue)
+    if (value == shuttlevalue) {
+       shuttlecounter = 1;
         return;
-    shuttlevalue = value;
-    switch (value) {
-    case - 7 :
-    case - 6 :
-    case - 5 :
-    case - 4 :
-    case - 3 :
-        QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK_FAST));
-        break;  // Reverse fast
-    case - 2 :
-        QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK));
-        break;  // Reverse
-    case - 1 :
-        QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK_SLOW));
-        break;  // Reverse slow
-    case  0 :
-        QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
-        break;  // Stop!
-    case  1 :
-        QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD_SLOW));
-        break;  // Forward slow
-    case  2 :
-        QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD));
-        break;  // Normal play
-    case  3 :
-    case  4 :
-    case  5 :
-    case  6 :
-    case  7 :
-        QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD_FAST));
-        break; // Fast forward
     }
 
+    if (value > MAX_SHUTTLE_RANGE || value < -MAX_SHUTTLE_RANGE) {
+        fprintf(stderr, "Jog Shuttle returned value of %d (should be between -%d ad +%d)", value, MAX_SHUTTLE_RANGE, MAX_SHUTTLE_RANGE);
+        return;
+    }
+    shuttlevalue = value;
+    shuttlecounter = 1;
+    QApplication::postEvent(m_parent, new QEvent((QEvent::Type) (JOG_STOP + value)));
 }
 
-void ShuttleThread::jog(unsigned int value) {
-    // We should generate a synthetic event for the shuttle going
-    // to the home position if we have not seen one recently
-    //check_synthetic();
+void ShuttleThread::jog(struct media_ctrl_event ev)
+{
+    if (ev.value < 0)
+        QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK1));
+    else if (ev.value > 0)
+        QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD1));
+}
 
+void ShuttleThread::jog(unsigned int value)
+{
+    // generate a synthetic event for the shuttle going
+    // to the home position if we have not seen one recently.
+    //if (shuttlevalue != 0) {
+    //  QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
+    //  shuttlevalue = 0;
+    //}
+
+    // This code takes care of wrapping around the limits of the jog dial number (it is represented as a single byte, hence
+    // wraps at the 0/255 boundary). I used 25 as the difference to make sure that even in heavy load, with the jog dial
+    // turning fast and we miss some events that we do not mistakenly reverse the direction.
+    // Note also that at least the Contour ShuttlePRO v2 does not send an event for the value 0, so at the wrap it will
+    // need 2 events to go forward. But that is nothing we can do about...
     if (jogvalue != 0xffff) {
-        if (value < jogvalue)
+        //fprintf(stderr, "value=%d jogvalue=%d\n", value, jogvalue);
+        bool wrap = abs(value - jogvalue) > 25;
+        bool rewind = value < jogvalue;
+        bool forward = value > jogvalue;
+        if ((rewind && !wrap) || (forward && wrap))
             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_BACK1));
-        else if (value > jogvalue)
+        else if ((forward && !wrap) || (rewind && wrap))
             QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_FWD1));
+        else if (!forward && !rewind && shuttlecounter > 2) {
+            // An event without changing the jog value is sent after each shuttle change.
+            // As the shuttle rest position does not get a shuttle event, only a non-position-changing jog event.
+            // Hence we stop on this when we see 2 non-position-changing jog events in a row.
+           shuttlecounter = 0;
+            QApplication::postEvent(m_parent, new QEvent((QEvent::Type) JOG_STOP));
+       }
     }
     jogvalue = value;
+    if (shuttlecounter > 0) shuttlecounter++;
 }
 
 
-void ShuttleThread::jogshuttle(unsigned short code, unsigned int value) {
-    switch (code) {
-    case JOG :
-        jog(value);
-        break;
-    case SHUTTLE :
-        shuttle(value);
-        break;
-    }
-}
-
-
-JogShuttle::JogShuttle(QString device, QObject *parent): QObject(parent) {
+JogShuttle::JogShuttle(const QString &device, QObject *parent) :
+        QObject(parent)
+{
     initDevice(device);
 }
 
-JogShuttle::~JogShuttle() {
-    if (m_shuttleProcess.isRunning()) m_shuttleProcess.exit();
+JogShuttle::~JogShuttle()
+{
+       stopDevice();
 }
 
-void JogShuttle::initDevice(QString device) {
-    if (m_shuttleProcess.isRunning()) return;
+void JogShuttle::initDevice(const QString &device)
+{
+    if (m_shuttleProcess.isRunning()) {
+        if (device == m_shuttleProcess.m_device) return;
+        stopDevice();
+    }
     m_shuttleProcess.init(this, device);
     m_shuttleProcess.start(QThread::LowestPriority);
 }
 
-void JogShuttle::stopDevice() {
-    if (m_shuttleProcess.isRunning()) m_shuttleProcess.stop_me = true;
+void JogShuttle::stopDevice()
+{
+    if (m_shuttleProcess.isRunning()) {
+       /* tell thread to stop */
+        m_shuttleProcess.stop_me = true;
+        m_shuttleProcess.exit();
+        /* give the thread some time (ms) to shutdown */
+        m_shuttleProcess.wait(600);
+
+        /* if still running - do it in the hardcore way */
+        if (m_shuttleProcess.isRunning()) {
+               m_shuttleProcess.terminate();
+            kDebug() << "/// terminate jogshuttle process\n";
+        }
+    }
 }
 
-void JogShuttle::customEvent(QEvent* e) {
-    switch (e->type()) {
+void JogShuttle::customEvent(QEvent* e)
+{
+    int code = e->type();
+
+    // Handle simple job events
+    switch (code) {
     case JOG_BACK1:
-        emit rewind1();
-        break;
+        emit jogBack();
+        return;
     case JOG_FWD1:
-        emit forward1();
-        break;
-    case JOG_BACK:
-        emit rewind(-1);
-        break;
-    case JOG_FWD:
-        emit forward(1);
-        break;
-    case JOG_BACK_SLOW:
-        emit rewind(-0.5);
-        break;
-    case JOG_FWD_SLOW:
-        emit forward(0.5);
-        break;
-    case JOG_BACK_FAST:
-        emit rewind(-2);
-        break;
-    case JOG_FWD_FAST:
-        emit forward(2);
-        break;
-    case JOG_STOP:
-        emit stop();
-        break;
-    default:
-        emit button(e->type() - 20000);
+        emit jogForward();
+        return;
+    }
+
+    int shuttle_pos = code - JOG_STOP;
+    if (shuttle_pos >= -MAX_SHUTTLE_RANGE && shuttle_pos <= MAX_SHUTTLE_RANGE) {
+        emit shuttlePos(shuttle_pos);
+        return;
     }
+
+    // we've got a key event.
+    //fprintf(stderr, "Firing button event for #%d\n", e->type() - KEY_EVENT_OFFSET); // DBG
+    emit button(e->type() - KEY_EVENT_OFFSET);
+}
+
+QString JogShuttle::enumerateDevice(const QString& device)
+{
+    return QDir(device).canonicalPath();
 }
 
+DeviceMap JogShuttle::enumerateDevices(const QString& devPath)
+{
+    DeviceMap devs;
+    QDir devDir(devPath);
+
+    if (!devDir.exists()) {
+        return devs;
+    }
+
+    QStringList fileList = devDir.entryList(QDir::System | QDir::Files);
+    foreach (const QString &fileName, fileList) {
+        QString devFullPath = devDir.absoluteFilePath(fileName);
+        QString fileLink = JogShuttle::enumerateDevice(devFullPath);
+        kDebug() << QString(" [%1] ").arg(fileName);
+        kDebug() << QString(" [%1] ").arg(fileLink);
+
+        struct media_ctrl mc;
+        media_ctrl_open2(&mc, (char*)fileLink.toUtf8().data());
+        if (mc.fd > 0 && mc.device) {
+            devs.insert(QString(mc.device->name), devFullPath);
+        }
+        media_ctrl_close(&mc);
+    }
+
+    return devs;
+}
 
 
 // #include "jogshuttle.moc"
 
+
+#include "jogshuttle.moc"