2 // Copyright 2013 Eric Messick (FixedImagePhoto.com/Contact)
3 // reworked 2019 for cinelerra-gg by William Morrow
17 #include "mwindowgui.h"
19 #include "awindowgui.h"
21 #include "cwindowgui.h"
23 #include "vwindowgui.h"
35 #include <X11/keysym.h>
37 static Time milliTimeClock()
41 return (tv.tv_sec * 1000) + (tv.tv_usec / 1000);
44 KeySymMapping KeySymMapping::key_sym_mapping[] = {
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"
55 KeySym KeySymMapping::to_keysym(const char *str)
57 if( !strncmp("FWD_",str, 4) ) {
58 float speed = atof(str+4) / SHUTTLE_MAX_SPEED;
59 if( speed > SHUTTLE_MAX_SPEED ) return 0;
60 int key_code = (SKEY_MAX+SKEY_MIN)/2. +
61 (SKEY_MAX-SKEY_MIN)/2. * speed;
62 if( key_code > SKEY_MAX ) key_code = SKEY_MAX;
65 if( !strncmp("REV_",str, 4) ) {
66 float speed = atof(str+4) / SHUTTLE_MAX_SPEED;
67 if( speed > SHUTTLE_MAX_SPEED ) return 0;
68 int key_code = (SKEY_MAX+SKEY_MIN)/2. -
69 (SKEY_MAX-SKEY_MIN)/2. * speed;
70 if( key_code < SKEY_MIN ) key_code = SKEY_MIN;
73 for( KeySymMapping *ksp = &key_sym_mapping[0]; ksp->str; ++ksp )
74 if( !strcmp(str, ksp->str) ) return ksp->sym;
78 const char *KeySymMapping::to_string(KeySym ks)
80 for( KeySymMapping *ksp = &key_sym_mapping[0]; ksp->sym; ++ksp )
81 if( ksp->sym == ks ) return ksp->str;
82 if( ks >= SKEY_MIN && ks <= SKEY_MAX ) {
83 double speed = SHUTTLE_MAX_SPEED *
84 (ks-(SKEY_MAX+SKEY_MIN)/2.) / ((SKEY_MAX-SKEY_MIN)/2.);
85 static char text[BCSTRLEN];
86 sprintf(text, "%s_%0.3f", speed>=0 ? "FWD" : "REV", fabs(speed));
87 char *bp = strchr(text,'.');
89 char *cp = bp+strlen(bp);
90 while( --cp>bp && *cp=='0' ) *cp=0;
91 if( cp == bp ) *cp = 0;
98 TransName::TransName(int cin, const char *nm, const char *re)
101 this->name = cstrdup(nm);
102 this->err = regcomp(&this->regex, re, REG_NOSUB);
104 fprintf(stderr, "error compiling regex for [%s]: %s\n", name, re);
105 char emsg[BCTEXTLEN];
106 regerror(err, ®ex, emsg, sizeof(emsg));
107 fprintf(stderr, "regerror: %s\n", emsg);
110 TransName::~TransName()
116 void Translation::init(int def)
120 first_release_stroke = 0;
126 Translation::Translation(Shuttle *shuttle)
128 { // initial default translation
130 this->shuttle = shuttle;
131 this->name = cstrdup("Default");
132 names.append(new TransName(FOCUS_DEFAULT, name, ""));
133 key_down[K6].add_stroke(XK_Button_1, 1);
134 key_up[K6].add_stroke(XK_Button_1, 0);
135 key_down[K7].add_stroke(XK_Button_2, 1);
136 key_up[K7].add_stroke(XK_Button_2, 0);
137 key_down[K8].add_stroke(XK_Button_3, 1);
138 key_up[K8].add_stroke(XK_Button_3, 0);
139 jog[JL].add_stroke(XK_Scroll_Up, 1);
140 jog[JL].add_stroke(XK_Scroll_Up, 0);
141 jog[JR].add_stroke(XK_Scroll_Down, 0);
142 jog[JR].add_stroke(XK_Scroll_Down, 1);
145 Translation::Translation(Shuttle *shuttle, const char *name)
149 this->shuttle = shuttle;
150 this->name = cstrdup(name);
153 Translation::~Translation()
158 void Translation::clear()
160 names.remove_all_objects();
162 for( int i=0; i<NUM_KEYS; ++i ) key_down[i].clear();
163 for( int i=0; i<NUM_KEYS; ++i ) key_up[i].clear();
164 for( int i=0; i<NUM_SHUTTLES; ++i ) shuttles[i].clear();
165 for( int i=0; i<NUM_JOGS; ++i ) jog[i].clear();
168 void Translation::append_stroke(KeySym sym, int press)
170 Stroke *s = pressed_strokes->append();
175 void Translation::add_keysym(KeySym sym, int press_release)
177 //printf("add_keysym(0x%x, %d)\n", (int)sym, press_release);
178 switch( press_release ) {
180 append_stroke(sym, 1);
181 modifiers.mark_as_down(sym, 0);
184 append_stroke(sym, 0);
185 modifiers.mark_as_up(sym);
188 append_stroke(sym, 1);
189 modifiers.mark_as_down(sym, 1);
193 if( first_release_stroke ) {
194 modifiers.re_press();
195 first_release_stroke = 0;
198 append_stroke(keysym_down, 0);
200 append_stroke(sym, 1);
206 void Translation::add_release(int all_keys)
208 //printf("add_release(%d)\n", all_keys);
209 modifiers.release(all_keys);
211 pressed_strokes = released_strokes;
214 append_stroke(keysym_down, 0);
217 first_release_stroke = 1;
220 void Translation::add_keystroke(const char *keySymName, int press_release)
224 if( is_key && !strncmp(keySymName, "RELEASE", 8) ) {
228 sym = KeySymMapping::to_keysym(keySymName);
230 add_keysym(sym, press_release);
233 fprintf(stderr, "unrecognized KeySym: %s\n", keySymName);
236 void Translation::add_string(const char *str)
238 while( str && *str ) {
239 if( *str >= ' ' && *str <= '~' )
240 add_keysym((KeySym)(*str), PRESS_RELEASE);
245 int Translation::start_line(const char *key)
248 released_strokes = 0;
249 pressed = released = 0;
251 if( !strcasecmp("JL", key) ) {
254 else if( !strcasecmp("JR", key) ) {
258 char c = 0; int k = -1, n = 0;
259 if( sscanf(key, "%c%d%n", &c, &k, &n) != 2 ) return 1;
263 if( k >= K1 && k <= K15 ) {
264 pressed = &key_down[k];
265 released = &key_up[k];
270 if( k >= S_7 && k <= S7 ) {
271 pressed = &shuttles[k-S_7];
276 fprintf(stderr, "bad key name: [%s]%s\n", name, key);
279 if( pressed->first ) {
280 fprintf(stderr, "dupl key name: [%s]%s\n", name, key);
284 pressed_strokes = pressed;
285 released_strokes = released;
289 void Translation::print_stroke(Stroke *s)
292 const char *cp = KeySymMapping::to_string(s->keysym);
293 if( !cp ) { printf("0x%x", (int)s->keysym); cp = "???"; }
294 printf("%s/%c ", cp, s->press ? 'D' : 'U');
297 void Translation::print_strokes(const char *name, const char *up_dn, Strokes *strokes)
299 printf("%s[%s]: ", name, up_dn);
300 for( Stroke *s=strokes->first; s; s=s->next )
305 void Translation::finish_line()
307 //printf("finish_line()\n");
314 void Translation::print_line(const char *key)
317 print_strokes(key, "D", pressed_strokes);
318 print_strokes(key, "U", released_strokes);
321 print_strokes(key, "", pressed_strokes);
326 // press values in Modifiers:
329 // PRESS_RELEASE -> released, but to be re-pressed if necessary
332 void Modifiers::mark_as_down(KeySym sym, int hold)
334 Modifiers &modifiers = *this;
335 for( int i=0; i<size(); ++i ) {
336 Stroke &s = modifiers[i];
337 if( s.keysym == sym ) {
338 s.press = hold ? HOLD : PRESS;
342 Stroke &s = append();
344 s.press = hold ? HOLD : PRESS;
347 void Modifiers::mark_as_up(KeySym sym)
349 Modifiers &modifiers = *this;
350 for( int i=0; i<size(); ++i ) {
351 Stroke &s = modifiers[i];
352 if( s.keysym == sym ) {
359 void Modifiers::release(int allkeys)
361 Modifiers &modifiers = *this;
362 for( int i=0; i<size(); ++i ) {
363 Stroke &s = modifiers[i];
364 if( s.press == PRESS ) {
365 trans->append_stroke(s.keysym, 0);
366 s.press = PRESS_RELEASE;
368 else if( allkeys && s.press == HOLD ) {
369 trans->append_stroke(s.keysym, 0);
375 void Modifiers::re_press()
377 Modifiers &modifiers = *this;
378 for( int i=0; i<size(); ++i ) {
379 Stroke &s = modifiers[i];
380 if( s.press == PRESS_RELEASE ) {
381 trans->append_stroke(s.keysym, 1);
388 Shuttle::Shuttle(MWindow *mwindow)
391 this->mwindow = mwindow;
400 shuttlevalue = 0xffff;
401 last_shuttle.tv_sec = 0;
402 last_shuttle.tv_usec = 0;
403 need_synthetic_shuttle = 0;
410 last_translation = 0;
413 default_translation = new Translation(this);
422 delete default_translation;
423 delete [] config_path;
426 int Shuttle::send_button(unsigned int button, int press)
429 printf("btn: %u %d\n", button, press);
430 XButtonEvent *b = new XButtonEvent();
431 memset(b, 0, sizeof(*b));
432 b->type = press ? ButtonPress : ButtonRelease;
433 b->time = milliTimeClock();
435 b->display = wdw->top_level->display;
436 b->root = wdw->top_level->rootwin;
445 wdw->top_level->put_event((XEvent *) b);
448 int Shuttle::send_keycode(unsigned int keycode, int press, int send)
451 const char *cp = !send ? 0 :
452 KeySymMapping::to_string(keycode);
454 printf("key: %s %d\n", cp, press);
456 printf("key: %04x %d\n", keycode, press);
458 XKeyEvent *k = new XKeyEvent();
459 memset(k, 0, sizeof(*k));
460 k->type = press ? KeyPress : KeyRelease;
461 k->time = milliTimeClock();
462 k->send_event = send;
463 k->display = wdw->top_level->display;
464 k->root = wdw->top_level->rootwin;
471 k->keycode = keycode;
473 wdw->top_level->put_event((XEvent *) k);
477 int Shuttle::send_keysym(KeySym keysym, int press)
479 return keysym >= XK_Button_1 && keysym <= XK_Scroll_Down ?
480 send_button((unsigned int)keysym - XK_Button_0, press) :
481 send_keycode((unsigned int)keysym, press, 1);
482 // unsigned int keycode = XKeysymToKeycode(wdw->top_level->display, keysym);
483 // return send_keycode(keycode, press, 0);
487 static Stroke *fetch_stroke(Translation *translation, int kjs, int index)
493 case KJS_KEY_DOWN: ret = translation->key_down[index].first; break;
494 case KJS_KEY_UP: ret = translation->key_up[index].first; break;
495 case KJS_JOG: ret = translation->jog[index].first; break;
496 case KJS_SHUTTLE: ret = translation->shuttles[index].first; break;
502 void Shuttle::send_stroke_sequence(int kjs, int index)
505 Stroke *s = fetch_stroke(tr, kjs, index);
506 if( !s ) s = fetch_stroke(default_translation, kjs, index);
508 send_keysym(s->keysym, s->press);
513 void Shuttle::key(unsigned short code, unsigned int value)
515 code -= EVENT_CODE_KEY1;
516 if( code >= NUM_KEYS ) {
517 fprintf(stderr, "key(%d, %d) out of range\n", code + EVENT_CODE_KEY1, value);
520 send_stroke_sequence(value ? KJS_KEY_DOWN : KJS_KEY_UP, code);
524 void Shuttle::shuttle(int value)
526 if( value < S_7 || value > S7 ) {
527 fprintf(stderr, "shuttle(%d) out of range\n", value);
530 gettimeofday(&last_shuttle, 0);
531 need_synthetic_shuttle = value != 0;
532 if( value != shuttlevalue ) {
533 shuttlevalue = value;
534 send_stroke_sequence(KJS_SHUTTLE, value+7);
538 // Due to a bug (?) in the way Linux HID handles the ShuttlePro, the
539 // center position is not reported for the shuttle wheel. Instead,
540 // a jog event is generated immediately when it returns. We check to
541 // see if the time since the last shuttle was more than a few ms ago
542 // and generate a shuttle of 0 if so.
544 // Note, this fails if jogvalue happens to be 0, as we don't see that
546 void Shuttle::jog(unsigned int value)
550 struct timeval delta;
552 // We should generate a synthetic event for the shuttle going
553 // to the home position if we have not seen one recently
554 if( need_synthetic_shuttle ) {
555 gettimeofday( &now, 0 );
556 timersub( &now, &last_shuttle, &delta );
558 if( delta.tv_sec >= 1 || delta.tv_usec >= 5000 ) {
560 need_synthetic_shuttle = 0;
564 if( jogvalue != 0xffff ) {
565 value = value & 0xff;
566 direction = ((value - jogvalue) & 0x80) ? -1 : 1;
567 while( jogvalue != value ) {
568 // driver fails to send an event when jogvalue == 0
569 if( jogvalue != 0 ) {
570 send_stroke_sequence(KJS_JOG, direction > 0 ? 1 : 0);
572 jogvalue = (jogvalue + direction) & 0xff;
578 void Shuttle::jogshuttle(unsigned short code, unsigned int value)
584 case EVENT_CODE_SHUTTLE:
588 fprintf(stderr, "jogshuttle(%d, %d) invalid code\n", code, value);
593 const char *Shuttle::probe()
596 static const char *shuttle_devs[] = {
597 "/dev/input/by-id/usb-Contour_Design_ShuttleXpress-event-if00",
598 "/dev/input/by-id/usb-Contour_Design_ShuttlePRO_v2-event-if00",
599 "/dev/input/by-id/usb-Contour_Design_ShuttlePro-event-if00",
601 int ret = sizeof(shuttle_devs) / sizeof(shuttle_devs[0]);
602 while( --ret >= 0 && stat(shuttle_devs[ret] , &st) );
603 return ret >= 0 ? shuttle_devs[ret] : 0;
606 void Shuttle::start(const char *dev_name)
608 this->dev_name = dev_name;
616 if( running() && !done ) {
623 BC_WindowBase *Shuttle::owns(BC_WindowBase *wdw, Window win)
625 if( wdw->win == win ) return wdw;
626 if( (wdw=wdw->top_level)->win == win ) return wdw;
627 for( int i=wdw->popups.size(); --i>=0; )
628 if( wdw->popups[i]->win == win ) return wdw;
632 int Shuttle::get_focused_window_translation()
634 MWindowGUI *gui = mwindow->gui;
635 Display *dpy = gui->display;
637 int ret = 0, revert = 0;
638 char win_title[BCTEXTLEN]; win_title[0] = 0;
639 gui->lock_window("Shuttle::get_focused_window_translation");
640 XGetInputFocus(dpy, &focus, &revert);
641 if( last_focused != focus ) {
642 last_focused = focus;
643 Atom prop = XInternAtom(dpy, "WM_NAME", False);
645 unsigned long remain, len;
647 if( XGetWindowProperty(dpy, focus, prop, 0, sizeof(win_title)-1, False,
648 AnyPropertyType, &type, &form, &len, &remain, &list) == Success ) {
649 len = len*(form/8) - remain;
650 memcpy(win_title, list, len);
654 printf("new focus: %08x\n", (unsigned)focus);
658 fprintf(stderr, "XGetWindowProperty failed for window 0x%x\n",
663 gui->unlock_window();
666 this->wdw = 0; this->win = 0;
667 this->wx = 0; this->wy = 0;
668 this->rx = 0; this->ry = 0;
670 BC_WindowBase *wdw = 0;
672 if( (wdw=owns(mwindow->gui, focus)) != 0 )
674 else if( (wdw=owns(mwindow->awindow->gui, focus)) != 0 )
676 else if( (wdw=owns(mwindow->cwindow->gui, focus)) != 0 ) {
677 if( mwindow->cwindow->gui->canvas->get_fullscreen() )
678 wdw = mwindow->cwindow->gui->canvas->get_canvas();
681 else if( mwindow->gui->mainmenu->load_file->thread->running() &&
682 (wdw=mwindow->gui->mainmenu->load_file->thread->window) != 0 &&
686 int i = mwindow->vwindows.size();
688 VWindow *vwdw = mwindow->vwindows[i];
689 if( !vwdw->is_running() ) continue;
690 if( (wdw=owns(vwdw->gui, focus)) != 0 ) {
691 if( vwdw->gui->canvas->get_fullscreen() )
692 wdw = vwdw->gui->canvas->get_canvas();
693 cin = FOCUS_VIEWER; break;
697 if( cin < 0 ) return -1;
698 Window root = 0, child = 0;
699 int root_x = 0, root_y = 0, win_x = 0, win_y = 0, x = 0, y = 0;
700 unsigned int mask = 0, width = 0, height = 0, border_width = 0, depth = 0;
701 wdw->lock_window("Shuttle::get_focused_window_translation 1");
702 if( XQueryPointer(wdw->top_level->display, focus, &root, &child,
703 &root_x, &root_y, &win_x, &win_y, &mask) ) {
705 if( wdw->active_menubar )
706 child = wdw->active_menubar->win;
707 else if( wdw->active_popup_menu )
708 child = wdw->active_popup_menu->win;
709 else if( wdw->active_subwindow )
710 child = wdw->active_subwindow->win;
715 XGetGeometry(wdw->top_level->display, child, &root, &x, &y,
716 &width, &height, &border_width, &depth);
718 wdw->unlock_window();
719 if( !child || !wdw->match_window(child) ) return -1;
726 this->wx = win_x - x;
727 this->wy = win_y - y;
728 for( tr=translations.first; tr; tr=tr->next ) {
729 if( tr->is_default ) return 1;
730 for( int i=0; i<tr->names.size(); ++i ) {
731 TransName *name = tr->names[i];
732 if( name->cin != cin ) continue;
733 if( regexec(&name->regex, win_title, 0, NULL, 0) )
737 tr = default_translation;
741 void Shuttle::handle_event()
743 if( read_config_file() > 0 ) {
747 if( get_focused_window_translation() < 0 )
749 if( last_translation != tr ) {
750 last_translation = tr;
752 printf("new translation: %s\n", tr->name);
754 //fprintf(stderr, "event: (%d, %d, 0x%x)\n", ev.type, ev.code, ev.value);
756 case EVENT_TYPE_DONE:
757 case EVENT_TYPE_ACTIVE_KEY:
760 key(ev.code, ev.value);
762 case EVENT_TYPE_JOGSHUTTLE:
763 jogshuttle(ev.code, ev.value);
766 fprintf(stderr, "handle_event() invalid type code\n");
773 for( enable_cancel(); !done; sleep(1) ) {
774 fd = open(dev_name, O_RDONLY);
777 if( first_time ) break;
780 if( !ioctl(fd, EVIOCGRAB, 1) ) { // exclusive access
783 int ret = read(fd, &ev, sizeof(ev));
785 if( ret != sizeof(ev) ) {
786 if( ret < 0 ) { perror("read event"); break; }
787 fprintf(stderr, "bad read: %d\n", ret);
794 perror( "evgrab ioctl" );
800 int Shuttle::read_config_file()
804 config_path = (env=getenv("SHUTTLE_CONFIG_FILE")) != 0 ? cstrdup(env) :
805 (env=getenv("HOME")) != 0 ? cstrcat(2, env, "/.shuttlerc") : 0;
806 if( !config_path ) { fprintf(stderr, "no config file\n"); return 1; }
809 if( stat(config_path, &st) ) {
811 char shuttlerc[BCTEXTLEN];
812 snprintf(shuttlerc, sizeof(shuttlerc), "%s/shuttlerc",
813 File::get_cindat_path());
814 if( stat(shuttlerc, &st) ) {
818 delete [] config_path;
819 config_path = cstrdup(shuttlerc);
821 if( config_mtime > 0 &&
822 config_mtime == st.st_mtime ) return 0;
823 FILE *fp = fopen(config_path, "r");
829 config_mtime = st.st_mtime;
830 translations.clear();
832 #define ws(ch) (ch==' ' || ch=='\t')
833 char line[BCTEXTLEN], *cp;
834 Translation *trans = 0;
836 int ret = fgets(cp=line,sizeof(line),fp) ? 0 : -1;
841 while( !ret && *cp == '[' ) {
843 while( *cp && *cp != ']' ) ++cp;
845 if( !name || !*name ) { ret = 1; break; }
847 if( !strcasecmp("default", name) )
849 else if( !strcasecmp("cinelerra", name) )
851 else if( !strcasecmp("resources", name) )
853 else if( !strcasecmp("composer", name) )
855 else if( !strcasecmp("viewer", name) )
857 else if( !strcasecmp("load", name) )
860 fprintf(stderr, "unknown focus target window: %s\n",
865 if( cin == FOCUS_DEFAULT ) {
866 trans = default_translation;
870 trans = new Translation(this, name);
873 while( ws(*cp) ) ++cp;
874 // regex in TransName constructor
875 trans->names.append(new TransName(cin, name, cp));
876 if( trans->names.last()->err ) { ret = 1; break; }
877 ret = fgets(cp=line,sizeof(line),fp) ? 0 : 1;
879 fprintf(stderr, "hit eof, no translation def for: %s\n",
880 trans->names.last()->name);
886 if( debug && trans ) {
887 printf("------------------------\n");
888 TransNames &names = trans->names;
889 for( int i=0; i<names.size(); ++i ) {
890 TransName *tp = names[i];
891 printf("[%s] # %d\n\n", tp->name, tp->cin);
894 // rules lines: "tok <stroke list>\n"
895 while( !ret && *cp != '[' ) {
896 const char *key = 0, *tok = 0;
897 while( ws(*cp) ) ++cp;
898 if( !*cp || *cp == '\n' || *cp == '#' ) goto skip;
900 while( *cp && !ws(*cp) && *cp != '\n' ) ++cp;
902 if( !strcmp(tok, "DEBUG") ) {
903 debug = 1; goto skip;
907 fprintf(stderr, "no translation section defining key: %s\n", key);
911 ret = trans->start_line(key);
912 while( !ret && *cp && *cp != '\n' ) {
913 while( ws(*cp) ) ++cp;
914 if( !*cp || *cp == '#' || *cp == '\n' ) break;
917 while( *cp && *cp != '"' && *cp != '\n' ) {
918 if( *cp != '\\' ) { ++cp; continue; }
919 for( char *bp=cp; *bp; ++bp ) bp[0] = bp[1];
922 trans->add_string(tok);
926 while( *cp && !ws(*cp) && *cp!='/' && *cp != '\n' ) ++cp;
927 int dhu = PRESS_RELEASE;
931 case 'D': dhu = PRESS; break;
932 case 'H': dhu = HOLD; break;
933 case 'U': dhu = RELEASE; break;
935 fprintf(stderr, "invalid up/down modifier [%s]%s: '%c'\n",
936 trans->name, tok, *cp);
943 trans->add_keystroke(tok, dhu);
946 trans->finish_line();
948 trans->print_line(key);
949 skip: ret = fgets(cp=line,sizeof(line),fp) ? 0 : -1;
953 if( trans != default_translation )
954 translations.append(trans);
959 fprintf(stderr, "shuttle config err file: %s, line:%d\n",