CLC_Fct_ModifierMessage.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_ModifierMessage.h
// Project:         CopperLan CHAILink Client SDK
// Version:         1.3
// Release Date:    2014/04/15
//*********************************************************

/********************************************************************
Software License Agreement:  CHAILink Client source code

The software supplied herewith by Klavis Technology (the “Company”) is intended and
supplied to you, the Company’s customer, for use solely and exclusively on embedded
CopperLan products needing a CHAILink Client. 
 The software is owned by the Company and/or its supplier, and is protected 
 under applicable copyright laws. All rights are reserved. Any use in violation of the 
 foregoing restrictions may subject the user to criminal sanctions under applicable laws,
as well as to civil liability for the breach of the terms and conditions of this license.

THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS, 
 IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF 
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
OF ANY KIND.
********************************************************************/

#ifndef _CLC_FCT_MODIFIERMESSAGE_H_
#define _CLC_FCT_MODIFIERMESSAGE_H_

#ifdef __cplusplus
extern "C" {
#endif

#define MODIFIERMESSAGE_PROFILEBITS     8

typedef enum
{
    MP_None                     = 0x0000,
    MP_VoiceIDAvailable         = 0x0001,
    MP_AutomationAvailable      = 0x0002,
    MP_IndexAvailable           = 0x0004,
    MP_MorphAvailable           = 0x0008,
    MP_PreLoad                  = 0x0010,
    MP_Relative                 = 0x0020,
    MP_Trigger                  = 0x0040,
    MP_RelativeOneWay           = 0x0100
}ModifierProfiles;

typedef struct
{
    CPUINT16 wNumber; 
    CPVALUE   Value;

    CPUINT16 wProfiles;
    union
    {
        CPUINT16        DataArray[MODIFIERMESSAGE_PROFILEBITS];       

        struct
        {
            CPUINT16    wTransaction;
            CPUINT16    wVoiceID;
            CPUINT16    wAutomation;
            CPUINT16    wIndex;
            CPUINT16    wSource;
            CPUINT16    wMorph;       

            CPUINT16    w_Reserved_;
            CPUINT16    w_Reserved1_;
        } Discrete;                 
    } Profile;
} CPMODIFIERMSG;


CLC_SDK_API void ModifierMessage_Clear(
    CPMODIFIERMSG * const pModifierMessageData);


CLC_SDK_API CPUINT16 ModifierMessage_GetProfiles(
    CPMODIFIERMSG const * const pModifierMessageData);

CLC_SDK_API void ModifierMessage_SetSourceType(
    CPMODIFIERMSG * const pModifierMessageData, 
    PerformanceMessageSources const source);

CLC_SDK_API PerformanceMessageSources ModifierMessage_GetSourceType(
    CPMODIFIERMSG const * const pModifierMessageData);

CLC_SDK_API void ModifierMessage_SetRelativeMode(
    CPMODIFIERMSG * const pModifierMessageData, 
    RelativeMode const mode);

CLC_SDK_API RelativeMode ModifierMessage_GetRelativeMode(
    CPMODIFIERMSG const * const pModifierMessageData);

CLC_SDK_API void ModifierMessage_SetPreLoad(
    CPMODIFIERMSG * const pModifierMessageData, 
    CPBOOLEAN const fValue);

CLC_SDK_API CPBOOLEAN ModifierMessage_GetPreLoad(
    CPMODIFIERMSG const * const pModifierMessageData);

CLC_SDK_API void ModifierMessage_SetTrigger(
    CPMODIFIERMSG * const pModifierMessageData, 
    CPBOOLEAN const fValue);

CLC_SDK_API CPBOOLEAN ModifierMessage_GetTrigger(
    CPMODIFIERMSG const * const pModifierMessageData);


CLC_SDK_API CPBOOLEAN ModifierMessage_IsIndexAvailable(
    CPMODIFIERMSG const * const pModifierMessageData);

CLC_SDK_API void ModifierMessage_SetIndex(
    CPMODIFIERMSG * const pModifierMessageData, 
    CPUINT16 const wIndex);

CLC_SDK_API CPUINT16 ModifierMessage_GetIndex(
    CPMODIFIERMSG const * const pModifierMessageData);


CLC_SDK_API CPBOOLEAN ModifierMessage_IsAutomationAvailable(
    CPMODIFIERMSG const * const pModifierMessageData);

CLC_SDK_API void ModifierMessage_SetAutomationState(
    CPMODIFIERMSG* const pModifierMessageData, 
    PerformanceMessageAutomationStates const state);

CLC_SDK_API PerformanceMessageAutomationStates ModifierMessage_GetAutomationState(
    CPMODIFIERMSG const * const pModifierMessageData);

CLC_SDK_API void ModifierMessage_SetAutomationTouch(
    CPMODIFIERMSG* const pModifierMessageData, 
    CPBOOLEAN const fValue);

CLC_SDK_API CPBOOLEAN ModifierMessage_GetAutomationTouch(
    CPMODIFIERMSG const * const pModifierMessageData);

CLC_SDK_API void ModifierMessage_SetAutomationWTE(
    CPMODIFIERMSG * const pModifierMessageData, 
    CPBOOLEAN const fValue);

CLC_SDK_API CPBOOLEAN ModifierMessage_GetAutomationWTE(
    CPMODIFIERMSG const * const pModifierMessageData);


CLC_SDK_API CPBOOLEAN ModifierMessage_IsMorphAvailable(
    CPMODIFIERMSG const * const pModifierMessageData);

CLC_SDK_API void ModifierMessage_SetMorph(
    CPMODIFIERMSG * const pModifierMessageData, 
    CPUINT16 const wValue);

CLC_SDK_API CPUINT16 ModifierMessage_GetMorph(
    CPMODIFIERMSG const * const pModifierMessageData);


CLC_SDK_API CPBOOLEAN ModifierMessage_IsVoiceIDAvailable(
    CPMODIFIERMSG const * const pModifierMessageData);

CLC_SDK_API void ModifierMessage_SetVoiceID(
    CPMODIFIERMSG * const pModifierMessageData,   
    CPUINT16 const wVoiceID);

CLC_SDK_API CPUINT16 ModifierMessage_GetVoiceID(
    CPMODIFIERMSG const * const pModifierMessageData);


CLC_SDK_API void ModifierMessage_SetTransaction(
    CPMODIFIERMSG * const pModifierMessageData, 
    TransactionModes const mode);

CLC_SDK_API TransactionModes ModifierMessage_GetTransaction(
    CPMODIFIERMSG const * const pModifierMessageData);



#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_MODIFIERMESSAGE_H_