xwiimote.h

Go to the documentation of this file.

/*
 * XWiimote - lib
 * Written 2010-2013 by David Herrmann <dh.herrmann@gmail.com>
 * Dedicated to the Public Domain
 */

#ifndef XWII_XWIIMOTE_H
#define XWII_XWIIMOTE_H

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <sys/time.h>
#include <time.h>

#ifdef __cplusplus
extern "C" {
#endif

#if (__GNUC__ > 3)
#define XWII__DEPRECATED __attribute__((__deprecated__))
#else
#define XWII__DEPRECATED
#endif /* __GNUC__ */

#define XWII__NAME          "Nintendo Wii Remote"

#define XWII_NAME_CORE          XWII__NAME

#define XWII_NAME_ACCEL         XWII__NAME " Accelerometer"

#define XWII_NAME_IR            XWII__NAME " IR"

#define XWII_NAME_MOTION_PLUS       XWII__NAME " Motion Plus"

#define XWII_NAME_NUNCHUK       XWII__NAME " Nunchuk"

#define XWII_NAME_CLASSIC_CONTROLLER    XWII__NAME " Classic Controller"

#define XWII_NAME_BALANCE_BOARD     XWII__NAME " Balance Board"

#define XWII_NAME_PRO_CONTROLLER    XWII__NAME " Pro Controller"

#define XWII_NAME_DRUMS         XWII__NAME " Drums"

#define XWII_NAME_GUITAR        XWII__NAME " Guitar"

enum xwii_event_types {
    XWII_EVENT_KEY,

    XWII_EVENT_ACCEL,

    XWII_EVENT_IR,

    XWII_EVENT_BALANCE_BOARD,

    XWII_EVENT_MOTION_PLUS,

    XWII_EVENT_PRO_CONTROLLER_KEY,

    XWII_EVENT_PRO_CONTROLLER_MOVE,

    XWII_EVENT_WATCH,

    XWII_EVENT_CLASSIC_CONTROLLER_KEY,

    XWII_EVENT_CLASSIC_CONTROLLER_MOVE,

    XWII_EVENT_NUNCHUK_KEY,

    XWII_EVENT_NUNCHUK_MOVE,

    XWII_EVENT_DRUMS_KEY,

    XWII_EVENT_DRUMS_MOVE,

    XWII_EVENT_GUITAR_KEY,

    XWII_EVENT_GUITAR_MOVE,

    XWII_EVENT_GONE,

    XWII_EVENT_NUM
};

enum xwii_event_keys {
    XWII_KEY_LEFT,
    XWII_KEY_RIGHT,
    XWII_KEY_UP,
    XWII_KEY_DOWN,
    XWII_KEY_A,
    XWII_KEY_B,
    XWII_KEY_PLUS,
    XWII_KEY_MINUS,
    XWII_KEY_HOME,
    XWII_KEY_ONE,
    XWII_KEY_TWO,
    XWII_KEY_X,
    XWII_KEY_Y,
    XWII_KEY_TL,
    XWII_KEY_TR,
    XWII_KEY_ZL,
    XWII_KEY_ZR,

    XWII_KEY_THUMBL,

    XWII_KEY_THUMBR,

    XWII_KEY_C,

    XWII_KEY_Z,

    XWII_KEY_STRUM_BAR_UP,

    XWII_KEY_STRUM_BAR_DOWN,

    XWII_KEY_FRET_FAR_UP,

    XWII_KEY_FRET_UP,

    XWII_KEY_FRET_MID,

    XWII_KEY_FRET_LOW,

    XWII_KEY_FRET_FAR_LOW,

    XWII_KEY_NUM
};

struct xwii_event_key {
    unsigned int code;
    unsigned int state;
};

struct xwii_event_abs {
    int32_t x;
    int32_t y;
    int32_t z;
};

enum xwii_drums_abs {
    XWII_DRUMS_ABS_PAD,
    XWII_DRUMS_ABS_CYMBAL_LEFT,
    XWII_DRUMS_ABS_CYMBAL_RIGHT,
    XWII_DRUMS_ABS_TOM_LEFT,
    XWII_DRUMS_ABS_TOM_RIGHT,
    XWII_DRUMS_ABS_TOM_FAR_RIGHT,
    XWII_DRUMS_ABS_BASS,
    XWII_DRUMS_ABS_HI_HAT,
    XWII_DRUMS_ABS_NUM,
};

#define XWII_ABS_NUM 8

union xwii_event_union {
    struct xwii_event_key key;
    struct xwii_event_abs abs[XWII_ABS_NUM];
    uint8_t reserved[128];
};

struct xwii_event {
    struct timeval time;
    unsigned int type;

    union xwii_event_union v;
};

static inline bool xwii_event_ir_is_valid(const struct xwii_event_abs *abs)
{
    return abs->x != 1023 || abs->y != 1023;
}

struct xwii_iface;

enum xwii_iface_type {
    XWII_IFACE_CORE         = 0x000001,
    XWII_IFACE_ACCEL        = 0x000002,
    XWII_IFACE_IR           = 0x000004,

    XWII_IFACE_MOTION_PLUS      = 0x000100,
    XWII_IFACE_NUNCHUK      = 0x000200,
    XWII_IFACE_CLASSIC_CONTROLLER   = 0x000400,
    XWII_IFACE_BALANCE_BOARD    = 0x000800,
    XWII_IFACE_PRO_CONTROLLER   = 0x001000,
    XWII_IFACE_DRUMS        = 0x002000,
    XWII_IFACE_GUITAR       = 0x004000,

    XWII_IFACE_ALL          = XWII_IFACE_CORE |
                      XWII_IFACE_ACCEL |
                      XWII_IFACE_IR |
                      XWII_IFACE_MOTION_PLUS |
                      XWII_IFACE_NUNCHUK |
                      XWII_IFACE_CLASSIC_CONTROLLER |
                      XWII_IFACE_BALANCE_BOARD |
                      XWII_IFACE_PRO_CONTROLLER |
                      XWII_IFACE_DRUMS |
                      XWII_IFACE_GUITAR,
    XWII_IFACE_WRITABLE     = 0x010000,
};

const char *xwii_get_iface_name(unsigned int iface);

enum xwii_led {
    XWII_LED1 = 1,
    XWII_LED2 = 2,
    XWII_LED3 = 3,
    XWII_LED4 = 4,
};

#define XWII_LED(num) (XWII_LED1 + (num) - 1)

int xwii_iface_new(struct xwii_iface **dev, const char *syspath);

void xwii_iface_ref(struct xwii_iface *dev);

void xwii_iface_unref(struct xwii_iface *dev);

const char *xwii_iface_get_syspath(struct xwii_iface *dev);

int xwii_iface_get_fd(struct xwii_iface *dev);

int xwii_iface_watch(struct xwii_iface *dev, bool watch);

int xwii_iface_open(struct xwii_iface *dev, unsigned int ifaces);

void xwii_iface_close(struct xwii_iface *dev, unsigned int ifaces);

unsigned int xwii_iface_opened(struct xwii_iface *dev);

unsigned int xwii_iface_available(struct xwii_iface *dev);

XWII__DEPRECATED
int xwii_iface_poll(struct xwii_iface *dev, struct xwii_event *ev);

int xwii_iface_dispatch(struct xwii_iface *dev, struct xwii_event *ev,
            size_t size);

int xwii_iface_rumble(struct xwii_iface *dev, bool on);

int xwii_iface_get_led(struct xwii_iface *dev, unsigned int led, bool *state);

int xwii_iface_set_led(struct xwii_iface *dev, unsigned int led, bool state);

int xwii_iface_get_battery(struct xwii_iface *dev, uint8_t *capacity);

int xwii_iface_get_devtype(struct xwii_iface *dev, char **devtype);

int xwii_iface_get_extension(struct xwii_iface *dev, char **extension);

void xwii_iface_set_mp_normalization(struct xwii_iface *dev, int32_t x,
                     int32_t y, int32_t z, int32_t factor);

void xwii_iface_get_mp_normalization(struct xwii_iface *dev, int32_t *x,
                     int32_t *y, int32_t *z, int32_t *factor);

struct xwii_monitor;

struct xwii_monitor *xwii_monitor_new(bool poll, bool direct);

void xwii_monitor_ref(struct xwii_monitor *mon);

void xwii_monitor_unref(struct xwii_monitor *mon);

int xwii_monitor_get_fd(struct xwii_monitor *monitor, bool blocking);

char *xwii_monitor_poll(struct xwii_monitor *monitor);

#ifdef __cplusplus
}
#endif

#endif /* XWII_XWIIMOTE_H */