cinelerra-5.1/cinelerra/shuttle.C

   1 #ifdef HAVE_SHUTTLE
   2 // Copyright 2013 Eric Messick (FixedImagePhoto.com/Contact)
   3 // reworked 2019 for cinelerra-gg by William Morrow
   4
   5 #include "arraylist.h"
   6 #include "cstrdup.h"
   7 #include "file.h"
   8 #include "guicast.h"
   9 #include "keys.h"
  10 #include "linklist.h"
  11 #include "loadfile.h"
  12 #include "mainmenu.h"
  13 #include "shuttle.h"
  14 #include "thread.h"
  15
  16 #include "mwindow.h"
  17 #include "mwindowgui.h"
  18 #include "awindow.h"
  19 #include "awindowgui.h"
  20 #include "cwindow.h"
  21 #include "cwindowgui.h"
  22 #include "vwindow.h"
  23 #include "vwindowgui.h"
  24
  25 #include <stdio.h>
  26 #include <stdint.h>
  27 #include <stdlib.h>
  28 #include <unistd.h>
  29 #include <fcntl.h>
  30 #include <string.h>
  31 #include <sys/time.h>
  32 #include <sys/stat.h>
  33
  34 #include <X11/Xlib.h>
  35 #include <X11/keysym.h>
  36
  37 static Time milliTimeClock()
  38 {
  39         struct timeval tv;
  40         gettimeofday(&tv, 0);
  41         return (tv.tv_sec * 1000) + (tv.tv_usec / 1000);
  42 }
  43
  44 KeySymMapping KeySymMapping::key_sym_mapping[] = {
  45 // button keycodes
  46         { "XK_Button_1", XK_Button_1 },
  47         { "XK_Button_2", XK_Button_2 },
  48         { "XK_Button_3", XK_Button_3 },
  49         { "XK_Scroll_Up", XK_Scroll_Up },
  50         { "XK_Scroll_Down", XK_Scroll_Down },
  51 #include "shuttle_keys.h"
  52         { NULL, 0 }
  53 };
  54
  55 int KeySymMapping::get_mask(const char *&str)
  56 {
  57         int mask = 0;
  58         while( *str ) {
  59                 if( !strncmp("Shift-",str,6) ) {
  60                         mask |= ShiftMask;
  61                         str += 6;  continue;
  62                 }
  63                 if( !strncmp("Ctrl-",str,5) ) {
  64                         mask |= ControlMask;
  65                         str += 5;  continue;
  66                 }
  67                 else if( !strncmp("Alt-",str,4) ) {
  68                         mask |= Mod1Mask;
  69                         str += 4;  continue;
  70                 }
  71                 break;
  72         }
  73         return mask;
  74 }
  75
  76 SKeySym KeySymMapping::to_keysym(const char *str)
  77 {
  78         if( !strncmp("FWD_",str, 4) ) {
  79                 float speed = atof(str+4) / SHUTTLE_MAX_SPEED;
  80                 if( speed > SHUTTLE_MAX_SPEED ) return 0;
  81                 int key_code = (SKEY_MAX+SKEY_MIN)/2. +
  82                         (SKEY_MAX-SKEY_MIN)/2. * speed;
  83                 if( key_code > SKEY_MAX ) key_code = SKEY_MAX;
  84                 return key_code;
  85         }
  86         if( !strncmp("REV_",str, 4) ) {
  87                 float speed = atof(str+4) / SHUTTLE_MAX_SPEED;
  88                 if( speed > SHUTTLE_MAX_SPEED ) return 0;
  89                 int key_code = (SKEY_MAX+SKEY_MIN)/2. -
  90                         (SKEY_MAX-SKEY_MIN)/2. * speed;
  91                 if( key_code < SKEY_MIN ) key_code = SKEY_MIN;
  92                 return key_code;
  93         }
  94         int mask = get_mask(str);
  95         for( KeySymMapping *ksp = &key_sym_mapping[0]; ksp->str; ++ksp )
  96                 if( !strcmp(str, ksp->str) )
  97                         return SKeySym(ksp->sym, mask);
  98         return 0;
  99 }
 100
 101 const char *KeySymMapping::to_string(SKeySym ks)
 102 {
 103         for( KeySymMapping *ksp = &key_sym_mapping[0]; ksp->sym.key; ++ksp ) {
 104                 if( ksp->sym.key == ks.key ) {
 105                         static char string[BCSTRLEN];
 106                         char *sp = string, *ep = sp+sizeof(string);
 107                         if( ks.msk & Mod1Mask ) sp += snprintf(sp, ep-sp, "Alt-");
 108                         if( ks.msk & ControlMask ) sp += snprintf(sp, ep-sp, "Ctrl-");
 109                         if( ks.msk & ShiftMask ) sp += snprintf(sp, ep-sp, "Shift-");
 110                         snprintf(sp, ep-sp, "%s", ksp->str);
 111                         return string;
 112                 }
 113         }
 114         if( ks >= SKEY_MIN && ks <= SKEY_MAX ) {
 115                 double speed = SHUTTLE_MAX_SPEED *
 116                         (ks-(SKEY_MAX+SKEY_MIN)/2.) / ((SKEY_MAX-SKEY_MIN)/2.);
 117                 static char text[BCSTRLEN];
 118                 sprintf(text, "%s_%0.3f", speed>=0 ? "FWD" : "REV", fabs(speed));
 119                 char *bp = strchr(text,'.');
 120                 if( bp ) {
 121                         char *cp = bp+strlen(bp);
 122                         while( --cp>bp && *cp=='0' ) *cp=0;
 123                         if( cp == bp ) *cp = 0;
 124                 }
 125                 return text;
 126         }
 127         return 0;
 128 }
 129
 130 TransName::TransName(int cin, const char *nm, const char *re)
 131 {
 132         this->cin = cin;
 133         this->name = cstrdup(nm);
 134 }
 135 TransName::~TransName()
 136 {
 137         delete [] name;
 138 }
 139
 140 void Translation::init(int def)
 141 {
 142         is_default = def;
 143         is_key = 0;
 144         first_release_stroke = 0;
 145         pressed = 0;
 146         released = 0;
 147         keysym_down = 0;
 148 }
 149
 150 Translation::Translation(Shuttle *shuttle)
 151  : modifiers(this)
 152 { // initial default translation
 153         init(1);
 154         this->shuttle = shuttle;
 155         this->name = cstrdup("Default");
 156         names.append(new TransName(FOCUS_DEFAULT, name, ""));
 157         key_down[K6].add_stroke(XK_Button_1, 1);
 158         key_up[K6].add_stroke(XK_Button_1, 0);
 159         key_down[K7].add_stroke(XK_Button_2, 1);
 160         key_up[K7].add_stroke(XK_Button_2, 0);
 161         key_down[K8].add_stroke(XK_Button_3, 1);
 162         key_up[K8].add_stroke(XK_Button_3, 0);
 163         jog[JL].add_stroke(XK_Scroll_Up, 1);
 164         jog[JL].add_stroke(XK_Scroll_Up, 0);
 165         jog[JR].add_stroke(XK_Scroll_Down, 0);
 166         jog[JR].add_stroke(XK_Scroll_Down, 1);
 167 }
 168
 169 Translation::Translation(Shuttle *shuttle, const char *name)
 170  : modifiers(this)
 171 {
 172         init(0);
 173         this->shuttle = shuttle;
 174         this->name = cstrdup(name);
 175 }
 176
 177 Translation::~Translation()
 178 {
 179         delete [] name;
 180 }
 181
 182 void Translation::clear()
 183 {
 184         names.remove_all_objects();
 185         init(0);
 186         for( int i=0; i<NUM_KEYS; ++i ) key_down[i].clear();
 187         for( int i=0; i<NUM_KEYS; ++i ) key_up[i].clear();
 188         for( int i=0; i<NUM_SHUTTLES; ++i ) shuttles[i].clear();
 189         for( int i=0; i<NUM_JOGS; ++i ) jog[i].clear();
 190 }
 191
 192 void Translation::append_stroke(SKeySym sym, int press)
 193 {
 194         Stroke *s = pressed_strokes->append();
 195         s->keysym = sym;
 196         s->press = press;
 197 }
 198
 199 void Translation::add_keysym(SKeySym sym, int press_release)
 200 {
 201 //printf("add_keysym(0x%x, %d)\n", (int)sym, press_release);
 202         switch( press_release ) {
 203         case PRESS:
 204                 append_stroke(sym, 1);
 205                 modifiers.mark_as_down(sym, 0);
 206                 break;
 207         case RELEASE:
 208                 append_stroke(sym, 0);
 209                 modifiers.mark_as_up(sym);
 210                 break;
 211         case HOLD:
 212                 append_stroke(sym, 1);
 213                 modifiers.mark_as_down(sym, 1);
 214                 break;
 215         case PRESS_RELEASE:
 216         default:
 217                 if( first_release_stroke ) {
 218                         modifiers.re_press();
 219                         first_release_stroke = 0;
 220                 }
 221                 if( keysym_down ) {
 222                         append_stroke(keysym_down, 0);
 223                 }
 224                 append_stroke(sym, 1);
 225                 keysym_down = sym;
 226                 break;
 227         }
 228 }
 229
 230 void Translation::add_release(int all_keys)
 231 {
 232 //printf("add_release(%d)\n", all_keys);
 233         modifiers.release(all_keys);
 234         if( !all_keys )
 235                 pressed_strokes = released_strokes;
 236         if( keysym_down ) {
 237                 append_stroke(keysym_down, 0);
 238                 keysym_down = 0;
 239         }
 240         first_release_stroke = 1;
 241 }
 242
 243 void Translation::add_keystroke(const char *keySymName, int press_release)
 244 {
 245         SKeySym sym;
 246
 247         if( is_key && !strncmp(keySymName, "RELEASE", 8) ) {
 248                 add_release(0);
 249                 return;
 250         }
 251         sym = KeySymMapping::to_keysym(keySymName);
 252         if( sym != 0 ) {
 253                 add_keysym(sym, press_release);
 254         }
 255         else
 256                 fprintf(stderr, "unrecognized KeySym: %s\n", keySymName);
 257 }
 258
 259 void Translation::add_string(char *&str)
 260 {
 261         int delim = *str++;
 262         if( !delim ) return;
 263         while( str && *str && *str!=delim ) {
 264                 if( *str < ' ' || *str > '~' ) continue;
 265                 int mask = KeySymMapping::get_mask((const char *&)str);
 266                 if( str[0] == '\\' && str[1] ) ++str;
 267                 add_keysym(SKeySym(*str++, mask), PRESS_RELEASE);
 268                 mask = 0;
 269         }
 270         if( *str == delim ) ++str;
 271 }
 272
 273 int Translation::start_line(const char *key)
 274 {
 275         pressed_strokes = 0;
 276         released_strokes = 0;
 277         pressed = released = 0;
 278         is_key = 0;
 279         if( !strcasecmp("JL", key) ) {
 280                 pressed = &jog[0];
 281         }
 282         else if( !strcasecmp("JR", key) ) {
 283                 pressed = &jog[1];
 284         }
 285         else {
 286                 char c = 0;  int k = -1, n = 0;
 287                 if( sscanf(key, "%c%d%n", &c, &k, &n) != 2 ) return 1;
 288                 switch( c ) {
 289                 case 'K': case 'k':
 290                         --k;
 291                         if( k >= K1 && k <= K15 ) {
 292                                 pressed = &key_down[k];
 293                                 released = &key_up[k];
 294                                 is_key = 1;
 295                         }
 296                         break;
 297                 case 'S': case 's':
 298                         if( k >= S_7 && k <= S7 ) {
 299                                 pressed = &shuttles[k-S_7];
 300                         }
 301                         break;
 302                 }
 303                 if( !pressed ) {
 304                         fprintf(stderr, "bad key name: [%s]%s\n", name, key);
 305                         return 1;
 306                 }
 307                 if( pressed->first ) {
 308                         fprintf(stderr, "dupl key name: [%s]%s\n", name, key);
 309                         return 1;
 310                 }
 311         }
 312         pressed_strokes = pressed;
 313         released_strokes = released;
 314         return 0;
 315 }
 316
 317 void Translation::print_stroke(Stroke *s)
 318 {
 319         if( !s ) return;
 320         const char *cp = KeySymMapping::to_string(s->keysym);
 321         if( !cp ) { printf("0x%x", (int)s->keysym); cp = "???"; }
 322         printf("%s/%c ", cp, s->press ? 'D' : 'U');
 323 }
 324
 325 void Translation::print_strokes(const char *name, const char *up_dn, Strokes *strokes)
 326 {
 327         printf("%s[%s]: ", name, up_dn);
 328         for( Stroke *s=strokes->first; s; s=s->next )
 329                 print_stroke(s);
 330         printf("\n");
 331 }
 332
 333 void Translation::finish_line()
 334 {
 335 //printf("finish_line()\n");
 336         if( is_key ) {
 337                 add_release(0);
 338         }
 339         add_release(1);
 340 }
 341
 342 void Translation::print_line(const char *key)
 343 {
 344         if( is_key ) {
 345                 print_strokes(key, "D", pressed);
 346                 print_strokes(key, "U", released);
 347         }
 348         else {
 349                 print_strokes(key, "", pressed);
 350         }
 351         printf("\n");
 352 }
 353
 354 // press values in Modifiers:
 355 // PRESS -> down
 356 // HOLD -> held
 357 // PRESS_RELEASE -> released, but to be re-pressed if necessary
 358 // RELEASE -> up
 359
 360 void Modifiers::mark_as_down(SKeySym sym, int hold)
 361 {
 362         Modifiers &modifiers = *this;
 363         for( int i=0; i<size(); ++i ) {
 364                 Stroke &s = modifiers[i];
 365                 if( s.keysym == sym ) {
 366                         s.press = hold ? HOLD : PRESS;
 367                         return;
 368                 }
 369         }
 370         Stroke &s = append();
 371         s.keysym = sym;
 372         s.press = hold ? HOLD : PRESS;
 373 }
 374
 375 void Modifiers::mark_as_up(SKeySym sym)
 376 {
 377         Modifiers &modifiers = *this;
 378         for( int i=0; i<size(); ++i ) {
 379                 Stroke &s = modifiers[i];
 380                 if( s.keysym == sym ) {
 381                         s.press = RELEASE;
 382                         return;
 383                 }
 384         }
 385 }
 386
 387 void Modifiers::release(int allkeys)
 388 {
 389         Modifiers &modifiers = *this;
 390         for( int i=0; i<size(); ++i ) {
 391                 Stroke &s = modifiers[i];
 392                 if( s.press == PRESS ) {
 393                         trans->append_stroke(s.keysym, 0);
 394                         s.press = PRESS_RELEASE;
 395                 }
 396                 else if( allkeys && s.press == HOLD ) {
 397                         trans->append_stroke(s.keysym, 0);
 398                         s.press = RELEASE;
 399                 }
 400         }
 401 }
 402
 403 void Modifiers::re_press()
 404 {
 405         Modifiers &modifiers = *this;
 406         for( int i=0; i<size(); ++i ) {
 407                 Stroke &s = modifiers[i];
 408                 if( s.press == PRESS_RELEASE ) {
 409                         trans->append_stroke(s.keysym, 1);
 410                         s.press = PRESS;
 411                 }
 412         }
 413 }
 414
 415
 416 Shuttle::Shuttle(MWindow *mwindow)
 417  : Thread(1, 0, 0)
 418 {
 419         this->mwindow = mwindow;
 420
 421         fd = -1;
 422         wdw = 0;
 423         win = 0;
 424         msk = 0;
 425         rx = ry = 0;
 426         wx = wy = 0;
 427         jogvalue = 0xffff;
 428         shuttlevalue = 0xffff;
 429         dev_index = -1;
 430
 431         done = -1;
 432         failed = 0;
 433         first_time = 1;
 434         tr = 0;
 435         debug = 0;
 436         usb_direct = 0;
 437
 438         last_translation = 0;
 439         last_focused = 0;
 440
 441 #ifdef HAVE_SHUTTLE_USB
 442         devsh = 0;
 443         claimed = -1;
 444         last_jog = 0;
 445         last_shuttle = 0;
 446         last_btns = 0;
 447 #endif
 448
 449         default_translation = new Translation(this);
 450         config_path = 0;
 451         config_mtime = 0;
 452         ev.type = ~0;
 453 }
 454
 455 Shuttle::~Shuttle()
 456 {
 457         stop();
 458         delete default_translation;
 459         delete [] config_path;
 460 }
 461
 462 int Shuttle::send_button(unsigned int button, int press)
 463 {
 464         if( debug )
 465                 printf("btn: %u %d\n", button, press);
 466         XButtonEvent *b = new XButtonEvent();
 467         memset(b, 0, sizeof(*b));
 468         b->type = press ? ButtonPress : ButtonRelease;
 469         b->time = milliTimeClock();
 470         b->send_event = 1;
 471         b->display = wdw->top_level->display;
 472         b->root = wdw->top_level->rootwin;
 473         b->window = win;
 474         b->x_root = rx;
 475         b->y_root = ry;
 476         b->x = wx;
 477         b->y = wy;
 478         b->state = msk;
 479         b->button = button;
 480         b->same_screen = 1;
 481         wdw->top_level->put_event((XEvent *) b);
 482         return 0;
 483 }
 484 int Shuttle::send_keycode(unsigned key, unsigned msk, int press, int send)
 485 {
 486         if( debug ) {
 487                 const char *cp = !send ? 0 :
 488                         KeySymMapping::to_string(SKeySym(key, msk));
 489                 if( cp )
 490                         printf("key: %s %d\n", cp, press);
 491                 else
 492                         printf("key: %04x/%04x %d\n", key, msk, press);
 493         }
 494         XKeyEvent *k = new XKeyEvent();
 495         memset(k, 0, sizeof(*k));
 496         k->type = press ? KeyPress : KeyRelease;
 497         k->time = milliTimeClock();
 498         k->send_event = send;
 499         k->display = wdw->top_level->display;
 500         k->root = wdw->top_level->rootwin;
 501         k->window = win;
 502         k->x_root = rx;
 503         k->y_root = ry;
 504         k->x = wx;
 505         k->y = wy;
 506         k->state = msk;
 507 // also clear modifiers state if a key is to be released
 508         if( !press ) k->state = 0;
 509         k->keycode = key;
 510         k->same_screen = 1;
 511         wdw->top_level->put_event((XEvent *) k);
 512         return 0;
 513 }
 514
 515 int Shuttle::send_keysym(SKeySym keysym, int press)
 516 {
 517         return keysym >= XK_Button_1 && keysym <= XK_Scroll_Down ?
 518                 send_button((unsigned int)keysym - XK_Button_0, press) :
 519                 send_keycode(keysym.key, keysym.msk, press, 1);
 520 //      unsigned int keycode = XKeysymToKeycode(wdw->top_level->display, keysym);
 521 //      return send_keycode(keycode, press, 0);
 522 }
 523
 524
 525 static Stroke *fetch_stroke(Translation *translation, int kjs, int index)
 526 {
 527         Stroke *ret = 0;
 528         if( translation ) {
 529                 switch( kjs ) {
 530                 default:
 531                 case KJS_KEY_DOWN:  ret = translation->key_down[index].first;     break;
 532                 case KJS_KEY_UP:    ret = translation->key_up[index].first;       break;
 533                 case KJS_JOG:       ret = translation->jog[index].first;          break;
 534                 case KJS_SHUTTLE:   ret = translation->shuttles[index-S_7].first; break;
 535                 }
 536         }
 537         return ret;
 538 }
 539
 540 void Shuttle::send_stroke_sequence(int kjs, int index)
 541 {
 542         if( !wdw ) return;
 543         Stroke *s = fetch_stroke(tr, kjs, index);
 544         if( !s ) s = fetch_stroke(default_translation, kjs, index);
 545         while( s ) {
 546                 send_keysym(s->keysym, s->press);
 547                 s = s->next;
 548         }
 549 }
 550
 551 void Shuttle::key(unsigned short code, unsigned int value)
 552 {
 553         code -= EVENT_CODE_KEY1;
 554         if( code >= NUM_KEYS ) {
 555                 fprintf(stderr, "key(%d, %d) out of range\n", code + EVENT_CODE_KEY1, value);
 556                 return;
 557         }
 558 // Show help if Alt is pressed on the keyboard together with a shuttle button
 559         if( wdw && wdw->alt_down() && value ) {
 560                 wdw->context_help_show("Shuttle key default arrangement");
 561                 return;
 562         }
 563         send_stroke_sequence(value ? KJS_KEY_DOWN : KJS_KEY_UP, code);
 564 }
 565
 566
 567 void Shuttle::shuttle(int value)
 568 {
 569         if( value < S_7 || value > S7 ) {
 570                 fprintf(stderr, "shuttle(%d) out of range\n", value);
 571                 return;
 572         }
 573         if( value != (int)shuttlevalue ) {
 574                 shuttlevalue = value;
 575                 send_stroke_sequence(KJS_SHUTTLE, value);
 576         }
 577 }
 578
 579 // Due to a bug (?) in the way Linux HID handles the ShuttlePro, the
 580 // center position is not reported for the shuttle wheel.       Instead,
 581 // a jog event is generated immediately when it returns.        We check to
 582 // see if the time since the last shuttle was more than a few ms ago
 583 // and generate a shuttle of 0 if so.
 584 //
 585 // Note, this fails if jogvalue happens to be 0, as we don't see that
 586 // event either!
 587 void Shuttle::jog(unsigned int value)
 588 {
 589         if( jogvalue != 0xffff ) {
 590                 value = value & 0xff;
 591                 int direction = ((value - jogvalue) & 0x80) ? -1 : 1;
 592                 int index = direction > 0 ? 1 : 0;
 593                 while( jogvalue != value ) {
 594                         // driver fails to send an event when jogvalue == 0
 595                         if( jogvalue != 0 ) {
 596                                 send_stroke_sequence(KJS_JOG, index);
 597                         }
 598                         jogvalue = (jogvalue + direction) & 0xff;
 599                 }
 600         }
 601         jogvalue = value;
 602 }
 603
 604 void Shuttle::jogshuttle(unsigned short code, unsigned int value)
 605 {
 606         switch( code ) {
 607         case EVENT_CODE_JOG:
 608                 jog(value);
 609                 break;
 610         case EVENT_CODE_SHUTTLE:
 611                 shuttle(value);
 612                 break;
 613         case EVENT_CODE_HI_JOG:  // redundant report of JOG value*120
 614                 break;
 615         default:
 616                 fprintf(stderr, "jogshuttle(%d, %d) invalid code\n", code, value);
 617                 break;
 618         }
 619 }
 620
 621 static const struct shuttle_dev {
 622         const char *path;
 623         unsigned vendor, product;
 624 } shuttle_devs[] = {
 625         { "/dev/input/by-id/usb-Contour_Design_ShuttleXpress-event-if00",
 626                 0x0b33, 0x0020 },
 627         { "/dev/input/by-id/usb-Contour_Design_ShuttlePRO_v2-event-if00",
 628                 0x0b33, 0x0030 },
 629         { "/dev/input/by-id/usb-Contour_Design_ShuttlePro-event-if00",
 630                 0x0b33, 0x0030 },
 631         { "/dev/input/by-id/usb-Contour_Design_ShuttlePRO_v2-event-joystick",
 632                 0x0b33, 0x0030 },
 633 };
 634
 635 #ifdef HAVE_SHUTTLE_USB
 636 void Shuttle::usb_probe(int idx)
 637 {
 638         int ret = libusb_init(0);
 639         if( ret < 0 ) return;
 640         claimed = 0;
 641         const struct shuttle_dev *s = &shuttle_devs[idx];
 642         devsh = libusb_open_device_with_vid_pid(0, s->vendor, s->product);
 643         if( devsh ) {
 644                 int sh_iface = SHUTTLE_INTERFACE;
 645                 libusb_detach_kernel_driver(devsh, sh_iface);
 646                 ret = libusb_claim_interface(devsh, sh_iface);
 647                 if( ret >= 0 ) claimed = 1;
 648         }
 649         if( !claimed )
 650                 usb_done();
 651 }
 652
 653 void Shuttle::usb_done()
 654 {
 655         if( devsh ) {
 656                 if( claimed > 0 ) {
 657                         int sh_iface = SHUTTLE_INTERFACE;
 658                         libusb_release_interface(devsh, sh_iface);
 659                         libusb_attach_kernel_driver(devsh, sh_iface);
 660                         claimed = 0;
 661                 }
 662                 libusb_close(devsh);
 663                 devsh = 0;
 664         }
 665         if( claimed >= 0 ) {
 666                 libusb_exit(0);
 667                 claimed = -1;
 668         }
 669 }
 670 #endif
 671
 672 int Shuttle::probe()
 673 {
 674         struct stat st;
 675         int ret = sizeof(shuttle_devs) / sizeof(shuttle_devs[0]);
 676         while( --ret >= 0 && stat(shuttle_devs[ret].path , &st) );
 677         return ret;
 678 }
 679
 680 void Shuttle::start(int idx)
 681 {
 682         this->dev_index = idx;
 683         first_time = 1;
 684         done = 0;
 685         Thread::start();
 686 }
 687
 688 void Shuttle::stop()
 689 {
 690         if( running() && !done ) {
 691                 done = 1;
 692                 cancel();
 693                 join();
 694         }
 695 }
 696
 697 BC_WindowBase *Shuttle::owns(BC_WindowBase *wdw, Window win)
 698 {
 699         if( wdw->win == win ) return wdw;
 700         if( (wdw=wdw->top_level)->win == win ) return wdw;
 701         for( int i=wdw->popups.size(); --i>=0; )
 702                 if( wdw->popups[i]->win == win ) return wdw;
 703         return 0;
 704 }
 705
 706 int Shuttle::get_focused_window_translation()
 707 {
 708         MWindowGUI *gui = mwindow->gui;
 709         Display *dpy = gui->display;
 710         Window focus = 0;
 711         int ret = 0, revert = 0;
 712         char win_title[BCTEXTLEN];  win_title[0] = 0;
 713         gui->lock_window("Shuttle::get_focused_window_translation");
 714         XGetInputFocus(dpy, &focus, &revert);
 715         if( last_focused != focus ) {
 716                 last_focused = focus;
 717                 Atom prop = XInternAtom(dpy, "WM_NAME", False);
 718                 Atom type;  int form;
 719                 unsigned long remain, len;
 720                 unsigned char *list;
 721                 if( XGetWindowProperty(dpy, focus, prop, 0, sizeof(win_title)-1, False,
 722                         AnyPropertyType, &type, &form, &len, &remain, &list) == Success ) {
 723                         len = len*(form/8) - remain;
 724                         memcpy(win_title, list, len);
 725                         win_title[len] = 0;
 726                         XFree(list);
 727                         if( debug )
 728                                 printf("new focus: %08x %s\n", (unsigned)focus, win_title);
 729                 }
 730                 else {
 731                         last_focused = 0;
 732                         fprintf(stderr, "XGetWindowProperty failed for window 0x%x\n",
 733                                         (int)focus);
 734                         ret = 1;
 735                 }
 736         }
 737         gui->unlock_window();
 738         if( ret ) return -1;
 739
 740         this->wdw = 0;  this->win = 0;
 741         this->wx = 0;   this->wy = 0;
 742         this->rx = 0;   this->ry = 0;
 743         this->msk = 0;
 744         BC_WindowBase *wdw = 0;
 745         int cin = -1;
 746         if( (wdw=owns(mwindow->gui, focus)) != 0 )
 747                 cin = FOCUS_MWINDOW;
 748         else if( (wdw=owns(mwindow->awindow->gui, focus)) != 0 )
 749                 cin = FOCUS_AWINDOW;
 750         else if( (wdw=owns(mwindow->cwindow->gui, focus)) != 0 ) {
 751                 if( mwindow->cwindow->gui->canvas->get_fullscreen() )
 752                         wdw = mwindow->cwindow->gui->canvas->get_canvas();
 753                 cin = FOCUS_CWINDOW;
 754         }
 755         else if( mwindow->gui->mainmenu->load_file->thread->running() &&
 756                  (wdw=mwindow->gui->mainmenu->load_file->thread->window) != 0 &&
 757                  wdw->win == focus )
 758                 cin = FOCUS_LOAD;
 759         else {
 760                 int i = mwindow->vwindows.size();
 761                 while( --i >= 0 ) {
 762                         VWindow *vwdw =  mwindow->vwindows[i];
 763                         if( !vwdw->is_running() ) continue;
 764                         if( (wdw=owns(vwdw->gui, focus)) != 0 ) {
 765                                 if( vwdw->gui->canvas->get_fullscreen() )
 766                                         wdw = vwdw->gui->canvas->get_canvas();
 767                                 cin = FOCUS_VIEWER;  break;
 768                         }
 769                 }
 770         }
 771         if( cin < 0 ) return -1;
 772         Window root = 0, child = 0;
 773         int root_x = 0, root_y = 0, win_x = 0, win_y = 0, x = 0, y = 0;
 774         unsigned int mask = 0, width = 0, height = 0, border_width = 0, depth = 0;
 775         wdw->lock_window("Shuttle::get_focused_window_translation 1");
 776         if( XQueryPointer(wdw->top_level->display, focus, &root, &child,
 777                         &root_x, &root_y, &win_x, &win_y, &mask) ) {
 778                 if( !child ) {
 779                         if( wdw->active_menubar )
 780                                 child = wdw->active_menubar->win;
 781                         else if( wdw->active_popup_menu )
 782                                 child = wdw->active_popup_menu->win;
 783                         else if( wdw->active_subwindow )
 784                                 child = wdw->active_subwindow->win;
 785                         else
 786                                 child = wdw->win;
 787                 }
 788                 else
 789                         XGetGeometry(wdw->top_level->display, child, &root, &x, &y,
 790                                 &width, &height, &border_width, &depth);
 791         }
 792         wdw->unlock_window();
 793         if( !child || !wdw->match_window(child) ) return -1;
 794 // success
 795         this->wdw = wdw;
 796         this->win = child;
 797         this->msk = mask;
 798         this->rx = root_x;
 799         this->ry = root_y;
 800         this->wx = win_x - x;
 801         this->wy = win_y - y;
 802         for( tr=translations.first; tr; tr=tr->next ) {
 803                 if( tr->is_default ) return 1;
 804                 for( int i=0; i<tr->names.size(); ++i ) {
 805                         TransName *name = tr->names[i];
 806                         if( name->cin == cin ) return 1;
 807                 }
 808         }
 809         tr = default_translation;
 810         return 0;
 811 }
 812
 813 int Shuttle::load_translation()
 814 {
 815         if( read_config_file() > 0 )
 816                 return done = 1;
 817         if( get_focused_window_translation() < 0 )
 818                 return 0;
 819         if( last_translation != tr ) {
 820                 last_translation = tr;
 821                 if( debug )
 822                         printf("new translation: %s\n", tr->name);
 823         }
 824         return 0;
 825 }
 826
 827 void Shuttle::handle_event()
 828 {
 829         if( load_translation() ) return;
 830 //      if( debug )
 831 //              printf("event: (%d, %d, 0x%x)\n", ev.type, ev.code, ev.value);
 832         switch( ev.type ) {
 833         case EVENT_TYPE_DONE:
 834         case EVENT_TYPE_ACTIVE_KEY:
 835                 break;
 836         case EVENT_TYPE_KEY:
 837                 key(ev.code, ev.value);
 838                 break;
 839         case EVENT_TYPE_JOGSHUTTLE:
 840                 jogshuttle(ev.code, ev.value);
 841                 break;
 842         default:
 843                 fprintf(stderr, "handle_event() invalid type code\n");
 844                 break;
 845         }
 846 }
 847
 848 void Shuttle::run()
 849 {
 850         if( dev_index < 0 ) return;
 851         const char *dev_name = shuttle_devs[dev_index].path;
 852
 853 #ifdef HAVE_SHUTTLE_USB
 854         if( usb_direct )
 855                 usb_probe(dev_index);
 856
 857         disable_cancel();
 858         while( devsh && !done ) {
 859                 int len = 0;
 860                 static const int IN_ENDPOINT = 0x81;
 861                 unsigned char dat[5];
 862                 int ret = libusb_interrupt_transfer(devsh,
 863                                 IN_ENDPOINT, dat, sizeof(dat), &len, 100);
 864                 if( ret != 0 ) {
 865                         if( ret == LIBUSB_ERROR_TIMEOUT ) continue;
 866                         printf("shuttle: %s\n  %s\n",
 867                                 dev_name, libusb_strerror((libusb_error)ret));
 868                         sleep(1);  continue;
 869                 }
 870                 if( load_translation() ) break;
 871                 if( debug ) {
 872                         printf("shuttle: ");
 873                         for( int i=0; i<len; ++i ) printf(" %02x", dat[i]);
 874                         printf("\n");
 875                 }
 876                 if( last_shuttle != dat[0] )
 877                         shuttle((char)(last_shuttle = dat[0]));
 878
 879                 if( last_jog != dat[1] )
 880                         jog(last_jog = dat[1]);
 881
 882                 unsigned btns = (dat[4]<<8) | dat[3];
 883                 unsigned dif = last_btns ^ btns;
 884                 if( dif ) {
 885                         last_btns = btns;
 886                         for( int i=0; i<15; ++i ) {
 887                                 unsigned msk = 1 << i;
 888                                 if( !(dif & msk) ) continue;
 889                                 key(i+EVENT_CODE_KEY1, btns & msk ? 1 : 0);
 890                         }
 891                 }
 892         }
 893         usb_done();
 894 #endif
 895         usb_direct = 0;
 896         enable_cancel();
 897
 898         for( ; !done; sleep(1) ) {
 899                 fd = open(dev_name, O_RDONLY);
 900                 if( fd < 0 ) {
 901                         perror(dev_name);
 902                         if( first_time ) break;
 903                         continue;
 904                 }
 905                 if( 1 || !ioctl(fd, EVIOCGRAB, 1) ) { // exclusive access
 906                         first_time = 0;
 907                         while( !done ) {
 908                                 int ret = read(fd, &ev, sizeof(ev));
 909                                 if( done ) break;
 910                                 if( ret != sizeof(ev) ) {
 911                                         if( ret < 0 ) { perror("read event"); break; }
 912                                         fprintf(stderr, "bad read: %d\n", ret);
 913                                         break;
 914                                 }
 915                                 handle_event();
 916                         }
 917                 }
 918                 else
 919                         perror( "evgrab ioctl" );
 920                 close(fd);
 921         }
 922         done = 2;
 923 }
 924
 925 int Shuttle::read_config_file()
 926 {
 927         if( !config_path ) {
 928                 const char *env;
 929                 config_path = (env=getenv("SHUTTLE_CONFIG_FILE")) != 0 ? cstrdup(env) :
 930                         (env=getenv("HOME")) != 0 ? cstrcat(2, env, "/.shuttlerc") : 0;
 931                 if( !config_path ) { fprintf(stderr, "no config file\n");  return 1; }
 932         }
 933         struct stat st;
 934         if( stat(config_path, &st) ) {
 935                 perror(config_path);
 936                 char shuttlerc[BCTEXTLEN];
 937                 snprintf(shuttlerc, sizeof(shuttlerc), "%s/shuttlerc",
 938                                 File::get_cindat_path());
 939                 if( stat(shuttlerc, &st) ) {
 940                         perror(shuttlerc);
 941                         return 1;
 942                 }
 943                 delete [] config_path;
 944                 config_path = cstrdup(shuttlerc);
 945         }
 946         if( config_mtime > 0 &&
 947             config_mtime == st.st_mtime ) return 0;
 948         FILE *fp = fopen(config_path, "r");
 949         if( !fp ) {
 950                 perror(config_path);
 951                 return 1;
 952         }
 953
 954         config_mtime = st.st_mtime;
 955         translations.clear();
 956         debug = 0;
 957         usb_direct = 0;
 958 #define ws(ch) (ch==' ' || ch=='\t')
 959         char line[BCTEXTLEN], *cp;
 960         Translation *trans = 0;
 961         int no = 0;
 962         int ret = fgets(cp=line,sizeof(line),fp) ? 0 : -1;
 963         if( !ret ) ++no;
 964 // lines
 965         while( !ret ) {
 966 // translation names
 967                 while( !ret && *cp == '[' ) {
 968                         char *name = ++cp;
 969                         while( *cp && *cp != ']' ) ++cp;
 970                         *cp++ = 0;
 971                         if( !name || !*name ) { ret = 1;  break; }
 972                         int cin = -1;
 973                         if( !strcasecmp("default", name) )
 974                                 cin = FOCUS_DEFAULT;
 975                         else if( !strcasecmp("cinelerra", name) )
 976                                 cin = FOCUS_MWINDOW;
 977                         else if( !strcasecmp("resources", name) )
 978                                 cin = FOCUS_AWINDOW;
 979                         else if( !strcasecmp("composer", name) )
 980                                 cin = FOCUS_CWINDOW;
 981                         else if( !strcasecmp("viewer", name) )
 982                                 cin = FOCUS_VIEWER;
 983                         else if( !strcasecmp("load", name) )
 984                                 cin = FOCUS_LOAD;
 985                         else {
 986                                 fprintf(stderr, "unknown focus target window: %s\n",
 987                                          name);
 988                                 ret = 1;  break;
 989                         }
 990                         if( !trans ) {
 991                                 if( cin == FOCUS_DEFAULT ) {
 992                                         trans = default_translation;
 993                                         trans->clear();
 994                                 }
 995                                 else {
 996                                         trans = new Translation(this, name);
 997                                 }
 998                         }
 999                         while( ws(*cp) ) ++cp;
1000                         trans->names.append(new TransName(cin, name, cp));
1001                         ret = fgets(cp=line,sizeof(line),fp) ? 0 : 1;
1002                         if( ret ) {
1003                                 fprintf(stderr, "hit eof, no translation def for: %s\n",
1004                                         trans->names.last()->name);
1005                                 ret = 1;  break;
1006                         }
1007                         ++no;
1008                 }
1009                 if( ret ) break;
1010                 if( debug && trans ) {
1011                         printf("------------------------\n");
1012                         TransNames &names = trans->names;
1013                         for( int i=0; i<names.size(); ++i ) {
1014                                 TransName *tp = names[i];
1015                                 printf("[%s] # %d\n\n", tp->name, tp->cin);
1016                         }
1017                 }
1018 // rules lines: "tok <stroke list>\n"
1019                 while( !ret && *cp != '[' ) {
1020                         const char *key = 0, *tok = 0;
1021                         while( ws(*cp) ) ++cp;
1022                         if( !*cp || *cp == '\n' || *cp == '#' ) goto skip;
1023                         tok = cp;
1024                         while( *cp && !ws(*cp) && *cp != '\n' ) ++cp;
1025                         *cp++ = 0;
1026                         if( !strcmp(tok, "DEBUG") ) {
1027                                 debug = 1;  goto skip;
1028                         }
1029                         if( !strcmp(tok, "USB_DIRECT") ) {
1030                                 usb_direct = 1;  goto skip;
1031                         }
1032                         key = tok;
1033                         if( !trans ) {
1034                                 fprintf(stderr, "no translation section defining key: %s\n", key);
1035                                 ret = 1;  break;
1036                         }
1037
1038                         ret = trans->start_line(key);
1039                         while( !ret && *cp && *cp != '\n' ) {
1040                                 while( ws(*cp) ) ++cp;
1041                                 if( !*cp || *cp == '#' || *cp == '\n' ) break;
1042                                 if( *cp == '"' ) {
1043                                         while( *cp ) {
1044                                                 if( *cp == '"' )
1045                                                         trans->add_string(cp);
1046                                                 while( ws(*cp) ) ++cp;
1047                                                 if( !*cp || *cp == '#' || *cp == '\n' ) break;
1048                                                 tok = cp;
1049                                                 while( *cp && !ws(*cp) && *cp != '\n' ) ++cp;
1050                                                 *cp = 0;
1051                                                 SKeySym sym = KeySymMapping::to_keysym(tok);
1052                                                 if( !sym ) {
1053                                                         fprintf(stderr, "unknown keysym: %s\n", tok);
1054                                                         ret = 1;  break;
1055                                                 }
1056                                                 trans->add_keysym(sym, PRESS_RELEASE);
1057                                         }
1058                                         continue;
1059                                 }
1060                                 tok = cp;
1061                                 while( *cp && !ws(*cp) && *cp!='/' && *cp != '\n' ) ++cp;
1062                                 int dhu = PRESS_RELEASE;
1063                                 if( *cp == '/' ) {
1064                                         *cp++ = 0;
1065                                         switch( *cp ) {
1066                                         case 'D':  dhu = PRESS;    break;
1067                                         case 'H':  dhu = HOLD;     break;
1068                                         case 'U':  dhu = RELEASE;  break;
1069                                         default:
1070                                                 fprintf(stderr, "invalid up/down modifier [%s]%s: '%c'\n",
1071                                                         trans->name, tok, *cp);
1072                                                 ret = 1;  break;
1073                                         }
1074                                         ++cp;
1075                                 }
1076                                 else
1077                                         *cp++ = 0;
1078                                 trans->add_keystroke(tok, dhu);
1079                         }
1080                         if( ret ) break;
1081                         trans->finish_line();
1082                         if( debug )
1083                                 trans->print_line(key);
1084                 skip:   ret = fgets(cp=line,sizeof(line),fp) ? 0 : -1;
1085                         if( !ret ) ++no;
1086                 }
1087                 if( trans ) {
1088                         if( trans != default_translation )
1089                                 translations.append(trans);
1090                         trans = 0;
1091                 }
1092         }
1093         if( ret > 0 )
1094                 fprintf(stderr, "shuttle config err file: %s, line:%d\n",
1095                         config_path, no);
1096
1097         fclose(fp);
1098         return ret;
1099 }
1100 #endif