rotator.h

Go to the documentation of this file.

/*
 * Copyright 2017-2018 Leo McCormack
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef __ROTATOR_H_INCLUDED__
#define __ROTATOR_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void rotator_create(void** const phRot);
 
void rotator_destroy(void** const phRot);
 
void rotator_init(void* const hRot,
                  int samplerate);
 
void rotator_process(void* const hRot,
                     const float *const * inputs,
                     float* const* outputs,
                     int nInputs,
                     int nOutputs,
                     int nSamples);
 
 
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
int rotator_getFrameSize(void);
 
void rotator_setYaw(void* const hRot, float newYaw);
 
void rotator_setPitch(void* const hRot, float newPitch);
 
void rotator_setRoll(void* const hRot, float newRoll);
 
void rotator_setQuaternionW(void* const hRot, float newValue);
 
void rotator_setQuaternionX(void* const hRot, float newValue);
 
void rotator_setQuaternionY(void* const hRot, float newValue);
 
void rotator_setQuaternionZ(void* const hRot, float newValue);
 
void rotator_setFlipYaw(void* const hRot, int newState);
 
void rotator_setFlipPitch(void* const hRot, int newState);
 
void rotator_setFlipRoll(void* const hRot, int newState);
 
void rotator_setFlipQuaternion(void* const hRot, int newState);
 
void rotator_setChOrder(void* const hRot, int newOrder);
 
void rotator_setNormType(void* const hRot, int newType);
 
void rotator_setOrder(void* const hRot, int newOrder);
 
void rotator_setRPYflag(void* const hRot, int newState);
 
 
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
float rotator_getYaw(void* const hRot);
 
float rotator_getPitch(void* const hRot);
 
float rotator_getRoll(void* const hRot);
 
float rotator_getQuaternionW(void* const hRot);
 
float rotator_getQuaternionX(void* const hRot);
 
float rotator_getQuaternionY(void* const hRot);
 
float rotator_getQuaternionZ(void* const hRot);
 
int rotator_getFlipYaw(void* const hRot);
 
int rotator_getFlipPitch(void* const hRot);
 
int rotator_getFlipRoll(void* const hRot);
 
int rotator_getFlipQuaternion(void* const hRot);
 
int rotator_getRPYflag(void* const hRot);
 
int rotator_getChOrder(void* const hRot);
 
int rotator_getNormType(void* const hRot);
 
int rotator_getOrder(void* const hRot);
 
int rotator_getNSHrequired(void* const hRot);
 
int rotator_getProcessingDelay(void);
    
    
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __ROTATOR_H_INCLUDED__ */