ergodox-firmware/src/lib/key-functions/private.c

/* ----------------------------------------------------------------------------
 * key functions : private : code
 * ----------------------------------------------------------------------------
 * Copyright (c) 2012 Ben Blazak <benblazak.dev@gmail.com>
 * Released under The MIT License (MIT) (see "license.md")
 * Project located at <https://github.com/benblazak/ergodox-firmware>
 * ------------------------------------------------------------------------- */


#include <stdbool.h>
#include <stdint.h>
#include "../../lib-other/pjrc/usb_keyboard/usb_keyboard.h"
#include "../../lib/usb/usage-page/keyboard.h"
#include "../../keyboard/layout.h"
#include "../../keyboard/matrix.h"
#include "../../main.h"
#include "./public.h"

/*
 * MediaCodeLookupTable is used to translate from enumeration in keyboard.h to
 *  consumer key scan code in usb_keyboard.h
 */
static const uint16_t _media_code_lookup_table[] = {
  AUDIO_MUTE,          	// MEDIAKEY_AUDIO_MUTE
  AUDIO_VOL_UP,        	// MEDIAKEY_AUDIO_VOL_UP
  AUDIO_VOL_DOWN,      	// MEDIAKEY_AUDIO_VOL_DOWN
  TRANSPORT_NEXT_TRACK,	// MEDIAKEY_NEXT_TRACK
  TRANSPORT_PREV_TRACK,	// MEDIAKEY_PREV_TRACK
  TRANSPORT_STOP,      	// MEDIAKEY_STOP
  TRANSPORT_PLAY_PAUSE,	// MEDIAKEY_PLAY_PAUSE
  TRANSPORT_RECORD,    	// MEDIAKEY_RECORD
  TRANSPORT_REWIND,    	// MEDIAKEY_REWIND
  TRANSPORT_EJECT,     	// MEDIAKEY_EJECT
  AL_CC_CONFIG,        	// MEDIAKEY_CC_CONFIG
  AL_EMAIL,            	// MEDIAKEY_EMAIL
  AL_CALCULATOR,       	// MEDIAKEY_CALCULATOR
  AL_LOCAL_BROWSER,    	// MEDIAKEY_LOCAL_BROWSER
  AC_SEARCH,           	// MEDIAKEY_BROWSER_SEARCH
  AC_HOME,             	// MEDIAKEY_BROWSER_HOME
  AC_BACK,             	// MEDIAKEY_BROWSER_BACK
  AC_FORWARD,          	// MEDIAKEY_BROWSER_FORWARD
  AC_STOP,             	// MEDIAKEY_BROWSER_STOP
  AC_REFRESH,          	// MEDIAKEY_BROWSER_REFRESH
  AC_BOOKMARKS,        	// MEDIAKEY_BROWSER_BOOKMARKS
};

// ----------------------------------------------------------------------------

/*
 * Generate a normal keypress or keyrelease
 *
 * Arguments
 * - press: whether to generate a keypress (true) or keyrelease (false)
 * - keycode: the keycode to use
 *
 * Note
 * - Because of the way USB does things, what this actually does is either add
 *   or remove 'keycode' from the list of currently pressed keys, to be sent at
 *   the end of the current cycle (see main.c)
 */
void _kbfun_press_release(bool press, uint8_t keycode) {
	// no-op
	if (keycode == 0)
		return;

	// modifier keys
	switch (keycode) {
		case KEY_LeftControl:  (press)
				       ? (keyboard_modifier_keys |=  (1<<0))
				       : (keyboard_modifier_keys &= ~(1<<0));
				       return;
		case KEY_LeftShift:    (press)
				       ? (keyboard_modifier_keys |=  (1<<1))
				       : (keyboard_modifier_keys &= ~(1<<1));
				       return;
		case KEY_LeftAlt:      (press)
				       ? (keyboard_modifier_keys |=  (1<<2))
				       : (keyboard_modifier_keys &= ~(1<<2));
				       return;
		case KEY_LeftGUI:      (press)
				       ? (keyboard_modifier_keys |=  (1<<3))
				       : (keyboard_modifier_keys &= ~(1<<3));
				       return;
		case KEY_RightControl: (press)
				       ? (keyboard_modifier_keys |=  (1<<4))
				       : (keyboard_modifier_keys &= ~(1<<4));
				       return;
		case KEY_RightShift:   (press)
				       ? (keyboard_modifier_keys |=  (1<<5))
				       : (keyboard_modifier_keys &= ~(1<<5));
				       return;
		case KEY_RightAlt:     (press)
				       ? (keyboard_modifier_keys |=  (1<<6))
				       : (keyboard_modifier_keys &= ~(1<<6));
				       return;
		case KEY_RightGUI:     (press)
				       ? (keyboard_modifier_keys |=  (1<<7))
				       : (keyboard_modifier_keys &= ~(1<<7));
				       return;
	}

	// all others
	for (uint8_t i=0; i<6; i++) {
		if (press) {
			if (keyboard_keys[i] == 0) {
				keyboard_keys[i] = keycode;
				return;
			}
		} else {
			if (keyboard_keys[i] == keycode) {
				keyboard_keys[i] = 0;
				return;
			}
		}
	}
}

/*
 * Is the given keycode pressed?
 */
bool _kbfun_is_pressed(uint8_t keycode) {
	// modifier keys
	switch (keycode) {
		case KEY_LeftControl:  if (keyboard_modifier_keys & (1<<0))
					       return true;
		case KEY_LeftShift:    if (keyboard_modifier_keys & (1<<1))
					       return true;
		case KEY_LeftAlt:      if (keyboard_modifier_keys & (1<<2))
					       return true;
		case KEY_LeftGUI:      if (keyboard_modifier_keys & (1<<3))
					       return true;
		case KEY_RightControl: if (keyboard_modifier_keys & (1<<4))
					       return true;
		case KEY_RightShift:   if (keyboard_modifier_keys & (1<<5))
					       return true;
		case KEY_RightAlt:     if (keyboard_modifier_keys & (1<<6))
					       return true;
		case KEY_RightGUI:     if (keyboard_modifier_keys & (1<<7))
					       return true;
	}

	// all others
	for (uint8_t i=0; i<6; i++)
		if (keyboard_keys[i] == keycode)
			return true;

	return false;
}

void _kbfun_mediakey_press_release(bool press, uint8_t keycode) {
	uint16_t mediakey_code = _media_code_lookup_table[keycode];
	if (press) {
		consumer_key = mediakey_code;
	} else {
		// Only one key can be pressed at a time so only clear the keypress for
		//  active key (most recently pressed)
		if (mediakey_code == consumer_key) {
			consumer_key = 0;
		}
	}
}