|
| 1 | +#ifndef SDRPLAY_API_H |
| 2 | +#define SDRPLAY_API_H |
| 3 | + |
| 4 | +#include "sdrplay_api_dev.h" |
| 5 | +#include "sdrplay_api_rx_channel.h" |
| 6 | +#include "sdrplay_api_callback.h" |
| 7 | + |
| 8 | +//#if defined(_M_X64) || defined(_M_IX86) |
| 9 | +//#include "windows.h" |
| 10 | +//#elif defined (__GNUC__) |
| 11 | +typedef void *HANDLE; |
| 12 | +//#endif |
| 13 | +// |
| 14 | +//#ifndef _SDRPLAY_DLL_QUALIFIER |
| 15 | +//#if !defined(STATIC_LIB) && (defined(_M_X64) || defined(_M_IX86)) |
| 16 | +//#define _SDRPLAY_DLL_QUALIFIER __declspec(dllimport) |
| 17 | +//#elif defined(STATIC_LIB) || defined(__GNUC__) |
| 18 | +//#define _SDRPLAY_DLL_QUALIFIER |
| 19 | +//#endif |
| 20 | +//#endif // _SDRPLAY_DLL_QUALIFIER |
| 21 | + |
| 22 | +// Application code should check that it is compiled against the same API version |
| 23 | +// sdrplay_api_ApiVersion() returns the API version |
| 24 | +#define SDRPLAY_API_VERSION (float)(3.08) |
| 25 | + |
| 26 | +// API Constants |
| 27 | +#define SDRPLAY_MAX_DEVICES (16) |
| 28 | +#define SDRPLAY_MAX_TUNERS_PER_DEVICE (2) |
| 29 | + |
| 30 | +#define SDRPLAY_MAX_SER_NO_LEN (64) |
| 31 | +#define SDRPLAY_MAX_ROOT_NM_LEN (32) |
| 32 | + |
| 33 | +#define SDRPLAY_RSP1_ID (1) |
| 34 | +#define SDRPLAY_RSP1A_ID (255) |
| 35 | +#define SDRPLAY_RSP2_ID (2) |
| 36 | +#define SDRPLAY_RSPduo_ID (3) |
| 37 | +#define SDRPLAY_RSPdx_ID (4) |
| 38 | + |
| 39 | +// Enum types |
| 40 | +typedef enum |
| 41 | +{ |
| 42 | + sdrplay_api_Success = 0, |
| 43 | + sdrplay_api_Fail = 1, |
| 44 | + sdrplay_api_InvalidParam = 2, |
| 45 | + sdrplay_api_OutOfRange = 3, |
| 46 | + sdrplay_api_GainUpdateError = 4, |
| 47 | + sdrplay_api_RfUpdateError = 5, |
| 48 | + sdrplay_api_FsUpdateError = 6, |
| 49 | + sdrplay_api_HwError = 7, |
| 50 | + sdrplay_api_AliasingError = 8, |
| 51 | + sdrplay_api_AlreadyInitialised = 9, |
| 52 | + sdrplay_api_NotInitialised = 10, |
| 53 | + sdrplay_api_NotEnabled = 11, |
| 54 | + sdrplay_api_HwVerError = 12, |
| 55 | + sdrplay_api_OutOfMemError = 13, |
| 56 | + sdrplay_api_ServiceNotResponding = 14, |
| 57 | + sdrplay_api_StartPending = 15, |
| 58 | + sdrplay_api_StopPending = 16, |
| 59 | + sdrplay_api_InvalidMode = 17, |
| 60 | + sdrplay_api_FailedVerification1 = 18, |
| 61 | + sdrplay_api_FailedVerification2 = 19, |
| 62 | + sdrplay_api_FailedVerification3 = 20, |
| 63 | + sdrplay_api_FailedVerification4 = 21, |
| 64 | + sdrplay_api_FailedVerification5 = 22, |
| 65 | + sdrplay_api_FailedVerification6 = 23, |
| 66 | + sdrplay_api_InvalidServiceVersion = 24 |
| 67 | +} sdrplay_api_ErrT; |
| 68 | + |
| 69 | +typedef enum |
| 70 | +{ |
| 71 | + sdrplay_api_Update_None = 0x00000000, |
| 72 | + |
| 73 | + // Reasons for master only mode |
| 74 | + sdrplay_api_Update_Dev_Fs = 0x00000001, |
| 75 | + sdrplay_api_Update_Dev_Ppm = 0x00000002, |
| 76 | + sdrplay_api_Update_Dev_SyncUpdate = 0x00000004, |
| 77 | + sdrplay_api_Update_Dev_ResetFlags = 0x00000008, |
| 78 | + |
| 79 | + sdrplay_api_Update_Rsp1a_BiasTControl = 0x00000010, |
| 80 | + sdrplay_api_Update_Rsp1a_RfNotchControl = 0x00000020, |
| 81 | + sdrplay_api_Update_Rsp1a_RfDabNotchControl = 0x00000040, |
| 82 | + |
| 83 | + sdrplay_api_Update_Rsp2_BiasTControl = 0x00000080, |
| 84 | + sdrplay_api_Update_Rsp2_AmPortSelect = 0x00000100, |
| 85 | + sdrplay_api_Update_Rsp2_AntennaControl = 0x00000200, |
| 86 | + sdrplay_api_Update_Rsp2_RfNotchControl = 0x00000400, |
| 87 | + sdrplay_api_Update_Rsp2_ExtRefControl = 0x00000800, |
| 88 | + |
| 89 | + sdrplay_api_Update_RspDuo_ExtRefControl = 0x00001000, |
| 90 | + |
| 91 | + sdrplay_api_Update_Master_Spare_1 = 0x00002000, |
| 92 | + sdrplay_api_Update_Master_Spare_2 = 0x00004000, |
| 93 | + |
| 94 | + // Reasons for master and slave mode |
| 95 | + // Note: sdrplay_api_Update_Tuner_Gr MUST be the first value defined in this section! |
| 96 | + sdrplay_api_Update_Tuner_Gr = 0x00008000, |
| 97 | + sdrplay_api_Update_Tuner_GrLimits = 0x00010000, |
| 98 | + sdrplay_api_Update_Tuner_Frf = 0x00020000, |
| 99 | + sdrplay_api_Update_Tuner_BwType = 0x00040000, |
| 100 | + sdrplay_api_Update_Tuner_IfType = 0x00080000, |
| 101 | + sdrplay_api_Update_Tuner_DcOffset = 0x00100000, |
| 102 | + sdrplay_api_Update_Tuner_LoMode = 0x00200000, |
| 103 | + |
| 104 | + sdrplay_api_Update_Ctrl_DCoffsetIQimbalance = 0x00400000, |
| 105 | + sdrplay_api_Update_Ctrl_Decimation = 0x00800000, |
| 106 | + sdrplay_api_Update_Ctrl_Agc = 0x01000000, |
| 107 | + sdrplay_api_Update_Ctrl_AdsbMode = 0x02000000, |
| 108 | + sdrplay_api_Update_Ctrl_OverloadMsgAck = 0x04000000, |
| 109 | + |
| 110 | + sdrplay_api_Update_RspDuo_BiasTControl = 0x08000000, |
| 111 | + sdrplay_api_Update_RspDuo_AmPortSelect = 0x10000000, |
| 112 | + sdrplay_api_Update_RspDuo_Tuner1AmNotchControl = 0x20000000, |
| 113 | + sdrplay_api_Update_RspDuo_RfNotchControl = 0x40000000, |
| 114 | + sdrplay_api_Update_RspDuo_RfDabNotchControl = 0x80000000, |
| 115 | +} sdrplay_api_ReasonForUpdateT; |
| 116 | + |
| 117 | +typedef enum |
| 118 | +{ |
| 119 | + sdrplay_api_Update_Ext1_None = 0x00000000, |
| 120 | + |
| 121 | + // Reasons for master only mode |
| 122 | + sdrplay_api_Update_RspDx_HdrEnable = 0x00000001, |
| 123 | + sdrplay_api_Update_RspDx_BiasTControl = 0x00000002, |
| 124 | + sdrplay_api_Update_RspDx_AntennaControl = 0x00000004, |
| 125 | + sdrplay_api_Update_RspDx_RfNotchControl = 0x00000008, |
| 126 | + sdrplay_api_Update_RspDx_RfDabNotchControl = 0x00000010, |
| 127 | + sdrplay_api_Update_RspDx_HdrBw = 0x00000020, |
| 128 | + |
| 129 | + // Reasons for master and slave mode |
| 130 | +} sdrplay_api_ReasonForUpdateExtension1T; |
| 131 | + |
| 132 | +typedef enum |
| 133 | +{ |
| 134 | + sdrplay_api_DbgLvl_Disable = 0, |
| 135 | + sdrplay_api_DbgLvl_Verbose = 1, |
| 136 | + sdrplay_api_DbgLvl_Warning = 2, |
| 137 | + sdrplay_api_DbgLvl_Error = 3, |
| 138 | + sdrplay_api_DbgLvl_Message = 4, |
| 139 | +} sdrplay_api_DbgLvl_t; |
| 140 | + |
| 141 | +// Device structure |
| 142 | +typedef struct |
| 143 | +{ |
| 144 | + char SerNo[SDRPLAY_MAX_SER_NO_LEN]; |
| 145 | + unsigned char hwVer; |
| 146 | + sdrplay_api_TunerSelectT tuner; |
| 147 | + sdrplay_api_RspDuoModeT rspDuoMode; |
| 148 | + unsigned char valid; |
| 149 | + double rspDuoSampleFreq; |
| 150 | + HANDLE dev; |
| 151 | +} sdrplay_api_DeviceT; |
| 152 | + |
| 153 | +// Device parameter structure |
| 154 | +typedef struct |
| 155 | +{ |
| 156 | + sdrplay_api_DevParamsT *devParams; |
| 157 | + sdrplay_api_RxChannelParamsT *rxChannelA; |
| 158 | + sdrplay_api_RxChannelParamsT *rxChannelB; |
| 159 | +} sdrplay_api_DeviceParamsT; |
| 160 | + |
| 161 | +// Extended error message structure |
| 162 | +typedef struct |
| 163 | +{ |
| 164 | + char file[256]; |
| 165 | + char function[256]; |
| 166 | + int line; |
| 167 | + char message[1024]; |
| 168 | +} sdrplay_api_ErrorInfoT; |
| 169 | + |
| 170 | +// Comman API function types |
| 171 | +typedef sdrplay_api_ErrT (*sdrplay_api_Open_t)(void); |
| 172 | +typedef sdrplay_api_ErrT (*sdrplay_api_Close_t)(void); |
| 173 | +typedef sdrplay_api_ErrT (*sdrplay_api_ApiVersion_t)(float *apiVer); |
| 174 | +typedef sdrplay_api_ErrT (*sdrplay_api_LockDeviceApi_t)(void); |
| 175 | +typedef sdrplay_api_ErrT (*sdrplay_api_UnlockDeviceApi_t)(void); |
| 176 | +typedef sdrplay_api_ErrT (*sdrplay_api_GetDevices_t)(sdrplay_api_DeviceT *devices, unsigned int *numDevs, unsigned int maxDevs); |
| 177 | +typedef sdrplay_api_ErrT (*sdrplay_api_SelectDevice_t)(sdrplay_api_DeviceT *device); |
| 178 | +typedef sdrplay_api_ErrT (*sdrplay_api_ReleaseDevice_t)(sdrplay_api_DeviceT *device); |
| 179 | +typedef const char* (*sdrplay_api_GetErrorString_t)(sdrplay_api_ErrT err); |
| 180 | +typedef sdrplay_api_ErrorInfoT* (*sdrplay_api_GetLastError_t)(sdrplay_api_DeviceT *device); |
| 181 | +typedef sdrplay_api_ErrT (*sdrplay_api_DisableHeartbeat_t)(void); |
| 182 | + |
| 183 | +// Device API function types |
| 184 | +typedef sdrplay_api_ErrT (*sdrplay_api_DebugEnable_t)(HANDLE dev, sdrplay_api_DbgLvl_t dbgLvl); |
| 185 | +typedef sdrplay_api_ErrT (*sdrplay_api_GetDeviceParams_t)(HANDLE dev, sdrplay_api_DeviceParamsT **deviceParams); |
| 186 | +typedef sdrplay_api_ErrT (*sdrplay_api_Init_t)(HANDLE dev, sdrplay_api_CallbackFnsT *callbackFns, void *cbContext); |
| 187 | +typedef sdrplay_api_ErrT (*sdrplay_api_Uninit_t)(HANDLE dev); |
| 188 | +typedef sdrplay_api_ErrT (*sdrplay_api_Update_t)(HANDLE dev, sdrplay_api_TunerSelectT tuner, sdrplay_api_ReasonForUpdateT reasonForUpdate, sdrplay_api_ReasonForUpdateExtension1T reasonForUpdateExt1); |
| 189 | +typedef sdrplay_api_ErrT (*sdrplay_api_SwapRspDuoActiveTuner_t)(HANDLE dev, sdrplay_api_TunerSelectT *tuner, sdrplay_api_RspDuo_AmPortSelectT tuner1AmPortSel); |
| 190 | +typedef sdrplay_api_ErrT (*sdrplay_api_SwapRspDuoDualTunerModeSampleRate_t)(double *currentSampleRate, double newSampleRate); |
| 191 | +typedef sdrplay_api_ErrT (*sdrplay_api_SwapRspDuoMode_t)(sdrplay_api_DeviceT *currDevice, sdrplay_api_DeviceParamsT **deviceParams, |
| 192 | + sdrplay_api_RspDuoModeT rspDuoMode, double sampleRate, sdrplay_api_TunerSelectT tuner, |
| 193 | + sdrplay_api_Bw_MHzT bwType, sdrplay_api_If_kHzT ifType, sdrplay_api_RspDuo_AmPortSelectT tuner1AmPortSel); |
| 194 | + |
| 195 | +// API function definitions |
| 196 | +#ifdef __cplusplus |
| 197 | +extern "C" |
| 198 | +{ |
| 199 | +#endif |
| 200 | + |
| 201 | +// // Comman API function definitions |
| 202 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_Open(void); |
| 203 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_Close(void); |
| 204 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_ApiVersion(float *apiVer); |
| 205 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_LockDeviceApi(void); |
| 206 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_UnlockDeviceApi(void); |
| 207 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_GetDevices(sdrplay_api_DeviceT *devices, unsigned int *numDevs, unsigned int maxDevs); |
| 208 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_SelectDevice(sdrplay_api_DeviceT *device); |
| 209 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_ReleaseDevice(sdrplay_api_DeviceT *device); |
| 210 | +// _SDRPLAY_DLL_QUALIFIER const char* sdrplay_api_GetErrorString(sdrplay_api_ErrT err); |
| 211 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrorInfoT* sdrplay_api_GetLastError(sdrplay_api_DeviceT *device); |
| 212 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_DisableHeartbeat(void); // Must be called before sdrplay_api_SelectDevice() |
| 213 | +// |
| 214 | +// // Device API function definitions |
| 215 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_DebugEnable(HANDLE dev, sdrplay_api_DbgLvl_t enable); |
| 216 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_GetDeviceParams(HANDLE dev, sdrplay_api_DeviceParamsT **deviceParams); |
| 217 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_Init(HANDLE dev, sdrplay_api_CallbackFnsT *callbackFns, void *cbContext); |
| 218 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_Uninit(HANDLE dev); |
| 219 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_Update(HANDLE dev, sdrplay_api_TunerSelectT tuner, sdrplay_api_ReasonForUpdateT reasonForUpdate, sdrplay_api_ReasonForUpdateExtension1T reasonForUpdateExt1); |
| 220 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_SwapRspDuoActiveTuner(HANDLE dev, sdrplay_api_TunerSelectT *currentTuner, sdrplay_api_RspDuo_AmPortSelectT tuner1AmPortSel); |
| 221 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_SwapRspDuoDualTunerModeSampleRate(HANDLE dev, double *currentSampleRate, double newSampleRate); |
| 222 | +// _SDRPLAY_DLL_QUALIFIER sdrplay_api_ErrT sdrplay_api_SwapRspDuoMode(sdrplay_api_DeviceT *currDevice, sdrplay_api_DeviceParamsT **deviceParams, |
| 223 | +// sdrplay_api_RspDuoModeT rspDuoMode, double sampleRate, sdrplay_api_TunerSelectT tuner, |
| 224 | +// sdrplay_api_Bw_MHzT bwType, sdrplay_api_If_kHzT ifType, sdrplay_api_RspDuo_AmPortSelectT tuner1AmPortSel); |
| 225 | + |
| 226 | +#ifdef __cplusplus |
| 227 | +} |
| 228 | +#endif |
| 229 | + |
| 230 | +#endif //SDRPLAY_API_H |
0 commit comments