stratcom.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2010-2014 Andreas Weis <der_ghulbus@ghulbus-inc.de>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *****************************************************************************/

#ifndef LIBSTRATCOM_INCLUDE_GUARD_STRATCOM_H_
#define LIBSTRATCOM_INCLUDE_GUARD_STRATCOM_H_

#ifdef _WIN32
#   ifdef LIBSTRATCOM_EXPORT
#       define LIBSTRATCOM_API __declspec(dllexport)
#   else
#       define LIBSTRATCOM_API __declspec(dllimport)
#   endif
#else
#   define LIBSTRATCOM_API
#endif

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

    struct stratcom_device_;
    typedef struct stratcom_device_ stratcom_device;


    typedef enum stratcom_button_ {
        STRATCOM_BUTTON_1      = 0x0001,            
        STRATCOM_BUTTON_2      = 0x0002,            
        STRATCOM_BUTTON_3      = 0x0004,            
        STRATCOM_BUTTON_4      = 0x0008,            
        STRATCOM_BUTTON_5      = 0x0010,            
        STRATCOM_BUTTON_6      = 0x0020,            
        STRATCOM_BUTTON_PLUS   = 0x0040,            
        STRATCOM_BUTTON_MINUS  = 0x0080,            
        STRATCOM_BUTTON_SHIFT1 = 0x0100,            
        STRATCOM_BUTTON_SHIFT2 = 0x0200,            
        STRATCOM_BUTTON_SHIFT3 = 0x0400,            
        STRATCOM_BUTTON_REC    = 0x0800,            
        STRATCOM_BUTTON_NONE   = 0x0                
    } stratcom_button;

    typedef enum stratcom_button_led_ {
        STRATCOM_LEDBUTTON_1    = 0x0001,           
        STRATCOM_LEDBUTTON_2    = 0x0004,           
        STRATCOM_LEDBUTTON_3    = 0x0010,           
        STRATCOM_LEDBUTTON_4    = 0x0040,           
        STRATCOM_LEDBUTTON_5    = 0x0100,           
        STRATCOM_LEDBUTTON_6    = 0x0400,           
        STRATCOM_LEDBUTTON_REC  = 0x1000,           
        STRATCOM_LEDBUTTON_ALL  = 0x1555,           
        STRATCOM_LEDBUTTON_NONE = 0x0               
    } stratcom_button_led;

    typedef enum stratcom_axis_ {
        STRATCOM_AXIS_X,                            
        STRATCOM_AXIS_Y,                            
        STRATCOM_AXIS_Z                             
    } stratcom_axis;

    typedef enum stratcom_led_state_ {
        STRATCOM_LED_ON,                            
        STRATCOM_LED_OFF,                           
        STRATCOM_LED_BLINK                          
    } stratcom_led_state;

    typedef enum stratcom_slider_state_ {
        STRATCOM_SLIDER_UNKNOWN = 0,                
        STRATCOM_SLIDER_1,                          
        STRATCOM_SLIDER_2,                          
        STRATCOM_SLIDER_3                           
    } stratcom_slider_state;

    typedef uint16_t stratcom_button_word;
    typedef int16_t stratcom_axis_word;
    typedef struct stratcom_input_state_ {
        stratcom_button_word  buttons;           
        stratcom_axis_word    axisX;             
        stratcom_axis_word    axisY;             
        stratcom_axis_word    axisZ;             
        stratcom_slider_state slider;            
    } stratcom_input_state;

    typedef struct stratcom_input_event_button_ {
        stratcom_button button;                  
        int status;                              
    } stratcom_input_event_button;

    typedef struct stratcom_input_event_slider_ {
        stratcom_slider_state status;            
    } stratcom_input_event_slider;

    typedef struct stratcom_input_event_axis_ {
        stratcom_axis axis;                      
        stratcom_axis_word status;               
    } stratcom_input_event_axis;

    typedef enum stratcom_input_event_type_ {
        STRATCOM_INPUT_EVENT_BUTTON,             
        STRATCOM_INPUT_EVENT_SLIDER,             
        STRATCOM_INPUT_EVENT_AXIS                
    } stratcom_input_event_type;

    typedef struct stratcom_input_event_ {
        stratcom_input_event_type type;          
        union event_desc_T {
            stratcom_input_event_button button;  
            stratcom_input_event_slider slider;  
            stratcom_input_event_axis axis;      
        } desc;                                  
        struct stratcom_input_event_* next;      
    } stratcom_input_event;

    typedef enum stratcom_return_ {
        STRATCOM_RET_SUCCESS = 0,                
        STRATCOM_RET_ERROR   = (-1),             
        STRATCOM_RET_NO_DATA = (-2)              
    } stratcom_return;

    LIBSTRATCOM_API stratcom_return stratcom_init();

    LIBSTRATCOM_API void stratcom_shutdown();

    LIBSTRATCOM_API stratcom_device* stratcom_open_device();

    LIBSTRATCOM_API stratcom_device* stratcom_open_device_on_path(char const* device_path);

    LIBSTRATCOM_API void stratcom_close_device(stratcom_device* device);

    LIBSTRATCOM_API stratcom_led_state stratcom_get_button_led_state(stratcom_device* device,
                                                                     stratcom_button_led led);

    LIBSTRATCOM_API stratcom_return stratcom_set_button_led_state(stratcom_device* device,
                                                                  stratcom_button_led led, stratcom_led_state state);

    LIBSTRATCOM_API void stratcom_set_button_led_state_without_flushing(stratcom_device* device,
                                                                        stratcom_button_led led,
                                                                        stratcom_led_state state);

    LIBSTRATCOM_API stratcom_return stratcom_flush_button_led_state(stratcom_device* device);

    LIBSTRATCOM_API int stratcom_led_state_has_unflushed_changes(stratcom_device* device);

    LIBSTRATCOM_API void stratcom_get_led_blink_interval(stratcom_device* device,
                                                         uint8_t* out_on_time, uint8_t* out_off_time);

    LIBSTRATCOM_API stratcom_return stratcom_set_led_blink_interval(stratcom_device* device,
                                                                    uint8_t on_time, uint8_t off_time);

    LIBSTRATCOM_API stratcom_return stratcom_read_button_led_state(stratcom_device* device);

    LIBSTRATCOM_API stratcom_return stratcom_read_led_blink_intervals(stratcom_device* device);

    LIBSTRATCOM_API stratcom_button_led stratcom_get_led_for_button(stratcom_button button);

    LIBSTRATCOM_API stratcom_return stratcom_read_input(stratcom_device* device);

    LIBSTRATCOM_API stratcom_return stratcom_read_input_with_timeout(stratcom_device* device, int timeout_milliseconds);

    LIBSTRATCOM_API stratcom_return stratcom_read_input_non_blocking(stratcom_device* device);

    LIBSTRATCOM_API stratcom_input_state stratcom_get_input_state(stratcom_device* device);

    LIBSTRATCOM_API int stratcom_is_button_pressed(stratcom_device* device, stratcom_button button);

    LIBSTRATCOM_API stratcom_axis_word stratcom_get_axis_value(stratcom_device* device, stratcom_axis axis);

    LIBSTRATCOM_API stratcom_slider_state stratcom_get_slider_state(stratcom_device* device);

    LIBSTRATCOM_API stratcom_button stratcom_iterate_buttons_range_begin();

    LIBSTRATCOM_API stratcom_button stratcom_iterate_buttons_range_end();

    LIBSTRATCOM_API stratcom_button stratcom_iterate_buttons_range_increment(stratcom_button button);

    LIBSTRATCOM_API stratcom_input_event* stratcom_create_input_events_from_states(stratcom_input_state* old_state,
                                                                                   stratcom_input_state* new_state);

    LIBSTRATCOM_API stratcom_input_event* stratcom_append_input_events_from_states(stratcom_input_event* events,
                                                                                   stratcom_input_state* old_state,
                                                                                   stratcom_input_state* new_state);

    LIBSTRATCOM_API void stratcom_free_input_events(stratcom_input_event* events);

#ifdef __cplusplus
}
#endif

#endif