CLC_Types.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Types.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_TYPES_H__
#define __CLC_TYPES_H__

#ifdef __cplusplus
extern "C" {
#endif

//=========================================================================
// Complex types
//=========================================================================

typedef struct
{
    CPUINT16    wBrandID;               
    CPUINT16    wModelID;               
    CPUINT32    dwDuplicateNumber;      
    CPUINT16    wModuleID;              
} CPDEVICEID;

typedef struct
{
    CPDEVICEID  deviceID;               
    CPUINT16    wInOutID;               
} CPENDPOINT;

#define CPDEVICEID_Equals(a,b) (((a).wBrandID == (b).wBrandID) && ((a).wModelID == (b).wModelID) && ((a).dwDuplicateNumber == (b).dwDuplicateNumber) && ((a).wModuleID == (b).wModuleID) )
#define CPDEVICEID_IsEmpty(a) (((a).wBrandID == 0) && ((a).wModelID == 0) && ((a).dwDuplicateNumber == 0) && ((a).wModuleID == 0))
#define CPENDPOINT_Equals(a,b) (CPDEVICEID_Equals((a).deviceID, (b).deviceID) && ((a).wInOutID == (b).wInOutID))
#define CPENDPOINT_IsEmpty(a) (CPDEVICEID_IsEmpty((a).deviceID) && ((a).wInOutID == 0))


typedef struct
{
    CPUINT64        qwSectionType;      
    CPUINT16        wInstance;          
}CPSECTIONID;

typedef struct
{
    CPUINT16        wInputID;           
    CPUINT16        wMsgType;           
    CPUINT16        wMsgNum;            
    CPUINT16        wMsgIndex;          
}CPPARAMETERID;

typedef struct
{
    CPENDPOINT      target;                 
    CPUINT16        wMsgType;               
    CPUINT16        wMsgNum;                
    CPUINT16        wMsgIndex;              
    CPUINT16        wInformationProfile;    
    CPUINT16        wValueDown;             
    CPUINT16        wValueUp;               
    CPUINT8         bAvailableValues;       
}CPCONTROLLERASSIGNMENT;

typedef struct
{
    CPUINT64        qwSectionType;          
    CPDEVICEID      DevID;                  
    CPUINT16        wInstanceCount;         
}CPSMARTCONNECTSECTIONITEM;

typedef struct
{
    CPUINT16        wControllerID;          
    CPUINT16        wControllerTypes;       
    CPUINT16        wPreferredMsgType;      
    CPUINT16        wPreferredMsgNum;       
    CPUINT16        wGroup;                 
}CPSMARTCONNECTCONTROLLERITEM;

typedef struct
{
    CPUINT16    wRawValue;      
    CPUINT16    wDataType;      
   
    union
    {
        CPUINT16    u16;
        CPUINT32    u32;
        CPUINT64    u64;
        CPINT16     i16;
        CPINT32     i32;
        CPINT64     i64;
#ifdef ENABLE_FLOAT
        CPFLOAT32   f32;
        CPFLOAT64   f64;
#endif
        CPUINT8     data[8];
    }value; 
} CPVALUE;

typedef struct 
{
    CPUINT32                    dwInCaps;                       
    CPSECTIONID                 sectionID;                      
    CPENDPOINT                  endpoint;                       
    CPUINT16                    wNumSources;                    
} CPINPUTINFO;

typedef struct 
{
    CPUINT32                    dwOutCaps;                      
    CPSECTIONID                 sectionID;                      
    CPENDPOINT                  endpoint;                       
    CPUINT16                    wObjectType;                    
    CPUINT16                    wDestinationCount;              
    CPUINT16                    wRecordingDestinationCount;     
    CPUINT8                     bDataConsumeMode;               
} CPBASEOUTPUTINFO;

typedef struct 
{
    CPUINT16                    wControllerTypes;               
    CPUINT16                    wGroup;                         
    CPUINT16                    wMsgType;                   
    CPUINT16                    wPreferredMsgNumber;        
    CPCONTROLLERASSIGNMENT      CurrentAssignment;              
    CPBOOLEAN                   fIsDefaultAssignment;           
}CPCONTROLLERINFO;

typedef struct 
{
    CPENDPOINT                  endpoint;                       
    CPUINT16                    wConnectionCount;               
    CPBOOLEAN                   fIsSynapse;                     
} CPPIPEINFO;

typedef struct 
{
    CPDEVICEID                  deviceID;                       
    CPDEVICEID                  parentDeviceID;                 
    CPUINT32                    dwDeviceCapabilities;           
    CPUINT32                    dwOutputCapabilities;           
    CPUINT32                    dwInputCapabilities;            
    CPUINT32                    dwOwnDeviceCapabilities;        
    CPUINT32                    dwOwnOutputCapabilities;        
    CPUINT32                    dwOwnInputCapabilities;         
    CPUINT32                    dwCHAIGroups;                   
    CPUINT32                    dwExtendedCapabilities;         
} CPREMOTEDEVICEINFO;

typedef struct
{
    CPUINT32        dwDeviceCapabilities;           
    CPUINT32        dwOutputCapabilities;           
    CPUINT32        dwInputCapabilities;            
    CPUINT32        dwOwnDeviceCapabilities;        
    CPUINT32        dwOwnOutputCapabilities;        
    CPUINT32        dwOwnInputCapabilities;         
    CPUINT32        dwExtendedCapabilities;         
    CPUINT16        wInputCount;            
    CPUINT16        wOutputCount;           
    CPUINT16        wControllerCount;       
    CPUINT16        wPipeCount;             
    CPDEVICEID      deviceID;               
    CPDEVICEID      parentID;               
    CPUINT8         bDuplicateMode;         
}CPLOCALDEVICEINFO;

typedef struct 
{    
    CPUINT16        wTimeStampFlags;        
    SongPosition    songPosition;           
    SystemTime      systemTime;             
} CPTIMESTAMPINFO;

#ifdef __cplusplus
}
#endif

#endif // __CLC_TYPES_H__