git.sesse.net Git - kdenlive/blob - src/lib/external/media_ctrl/mediactrl.c

   1 /*
   2 * mediactrl.c -- Jog Shuttle device support
   3 * Copyright (C) 2001-2007 Dan Dennedy <dan@dennedy.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 Free Software Foundation,
  17 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18 */
  19 #include <stdlib.h>
  20 #include <stdio.h>
  21 #include <sys/ioctl.h>
  22 #include <sys/types.h>
  23 #include <sys/stat.h>
  24 #include <sys/time.h>
  25 #include <asm/types.h>
  26 #include <fcntl.h>
  27 #include <unistd.h>
  28 #include <stdint.h>
  29 #include <string.h>
  30 #include <errno.h>
  31
  32 #include <linux/input.h>
  33 #include "mediactrl.h"
  34
  35
  36 static char *_shuttle_name = "Shuttle";
  37 static char *_jog_name = "Jog";
  38
  39 /*
  40         ShuttlePro keys
  41 */
  42 static struct  media_ctrl_key mc_shuttle_pro_keys[] = {
  43         { 0x100, "Button 1", MEDIA_CTRL_F1 },
  44         { 0x101, "Button 2", MEDIA_CTRL_F2 },
  45         { 0x102, "Button 3", MEDIA_CTRL_F3 },
  46         { 0x103, "Button 4", MEDIA_CTRL_F4 },
  47         { 0x104, "Button 5", MEDIA_CTRL_B4 },
  48         { 0x105, "Button 6", MEDIA_CTRL_B2 },
  49         { 0x106, "Button 7", MEDIA_CTRL_B1 },
  50         { 0x107, "Button 8", MEDIA_CTRL_B3 },
  51         { 0x108, "Button 9", MEDIA_CTRL_B5 },
  52         { 0x109, "Button 10", MEDIA_CTRL_B6 },
  53         { 0x10a, "Button 11", MEDIA_CTRL_B7 },
  54         { 0x10b, "Button 12", MEDIA_CTRL_B8 },
  55         { 0x10c, "Button 13", MEDIA_CTRL_B9 },
  56         { 0, NULL, 0 }
  57 };
  58
  59
  60 /*
  61         ShuttleXPress keys
  62 */
  63 static struct  media_ctrl_key _mc_shuttle_xpress_keys[] = {
  64     { 0x104, "Button B4", MEDIA_CTRL_B4 },
  65     { 0x105, "Button B2", MEDIA_CTRL_B2 },
  66     { 0x106, "Button B1", MEDIA_CTRL_B1 },
  67     { 0x107, "Button B3", MEDIA_CTRL_B3 },
  68     { 0x108, "Button B5", MEDIA_CTRL_B5 },
  69     { 0, NULL, 0 }
  70 };
  71
  72 static struct  media_ctrl_key mc_shuttle_xpress_keys[] = {
  73     { 0x104, "Button B1", MEDIA_CTRL_B1},
  74     { 0x105, "Button B2", MEDIA_CTRL_B2 },
  75     { 0x106, "Button B3", MEDIA_CTRL_B3 },
  76     { 0x107, "Button B4", MEDIA_CTRL_B4 },
  77     { 0x108, "Button B5", MEDIA_CTRL_B5 },
  78     { 0, NULL, 0 }
  79 };
  80
  81
  82
  83 /*
  84         JLCooper MCS3 Keys
  85 */
  86 static struct  media_ctrl_key mc_jlcooper_mcs3_keys[] = {
  87         { 0x107, "F1", MEDIA_CTRL_F1 },
  88         { 0x101, "F2", MEDIA_CTRL_F2 },
  89         { 0x105, "F3", MEDIA_CTRL_F3 },
  90         { 0x102, "F4", MEDIA_CTRL_F4 },
  91         { 0x103, "F5", MEDIA_CTRL_F5 },
  92         { 0x104, "F6", MEDIA_CTRL_F6 },
  93         { 0x10d, "W1", MEDIA_CTRL_B6 },
  94         { 0x10e, "W2", MEDIA_CTRL_B4 },
  95         { 0x100, "W3", MEDIA_CTRL_B2 },
  96         { 0x106, "W4", MEDIA_CTRL_B1 },
  97         { 0x110, "W5", MEDIA_CTRL_B3 },
  98         { 0x111, "W6", MEDIA_CTRL_B5 },
  99         { 0x115, "W7", MEDIA_CTRL_B7 },
 100         { 0x116, "STICK_LEFT", MEDIA_CTRL_STICK_LEFT },
 101         { 0x113, "STICK_RIGHT", MEDIA_CTRL_STICK_RIGHT },
 102         { 0x114, "STICK_UP", MEDIA_CTRL_STICK_UP },
 103         { 0x112, "STICK_DOWN", MEDIA_CTRL_STICK_DOWN },
 104         { 0x10f, "Rewind", MEDIA_CTRL_REWIND },
 105         { 0x108, "Fast Forward", MEDIA_CTRL_FAST_FORWARD },
 106         { 0x109, "Stop", MEDIA_CTRL_STOP },
 107         { 0x10a, "Play", MEDIA_CTRL_PLAY },
 108         { 0x10b, "Record", MEDIA_CTRL_RECORD },
 109         { 0, NULL, 0 }
 110 };
 111
 112
 113 /*
 114         Griffin PowerMate
 115 */
 116 static struct media_ctrl_key mc_powermate_keys[] = {
 117         { BTN_0, "Button", MEDIA_CTRL_B1 },
 118         { 0, NULL, 0 }
 119 };
 120
 121
 122 /*
 123         X-Keys Jog/Shuttle
 124 */
 125 static struct  media_ctrl_key mc_x_keys[] = {
 126         { 0x102, "Button L1", MEDIA_CTRL_F1 },
 127         { 0x103, "Button L2", MEDIA_CTRL_F9 },
 128         { 0x104, "Button L3", MEDIA_CTRL_B1 },
 129         { 0x105, "Button L4", MEDIA_CTRL_B3 },
 130         { 0x106, "Button L5", MEDIA_CTRL_B5 },
 131         { 0x10a, "Button L6", MEDIA_CTRL_F2 },
 132         { 0x10b, "Button L7", MEDIA_CTRL_F10 },
 133         { 0x10c, "Button L8", MEDIA_CTRL_B2 },
 134         { 0x10d, "Button L9", MEDIA_CTRL_B4 },
 135         { 0x10e, "Button L10", MEDIA_CTRL_B6 },
 136         { 0x112, "Button C1", MEDIA_CTRL_F3 },
 137         { 0x11a, "Button C2", MEDIA_CTRL_F4 },
 138         { 0x122, "Button C3", MEDIA_CTRL_F5 },
 139         { 0x12a, "Button C4", MEDIA_CTRL_F6 },
 140         { 0x113, "Button C5", MEDIA_CTRL_F11 },
 141         { 0x11b, "Button C6", MEDIA_CTRL_F12 },
 142         { 0x123, "Button C7", MEDIA_CTRL_F13 },
 143         { 0x12b, "Button C8", MEDIA_CTRL_F14 },
 144         { 0x132, "Button R1", MEDIA_CTRL_F7 },
 145         { 0x133, "Button R2", MEDIA_CTRL_F15 },
 146         { 0x134, "Button R3", MEDIA_CTRL_B7 },
 147         { 0x135, "Button R4", MEDIA_CTRL_B9 },
 148         { 0x136, "Button R5", MEDIA_CTRL_B11 },
 149         { 0x13a, "Button R6", MEDIA_CTRL_F8 },
 150         { 0x13b, "Button R7", MEDIA_CTRL_F16 },
 151         { 0x13c, "Button R8", MEDIA_CTRL_B8 },
 152         { 0x13d, "Button R9", MEDIA_CTRL_B10 },
 153         { 0x13e, "Button R10", MEDIA_CTRL_B12 },
 154         { 0, NULL, 0 }
 155 };
 156
 157 struct  media_ctrl_key *media_ctrl_get_key(struct media_ctrl *ctrl, int code, int *index)
 158 {
 159         int i = 0;
 160         struct media_ctrl_key *keys = ctrl->device->keys;
 161
 162         while ( keys[i].key != 0 ) {
 163                 if (keys[i].key == code) {
 164                         if (index != NULL)
 165                                 *index = i;
 166                         return &keys[i];
 167                 }
 168                 i++;
 169         }
 170
 171         return NULL;
 172 }
 173
 174
 175 void translate_contour_hid_event(struct media_ctrl *ctrl, struct input_event *ev, struct media_ctrl_event *me)
 176 {
 177
 178         int lv, cv;
 179
 180         me->type = 0;
 181
 182         if (ev->type == EV_REL) {
 183                 /* First check the outer dial */
 184                 if (ev->code == REL_WHEEL) {
 185
 186                         cv = (signed int)ev->value;
 187                         if (cv == 1 || cv == -1 ) cv = 0;
 188
 189
 190                         if ( cv == ctrl->lastshu ) return;
 191             ctrl->lastshu = cv;
 192
 193             if ( cv > 0 ) cv -= 1;
 194             if ( cv < 0) cv += 1;
 195
 196                         //printf("Shuttle: %d\n", cv);
 197                         me->type  = MEDIA_CTRL_EVENT_SHUTTLE;
 198                         me->value = cv*2;
 199                         me->name = _shuttle_name;
 200
 201                 } else if  (ev->code == REL_DIAL) {
 202
 203                         if ( ctrl->lastval == -1 ) ctrl->lastval = ev->value;
 204                         lv = ctrl->lastval;
 205                         cv = ev->value;
 206
 207                         if ( lv == cv ) return;
 208
 209                         ctrl->lastval = cv;
 210
 211                         if (cv < 10 && lv > 0xF0) cv +=0x100;
 212                         if (lv < 10 && cv > 0xF0) lv +=0x100;
 213
 214                         me->type  = MEDIA_CTRL_EVENT_JOG;
 215                         me->value = cv-lv;
 216                         me->name = _jog_name;
 217
 218                         ctrl->jogpos += me->value;
 219                         //printf("Jog: %06ld (%d)\n", ctrl->jogpos, me->value);
 220                 }
 221                 return;
 222         } else if (ev->type == EV_KEY) {
 223                 int index;
 224                 struct media_ctrl_key *key = media_ctrl_get_key(ctrl, ev->code, &index);
 225                 if ( key == NULL ) return;
 226
 227                 me->type  = MEDIA_CTRL_EVENT_KEY;
 228                 me->code = key->code;
 229                 me->value = ev->value;
 230                 me->name = ( char* )key->name;
 231                 me->index = index;
 232
 233                 //printf("Key: %04x %02x: %s\n", ev->code, ev->value, key->name);
 234
 235         }
 236
 237 }
 238
 239 void translate_compliant(struct media_ctrl *ctrl, struct input_event *ev, struct media_ctrl_event *me)
 240 {
 241         me->type = 0;
 242
 243         // printf("Translate %02x %02x\n", ev->type, ev->code );
 244
 245         if (ev->type == EV_REL) {
 246                 if  (ev->code == REL_DIAL) {
 247
 248                         me->type  = MEDIA_CTRL_EVENT_JOG;
 249                         me->value = (signed int)ev->value;
 250                         me->name = _jog_name;
 251
 252                         ctrl->jogpos += me->value;
 253                         //printf("Jog: %06ld (%d)\n", ctrl->jogpos, me->value);
 254         }
 255                 return;
 256         } else if (ev->type == EV_ABS) {
 257                 // printf("ABS\n" );
 258                 if  ( ev->code == 0x1c || ev->code == ABS_THROTTLE ) {
 259                         //printf("ABS_MISC\n" );
 260                         me->type  = MEDIA_CTRL_EVENT_SHUTTLE;
 261                         me->value = (signed int)ev->value;
 262                         me->name = _shuttle_name;
 263
 264                         ctrl->shuttlepos = me->value;
 265                         //printf("Shuttle: %06d (%d)\n", ctrl->shuttlepos, me->value);
 266                 }
 267         } else if (ev->type == EV_KEY) {
 268                 int index;
 269                 struct media_ctrl_key *key = media_ctrl_get_key(ctrl, ev->code, &index);
 270                 if ( key == NULL ) return;
 271
 272                 me->type  = MEDIA_CTRL_EVENT_KEY;
 273                 me->code = key->code;
 274                 me->value = ev->value;
 275                 me->name = ( char* )key->name;
 276                 me->index = index;
 277
 278                 //printf("Key: %04x %02x: %s\n", ev->code, ev->value, key->name);
 279
 280         }
 281 }
 282
 283 struct media_ctrl_device supported_devices[] = {
 284         { 0x0b33, 0x0030, "Contour ShuttlePRO v2", mc_shuttle_pro_keys, translate_contour_hid_event },
 285         { 0x0b33, 0x0020, "Contour Design ShuttleXpress", mc_shuttle_xpress_keys, translate_contour_hid_event },
 286         { 0x0b33, 0x0010, "Contour ShuttlePro", mc_shuttle_pro_keys, translate_contour_hid_event },
 287         { 0x0b33, 0x0011, "Contour ShuttlePro", mc_shuttle_pro_keys, translate_contour_hid_event }, /* Hercules OEM */
 288         { 0x05f3, 0x0240, "Contour ShuttlePro", mc_shuttle_pro_keys, translate_contour_hid_event },
 289         { 0x0760, 0x0001, "JLCooper MCS3", mc_jlcooper_mcs3_keys, translate_compliant },
 290         { 0x077d, 0x0410, "Griffin PowerMate", mc_powermate_keys, translate_compliant },
 291         { 0x05f3, 0x0241, "X-Keys Editor", mc_x_keys, translate_contour_hid_event },
 292         { 0, 0, 0 }
 293 };
 294
 295
 296 void media_ctrl_translate(struct media_ctrl *ctrl, struct input_event *ev, struct media_ctrl_event *me)
 297 {
 298         if ( ctrl->device ) ctrl->device->translate(ctrl, ev, me);
 299 }
 300
 301
 302 void media_ctrl_read_event(struct media_ctrl *ctrl, struct media_ctrl_event *me)
 303 {
 304         ssize_t n;
 305         struct input_event ev;
 306
 307         // struct media_ctrl_event me;
 308
 309         if ( ctrl->fd > 0 ) {
 310                 n = read(ctrl->fd, &ev, sizeof(ev));
 311         } else {
 312                 return;
 313         }
 314
 315         if (n != sizeof(ev)) {
 316                 //printf("JogShuttle::inputCallback: read: (%d) %s\n", errno, strerror(errno));
 317                 close(ctrl->fd);
 318                 ctrl->fd = 0;
 319                 return;
 320         }
 321
 322         if ( ctrl->device && ctrl->device->translate)
 323                 ctrl->device->translate(ctrl, &ev, me);
 324         else
 325                 me->type = 0;
 326
 327         if ( me->type  == MEDIA_CTRL_EVENT_JOG ) {
 328                 struct timeval timev;
 329                 gettimeofday(&timev, NULL);
 330                 unsigned long now = (unsigned long)timev.tv_usec + (1000000*(unsigned long)timev.tv_sec);
 331                 if ( now < ctrl->last_jog_time + 40000 ) {
 332                         //printf("*** Fast Jog %02d %05d ***\n", me->value, now - ctrl->last_jog_time);
 333                         ctrl->jogrel = me->value;
 334                         me->type = MEDIA_CTRL_EVENT_NONE;
 335                 } else {
 336                         me->value += ctrl->jogrel;
 337                         ctrl->jogrel = 0;
 338                         ctrl->last_jog_time = now;
 339                         // printf("*** Jog %02d ***\n", me->value);
 340                 }
 341         }
 342
 343         return;
 344
 345 }
 346
 347
 348 int probe_device(struct media_ctrl *mc)
 349 {
 350         short devinfo[4];
 351         int i = 0;
 352
 353         if ( ioctl(mc->fd, EVIOCGID, &devinfo) ) {
 354                 perror("evdev ioctl");
 355                 return 0;
 356         }
 357
 358         do {
 359                 if ( supported_devices[i].vendor == devinfo[1]
 360                         && supported_devices[i].product == devinfo[2] ) {
 361
 362                         mc->device = &supported_devices[i];
 363                         //printf("Success on /dev/input/event%d: %s\n", mc->eventno, mc->device->name);
 364                         // mc->fd = fd;
 365                         // mc->translate = mc->device.translate_function;
 366                         // mc = malloc(sizeof(struct media_ctrl));
 367                         mc->jogpos  = 0;
 368                         mc->lastval = -1;
 369                         mc->last_jog_time = 0;
 370                         return 1;
 371                 } else {
 372                         //mc->device = NULL;
 373                 }
 374
 375         } while ( supported_devices[++i].vendor != 0 );
 376
 377         return 0;
 378 }
 379
 380
 381 void media_ctrl_get_device_list()
 382 {
 383         // TBD
 384 }
 385
 386
 387
 388 void find_first_device(struct media_ctrl *mc)
 389 {
 390         char buf[256];
 391         int fd, i;
 392
 393         for ( i = 0; i < 32; i++ ) {
 394                 sprintf(buf, "/dev/input/event%d", i);
 395                 fd = open( buf, O_RDONLY );
 396                 if ( fd < 0 ) {
 397                         perror(buf);
 398                 } else {
 399                         mc->fd = fd;
 400                         mc->eventno = i;
 401                         if( probe_device(mc) ) {
 402                                 return;
 403                         } else {
 404                                 close(fd);
 405                                 mc->fd = -1;
 406                         }
 407                 }
 408         }
 409         return;
 410 }
 411
 412
 413 void media_ctrl_close(struct media_ctrl *mc)
 414 {
 415         if (mc->fd > 0)
 416                 close( mc->fd );
 417         memset( mc, 0, sizeof( struct media_ctrl ) );
 418 }
 419
 420
 421 void media_ctrl_open(struct media_ctrl *mc)
 422 {
 423         find_first_device(mc);
 424 }
 425
 426 void media_ctrl_open2(struct media_ctrl *mc, const char *devname)
 427 {
 428     int fd;
 429
 430     fd = open( devname, O_RDONLY );
 431     if ( fd < 0 ) {
 432         perror(devname);
 433         mc->fd = -1;
 434     } else {
 435         mc->fd = fd;
 436         //mc->eventno = i;
 437         if( probe_device(mc) ) {
 438             return;
 439         } else {
 440             close(fd);
 441             mc->fd = -1;
 442         }
 443     }
 444 }
 445