CLC_Fct_EventMessage.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_EventMessage.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_EVENTMESSAGE_H_
#define _CLC_FCT_EVENTMESSAGE_H_

#ifdef __cplusplus
extern "C" {
#endif

#define EVENTMESSAGE_PROFILEBITS        8

typedef enum
{
    EP_None                     = 0x0000,
    EP_VoiceIDAvailable         = 0x0001,
    EP_ImpulseAvailable         = 0x0002,
    EP_ToneAvailable            = 0x0004,
    EP_WaveSettingAvailable     = 0x0008,
    EP_OffsetTone               = 0x0010,
    EP_NoteOff2NoteOnVel0       = 0x8000
}EventProfiles;

typedef struct
{
    CPUINT16 wProfiles;
    union
    {
        CPUINT16        DataArray[EVENTMESSAGE_PROFILEBITS];
        struct
        {
            CPUINT16    wTransaction;
            CPUINT16    wVoiceID;

            CPUINT16    wTone;
            CPUINT16    wImpulse;
            CPUINT16    wGate;
            CPUINT16    wWaveSettings;

            CPUINT16    w_Reserved_;
            CPUINT16    w_Reserved2_;
        } Discrete;
    } Profile;

    CPUINT16 wReserved;    
}CPEVENTMSG;


CLC_SDK_API void EventMessage_Clear(
    CPEVENTMSG * const pEventMessageData);


CLC_SDK_API CPUINT16 EventMessage_GetProfiles(
    CPEVENTMSG const * const pEventMessageData);

CLC_SDK_API void EventMessage_SetGate(
    CPEVENTMSG * const pEventMessageData, 
    EventGateModes const gate);

CLC_SDK_API EventGateModes EventMessage_GetGate(
    CPEVENTMSG const * const pEventMessageData);

CLC_SDK_API void EventMessage_SetOffsetTone(
    CPEVENTMSG * const pEventMessageData, 
    CPBOOLEAN const fValue);

CLC_SDK_API CPBOOLEAN EventMessage_GetOffsetTone(
    CPEVENTMSG const * const pEventMessageData );


CLC_SDK_API CPBOOLEAN EventMessage_IsWaveSettingAvailable(
    CPEVENTMSG const * const pEventMessageData);

CLC_SDK_API void EventMessage_SetWaveSettingStartPoint(
    CPEVENTMSG* const pEventMessageData, 
    CPUINT16 const wValue);

CLC_SDK_API CPUINT16 EventMessage_GetWaveSettingStartPoint(
    CPEVENTMSG const * const pEventMessageData);

CLC_SDK_API void EventMessage_SetWaveSettingBoundaries(
    CPEVENTMSG * const pEventMessageData, 
    EventWaveBoundaries const values);

CLC_SDK_API EventWaveBoundaries EventMessage_GetWaveSettingBoundaries(
    CPEVENTMSG const * const pEventMessageData);

CLC_SDK_API void EventMessage_SetWaveSettingReset(
    CPEVENTMSG * const pEventMessageData, 
    CPBOOLEAN const fValue);

CLC_SDK_API CPBOOLEAN EventMessage_GetWaveSettingReset(
    CPEVENTMSG const * const pEventMessageData);


CLC_SDK_API CPBOOLEAN EventMessage_IsImpulseAvailable(
    CPEVENTMSG const * const pEventMessageData);

CLC_SDK_API void EventMessage_SetImpulse(
    CPEVENTMSG * const pEventMessageData, 
    CPUINT16 const wImpulse);

CLC_SDK_API CPUINT16 EventMessage_GetImpulse(
    CPEVENTMSG const * const pEventMessageData);


CLC_SDK_API CPBOOLEAN EventMessage_IsToneAvailable(
    CPEVENTMSG const * const pEventMessageData);

CLC_SDK_API void EventMessage_SetTone(
    CPEVENTMSG* const pEventMessageData,
    CPUINT16 const wTone);

CLC_SDK_API CPUINT16 EventMessage_GetTone(
    CPEVENTMSG const * const pEventMessageData);


CLC_SDK_API CPBOOLEAN EventMessage_IsVoiceIDAvailable(
    CPEVENTMSG const * const pEventMessageData);

CLC_SDK_API void EventMessage_SetVoiceID(
    CPEVENTMSG * const pEventMessageData, 
    CPUINT16 const wVoiceID);

CLC_SDK_API CPUINT16 EventMessage_GetVoiceID(
    CPEVENTMSG const * const pEventMessageData);


CLC_SDK_API void EventMessage_SetTransaction(
    CPEVENTMSG* const pEventMessageData, 
    TransactionModes const mode);

CLC_SDK_API TransactionModes EventMessage_GetTransaction(
    CPEVENTMSG const * const pEventMessageData);


#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_EVENTMESSAGE_H_