Programming Information for WiNRADiO G33DDC HF receiver.

The G33DDC API SDK is implemented as a 32-bit dynamic library (G33DDCAPI.dll). It provides object-oriented and non-object-oriented interfaces to control the G33DDC device. This document describes the non-object-oriented interface. The G33DDCAPI.dll library exports several functions that make it possible to control G33DDC receivers.

The API is not fully thread-safe so preferrably it should be used in single-threaded applications. It can be used in multi-threaded applications as well, but with some care: One G33DDC receiver can be controlled from a single user thread only.

A C/C++ header file G33DDCAPI.h is a part of the SDK. The API can be used by any 32-bit application under Microsoft Windows 2000, XP, Vista and Windows 7 (including their 64-bit versions).

Block diagram of G33DDC processing chain

Simplified block diagram of G33DDC processing chain
Attenuator Preselectors Preamplifier ADC Noise blanker IF DDC1 frequency shift DDC1 DDC1 stream DDC2 frequency shift DDC2 DDC2 stream DDC2 stream Demodulator filter Signal level Notch filter Gain Pre-processed DDC2 stream Demodulator Audio gain Audio stream Audio filter Filtered audio filter DDC2 frequency shift DDC2 DDC2 stream DDC2 stream Demodulator filter Signal level Notch filter Gain Pre-processed DDC2 stream Demodulator Audio gain Audio stream Audio filter Filtered audio filter DDC2 frequency shift DDC2 DDC2 stream DDC2 stream Demodulator filter Signal level Notch filter Gain Pre-processed DDC2 stream Demodulator Audio gain Audio stream Audio filter Filtered audio filter Simplified block diagram of G33DDC processing chain

Using WiNRADiO G33DDC API

Loading API

The G33DDCAPI.dll library can be loaded to the application by two Microsoft Windows API functions. The first one is LoadLibrary and the other one is LoadLibraryEx. After the library is loaded, it is required to get addresses of exported functions. When the API is no longer required in the memory, the FreeLibrary function can be used to unload the API. Before the FreeLibrary is called, all the handles to G33DDC devices returned by the OpenDevice function must be closed by the CloseDevice function, otherwise the application can become to unpredictable state.

The following source code shows how to load the API.

 

#include <stdio.h>

#include "G33DDCAPI.h"



G33DDC_OPEN_DEVICE OpenDevice;

G33DDC_CLOSE_DEVICE CloseDevice;

HMODULE hAPI;



void main(void)

{  

    //Loading the API

    hAPI=LoadLibrary("G33DDCAPI.dll");



    if(hAPI!=NULL)

    {

        //Retrieving addresses of used API functions

        OpenDevice=(G33DDC_OPEN_DEVICE)GetProcAddress(hAPI,"OpenDevice");

        CloseDevice=(G33DDC_CLOSE_DEVICE)GetProcAddress(hAPI,"CloseDevice");



        //Here place code that uses the API



        FreeLibrary(hAPI);

    }

    else

    {

        //If the LoadLibrary fails

        printf("Failed to load G33DDCAPI.dll.\n");

    }

}

List of available G33DDC devices

The G33DDC API provides the GetDeviceList function which returns list of available G33DDC device which can be open by the OpenDevice function.

The following source code produces list of serial numbers of available G33DDC devices.


#include <stdio.h>

#include "G33DDCAPI.h"



G33DDC_GET_DEVICE_LIST GetDeviceList;

HMODULE hAPI;



void main(void)

{

 INT32 Count,i;

 G33DDC_DEVICE_INFO *DeviceList;



    //Loading the API

    hAPI=LoadLibrary("G33DDCAPI.dll");



    if(hAPI!=NULL)

    {

        //Retrieving address of the GetDeviceList function

        GetDeviceList=(G33DDC_GET_DEVICE_LIST)GetProcAddress(hAPI,"GetDeviceList");



        //Retrieving number of available devices

        Count=GetDeviceList(NULL,0);

        

        if(Count>=0)

        {

            if(Count!=0)

            {

                //Allocating memory for device information structures

                DeviceList=(G33DDC_DEVICE_INFO*)malloc(Count*sizeof(G33DDC_DEVICE_INFO));

                                               

                if(DeviceList!=NULL)

                {

                    //Retrieving information about available devices

                    Count=GetDeviceList(DeviceList,Count*sizeof(G33DDC_DEVICE_INFO));

                    

                    if(Count>=0)

                    {

                        printf("Available G33DDC devices count=%d:\n",Count);

            

                        for(i=0;i<Count;i++)

                        {

                            printf("%d. SN: %s\n",i,DeviceList[i].SerialNumber);

                        }

                    }

                    else

                    {

                        printf("GetDeviceList failed with error %08X\n",GetLastError());

                    }

        

                    free(DeviceList);

                }

                else

                {

                    printf("Out of memory\n");

                }

            }

            else

            {

                printf("No available G33DDC device found.\n");

            }

        }

        else

        {

            printf("GetDeviceList failed with error %08X\n",GetLastError());

        }



        FreeLibrary(hAPI);

    }

    else

    {

        printf("Failed to load G33DDCAPI.dll.\n");

    }



    printf("Press enter to exit\n");

    getchar();

}

Opening G33DDC device

G33DDC device has to be open before it can be controlled. The API provide the OpenDevice function to open the device.

The following source code shows how to open the first available G33DDC device.


#include <stdio.h>

#include "G33DDCAPI.h"



G33DDC_OPEN_DEVICE OpenDevice;

G33DDC_CLOSE_DEVICE CloseDevice;

HMODULE hAPI;



void main(void)

{  

 INT32 hDevice;

 

    //Loading the API

    hAPI=LoadLibrary("G33DDCAPI.dll");



    if(hAPI!=NULL)

    {

        //Retrieving addresses of the OpenDevice and CloseDevice API functions

        OpenDevice=(G33DDC_OPEN_DEVICE)GetProcAddress(hAPI,"OpenDevice");

        CloseDevice=(G33DDC_CLOSE_DEVICE)GetProcAddress(hAPI,"CloseDevice");



        //Opening the first available G33DDC device using predefined G3XDDC_OPEN_FIRST constant

        hDevice=OpenDevice(G3XDDC_OPEN_FIRST);

        

        if(hDevice>=0)

        {

            //Here place code that works with the open G33DDC device            

            

            //Closing handle to opened G33DDC device

            CloseDevice(hDevice);

        }

        else

        {

            printf("OpenDevice failed with error %08X\n",GetLastError());

        }



        FreeLibrary(hAPI);

    }

    else

    {

        //If the LoadLibrary fails

        printf("Failed to load G33DDCAPI.dll.\n");

    }

}

GetDeviceList

The GetDeviceList function returns information about available G33DDC devices that can be open.

C/C++ declaration

INT32 __stdcall GetDeviceList(G33DDC_DEVICE_INFO *DeviceList,UINT32 BufferSize);

Address retrieval

G33DDC_GET_DEVICE_LIST GetDeviceList=(G33DDC_GET_DEVICE_LIST)GetProcAddress(hAPI,"GetDeviceList");

Parameters

DeviceList
[out] Pointer to array of G33DDC_DEVICE_INFO structures to be filled with information about available G33DDC devices.
This parameter can be NULL only if the BufferSize parameter is zero, otherwise the function fails.
BufferSize
[in] Specifies the size in bytes of the buffer pointed to by the DeviceList parameter. If this value is zero, function returns number of available G33DDC devices and makes no use of the DeviceList buffer.

Return value

If the function succeeds, the return value is number of available G33DDC devices.
If the function fails, the return value is negative. To get extended error information, call GetLastError.

OpenDevice

Opens G33DDC device by its serial number.

C/C++ declaration

INT32 __stdcall OpenDevice(CONST CHAR *SerialNumber);

Address retrieval

G33DDC_OPEN_DEVICE OpenDevice=(G33DDC_OPEN_DEVICE)GetProcAddress(hAPI,"OpenDevice");

Parameters

SerialNumber
[in] Pointer to a null-terminated string that specifies the serial number of the G33DDC device to open. It can be used one of the following values instead of serial number:

ValueMeaning
G3XDDC_OPEN_FIRSTThe function opens first available G33DDC device.
G3XDDC_OPEN_DEMOThe function opens demo G33DDC device. This allows to work with the API without physical G33DDC device.

Return value

If the function succeeds, the return value is handle to the specified G33DDC device. This handle can only be used with functions of G33DDC API.
If the function fails, the return value is negative. To get extended error information, call GetLastError.

Remarks

The OpenDevice function can be called from any user thread, the returned handle can only be used in the same thread, otherwise application can become to unpredictable state.

Use the CloseDevice function to close G33DDC device handle returned by OpenDevice.


CloseDevice

Closes G33DDC device.

C/C++ declaration

BOOL __stdcall CloseDevice(INT32 hDevice);

Address retrieval

G33DDC_CLOSE_DEVICE CloseDevice=(G33DDC_CLOSE_DEVICE)GetProcAddress(hAPI,"CloseDevice");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

IsDeviceConnected

Checks if the device is still connected to the computer.

C/C++ declaration

BOOL __stdcall IsDeviceConnected(INT32 hDevice);

Address retrieval

G33DDC_IS_DEVICE_CONNECTED IsDeviceConnected=(G33DDC_IS_DEVICE_CONNECTED)GetProcAddress(hAPI,"IsDeviceConnected");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.

Return value

The function returns non-zero value if the device is still connected.
If the device is disconnected or the function fails return value is zero. To determine if the function failed, call GetLastError. GetLastError returns ERROR_SUCCESS if the device is disconnected or another error code if IsDeviceConnected failed.

Remarks

If it is determined the device is disconnected, corresponding device handle is no longer usable and it should be closed using the CloseDevice function.

GetDeviceInfo

Retrieves information about the G33DDC device.

C/C++ declaration

BOOL __stdcall GetDeviceInfo(INT32 hDevice,G33DDC_DEVICE_INFO *Info,UINT32 BufferLength);

Address retrieval

G33DDC_GET_DEVICE_INFO GetDeviceInfo=(G33DDC_GET_DEVICE_INFO)GetProcAddress(hAPI,"GetDeviceInfo");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Info
[out] Pointer to a G33DDC_DEVICE_INFO structure to be filled with information about the device. This parameter cannot be NULL.
BufferLength
[in] Size in bytes of the G33DDC_DEVICE_INFO structure.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetLED

Sets the front panel LED flashing mode.

C/C++ declaration

BOOL __stdcall SetLED(INT32 hDevice,UINT32 LEDMode);

Address retrieval

G33DDC_SET_LED SetLED=(G33DDC_SET_LED)GetProcAddress(hAPI,"SetLED");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
LEDMode
[in] Specifies front panel LED flashing mode. It can be one of the following:

ValueMeaning
G3XDDC_FRONT_PANEL_LED_MODE_DIAGDiagnostic flashing.
G3XDDC_FRONT_PANEL_LED_MODE_ONAlways on.
G3XDDC_FRONT_PANEL_LED_MODE_OFFAlways off.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetLED function to determine current flashing mode of the front panel LED.

A complete list of the diagnostic flashing patterns and their meaning is as follows:

No. Pattern Description Mode
1
        
Off No power
2
        
Long flash, equal gap No connection to computer
3
        
Two short flashes USB connected, radio off
4
        
One short flash followed by a long one USB connected, radio on, ready
5
        
Two short flashes followed by a long one USB connected, driver not installed
6
        
Three short flashes USB connected, driver installed, application not running


GetLED

Determines current flashing mode of device's front panel LED.

C/C++ declaration

BOOL __stdcall GetLED(INT32 hDevice,UINT32 *LEDMode);

Address retrieval

G33DDC_GET_LED GetLED=(G33DDC_GET_LED)GetProcAddress(hAPI,"GetLED");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
LEDMode
[out] Pointer to a variable that receives current flashing mode of device's front panel LED. For list of possible values, see SetLED. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetPower

Turns the G33DDC device on or off.

C/C++ declaration

BOOL __stdcall SetPower(INT32 hDevice,BOOL Power);

Address retrieval

G33DDC_SET_POWER SetPower=(G33DDC_SET_POWER)GetProcAddress(hAPI,"SetPower");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Power
[in] Specifies whether to turn on or off the device. If this parameter is non-zero the device is turned on, if it is zero the device is turned off.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If SetPower turns the device off, all the running streaming are stopped.

Use the GetPower function to determine current power state of the device.


GetPower

The GetPower function determines whether the device is turned on or off.

C/C++ declaration

BOOL __stdcall GetPower(INT32 hDevice,BOOL *Power);

Address retrieval

G33DDC_GET_POWER GetPower=(G33DDC_GET_POWER)GetProcAddress(hAPI,"GetPower");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Power
[out] Pointer to a variable that receives current power state of the device. If it is non-zero, the device is turned on. If it is zero the device is turned off. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetAttenuator

Sets input attenuator.

C/C++ declaration

BOOL __stdcall SetAttenuator(INT32 hDevice,UINT32 Attenuator);

Address retrieval

G33DDC_SET_ATTENUATOR SetAttenuator=(G33DDC_SET_ATTENUATOR)GetProcAddress(hAPI,"SetAttenuator");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Attenuator
[in] Value that specifies attenuation level in dB. Possible values are: 0, 3, 6, 9, 12, 15, 18, 21. If the value is not from the list, the SetAttenuator function rounds the value to nearest lower one.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetAttenuator function to determine current setting of the attenuator.

GetAttenuator

Retrieves current setting of the attenuator.

C/C++ declaration

BOOL __stdcall GetAttenuator(INT32 hDevice,UINT32 *Attenuator);

Address retrieval

G33DDC_GET_ATTENUATOR GetAttenuator=(G33DDC_GET_ATTENUATOR)GetProcAddress(hAPI,"GetAttenuator");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Attenuator
[out] Pointer to a variable that receives current attenuation level. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetPreselectors

Controls the band pass filter at input.

C/C++ declaration

BOOL __stdcall SetPreselectors(INT32 hDevice,UINT32 Low,UINT32 High);

Address retrieval

G33DDC_SET_PRESELECTORS SetPreselectors=(G33DDC_SET_PRESELECTORS)GetProcAddress(hAPI,"SetPreselectors");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Low
[in] Specifies cut-off low frequency of the filter in Hz. Possible values are: 0, 700000, 1200000, 2000000, 2900000, 4000000, 5100000, 5600000, 8300000, 9200000, 9500000, 13300000, 14600000, 16100000, 21600000. If the value is not from the list, the function rounds it to nearest one.
High
[in] Specifies cut-off high frequency of the filter in Hz. Possible values are: 2200000, 2700000, 4000000, 4900000, 6200000, 7400000, 9400000, 10700000, 12900000, 14600000, 18900000, 23400000, 25800000, 32100000, 50000000. If the value is not from the list, the function rounds it to nearest one.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Value of the Low parameter must not be higher than value of the High parameter, otherwise the function fails.

Use the GetPreselectors function to determine current setting of the preselectors.


GetPreselectors

Retrieves current setting of input band pass filter.

C/C++ declaration

BOOL __stdcall GetPreselectors(INT32 hDevice,UINT32 *Low,UINT32 *High);

Address retrieval

G33DDC_GET_PRESELECTORS GetPreselectors=(G33DDC_GET_PRESELECTORS)GetProcAddress(hAPI,"GetPreselectors");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Low
[out] Pointer to a variable that receives current cut-off low frequency of the filter in Hz. This parameter can be NULL if the application does not require this information.
High
[out] Pointer to a variable that receives current cut-off high frequency of the filter in Hz. This parameter can be NULL if the application does not require this information.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetPreamp

Enables or disables input preamplifier.

C/C++ declaration

BOOL __stdcall SetPreamp(INT32 hDevice,BOOL Preamp);

Address retrieval

G33DDC_SET_PREAMP SetPreamp=(G33DDC_SET_PREAMP)GetProcAddress(hAPI,"SetPreamp");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Preamp
[in] Specifies whether to enable or disable preamplifier. If this parameter is non-zero, the preamplifier is enabled. If the parameter is zero, the preamplifier is disabled.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetPreamp function to determine current state of the preamplifier.


GetPreamp

Retrieves current state of input preamplifier.

C/C++ declaration

BOOL __stdcall GetPreamp(INT32 hDevice,BOOL *Preamp);

Address retrieval

G33DDC_GET_PREAMP GetPreamp=(G33DDC_GET_PREAMP)GetProcAddress(hAPI,"GetPreamp");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Preamp
[out] Pointer to a variable that receives current state of the preamplifier. The value is non-zero if the preamplifier is enabled and zero if it is disabled. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetDithering

Enables or disables ADC dithering.

C/C++ declaration

BOOL __stdcall SetDithering(INT32 hDevice,BOOL Enabled);

Address retrieval

G33DDC_SET_DITHERING SetDithering=(G33DDC_SET_DITHERING)GetProcAddress(hAPI,"SetDithering");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Enabled
[in] Specifies whether to enable or disable ADC dithering. If this parameter is non-zero, dithering is enabled. If the parameter is zero, dithering is disabled.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetDithering function to determine current state of ADC dithering.

GetDithering

Retrieves current state of ADC dithering.

C/C++ declaration

BOOL __stdcall GetDithering(INT32 hDevice,BOOL *Enabled);

Address retrieval

G33DDC_GET_DITHERING GetDithering=(G33DDC_GET_DITHERING)GetProcAddress(hAPI,"GetDithering");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Enabled
[out] Pointer to a variable that receives current state of dithering. The value is non-zero if dithering is enabled and zero if it is disabled. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetADCNoiseBlanker

Enables or disables noise blanker on ADC stream.

C/C++ declaration

BOOL __stdcall SetADCNoiseBlanker(INT32 hDevice,BOOL Enabled);

Address retrieval

G33DDC_SET_ADC_NOISE_BLANKER SetADCNoiseBlanker=(G33DDC_SET_ADC_NOISE_BLANKER)GetProcAddress(hAPI,"SetADCNoiseBlanker");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Enabled
[in] Specifies whether to enable or disable noise blanker. If this parameter is non-zero, noise blanker is enabled. If the parameter is zero, noise blanker is disabled.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetADCNoiseBlanker function to determine current state of the noise blanker.

GetADCNoiseBlanker

Retrieves current ADC noise blanker state.

C/C++ declaration

BOOL __stdcall GetADCNoiseBlanker(INT32 hDevice,BOOL *Enabled);

Address retrieval

G33DDC_GET_ADC_NOISE_BLANKER GetADCNoiseBlanker=(G33DDC_GET_ADC_NOISE_BLANKER)GetProcAddress(hAPI,"GetADCNoiseBlanker");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Enabled
[out] Pointer to a variable that receives current state of noise blanker. The value is non-zero if noise blanker is enabled and zero if it is disabled. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetADCNoiseBlankerThreshold

Specifies ADC noise blanker threshold.

C/C++ declaration

BOOL __stdcall SetADCNoiseBlankerThreshold(INT32 hDevice,WORD Threshold);

Address retrieval

G33DDC_SET_ADC_NOISE_BLANKER_THRESHOLD SetADCNoiseBlankerThreshold=

    (G33DDC_SET_ADC_NOISE_BLANKER_THRESHOLD)GetProcAddress(hAPI,"SetADCNoiseBlankerThreshold");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Threshold
[in] Specifies the maximum acceptable input signal. Maximum possible value of threshold is 32767, in this case the noise blanker has no effect event it is enabled using the SetADCNoiseBlanker function.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetADCNoiseBlankerThreshold function to retrieve current threshold of the noise blanker.

GetADCNoiseBlankerThreshold

Determines ADC noise blanker threshold.

C/C++ declaration

BOOL __stdcall GetADCNoiseBlankerThreshold(INT32 hDevice,WORD *Threshold);

Address retrieval

G33DDC_GET_ADC_NOISE_BLANKER_THRESHOLD GetADCNoiseBlankerThreshold=

    (G33DDC_GET_ADC_NOISE_BLANKER_THRESHOLD)GetProcAddress(hAPI,"GetADCNoiseBlankerThreshold");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Threshold
[out] Pointer to a variable that receives threshold of ADC noise blanker. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

StartIF

Starts sending of IF snapshots.

C/C++ declaration

BOOL __stdcall StartIF(INT32 hDevice,WORD Period);

Address retrieval

G33DDC_START_IF StartIF=(G33DDC_START_IF)GetProcAddress(hAPI,"StartIF");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Period
[in] Specifies time interval in milliseconds how often the IF snapshots are sent to IFCallback callback function.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The G33DDC device has to be turned on using the SetPower function before use of StartIF, otherwise the StartIF function fails.

Too low value of the Period parameter can dramatically increase data flow through USB wich could cause breaking of running streaming.


StopIF

Stops sending of IF snapshots.

C/C++ declaration

BOOL __stdcall StopIF(INT32 hDevice);

Address retrieval

G33DDC_STOP_IF StopIF=(G33DDC_STOP_IF)GetProcAddress(hAPI,"StopIF");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The IFCallback callback function is not called after StopIF returns.


SetInverted

Enables or disables frequency spectrum inversion.

C/C++ declaration

BOOL __stdcall SetInverted(INT32 hDevice,BOOL Inverted);

Address retrieval

G33DDC_SET_INVERTED SetInverted=(G33DDC_SET_INVERTED)GetProcAddress(hAPI,"SetInverted");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Inverted
[in] Specifies whether to enable or disable frequency spectrum inversion. If this parameter is non-zero, IF spectrum is inverted.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

GetInverted

Retrieves current frequency spectrum inversion setting.

C/C++ declaration

BOOL __stdcall GetInverted(INT32 hDevice,BOOL *Inverted);

Address retrieval

G33DDC_GET_INVERTED GetInverted=(G33DDC_GET_INVERTED)GetProcAddress(hAPI,"GetInverted");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Inverted
[out] Pointer to a variable that receives non-zero value if the frequency spectrum inversion is enabled, and zero if the inversion is disabled. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

GetDDCInfo

Retrieves information about DDC format.

C/C++ declaration

BOOL __stdcall GetDDCInfo(INT32 hDevice,UINT32 DDCTypeIndex,G3XDDC_DDC_INFO *Info);

Address retrieval

G33DDC_GET_DDC_INFO GetDDCInfo=(G33DDC_GET_DDC_INFO)GetProcAddress(hAPI,"GetDDCInfo");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
DDCTypeIndex
[in] Specifies index of DDC type. For more information, see remarks.
Info
[out] Pointer to a G3XDDC_DDC_INFO structure to be filled with information about information of the DDC type.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetDDC1Count function to determine the number of possible DDC types of DDC1. In this case the DDCTypeIndex parameter can vary from zero to one less than the number determined by GetDDC1Count.

Use the GetDDC1 function to determine current DDC type index of DDC1 and the GetDDC2 function to determine current DDC type of DDC2.


GetDDC1Count

Retrieves number of DDC types supported by DDC1.

C/C++ declaration

BOOL __stdcall GetDDC1Count(INT32 hDevice,UINT32 *Count);

Address retrieval

G33DDC_GET_DDC1_COUNT GetDDC1Count=(G33DDC_GET_DDC1_COUNT)GetProcAddress(hAPI,"GetDDC1Count");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Count
[in] Specifies index of DDC type.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetDDC1

Sets current DDC type of DDC1.

C/C++ declaration

BOOL __stdcall SetDDC1(INT32 hDevice,UINT32 DDCTypeIndex);

Address retrieval

G33DDC_SET_DDC1 SetDDC1=(G33DDC_SET_DDC1)GetProcAddress(hAPI,"SetDDC1");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
DDCTypeIndex
[in] Specifies index of DDC type to be used in DDC1.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetDDC1Count function to determine the number of possible DDC types of DDC1. The DDCTypeIndex parameter can vary from zero to one less than the number determined by GetDDC1Count.

DDC1 streaming must not run when calling SetDDC1. In other words, DDC1 streaming that is started using the StartDDC1 function has to be stopped using the StopDDC1 function before calling of SetDDC1, otherwise SetDDC1 fails. The SetDDC1 function does not start and stop DDC1 streaming, just changes DDC type of DDC1.

Calling of SetDDC1 can change current DDC type of DDC2 and current bandwidth of demodulator filter, so it is useful to call the GetDDC2 and GetDemodulatorFilterBandwidth functions immediately after SetDDC1 to determine current DDC type of DDC2 and current bandwidth of demodulator filter.

Use the GetDDC1 function to determine current DDC type of the DDC1.


GetDDC1

Retrieves information about current DDC type of the DDC1.

C/C++ declaration

BOOL __stdcall GetDDC1(INT32 hDevice,UINT32 *DDCTypeIndex,G3XDDC_DDC_INFO *DDCInfo);

Address retrieval

G33DDC_GET_DDC1 GetDDC1=(G33DDC_GET_DDC1)GetProcAddress(hAPI,"GetDDC1");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
DDCTypeIndex
[out] Pointer to a variable that receives index of current DDC type of the DDC1. This parameter can be NULL if the application does not require this information.
DDCInfo
[out] Pointer to a G3XDDC_DDC_INFO structure to be filled with information about current DDC type of the DDC1. This parameter can be NULL if the application does not require this information.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Returned DDCTypeIndex can be passed to the GetDDCInfo function.

SetDDC1Frequency

Sets DDC1 center frequency.

C/C++ declaration

BOOL __stdcall SetDDC1Frequency(INT32 hDevice,UINT32 Frequency);

Address retrieval

G33DDC_SET_DDC1_FREQUENCY SetDDC1Frequency=(G33DDC_SET_DDC1_FREQUENCY)GetProcAddress(hAPI,"SetDDC1Frequency");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Frequency
[in] Specifies new center frequency of DDC1 in Hz.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Changing of DDC1 frequency causes change of absolute frequency of the DDC2 and demodulator in each channel.

Use the GetDDC1Frequency function to determine current center frequency of DDC1.


GetDDC1Frequency

Retrieves current center frequency of DDC1.

C/C++ declaration

BOOL __stdcall GetDDC1Frequency(INT32 hDevice,UINT32 *Frequency);

Address retrieval

G33DDC_GET_DDC1_FREQUENCY GetDDC1Frequency=(G33DDC_GET_DDC1_FREQUENCY)GetProcAddress(hAPI,"GetDDC1Frequency");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Frequency
[out] Pointer to a variable that receives current center frequency of DDC1 in Hz. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

StartDDC1

Starts DDC1 streaming.

C/C++ declaration

BOOL __stdcall StartDDC1(INT32 hDevice,UINT32 SamplesPerBuffer);

Address retrieval

G33DDC_START_DDC1 StartDDC1=(G33DDC_START_DDC1)GetProcAddress(hAPI,"StartDDC1");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
SamplesPerBuffer
[in] Specifies number of I/Q sample sets in each buffer passed to the the DDC1StreamCallback callback function. The value has to be multiple of 64 greater than zero. If it is zero, the StartDDC1 function fails. If it is not multiple of 64 the function rounds it up to nearest multiple of 64.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The G33DDC device has to be turned on using the SetPower function before StartDDC1 is used. Otherwise StartDDC1 fails.

If the DDC1 streaming is already running before use of StartDDC1, StartDDC1 restarts the streaming except it was previously started with the same SamplesPerBuffer parameter. In this case StartDDC1 does nothing. Restart of DDC1 streaming stops of DDC2 and audio streaming in each channel. StartDDC1 does not restart DDC2 and audio streaming.

If DDC1 playback is running (started using StartDDC1Playback function) before use of StartDDC1, StartDDC1 stops it and starts DDC1 streaming from the device.

Use the StopDDC1 function to stop DDC1 streaming.

Decreasing value of the SamplesPerBuffer parameter decreases latency and it may increase CPU usage. Increasing value of the SamplesPerBuffer parameter increased latency and it may decrease CPU usage.


StopDDC1

Stops DDC1 streaming.

C/C++ declaration

BOOL __stdcall StopDDC1(INT32 hDevice);

Address retrieval

G33DDC_STOP_DDC1 StopDDC1=(G33DDC_STOP_DDC1)GetProcAddress(hAPI,"StopDDC1");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If DDC1 playback is running (started using StartDDC1Playback) before use of StopDDC1, the StopDDC1 function stops it.

The StopDDC1 function stops all the streaming beyond the DDC1 in processing chain (DDC2 and audio streaming in all the channels).

The DDC1StreamCallback and DDC1PlaybackStreamCallback callback functions are not called after StopDDC1 returns.


StartDDC1Playback

Starts DDC1 playback. It allows to pass previously recorded DDC1 I/Q samples to the processing chain instead of the samples received from the device.

C/C++ declaration

BOOL __stdcall StartDDC1Playback(INT32 hDevice,UINT32 SamplesPerBuffer,UINT32 BitsPerSample);

Address retrieval

G33DDC_START_DDC1_PLAYBACK StartDDC1Playback=(G33DDC_START_DDC1_PLAYBACK)GetProcAddress(hAPI,"StartDDC1Playback");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
SamplesPerBuffer
[in] Specifies number of I/Q sample sets in each buffer passed to the DDC1PlaybackStreamCallback callback to fill the buffer by the application and to the DDC1StreamCallback callback function. The value has to be multiple of 64 greater than zero. If it is zero, the StartDDC1Playback function fails. If it is not multiple of 64 the function rounds it up to nearest multiple of 64.
BitsPerSample
[in] Specifies number of bits per I and Q samples. It is used for both DDC1PlaybackStreamCallback and DDC1StreamCallback callback functions. The possible value is one of the following:

ValueMeaning
0I and Q samples have default number of bits. It is given by by BitsPerSample member of the G3XDDC_DDC_INFO structure which can be retrieved using the GetDDC1 or GetDDCInfo function. Possible values are 16 or 32 bits per sample, signed, little endian.
16I and Q samples have 16 bit (16 bits per I, 16 bits per Q), signed, little endian.
32I and Q samples have 32 bit (32 bits per I, 32 bits per Q), signed, little endian.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The G33DDC device has to be turned on using SetPower function before use of StartDDC1Playback.

The StartDDC1Playback function stops DDC1 streaming that was previously started by the StartDDC1 or StartDDC1Playback function and starts DDC1 playback with new parameters. Stopping of DDC1 streaming stops DDC2 and audio steaming in each channel. StartDDC1Playback does not restart DDC2 and audio streaming.

Use the StopDDC1 function to stop DDC1 playback.


PauseDDC1Playback

Pauses DDC1 playback.

C/C++ declaration

BOOL __stdcall PauseDDC1Playback(INT32 hDevice);

Address retrieval

G33DDC_PAUSE_DDC1_PLAYBACK PauseDDC1Playback=(G33DDC_PAUSE_DDC1_PLAYBACK)GetProcAddress(hAPI,"PauseDDC1Playback");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If DDC1 playback is not active or it is already paused, PauseDDC1Playback does nothing.

The DDC1PlaybackStreamCallback and DDC1StreamCallback callback functions can be called once after PauseDDC1Playback returns. Then they are not called until playback is resumed using the ResumeDDC1Playback function.


ResumeDDC1Playback

Resumes paused DDC1 playback.

C/C++ declaration

BOOL __stdcall ResumeDDC1Playback(INT32 hDevice);

Address retrieval

G33DDC_RESUME_DDC1_PLAYBACK ResumeDDC1Playback=(G33DDC_RESUME_DDC1_PLAYBACK)GetProcAddress(hAPI,"ResumeDDC1Playback");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If DDC1 playback is not active or it is not paused, ResumeDDC1Playback does nothing.


GetDDC2

Retrieves information about current DDC type of the DDC2.

C/C++ declaration

BOOL __stdcall GetDDC2(INT32 hDevice,UINT32 *DDCTypeIndex,G3XDDC_DDC_INFO *DDCInfo);

Address retrieval

G33DDC_GET_DDC2 GetDDC2=(G33DDC_GET_DDC2)GetProcAddress(hAPI,"GetDDC2");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
DDCTypeIndex
[out] Pointer to a variable that receives index of current DDC type of the DDC2. This parameter can be NULL if the application does not require this information.
DDCInfo
[out] Pointer to a G3XDDC_DDC_INFO structure to be filled with information about current DDC type of the DDC2. This parameter can be NULL if the application does not require this information.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Each channel has its own DDC2, see the block diagram. DDC type of each DDC2 is the same and it depends on DDC type of DDC1, it cannot be changed by the application directly. DDC type of DDC2 is equal to DDC type of DDC1 if DDC type index of DDC1 is less than or equal to 5 (sample rate: 80 kHz, bandwidth: 64 kHz, bits per sample: 32). If DDC type index of DDC1 is above 5, DDC type index of DDC2 is always 5. Changing of DDC type of DDC1 can cause change of DDC type of DDC2, so it is useful to call GetDDC2 immediately after the SetDDC1 function to determine current DDC type of DDC2 if the application needs to know parameters of DDC2.

The BitsPerSample member of the G3XDDC_DDC_INFO structure is not used and it can be ignored for DDC2. I and Q samples in buffers passed to the DDC2StreamCallback and DDC2PreprocessedStreamCallback DDC2 callback functions are always in IEEE float (32 bit, little endian) format.

Returned DDCTypeIndex can be passed to the GetDDCInfo function.


SetDDC2Frequency

Sets relative center frequency of DDC2 for given channel.

C/C++ declaration

BOOL __stdcall SetDDC2Frequency(INT32 hDevice,UINT32 Channel,INT32 Frequency);

Address retrieval

G33DDC_SET_DDC2_FREQUENCY SetDDC2Frequency=(G33DDC_SET_DDC2_FREQUENCY)GetProcAddress(hAPI,"SetDDC2Frequency");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Frequency
[in] Specifies new center frequency of DDC2 in Hz.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Value of the Frequency parameter is center frequency of the DDC2 relative to center of the DDC1. The value can be negative.

Absolute frequency of the DDC2 is given by the following formula:

faDDC2[i] = fDDC1 + frDDC2[i]

Where faDDC2[i] is absolute center frequency of DDC2 of i-th channel in Hz, fDDC1 is center frequency of the DDC1 in Hz (set using the SetDDC1Frequency function) and frDDC2[i] is relative center frequency of DDC2 of i-th channel in Hz (set using SetDDC2Frequency).

Changing of DDC2 relative frequency changes absolute frequency of the DDC2 and demodulator in the specified channel.

Use the GetDDC2Frequency function to determine current relative center frequency of the DDC2 for given channel.

The following example shows three methods how it is possible to set absolute DDC2 center frequency of channel 0 to 11.01 MHz:


INT32 hDevice; //Handle to G33DDC device returned by the OpenDevice function



//1. method

SetDDC1Frequency(hDevice,11010000);

SetDDC2Frequency(hDevice,0,0);



//2. method, it can be used if bandwidth of DDC2 is less than bandwidth of DDC1

SetDDC1Frequency(hDevice,11000000);

SetDDC2Frequency(hDevice,0,10000);



//3. method, it can be used if bandwidth of DDC2 is less than bandwidth of DDC1

SetDDC1Frequency(hDevice,11020000);

SetDDC2Frequency(hDevice,0,-10000);


GetDDC2Frequency

Retrieves current relative center frequency of DDC2.

C/C++ declaration

BOOL __stdcall GetDDC2Frequency(INT32 hDevice,UINT32 Channel,INT32 *Frequency);

Address retrieval

G33DDC_GET_DDC2_FREQUENCY GetDDC2Frequency=(G33DDC_GET_DDC2_FREQUENCY)GetProcAddress(hAPI,"GetDDC2Frequency");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Frequency
[out] Pointer to a variable that receives current relative center frequency of DDC2 in Hz. The returned value can be negative. See remarks of the SetDDC2Frequency for information how to calculate absolute center frequency of DDC2. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

StartDDC2

Starts DDC2 streaming for given channel.

C/C++ declaration

BOOL __stdcall StartDDC2(INT32 hDevice,UINT32 Channel,UINT32 SamplesPerBuffer);

Address retrieval

G33DDC_START_DDC2 StartDDC2=(G33DDC_START_DDC2)GetProcAddress(hAPI,"StartDDC2");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
SamplesPerBuffer
[in] Specifies number of I/Q sample sets in each buffer passed to the the DDC2StreamCallback and DDC2PreprocessedStreamCallback callback functions. The value has to be multiple of 64 greater than zero. If it is zero, the StartDDC2 function fails. If it is not multiple of 64 the function rounds it up to nearest multiple of 64.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Before StartDDC2 is used, the G33DDC device has to be turned on using the SetPower function and DDC1 streaming has to be started using the StartDDC1 or StartDDC1Playback function, otherwise StartDDC2 fails.

If the DDC2 streaming for given channel is already running, StartDDC2 restarts it except the streaming was previously started with the same SamplesPerBuffer parameter. In this case StartDDC2 does nothing. Restart of the DDC2 streaming stops audio streaming for give channel. StartDDC2 does not restart audio streaming.

Use the StopDDC2 function to stop DDC2 streaming.

Decreasing value of the SamplesPerBuffer parameter decreases latency and it may increase CPU usage. Increasing value of the SamplesPerBuffer parameter increased latency and it may decrease CPU usage.


StopDDC2

Stops DDC2 streaming for given channel.

C/C++ declaration

BOOL __stdcall StopDDC2(INT32 hDevice,UINT32 Channel);

Address retrieval

G33DDC_STOP_DDC2 StopDDC2=(G33DDC_STOP_DDC2)GetProcAddress(hAPI,"StopDDC2");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If audio streaming for given channel is running, it is stopped too.

If DDC2 streaming is not active, StopDDC2 does nothing.

The DDC2StreamCallback and DDC2PreprocessedStreamCallback callback functions are not called after StopDDC2 returns.


SetDDC2NoiseBlanker

Enables or disables noise blanker on DDC2 stream.

C/C++ declaration

BOOL __stdcall SetDDC2NoiseBlanker(INT32 hDevice,UINT32 Channel,BOOL Enabled);

Address retrieval

G33DDC_SET_DDC2_NOISE_BLANKER SetDDC2NoiseBlanker=(G33DDC_SET_DDC2_NOISE_BLANKER)GetProcAddress(hAPI,"SetDDC2NoiseBlanker");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Enabled
[in] Specifies whether to enable or disable noise blanker. If this parameter is non-zero, noise blanker is enabled. If the parameter is zero, noise blanker is disabled.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetDDC2NoiseBlanker function to determine current state of the noise blanker.

GetDDC2NoiseBlanker

Retrieves current DDC2 noise blanker state.

C/C++ declaration

BOOL __stdcall GetDDC2NoiseBlanker(INT32 hDevice,UINT32 Channel,BOOL *Enabled);

Address retrieval

G33DDC_GET_DDC2_NOISE_BLANKER GetDDC2NoiseBlanker=(G33DDC_GET_DDC2_NOISE_BLANKER)GetProcAddress(hAPI,"GetDDC2NoiseBlanker");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Enabled
[out] Pointer to a variable that receives current state of noise blanker. The value is non-zero if noise blanker is enabled and zero if it is disabled. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetDDC2NoiseBlankerThreshold

Specifies DDC2 noise blanker threshold.

C/C++ declaration

BOOL __stdcall SetDDC2NoiseBlankerThreshold(INT32 hDevice,UINT32 Channel,double Threshold);

Address retrieval

G33DDC_SET_DDC2_NOISE_BLANKER_THRESHOLD SetDDC2NoiseBlankerThreshold=

    (G33DDC_SET_DDC2_NOISE_BLANKER_THRESHOLD)GetProcAddress(hAPI,"SetDDC2NoiseBlankerThreshold");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Threshold
[in] Specifies threshold in %.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetDDC2NoiseBlankerThreshold function to retrieve current threshold of the noise blanker.

GetDDC2NoiseBlankerThreshold

Retrieves DDC2 noise blanker threshold.

C/C++ declaration

BOOL __stdcall GetDDC2NoiseBlankerThreshold(INT32 hDevice,UINT32 Channel,double *Threshold);

Address retrieval

G33DDC_GET_DDC2_NOISE_BLANKER_THRESHOLD GetDDC2NoiseBlankerThreshold=

    (G33DDC_GET_DDC2_NOISE_BLANKER_THRESHOLD)GetProcAddress(hAPI,"GetDDC2NoiseBlankerThreshold");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Threshold
[out] Pointer to a variable that receives threshold of the noise blanker. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

GetDDC2NoiseBlankerExcessValue

Determines value which indicates percentage ratio between short time average signal level and maximum level.

C/C++ declaration

BOOL __stdcall GetDDC2NoiseBlankerExcessValue(INT32 hDevice,UINT32 Channel,double *Value);

Address retrieval

G33DDC_GET_DDC2_NOISE_BLANKER_EXCESS_VALUE GetDDC2NoiseBlankerExcessValue=

    (G33DDC_GET_DDC2_NOISE_BLANKER_EXCESS_VALUE)GetProcAddress(hAPI,"GetDDC2NoiseBlankerExcessValue");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Value
[out] Pointer to a variable that receives current excess value in %. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

GetSignalLevel

Determines current signal level for given channel.

C/C++ declaration

BOOL __stdcall GetSignalLevel(INT32 hDevice,UINT32 Channel,FLOAT *Peak,FLOAT *RMS);

Address retrieval

G33DDC_GET_SIGNAL_LEVEL GetSignalLevel=(G33DDC_GET_SIGNAL_LEVEL)GetProcAddress(hAPI,"GetSignalLevel");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Peak
[out] Pointer to a variable that receives current signal level (peak) in Volts. This parameter can be NULL if the application does not require this information.
RMS
[out] Pointer to a variable that receives current signal level (RMS) in Volts. This parameter can be NULL if the application does not require this information.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

DDC2 streaming has to be active (started using the StartDDC2 function) before calling of GetSignalLevel, otherwise returned peak and RMS signal levels are zero.

Signal level is evaluated from signal after the demodulator filter and before the notch filter (see block diagram), the signal is selected by the demodulator filter.

Signal level is evaluated for each buffer that processed by the demoduletor filter. Buffer size (signal level evaluation rate) is given by the SamplesPerBuffer parameter of the StartDDC2 function.

The DDC2PreprocessedStreamCallback callback function provides signal level for each buffer passed the callback, i.e. for each buffer used in signal level evaluation. This provides way to get signal level from each processed buffer without need of pulling it using GetSignalLevel.

To convert RMS signal level in Volts to power in dBm use the following formulas:

P[W] = (VRMS)2 / R = (VRMS)2 / 50

P[dBm]= 10 * log10( P[W] * 1000 )

Where VRMS is RMS signal level in Volts obtained by GetSignalLevel, R is G33DDC receiver input impedance (50 Ω), P[W] is power in Watts, P[dBm] is power in dBm and 1000 is conversion coefficient W -> mW.

The following example shows how to obtain current signal level in dBm from channel 0:


#include <stdio.h>

#include <math.h>



INT32 hDevice; //handle to G33DDC device returned by the OpenDevice function

float P_dBm,V_RMS;



GetSignalLevel(hDevice,0,NULL,&V_RMS);



P_dBm=10.0*log10(V_RMS*V_RMS*(1000.0/50.0));



printf("Current signal level [RMS]: %.1f dBm\n",P_dBm);


SetNotchFilter

Enables or disables notch filter for given channel.

C/C++ declaration

BOOL __stdcall SetNotchFilter(INT32 hDevice,UINT32 Channel,UINT32 NotchFilterIndex,BOOL Enabled);

Address retrieval

G33DDC_SET_NOTCH_FILTER SetNotchFilter=(G33DDC_SET_NOTCH_FILTER)GetProcAddress(hAPI,"SetNotchFilter");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
NotchFilterIndex
[in] Specifies notch filter index. Possible values are: 0, 1.
Enabled
[in] Specifies whether to enable or disable notch filter. If this parameter is non-zero, the filter is enabled. If the parameter is zero, the filter is disabled.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetNotchFilter function to determine whether the filter is enabled or disabled.

GetNotchFilter

Retrieves current notch filter state for given channel.

C/C++ declaration

BOOL __stdcall GetNotchFilter(INT32 hDevice,UINT32 Channel,UINT32 NotchFilterIndex,BOOL *Enabled);

Address retrieval

G33DDC_SET_NOTCH_FILTER SetNotchFilter=(G33DDC_SET_NOTCH_FILTER)GetProcAddress(hAPI,"SetNotchFilter");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
NotchFilterIndex
[in] Specifies notch filter index. Possible values are: 0, 1.
Enabled
[out] Pointer to a variable that receives current state of the notch filter. The value is non-zero if the filter is enabled and zero if it is disabled. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetNotchFilterFrequency

Specifies relative center frequency of the notch filter for given channel.

C/C++ declaration

BOOL __stdcall SetNotchFilterFrequency(INT32 hDevice,UINT32 Channel,UINT32 NotchFilterIndex,INT32 Frequency);

Address retrieval

G33DDC_SET_NOTCH_FILTER_FREQUENCY SetNotchFilterFrequency=

        (G33DDC_SET_NOTCH_FILTER_FREQUENCY)GetProcAddress(hAPI,"SetNotchFilterFrequency");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
NotchFilterIndex
[in] Specifies notch filter index. Possible values are: 0, 1.
Frequency
[in] Specifies new center frequency of the notch filter in Hz.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Value of the Frequency parameter is new center frequency of the notch filter relative to center of the DDC2 (see the SetDDC2Frequency function). The value can be negative.

Use the GetNotchFilterFrequency function to retrieve current center frequency of the notch filter.


GetNotchFilterFrequency

Retrieves current relative center frequency of the notch filter.

C/C++ declaration

BOOL __stdcall GetNotchFilterFrequency(INT32 hDevice,UINT32 Channel,UINT32 NotchFilterIndex,INT32 *Frequency);

Address retrieval

G33DDC_GET_NOTCH_FILTER_FREQUENCY GetNotchFilterFrequency=

        (G33DDC_GET_NOTCH_FILTER_FREQUENCY)GetProcAddress(hAPI,"GetNotchFilterFrequency");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
NotchFilterIndex
[in] Specifies notch filter index. Possible values are: 0, 1.
Frequency
[out] Pointer to a variable that receives current center frequency of the notch filter. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetNotchFilterBandwidth

Specifies bandwidth of the notch filter for given channel.

C/C++ declaration

BOOL __stdcall SetNotchFilterBandwidth(INT32 hDevice,UINT32 Channel,UINT32 NotchFilterIndex,UINT32 Bandwidth);

Address retrieval

G33DDC_SET_NOTCH_FILTER_BANDWIDTH SetNotchFilterBandwidth=

        (G33DDC_SET_NOTCH_FILTER_BANDWIDTH)GetProcAddress(hAPI,"SetNotchFilterBandwidth");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
NotchFilterIndex
[in] Specifies notch filter index. Possible values are: 0, 1.
Bandwidth
[in] Specifies new bandwidth of the notch filter in Hz. The bandwidth can be from range 1 - 3000 Hz.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetNotchFilterBandwidth function to retrieve current bandwidth of the notch filter.


GetNotchFilterBandwidth

Retrieves current bandwidth of the notch filter for given channel.

C/C++ declaration

BOOL __stdcall GetNotchFilterBandwidth(INT32 hDevice,UINT32 Channel,UINT32 NotchFilterIndex,UINT32 *Bandwidth);

Address retrieval

G33DDC_GET_NOTCH_FILTER_BANDWIDTH GetNotchFilterBandwidth=

        (G33DDC_GET_NOTCH_FILTER_BANDWIDTH)GetProcAddress(hAPI,"GetNotchFilterBandwidth");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
NotchFilterIndex
[in] Specifies notch filter index. Possible values are: 0, 1.
Bandwidth
[out] Pointer to a variable that receives current bandwidth of the notch filter. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetNotchFilterLength

Specifies notch filter length for given channel. The notch filter is implemented as FIR filter. This function specifies number of coefficients used in filtration procedure.

C/C++ declaration

BOOL __stdcall SetNotchFilterLength(INT32 hDevice,UINT32 Channel,UINT32 NotchFilterIndex,UINT32 Length);

Address retrieval

G33DDC_SET_NOTCH_FILTER_LENGTH SetNotchFilterLength=

        (G33DDC_SET_NOTCH_FILTER_LENGTH)GetProcAddress(hAPI,"SetNotchFilterLength");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
NotchFilterIndex
[in] Specifies notch filter index. Possible values are: 0, 1.
Length
[in] Specifies length of the notch filter. The value has to be multiple of 64, greater than or equal to 64 and less than or equal to 32768. If it is not multiple of 64 the function rounds it up to nearest multiple of 64.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Increasing the filter length increases filter steepness and it may increase CPU usage.

Use the GetNotchFilterLength function to determine current length of the notch filter.


GetNotchFilterLength

Retrieves current notch filter length for given channel.

C/C++ declaration

BOOL __stdcall GetNotchFilterLength(INT32 hDevice,UINT32 Channel,UINT32 NotchFilterIndex,UINT32 *Length);

Address retrieval

G33DDC_GET_NOTCH_FILTER_LENGTH GetNotchFilterLength=

        (G33DDC_GET_NOTCH_FILTER_LENGTH)GetProcAddress(hAPI,"GetNotchFilterLength");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
NotchFilterIndex
[in] Specifies notch filter index. Possible values are: 0, 1.
Length
[out] Pointer to a variable that receives current length of the notch filter. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetAGC

Enables or disables AGC for given channel.

C/C++ declaration

BOOL __stdcall SetAGC(INT32 hDevice,UINT32 Channel,BOOL Enabled);

Address retrieval

G33DDC_SET_AGC SetAGC=(G33DDC_SET_AGC)GetProcAddress(hAPI,"SetAGC");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Enabled
[in] Specifies whether to enable or disable AGC. If this parameter is non-zero, the AGC is enabled. If the parameter is zero, the AGC is disabled.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If the AGC is disabled, the signal is affected by fixed gain specified using the SetGain function.

Use the GetAGC function to determine current state of the AGC.


GetAGC

Retrieves current state of the AGC for given channel.

C/C++ declaration

BOOL __stdcall GetAGC(INT32 hDevice,UINT32 Channel,BOOL *Enabled);

Address retrieval

G33DDC_GET_AGC GetAGC=(G33DDC_GET_AGC)GetProcAddress(hAPI,"GetAGC");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Enabled
[out] Pointer to a variable that receives current state of the AGC. The value is non-zero if the AGC is enabled and zero if it is disabled. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetAGCParams

Sets parameters of the AGC for given channel.

C/C++ declaration

BOOL __stdcall SetAGCParams(INT32 hDevice,UINT32 Channel,double AttackTime,double DecayTime,double ReferenceLevel);

Address retrieval

G33DDC_SET_AGC_PARAMS SetAGCParams=(G33DDC_SET_AGC_PARAMS)GetProcAddress(hAPI,"SetAGCParams");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
AttackTime
[in] Specifies new attack time of the AGC in seconds.
DecayTime
[in] Specifies new decay time of the AGC in seconds.
ReferenceLevel
[in] Specifies new reference level of the AGC in dB.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetAGCParams function to determine current parameters of the AGC.


GetAGCParams

Retrieves current parameters of the AGC for given channel.

C/C++ declaration

BOOL __stdcall GetAGCParams(INT32 hDevice,UINT32 Channel,double *AttackTime,double *DecayTime,double *ReferenceLevel);

Address retrieval

G33DDC_GET_AGC_PARAMS GetAGCParams=(G33DDC_GET_AGC_PARAMS)GetProcAddress(hAPI,"GetAGCParams");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
AttackTime
[out] Pointer to a variable that receives current attack time of the AGC in seconds. This parameter can be NULL if the application does not require this information.
DecayTime
[out] Pointer to a variable that receives current decay time of the AGC in seconds. This parameter can be NULL if the application does not require this information.
ReferenceLevel
[out] Pointer to a variable that receives current reference level of the AGC in dB. This parameter can be NULL if the application does not require this information.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetMaxAGCGain

Sets maximum gain of the AGC for given channel.

C/C++ declaration

BOOL __stdcall SetMaxAGCGain(INT32 hDevice,UINT32 Channel,double MaxGain);

Address retrieval

G33DDC_SET_MAX_AGC_GAIN SetMaxAGCGain=(G33DDC_SET_MAX_AGC_GAIN)GetProcAddress(hAPI,"SetMaxAGCGain");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
MaxGain
[in] Specifies new maximum gain of the AGC in dB.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetMaxAGCGain function to determine maximum gain of the AGC.


GetMaxAGCGain

Retrieves current maximum gain of the AGC for given channel.

C/C++ declaration

BOOL __stdcall GetMaxAGCGain(INT32 hDevice,UINT32 Channel,double *MaxGain);

Address retrieval

G33DDC_GET_MAX_AGC_GAIN GetMaxAGCGain=(G33DDC_GET_MAX_AGC_GAIN)GetProcAddress(hAPI,"GetMaxAGCGain");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
MaxGain
[out] Pointer to a variable that receives current maximum gain of the AGC in dB. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetGain

Sets fixed gain for given channel. This gain is applied to I/Q signal if the AGC is disabled, otherwise it is not used.

C/C++ declaration

BOOL __stdcall SetGain(INT32 hDevice,UINT32 Channel,double Gain);

Address retrieval

G33DDC_SET_GAIN SetGain=(G33DDC_SET_GAIN)GetProcAddress(hAPI,"SetGain");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Gain
[in] Specifies new fixed gain in dB.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetGain function to determine current fixed gain.


GetGain

Retrieves current fixed gain for given channel.

C/C++ declaration

BOOL __stdcall GetGain(INT32 hDevice,UINT32 Channel,double *Gain);

Address retrieval

G33DDC_GET_GAIN GetGain=(G33DDC_GET_GAIN)GetProcAddress(hAPI,"GetGain");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Gain
[out] Pointer to a variable that receives current fixed gain in dB. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

GetCurrentGain

Retrieves current gain that is applied to I/Q signal.

C/C++ declaration

BOOL __stdcall GetCurrentGain(INT32 hDevice,UINT32 Channel,double *CurrentGain);

Address retrieval

G33DDC_GET_CURRENT_GAIN GetCurrentGain=(G33DDC_GET_CURRENT_GAIN)GetProcAddress(hAPI,"GetCurrentGain");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
CurrentGain
[out] Pointer to a variable that receives current gain in dB. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If the AGC is enabled (using the SetAGC function), the variable pointed to by the CurrentGain parameter is filled by current gain of the AGC. If the AGC is disabled, the variable pointed to by the CurrentGain parameter is filled by fixed gain that is specified using the SetGain function.

SetDemodulatorFilterBandwidth

Sets bandwidth of the demodulator filter for given channel.

C/C++ declaration

BOOL __stdcall SetDemodulatorFilterBandwidth(INT32 hDevice,UINT32 Channel,UINT32 Bandwidth);

Address retrieval

G33DDC_SET_DEMODULATOR_FILTER_BANDWIDTH SetDemodulatorFilterBandwidth=

    (G33DDC_SET_DEMODULATOR_FILTER_BANDWIDTH)GetProcAddress(hAPI,"SetDemodulatorFilterBandwidth");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Bandwidth
[in] Specified new bandwidth of the demodulator filter in Hz. Possible values are from range 1 Hz to current DDC2 bandwidth. Use the GetDDC2 function to retrieve information about current DDC type of DDC2.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The demodulator filter bandwidth can be changed using the SetDDC1 function. It can change DDC type of DDC2 and if the current demodulator filter bandwidth is greater than new bandwidth of DDC2, the demodulator filter bandwidth is reduced. So it is useful to call the GetDemodulatorFilterBandwidth function immediately after SetDDC1.

GetDemodulatorFilterBandwidth

Retrieves current demodulator filter bandwidth for given channel.

C/C++ declaration

BOOL __stdcall GetDemodulatorFilterBandwidth(INT32 hDevice,UINT32 Channel,UINT32 *Bandwidth);

Address retrieval

G33DDC_GET_DEMODULATOR_FILTER_BANDWIDTH GetDemodulatorFilterBandwidth=

    (G33DDC_GET_DEMODULATOR_FILTER_BANDWIDTH)GetProcAddress(hAPI,"GetDemodulatorFilterBandwidth");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Bandwidth
[out] Pointer to a variable that receives current demodulator filter bandwidth. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetDemodulatorFilterShift

Sets demodulator filter shift for given channel.

C/C++ declaration

BOOL __stdcall SetDemodulatorFilterShift(INT32 hDevice,UINT32 Channel,INT32 Shift);

Address retrieval

G33DDC_SET_DEMODULATOR_FILTER_SHIFT SetDemodulatorFilterShift=

    (G33DDC_SET_DEMODULATOR_FILTER_SHIFT)GetProcAddress(hAPI,"SetDemodulatorFilterShift");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Shift
[in] Specified new shift of the demodulator filter in Hz.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Value of the Shift parameter is shift in Hz relative to center of the demodulator. This value can be negative.

This function does not change demodulator frequency just shift the filter from demodulator's centre.

Use the GetDemodulatorFilterShift function to determine current demodulator filter shift.


GetDemodulatorFilterShift

Retrieves current shift of the demodulator filter for given channel.

C/C++ declaration

BOOL __stdcall GetDemodulatorFilterShift(INT32 hDevice,UINT32 Channel,INT32 *Shift);

Address retrieval

G33DDC_GET_DEMODULATOR_FILTER_SHIFT GetDemodulatorFilterShift=

    (G33DDC_GET_DEMODULATOR_FILTER_SHIFT)GetProcAddress(hAPI,"GetDemodulatorFilterShift");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Shift
[out] Pointer to a variable that receives current shift of the demodulator. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetDemodulatorFilterLength

Specifies demodulator filter length for given channel. The demodulator filter is implemented as FIR filter. This function specifies number of coefficients used in filtration procedure..

C/C++ declaration

BOOL __stdcall SetDemodulatorFilterLength(INT32 hDevice,UINT32 Channel,UINT32 Length);

Address retrieval

G33DDC_SET_DEMODULATOR_FILTER_LENGTH SetDemodulatorFilterLength=

    (G33DDC_SET_DEMODULATOR_FILTER_LENGTH)GetProcAddress(hAPI,"SetDemodulatorFilterLength");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Length
[in] Specifies length of the demodulator filter. The value has to be multiple of 64, greater than or equal to 64 and less than or equal to 32768. If it is not multiple of 64 the function rounds it up to nearest multiple of 64..

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Increasing the filter length increases filter steepness and it may increase CPU usage.

Use the GetDemodulatorFilterLength function to determine current length of the demodulator filter.


GetDemodulatorFilterLength

Retrieves current length of the demodulator filter for given channel.

C/C++ declaration

BOOL __stdcall GetDemodulatorFilterLength(INT32 hDevice,UINT32 Channel,UINT32 *Length);

Address retrieval

G33DDC_GET_DEMODULATOR_FILTER_LENGTH GetDemodulatorFilterLength=

    (G33DDC_GET_DEMODULATOR_FILTER_LENGTH)GetProcAddress(hAPI,"GetDemodulatorFilterLength");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Length
[out] Pointer to a variable that receives current demodulator filter length. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetDemodulatorMode

Sets demodulator mode for given channel.

C/C++ declaration

BOOL __stdcall SetDemodulatorMode(INT32 hDevice,UINT32 Channel,UINT32 Mode);

Address retrieval

G33DDC_SET_DEMODULATOR_MODE SetDemodulatorMode=(G33DDC_SET_DEMODULATOR_MODE)GetProcAddress(hAPI,"SetDemodulatorMode");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Mode
[in] Specifies new demodulator mode. This value can be one of the following:

ValueMeaning
G3XDDC_MODE_CWContinuous wave
G3XDDC_MODE_AMAmplitude modulation
G3XDDC_MODE_FMFrequency modulation
G3XDDC_MODE_LSBLower sideband modulation
G3XDDC_MODE_USBUpper sideband modulation
G3XDDC_MODE_AMSAmplitude modulation
G3XDDC_MODE_DSBDouble sideband modulation
G3XDDC_MODE_ISBIndependent sideband modulation
G3XDDC_MODE_DRMDigital Radio Mondiale

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

DRM demodulation is only available if valid DRM key is loaded using the SetDRMKey function. More information about obtaining DRM key at http://www.winradio.com/home/drm.htm.

Use the GetDemodulatorMode function to retrieve current demodulator mode.


GetDemodulatorMode

Retrieves current demodulator mode for given channel.

C/C++ declaration

BOOL __stdcall GetDemodulatorMode(INT32 hDevice,UINT32 Channel,UINT32 *Mode);

Address retrieval

G33DDC_GET_DEMODULATOR_MODE GetDemodulatorMode=(G33DDC_GET_DEMODULATOR_MODE)GetProcAddress(hAPI,"GetDemodulatorMode");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Mode
[out] Pointer to a variable that receives current demodulator mode. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetDemodulatorFrequency

Sets relative center frequency of demodulator for given channel.

C/C++ declaration

BOOL __stdcall SetDemodulatorFrequency(INT32 hDevice,UINT32 Channel,INT32 Frequency);

Address retrieval

G33DDC_SET_DEMODULATOR_FREQUENCY SetDemodulatorFrequency=

    (G33DDC_SET_DEMODULATOR_FREQUENCY)GetProcAddress(hAPI,"SetDemodulatorFrequency");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Frequency
[in] Specified new center frequency of the demodulator in Hz.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Value of the Frequency parameter is center frequency of the demodulator relative to center of the DDC2. The value can be negative.

Absolute frequency of the demodulator is given by the following formula:

faDEM[i] = fDDC1 + frDDC2[i] + frDEM[i]

Where faDEM[i] is absolute center frequency of the demodulator of i-th channel in Hz, fDDC1 is center frequency of the DDC1 in Hz (set using the SetDDC1Frequency function), frDDC2[i] is relative center frequency of DDC2 of i-th channel in Hz (set using the SetDDC2Frequency) and frDEM[i] is relative center frequency of the demodulator of i-th channel in Hz (set using SetDemodulatorFrequency).

Absolute center frequency of the demodulator is the real-world frequency that you are listening to.

Use the GetDemodulatorFrequency function to determine current relative center frequency of the demodulator for given channel.

The following example shows four methods how it is possible to set absolute demodulator center frequency of channel 0 to 11.01 MHz:


INT32 hDevice; //Handle to G33DDC device returned by the OpenDevice function



//1. method

SetDDC1Frequency(hDevice,11010000);

SetDDC2Frequency(hDevice,0,0);

SetDemodulatorFrequency(hDevice,0,0);



//2. method

SetDDC1Frequency(hDevice,11000000);

SetDDC2Frequency(hDevice,0,10000);

SetDemodulatorFrequency(hDevice,0,0);



//3. method

SetDDC1Frequency(hDevice,11020000);

SetDDC2Frequency(hDevice,0,-5000);

SetDemodulatorFrequency(hDevice,0,-5000);



//4. method

SetFrequency(hDevice,0,11010000); 

//The SetFrequency function sets DDC1, DDC2 and demodulator

//center frequencies so that demodulator's absolute frequency is set to the required frequency


GetDemodulatorFrequency

Retrieves current relative center frequency of the demodulator for given channel.

C/C++ declaration

BOOL __stdcall GetDemodulatorFrequency(INT32 hDevice,UINT32 Channel,INT32 *Frequency);

Address retrieval

G33DDC_GET_DEMODULATOR_FREQUENCY GetDemodulatorFrequency=

    (G33DDC_GET_DEMODULATOR_FREQUENCY)GetProcAddress(hAPI,"GetDemodulatorFrequency");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Frequency
[out] Pointer to a variable that receives current center frequency of the demodulator. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetDemodulatorParam

Sets a parameter of the demodulation for given channel.

C/C++ declaration

BOOL __stdcall SetDemodulatorParam(INT32 hDevice,UINT32 Channel,UINT32 Code,CONST VOID *Buffer,UINT32 BufferSize);

Address retrieval

G33DDC_SET_DEMODULATOR_PARAM SetDemodulatorParam=

    (G33DDC_SET_DEMODULATOR_PARAM)GetProcAddress(hAPI,"SetDemodulatorParam");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Code
[in] Specifies code of the demodulator parameter to be set by the function. The code can be one of the following:

ValueMeaning
G3XDDC_DEMODULATOR_PARAM_AMS_SIDE_BAND

Side band for synchronous AM demodulation.

The Buffer parameter has to be pointer to an UINT32 variable, and the BufferSize parameter has to be sizeof(UINT32).

Value of the variable pointed to by the Buffer parameter can be one of the following:

G3XDDC_SIDE_BAND_LOWER
AMS demodulator will use lower sideband

G3XDDC_SIDE_BAND_UPPER
AMS demodulator will use upper sideband

G3XDDC_SIDE_BAND_BOTH
AMS demodulator will use both side bands.

G3XDDC_DEMODULATOR_PARAM_AMS_CAPTURE_RANGE

Capture range of synchronous AM demodulator.

The Buffer parameter has to be pointer to a G3XDDC_AMS_CAPTURE_RANGE structure, and the BufferSize parameter has to be sizeof(G3XDDC_AMS_CAPTURE_RANGE).

G3XDDC_DEMODULATOR_PARAM_CW_FREQUENCY

CW tone frequency

The Buffer parameter has to be pointer to a INT32 variable, and the BufferSize parameter has to be sizeof(INT32).

Value of the variable pointed to by the Buffer parameter is CW tone frequency in Hz.

G3XDDC_DEMODULATOR_PARAM_DSB_SIDE_BAND

Side band for DSB demodulation.

The Buffer parameter has to be pointer to an UINT32 variable, and the BufferSize parameter has to be sizeof(UINT32).

Value of the variable pointed to by the Buffer parameter can be one of the following:

G3XDDC_SIDE_BAND_LOWER
DSB demodulator will use lower sideband

G3XDDC_SIDE_BAND_UPPER
DSB demodulator will use upper sideband

G3XDDC_SIDE_BAND_BOTH
DSB demodulator will use both side bands.

G3XDDC_DEMODULATOR_PARAM_ISB_SIDE_BAND

Side band for ISB demodulation.

The Buffer parameter has to be pointer to an UINT32 variable, and the BufferSize parameter has to be sizeof(UINT32).

Value of the variable pointed to by the Buffer parameter can be one of the following:

G3XDDC_SIDE_BAND_LOWER
ISB demodulator will use lower sideband

G3XDDC_SIDE_BAND_UPPER
ISB demodulator will use upper sideband

G3XDDC_SIDE_BAND_BOTH
ISB demodulator will use both side bands.

G3XDDC_DEMODULATOR_PARAM_DRM_AUDIO_SERVICE

Audio service of DRM demodulator/decoder to be listening to.

The Buffer parameter has to be pointer to an UINT32 variable, and the BufferSize parameter has to be sizeof(UINT32).

Value of the variable pointed to by the Buffer parameter is index of the audio service. Possible value are: 1, 2, 3, 4, where 1 is the first audio service, 2 is the second one, etc. Use the GetDemodulatorState function with G3XDDC_DEMODULATOR_STATE_DRM_STATUS to retrieve information about available audio services for currently received DRM station.

G3XDDC_DEMODULATOR_PARAM_DRM_MULTIMEDIA_SERVICE

Multimedia service of DRM demodulator/decoder to be decoded.

The Buffer parameter has to be pointer to an UINT32 variable, and the BufferSize parameter has to be sizeof(UINT32).

Value of the variable pointed to by the Buffer parameter is index of the multimedia service. Possible value are: 1, 2, 3, 4, where 1 is the first audio service, 2 is the second one, etc. Use the GetDemodulatorState function with G3XDDC_DEMODULATOR_STATE_DRM_STATUS to retrieve information about available multimedia services for currently received DRM station.

It is required that DRM multimedia player has to be installed to display multimedia content. It is included in G33DDC software installer as optional.

Buffer
[in] Pointer to a buffer containing value of the demodulator parameter the function will set. This parameter cannot be NULL.
BufferSize
[in] Specifies the size of the buffer.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

GetDemodulatorParam

Retrieves a parameter of the demodulation for given channel.

C/C++ declaration

BOOL __stdcall GetDemodulatorParam(INT32 hDevice,UINT32 Channel,UINT32 Code,VOID *Buffer,UINT32 BufferSize);

Address retrieval

G33DDC_GET_DEMODULATOR_PARAM GetDemodulatorParam=

    (G33DDC_GET_DEMODULATOR_PARAM)GetProcAddress(hAPI,"GetDemodulatorParam");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Code
[in] Specifies code of the demodulator parameter to be retrieved. For detailed information about available codes see SetDemodulatorParam.
Buffer
[out] Pointer to a buffer that receives requested parameter. This parameter cannot be NULL.
BufferSize
[in] Specifies the size of the buffer.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

GetDemodulatorState

Retrieves information about current demodulator state for given channel.

C/C++ declaration

BOOL __stdcall GetDemodulatorState(INT32 hDevice,UINT32 Channel,UINT32 Code,VOID *Buffer,UINT32 BufferSize);

Address retrieval

G33DDC_GET_DEMODULATOR_STATE GetDemodulatorState=

    (G33DDC_GET_DEMODULATOR_STATE)GetProcAddress(hAPI,"GetDemodulatorState");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Code
[in] Specifies code of the demodulator state to be retrieved. It can be one of the following:

ValueMeaning
G3XDDC_DEMODULATOR_STATE_AMS_LOCK

Lock state of synchronous AM demodulation.

The Buffer parameter has to be pointer to a BOOL variable, and the BufferSize parameter has to be sizeof(BOOL).

Received value is non-zero if synchronous AM demodulator is locked to signal, and zero if it is not locked.

G3XDDC_DEMODULATOR_STATE_AMS_FREQUENCY

Frequency in Hz which synchronous AM demodulator is locked to. It is relative to center of the demodulator. It can be negative.

The Buffer parameter has to be pointer to a double variable, and the BufferSize parameter has to be sizeof(double).

G3XDDC_DEMODULATOR_STATE_AM_DEPTH

Depth of AM modulation in %.

The Buffer parameter has to be pointer to a double variable, and the BufferSize parameter has to be sizeof(double).

G3XDDC_DEMODULATOR_STATE_DSB_LOCK

Lock state of DSB demodulation.

The Buffer parameter has to be pointer to a BOOL variable, and the BufferSize parameter has to be sizeof(BOOL).

Received value is non-zero if DSB demodulator is locked to signal, and zero if it is not locked.

G3XDDC_DEMODULATOR_STATE_DSB_FREQUENCY

Frequency in Hz which DSB demodulator is locked to. It is relative to center of the demodulator. It can be negative.

The Buffer parameter has to be pointer to a double variable, and the BufferSize parameter has to be sizeof(double).

G3XDDC_DEMODULATOR_STATE_TUNE_ERROR

Estimated tune error in Hz.

The Buffer parameter has to be pointer to an INT32 variable, and the BufferSize parameter has to be sizeof(INT32).

Received value is difference between demodulator frequency and frequency of received signal. Subtract the returned tune error from demodulator frequency to get frequency of the received signal. Tune error is relative to center of the demodulator and it can be negative.

G3XDDC_DEMODULATOR_STATE_DRM_STATUS

Status of DRM demodulator/decoder.

The Buffer parameter has to be pointer to a G3XDDC_DRM_STATUS structure, and the BufferSize parameter has to be sizeof(G3XDDC_DRM_STATUS).

G3XDDC_DEMODULATOR_STATE_FM_DEVIATION

Estimated frequency deviation in Hz.

The Buffer parameter has to be pointer to an UINT32 variable, and the BufferSize parameter has to be sizeof(UINT32).

Buffer
[out] Pointer to a buffer that receives requested information. This parameter cannot be NULL.
BufferSize
[in] Specifies the size of the buffer.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

StartAudio

Starts audio streaming for given channel.

C/C++ declaration

BOOL __stdcall StartAudio(INT32 hDevice,UINT32 Channel,UINT32 SamplesPerBuffer);

Address retrieval

G33DDC_START_AUDIO StartAudio=(G33DDC_START_AUDIO)GetProcAddress(hAPI,"StartAudio");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
SamplesPerBuffer
[in] Specifies number of samples in each buffer passed to the the AudioStreamCallback callback function. The value has to be multiple of 64 greater than zero. If it is zero, the StartAudio function fails. If it is not multiple of 64 the function rounds it up to nearest multiple of 64.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Before StartAudio is used, the G33DDC device has to be turned on using the SetPower function and DDC1 streaming has to be started using the StartDDC1 or StartDDC1Playback function and DDC2 streaming has to be started using the StartDDC2 function, otherwise StartAudio fails.

If the audio streaming for given channel is already running, StartAudio restarts it except the streaming was previously started with the same SamplesPerBuffer parameter. In this case StartAudio does nothing.

Use the StopAudio function to stop audio streaming.

Decreasing value of the SamplesPerBuffer parameter decreases latency and it may increase CPU usage. Increasing value of the SamplesPerBuffer parameter increased latency and it may decrease CPU usage.


StopAudio

Stops audio streaming for given channel.

C/C++ declaration

BOOL __stdcall StopAudio(INT32 hDevice,UINT32 Channel);

Address retrieval

G33DDC_STOP_AUDIO StopAudio=(G33DDC_STOP_AUDIO)GetProcAddress(hAPI,"StopAudio");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If audio streaming is not active, StopAudio does nothing.

If audio playback (started using the StartAudioPlayback function) is active, StopAudio stops it.

The AudioStreamCallback and AudioPlaybackStreamCallback callback functions are not called after StopAudio returns.


StartAudioPlayback

Starts audio playback for given channel. It allows to pass previously recorded audio samples to the processing chain instead of the samples from the demodulator.

C/C++ declaration

BOOL __stdcall StartAudioPlayback(INT32 hDevice,UINT32 Channel,UINT32 SamplesPerBuffer);

Address retrieval

G33DDC_START_AUDIO_PLAYBACK StartAudioPlayback=(G33DDC_START_AUDIO_PLAYBACK)GetProcAddress(hAPI,"StartAudioPlayback");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
SamplesPerBuffer
[in] Specifies number of samples in each buffer passed to the AudioPlaybackStreamCallback callback to fill the buffer by the application and to the AudioStreamCallback callback function. The value has to be multiple of 64 greater than zero. If it is zero, the StartAudioPlayback function fails. If it is not multiple of 64 the function rounds it up to nearest multiple of 64.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The G33DDC device has to be turned on using SetPower function before use of StartAudioPlayback.

The StartAudioPlayback function stops audio streaming that was previously started by the StartAudio or StartAudioPlayback function and starts audio playback with new parameters.

Use the StopAudio function to stop audio playback.


PauseAudioPlayback

Pauses audio playback for given channel.

C/C++ declaration

BOOL __stdcall PauseAudioPlayback(INT32 hDevice,UINT23 Channel);

Address retrieval

G33DDC_PAUSE_AUDIO_PLAYBACK PauseAudioPlayback=(G33DDC_PAUSE_AUDIO_PLAYBACK)GetProcAddress(hAPI,"PauseAudioPlayback");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If audio playback is not active or it is already paused, PauseAudioPlayback does nothing.

The AudioPlaybackStreamCallback and AudioStreamCallback callback functions can be called once after PauseAudioPlayback returns. Then they are not called until playback is resumed using the ResumeAudioPlayback function.


ResumeAudioPlayback

Resumes paused audio playback for given channel.

C/C++ declaration

BOOL __stdcall ResumeAudioPlayback(INT32 hDevice,UINT32 Channel);

Address retrieval

G33DDC_RESUME_AUDIO_PLAYBACK ResumeAudioPlayback=(G33DDC_RESUME_AUDIO_PLAYBACK)GetProcAddress(hAPI,"ResumeAudioPlayback");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If audio playback is not active or it is not paused, ResumeAudioPlayback does nothing.


SetAudioGain

Sets fixed audio gain for given channel.

C/C++ declaration

BOOL __stdcall SetAudioGain(INT32 hDevice,UINT32 Channel,double Gain);

Address retrieval

G33DDC_SET_AUDIO_GAIN SetAudioGain=(G33DDC_SET_AUDIO_GAIN)GetProcAddress(hAPI,"SetAudioGain");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Gain
[in] Specifies new fixed audio gain in dB.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetAudioGain function to retrieve current audio gain.

GetAudioGain

Retrieves current fixed audio gain for given channel.

C/C++ declaration

BOOL __stdcall GetAudioGain(INT32 hDevice,UINT32 Channel,double *Gain);

Address retrieval

G33DDC_GET_AUDIO_GAIN GetAudioGain=(G33DDC_GET_AUDIO_GAIN)GetProcAddress(hAPI,"GetAudioGain");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Gain
[out] Pointer to a variable that receives current fixed gain in dB. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetAudioFilter

Enabled or disables audio filter for given channel.

C/C++ declaration

BOOL __stdcall SetAudioFilter(INT32 hDevice,UINT32 Channel,BOOL Enabled);

Address retrieval

G33DDC_SET_AUDIO_FILTER SetAudioFilter=(G33DDC_SET_AUDIO_FILTER)GetProcAddress(hAPI,"SetAudioFilter");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Enabled
[in] Specifies whether to enable or disable audio filter. If this parameter is non-zero, the filter is enabled. If the parameter is zero, the filter is disabled.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetAudioFiler function to retrieve current state of the audio filter.

GetAudioFilter

Retrieves current state of the audio filter for given channel.

C/C++ declaration

BOOL __stdcall GetAudioFilter(INT32 hDevice,UINT32 Channel,BOOL *Enabled);

Address retrieval

G33DDC_GET_AUDIO_FILTER GetAudioFilter=(G33DDC_GET_AUDIO_FILTER)GetProcAddress(hAPI,"GetAudioFilter");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Enabled
[out] Pointer to a variable that receives current state of the audio filter. The value is non-zero if the filter is enabled and zero if it is disabled. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetAudioFilterParams

Sets parameters of the audio filter for given channel.

C/C++ declaration

BOOL __stdcall SetAudioFilterParams(INT32 hDevice,UINT32 Channel,UINT32 CutOffLow,UINT32 CutOffHigh,double Deemphasis);

Address retrieval

G33DDC_SET_AUDIO_FILTER_PARAMS SetAudioFilterParams=

    (G33DDC_SET_AUDIO_FILTER_PARAMS)GetProcAddress(hAPI,"SetAudioFilterParams");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
CutOffLow
[in] Specifies cut-off low frequency of the filter in Hz. This is the start frequency of filter's passband, it can be from range 0 to 23999 Hz. The value has to be less then the cut-off high frequency specified by the CutOffHigh parameter.
CutOffHigh
[in] Specifies cut-off high frequency of the filter in Hz. This is the end frequency of filter's passband it can be from range 1 - 24000 Hz. The value has to be greater than the cut-off low frequency specified by the CutOffLow parameter.
Deemphasis
[in] Specifies de-emphasis the filter in dB per octave. De-emphasis starts at cut-off low frequency of the filter. This value can be from range -9.9 to 0.0 dB/octave. Zero means the de-emphasis is disabled.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Use the GetAudioFilerParams function to retrieve current parameters of the audio filter.

GetAudioFilterParams

Retrieves current parameters of the audio filter for given channel.

C/C++ declaration

BOOL __stdcall GetAudioFilterParams(INT32 hDevice,UINT32 Channel,UINT32 *CutOffLow,UINT32 *CutOffHigh,double *Deemphasis);

Address retrieval

G33DDC_GET_AUDIO_FILTER_PARAMS GetAudioFilterParams=

    (G33DDC_GET_AUDIO_FILTER_PARAMS)GetProcAddress(hAPI,"GetAudioFilterParams");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
CutOffLow
[out] Pointer to a variable that receives current cut-off low frequency of the filter. This parameter can be NULL if the application does not require this information.
CutOffHigh
[out] Pointer to a variable that receives current cut-off high frequency of the filter. This parameter can be NULL if the application does not require this information.
Deemphasis
[out] Pointer to a variable that receives current de-emphasis setting of the filter. This parameter can be NULL if the application does not require this information.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetAudioFilterLength

Specifies audio filter length for given channel. The audio filter is implemented as FIR filter. This function specifies number of coefficients used in filtration procedure.

C/C++ declaration

BOOL __stdcall SetAudioFilterLength(INT32 hDevice,UINT32 Channel,UINT32 Length);

Address retrieval

G33DDC_SET_AUDIO_FILTER_LENGTH SetAudioFilterLength=

        (G33DDC_SET_AUDIO_FILTER_LENGTH)GetProcAddress(hAPI,"SetAudioFilterLength");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Length
[in] Specifies length of the audio filter. The value has to be multiple of 64, greater than or equal to 64 and less than or equal to 32768. If it is not multiple of 64 the function rounds it up to nearest multiple of 64.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Increasing the filter length increases filter steepness and it may increase CPU usage.

Use the GetAudioFilterLength function to determine current length of the audio filter.


GetAudioFilterLength

Retrieves current audio filter length for given channel.

C/C++ declaration

BOOL __stdcall GetAudioFilterLength(INT32 hDevice,UINT32 Channel,UINT32 *Length);

Address retrieval

G33DDC_GET_AUDIO_FILTER_LENGTH GetAudioFilterLength=

        (G33DDC_GET_AUDIO_FILTER_LENGTH)GetProcAddress(hAPI,"GetAudioFilterLength");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Length
[out] Pointer to a variable that receives current length of the audio filter. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

SetFrequency

Sets absolute frequency of the demodulator for given channel.

C/C++ declaration

BOOL __stdcall SetFrequency(INT32 hDevice,UINT32 Channel,UINT32 Frequency);

Address retrieval

G33DDC_SET_FREQUENCY SetFrequency=(G33DDC_SET_FREQUENCY)GetProcAddress(hAPI,"SetFrequency");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Frequency
[in] Specifies new absolute frequency of the demodulator in Hz.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The function sets DDC1, DDC2 and demodulator frequencies so that new absolute frequency of the demodulator is the required one.

Absolute frequency of the demodulator is given by the following formula:

faDEM[i] = fDDC1 + frDDC2[i] + frDEM[i]

Where faDEM[i] is absolute center frequency of the demodulator of i-th channel in Hz, fDDC1 is center frequency of the DDC1 in Hz (set using the SetDDC1Frequency function), frDDC2[i] is relative center frequency of DDC2 of i-th channel in Hz (set using the SetDDC2Frequency) and frDEM[i] is relative center frequency of the demodulator of i-th channel in Hz (set using the SetDemodulatorFrequency function).

Absolute center frequency of the demodulator is the real-world frequency that you are listening to.

Use the GetFrequency function to retrieve current absolute frequency of the demodulator.


GetFrequency

Determines absolute frequency of the demodulator for given channel.

C/C++ declaration

BOOL __stdcall GetFrequency(INT32 hDevice,UINT32 Channel,UINT32 *Frequency);

Address retrieval

G33DDC_GET_FREQUENCY GetFrequency=(G33DDC_GET_FREQUENCY)GetProcAddress(hAPI,"GetFrequency");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Channel
[in] Specifies channel index. Possible values are: 0, 1, 2.
Frequency
[out] Pointer to a variable that receives current absolute frequency of the demodulator. This parameter cannot be NULL.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Returned value of the variable pointed to by the Frequency parameter is sum of DDC1, DDC2 and demodulator relative frequency. For more information, see remarks of the SetFrequency function.

GetSpectrumCompensation

Determines compensation data for frequency spectrum computed from DDC1 or DDC2 signal. It is used to convert relative amplitudes in dB to absolutes ones in dBm.

C/C++ declaration

BOOL __stdcall GetSpectrumCompensation(INT32 hDevice,UINT64 CenterFrequency,UINT32 Width,FLOAT *Buffer,UINT32 Count);

Address retrieval

G33DDC_GET_SPECTRUM_COMPENSATION GetSpectrumCompensation=

    (G33DDC_GET_SPECTRUM_COMPENSATION)GetProcAddress(hAPI,"GetSpectrumCompensation");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
CenterFrequency
[in] Specifies absolute center frequency of requested compensation data in Hz.
Width
[in] Specifies width of requested compensation data in Hz.
Buffer
[out] Pointer to a buffer to be filled with compensation data. This parameter cannot be NULL.
Count
[in] Specifies number of FLOAT items in the buffer pointed to by the Buffer parameter.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The following example shows how to use the GetSpectrumCompensation function in DDC2StreamCallback callback function:




//Let the following is prototype of a function which computes FFT from I/Q signal stored in

//the buffer pointed to be the Input parameter. Result is stored in complex form in the buffer

//pointed to by the Output parameter. Size of the FFT is given be the Size parameter.

//The example uses 2048 bins FFT.

void FFT(float *Output,const float *Input,int Size);



INT32 hDevice; //handle to G33DDC device

UINT32 AbsDDC2Frequency; //Absolute frequency of the DDC2

INT32 RelDDC2Frequency; //Relative frequency of the DDC2

UINT32 DDC1Frequency; //DDC1 frequency

G3XDDC_DDC_INFO DDC2Info; //Information about current DDC type of the DDC2

FLOAT FFTBuffer[2*2048]; //Buffer for FFT result

FLOAT Compensation[2048]; //Buffer for compensation data

UINT32 FirstBin,LastBin; //the first and last bins in the FFT of useful DDC2 band

G33DDC_CALLBACKS Callbacks; //Structure which contains pointer to callback functions



Code before...



//Retrieve frequency of the DDC1

GetDDC1Frequency(hDevice,&DDC1Frequency);



//Retrieve relative frequency of the DDC2 for channel 0

GetDDC2Frequency(hDevice,0,&RelDDC2Frequency);



//Calculate absolute frequency of the DDC2

AbsDDC2Frequency=(INT32)DDC1Frequency+RelDDC2Frequency;



//Retrieve DDC type information of the DDC2

GetDDC2(hDevice,NULL,&DDC2Info);



//Retrieve compensation data

GetSpectrumCompensation(hDevice,AbsDDC2Frequency,DDC2Info.SampleRate,Compensation,2048);

//In this case the Width parameter is equal to sample rate, because we need compensation data

//for whole DDC2 band.

//Compensation data have to be updated after change of absolute DDC2 frequency using

//the SetDDC1Frequency or SetDDC2Frequency function.

//In this case a mutual-exclusion synchronization method (for example critical section) should be used 

//if the Compensation buffer would be modified outside the MyDDC2StreamCallback callback.



FirstBin=2048*(DDC2Info.SampleRate-DDC2Info.Bandwidth)/2/DDC2Info.SampleRate;

LastBin=2048*(DDC2Info.SampleRate+DDC2Info.Bandwidth)/2/DDC2Info.SampleRate;



//Set callback function for DDC2 streaming

//Pointers to callback function which should not be called by the API have to be set to NULL.

Callbacks.DDC2StreamCallback=MyDDC2StreamCallback;



//Start DDC2 streaming for channel 0

//The SamplesPerBuffer parameter is set to 2048 which is size of the FFT to simplify

//the example.

StartDDC2(hDevice,0,2048);



Code after...

    

void __stdcall MyDDC2StreamCallback(UINT32 Channel,CONST FLOAT *Buffer,UINT32 NumberOfSamples,DWORD_PTR UserData)

{

 UINT32 i;

 

    //Compute FFT

    FFT(FFTBuffer,Buffer,2048);

    

    //Converts complex FFT result to dB

    for(i=0;i<2048;i++)

    {

        FFTBuffer[i]=(FLOAT)(10.0*log10(FFTBuffer[i*2]*FFTBuffer[i*2]+FFTBuffer[i*2+1]*FFTBuffer[i*2+1]));

    }

    

    //Apply compensation data to get amplitudes in frequency spectrum in dBm

    for(i=0;i<2048;i++)

    {

        FFTBuffer[i]+=Compensation[i];

    }

    

    //now the FFTBuffer contains amplitudes in dBm

    //Useful band starts at the bin given by the FirstBin variable

    //and ends at the bin given by the LastBin variable.

}




SetCallbacks

Registers user-defined functions as callback functions called by the API.

C/C++ declaration

BOOL __stdcall SetCallbacks(INT32 hDevice,CONST G33DDC_CALLBACKS *Callbacks,DWORD_PTR UserData);

Address retrieval

G33DDC_SET_CALLBACKS SetCallbacks=(G33DDC_SET_CALLBACKS)GetProcAddress(hAPI,"SetCallbacks");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
Callbacks
[in] Pointer to a G33DDC_CALLBACKS structure which contains pointers to the user-defined function to be registered as callback functions.
UserData
[in] Specifies a user-defined value which is passed to callback functions.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If the application does not require that the API calls some callback function, set related member of the G33DDC_CALLBACKS structure to NULL.

If value of the Callbacks parameter is NULL, all the callback functions are unregistered, the API will not call any callback function.


SetDRMKey

Sets directory with DRM key file to unlock DRM demodulator/decoder.

C/C++ declaration

BOOL __stdcall SetDRMKey(INT32 hDevice,CONST CHAR *DRMKeyFileDirectory);

Address retrieval

G33DDC_SET_DRM_KEY SetDRMKey=(G33DDC_SET_DRM_KEY)GetProcAddress(hAPI,"SetDRMKey");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.
DRMKeyFileDirectory
[in] Pointer to a null-terminated string that specifies the directory which contains valid DRM key file.

Return value

If the function succeeds, the return value is non-zero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If the specfied directory contains valid DRM key file, the key is loaded and the DRM demodulator/decoder is unlocked and available for use, otherwise the function fails.

If the DRM demodulator/decoder is already unlocked, the function does nothing.

Use the IsDRMUnlocked function to determine whether DRM demodulator/decoder is unlocked or not.

Information about obtaining DRM key at http://www.winradio.com/home/drm.htm.


IsDRMUnlocked

Determined whether DRM demodulator/decoder is unlocked or not.

C/C++ declaration

BOOL __stdcall IsDRMUnlocked(INT32 hDevice);

Address retrieval

G33DDC_IS_DRM_UNLOCKED IsDRMUnlocked=(G33DDC_IS_DRM_UNLOCKED)GetProcAddress(hAPI,"IsDRMUnlocked");

Parameters

hDevice
[in] Handle to G33DDC device returned by the OpenDevice function.

Return value

If the function succeeds and the DRM demodulator/decoder is unlocked, the return value is non-zero.
If the function fails or the DRM demodulator/decoder is locked, the return value is zero. To get extended error information, call GetLastError.

G33DDC_DEVICE_INFO

Contains information about G33DDC device.

C/C++ declaration


#pragma pack(push,1)



typedef struct

{

    CHAR        DevicePath[MAX_PATH];

    BYTE        InterfaceType;

    CHAR        SerialNumber[9];

    UINT32      ChannelCount;

    UINT32      DDCTypeCount;

} G33DDC_DEVICE_INFO;



#pragma pack(pop

Members

DevicePath
Device system path in a null-terminated string. It is used to open the device using object interface.
InterfaceType

Device interface type. The value can be one of the following:

G3XDDC_INTERFACE_TYPE_PCIE
The device is connected to the computer via PCI express.

G3XDDC_INTERFACE_TYPE_USB
The device is connected to the computer via USB.

SerialNumber
Serial number in null-terminated string.
ChannelCount
Number of channels.
DDCTypeCount
Number of DDC types supported by the DDC1.

G3XDDC_DDC_INFO

Contains information about DDC type.

C/C++ declaration


#pragma pack(push,1)



typedef struct

{

    UINT32  SampleRate;

    UINT32  Bandwidth;

    UINT32  BitsPerSample;

} G3XDDC_DDC_INFO;



#pragma pack(pop

Members

SampleRate
Sample rate of I/Q signal in Hz.
Bandwidth
Useful bandwidth in Hz.
BitsPerSample
Number of bits per sample. It can be 16 or 32. It is used to determine bits per sample for DDC1.

G3XDDC_AMS_CAPTURE_RANGE

Contains information about DDC type.

C/C++ declaration


#pragma pack(push,1)



typedef struct

{

    UINT32  Tune;

    UINT32  Lock;

} G3XDDC_AMS_CAPTURE_RANGE;



#pragma pack(pop

Members

Tune
Initial capture range in Hz.
Lock
Capture range (in Hz) used when AMS demodulator is locked.

G33DDC_CALLBACKS

Contains pointers to user-defined functions to be registered as callback functions.

Each callback function is called in context of thread created by the API. If some shared data are accessed inside callback functions, it is recommended to use a mutual-exclusion synchronization method. The application should not call any G33DDC API function from inside callback functions, otherwise it can cause deadlock or the application can become to unpredictable state.

C/C++ declaration


#pragma pack(push,1)



typedef struct

{

    G33DDC_IF_CALLBACK                          IFCallback;

    G33DDC_DDC1_STREAM_CALLBACK                 DDC1StreamCallback;

    G33DDC_DDC1_PLAYBACK_STREAM_CALLBACK        DDC1PlaybackStreamCallback;

    G33DDC_DDC2_STREAM_CALLBACK                 DDC2StreamCallback;

    G33DDC_DDC2_PREPROCESSED_STREAM_CALLBACK    DDC2PreprocessedStreamCallback;

    G33DDC_AUDIO_STREAM_CALLBACK                AudioStreamCallback;

    G33DDC_AUDIO_PLAYBACK_STREAM_CALLBACK       AudioPlaybackStreamCallback;

} G33DDC_CALLBACKS;



#pragma pack(pop)

Members

IFCallback

Pointer to a user-defined function to be registered as IF callback. It is called by the API to pass IF snapshots to the application. Sending of IF snapshots is started using the StartIF function.

C/C++ declaration

VOID __stdcall IFCallback(CONST SHORT *Buffer,UINT32 NumberOfSamples,WORD MaxADCAmplitude,UINT32 ADCSamplingRate,DWORD_PTR UserData);

Parameters

Buffer
Pointer to the buffer which contains samples directly received from ADC. Sample rate is 100 MHz, sample is 16bit signed little endian.
NumberOfSamples
Specifies number of samples in the buffer pointed to be the Buffer parameter. This is usually 65536.
MaxADCAmplitude
Specifies maximum amplitude. Measurement of the maximum is started at the end of the previous snapshot to the current one. The possible value is 0 to 32767.
ADCSamplingRate
Specifies sample rate of the ADC in Hz. It can vary a little bit because of temperature instability.
UserData
User-defined data. It is value passed to the SetCallbacks function as the UserData parameter.
DDC1StreamCallback

Pointer to a user-defined function to be registered as DDC1 stream callback. It is called by the API to pass I/Q samples from DDC1 to the application. The DDC1 streaming can be started using the StartDDC1 or StartDDC1Playback function.

C/C++ declaration

VOID __stdcall DDC1StreamCallback(CONST VOID *Buffer,UINT32 NumberOfSamples,UINT32 BitsPerSample,DWORD_PTR UserData);

Parameters

Buffer
Pointer to the buffer which contains I/Q sample sets from DDC1. Sample rate and bits per sample is given by used DDC type, see the SetDDC1 function. One I/Q sample set consists of two samples.
NumberOfSamples
Specifies number of I/Q sample sets in the buffer pointed to by the Buffer parameter. This value is equal to value of the SamplesPerBuffer parameter of the StartDDC1 or StartDDC1Playback function.
BitsPerSample
Specifies number of bits per sample. It is given by DDC type used for DDC1 and it can be 16 or 32. If it is 16, sample is 16bit integer (32bits per I/Q sample set), signed, little endian, from range -32768 to 32767. If it is 32, sample is 32bit integer (64bits per I/Q sample set), signed, little endian, from range -2147483648 to 2147483647.
UserData
User-defined data. It is value passed to the SetCallbacks function as the UserData parameter.
DDC1PlaybackStreamCallback

Pointer to a user-defined function to be registered as DDC1 playback stream callback. It is called by the API to fill the buffer with I/Q samples by the applcation. The DDC1 playback can be started using the StartDDC1Playback function.

C/C++ declaration

BOOL __stdcall DDC1PlaybackStreamCallback(VOID *Buffer,UINT32 NumberOfSamples,UINT32 BitsPerSample,DWORD_PTR UserData);

Parameters

Buffer
Pointer to the buffer to be filled with I/Q sample sets. Sample rate and bits per sample is given by used DDC type, see the SetDDC1 function.
NumberOfSamples
Specifies number of I/Q sample sets to be stored to the buffer pointed to by the Buffer parameter. This value is equal to value of the SamplesPerBuffer parameter of the StartDDC1Playback function. If the application does not have requested number of sample sets, it has to fill the buffer with zeros. One I/Q sample set consists of two samples.
BitsPerSample
Specifies number of bits per sample. It is given by DDC type used for DDC1 and it can be 16 or 32. If it is 16, sample is 16bit integer (32bits per I/Q sample set), signed, little endian, from range -32768 to 32767. If it is 32, sample is 32bit integer (64bits per I/Q sample set), signed, little endian, from range -2147483648 to 2147483647.
UserData
User-defined data. It is value passed to the SetCallbacks function as the UserData parameter.

Return value

The application should return non-zero to continue playback. The application should return zero to stop the API to call DDC1PlaybackStreamCallback again. This does not stop DDC1 playback, it has to be done explicitly by the application calling the StopDDC1 function from the thread in which the device was open using the OpenDevice function. StopDDC1 must not be called from inside the callback function.
DDC2StreamCallback

Pointer to a user-defined function to be registered as DDC2 stream callback. It is called by the API to pass I/Q samples from DDC2 to the application. The DDC2 streaming can be started using the StartDDC2 function.

C/C++ declaration

BOOL __stdcall DDC2StreamCallback(UINT32 Channel,CONST FLOAT *Buffer,UINT32 NumberOfSamples,DWORD_PTR UserData);

Parameters

Channel
Specifies channel index. It can be 0, 1, 2.
Buffer
Pointer to the buffer which contains I/Q sample sets from DDC2. Sample rate is given by the DDC type of the DDC2. Use the GetDDC2 function to determine current DDC type of the DDC2. Sample is 32bit IEEE float from range -1.0 to 1.0. One I/Q sample set consists of two samples.
NumberOfSamples
Specifies number of I/Q sample sets in the buffer pointed to by the Buffer parameter. This value is equal to value of the SamplesPerBuffer parameter of the StartDDC2 function.
UserData
User-defined data. It is value passed to the SetCallbacks function as the UserData parameter.
DDC2PreprocessedStreamCallback

Pointer to a user-defined function to be registered as preprocessed DDC2 stream callback. It is called by the API to pass preprocessed I/Q samples from DDC2 to the application. The samples are filtered by the demodulator filter, notch filter and affected by AGC or fixed gain. The DDC2 streaming can be started using the StartDDC2 function.

C/C++ declaration

BOOL __stdcall DDC2PreprocessedStreamCallback(UINT32 Channel,CONST FLOAT *Buffer,UINT32 NumberOfSamples,

            FLOAT SlevelPeak,FLOAT SlevelRMS,DWORD_PTR UserData);

Parameters

Channel
Specifies channel index. It can be 0, 1, 2.
Buffer
Pointer to the buffer which contains preprocessed I/Q sample sets from DDC2. Sample rate is given by the DDC type of the DDC2. Use the GetDDC2 function to determine current DDC type of the DDC2. Sample is 32bit IEEE float from range -1.0 to 1.0. One I/Q sample set consists of two samples.
NumberOfSamples
Specifies number of I/Q sample sets in the buffer pointed to by the Buffer parameter. This value is equal to value of the SamplesPerBuffer parameter of the StartDDC2 function.
SlevelPeak
Specifies peak signal level in Volts evaluated from samples stored in the buffer pointed to by the Buffer parameter.
SlevelRMS
Specifies RMS signal level in Volts evaluated from samples stored in the buffer pointed to by the Buffer parameter. For detailed information how to convert RMS signal level to dBm, see remarks of the GetSignalLevel function.
UserData
User-defined data. It is value passed to the SetCallbacks function as the UserData parameter.
AudioStreamCallback

Pointer to a user-defined function to be registered as audio stream callback. It is called by the API to pass audio samples to the application. The audio streaming can be started using the StartAudio or StartAudioPlayback function.

C/C++ declaration

VOID __stdcall AudioStreamCallback(UINT32 Channel,CONST FLOAT *Buffer,CONST FLOAT *BufferFiltered,

            UINT32 NumberOfSamples,DWORD_PTR UserData);

Parameters

Channel
Specifies channel index. It can be 0, 1, 2.
Buffer
Pointer to the buffer which contains samples of audio signal. The signal is mono, sample rate is 48000 Hz, sample is 32bit IEEE float from range -1.0 to 1.0.
BufferFiltered
Pointer to the buffer which contains samples of filtered audio signal. The signal is mono, sample rate is 48000 Hz, sample is 32bit IEEE float from range -1.0 to 1.0. If the audio filter is disabled, the samples in the buffer pointed to by the BufferFiltered are the same as the samples in the buffer pointed to by the Buffer parameter.
NumberOfSamples
Specifies number of samples to be stored in the buffer pointed to by the Buffer parameter. This value is equal to value of the SamplesPerBuffer parameter of the StartAudio or StartAudioPlayback function.
UserData
User-defined data. It is value passed to the SetCallbacks function as the UserData parameter.
AudioPlaybackStreamCallback

Pointer to a user-defined function to be registered as audio playback stream callback. It is called by the API to fill the buffer with audio samples by the application. The audio playback can be started using the StartAudioPlayback function.

C/C++ declaration

VOID __stdcall AudioPlaybackStreamCallback(UINT32 Channel,FLOAT *Buffer,UINT32 NumberOfSamples,DWORD_PTR UserData);

Parameters

Channel
Specifies channel index. It can be 0, 1, 2.
Buffer
Pointer to the buffer to by filled with audio samples. The audio signal is mono, sample rate is 48000 Hz, sample is 32bit IEEE float from range -1.0 to 1.0.
NumberOfSamples
Specifies number of samples in the buffer pointed to by the Buffer parameter. This value is equal to value of the SamplesPerBuffer parameter of the StartAudioPlayback function. If the application does not have requested number of samples, the application has to fill the buffer with zeros.
UserData
User-defined data. It is value passed to the SetCallbacks function as the UserData parameter.

Return value

The application should return non-zero to continue playback. The application should return zero to stop the API to call AudioPlaybackStreamCallback again. This does not stop audio playback, it has to be done explicitly by the application calling the StopAudio function from the thread in which the device was open using the OpenDevice function. StopAudio must not be called from inside the callback function.

G3XDDC_DRM_STATUS

Contains information about DRM demodulator/decoder status.

C/C++ declaration


#pragma pack(push,1)



typedef struct

{

    BOOL            Valid;



    struct

    {

        BOOL        SyncFound;

        BOOL        FACDecoded;

        BOOL        SDCDecoded;

        BOOL        AudioDecoded;

        SHORT       NumberOfAudioFrames;

        SHORT       NumberOfAudioErrors;

    } DecodingState;



    INT32           Mode;

    double          RFBandwidth;

    BYTE            Interleaver;

    SHORT           SDCQam;

    SHORT           MSCQam;

    BYTE            MSCQamType;

    double          CoderateH;

    double          CoderateA;

    double          CoderateB;

    double          EstimatedSNR;

    WCHAR           TextMessage[128 + 1 + 16];

   

    struct

    {

        BYTE        Content;

        WCHAR       DynamicLabel[256];

        WCHAR       Country[256];

        WCHAR       Language[256];

        WCHAR       ProgramType[256];

        double      AudioBitrate;

        double      TextMsgBitrate;

        double      MultimediaBitrate;

        double      DataBitrate;

    } ServiceInfo[4];



    struct

    {

        BOOL        Valid;

        BYTE        AudioCoding;

        BOOL        SBR;

        INT32       AudioMode;

    } AudioDecoderInfo[4];

} G3XDDC_DRM_STATUS;



#pragma pack(pop)

Members

Valid
The value is non-zero if content of the structure is valid. It is zero, if content of the structure is not valid.
DecodingState

Structure that contains status of the decoder modules.

Members

SyncFound
Status of the sync detection. It is non-zero if sync detected.
FACDecoded
Status of the FAC decoder. It is non-zero if FAC decoded.
SDCDecoded
Status of the SDC decoder. It is non-zero if SDC decoded.
AudioDecoded
Status of the audio decoder. It is non-zero if audio decoded.
NumberOfAudioFrames
Number of audio frames in the transmission frame. It is -1 if this information is not available.
NumberOfAudioErrors
Number of audio frames that were invalid.
Mode
Used DRM robustness mode. It can be one of the following:

ValueMeaning
G3XDDC_DRM_STATE_MODE_NOT_DETERMINED_YETRobustness mode is not determined yet.
G3XDDC_DRM_STATE_MODE_ABroadcast is using DRM robustness mode A.
G3XDDC_DRM_STATE_MODE_BDRM robustness mode B.
G3XDDC_DRM_STATE_MODE_CDRM robustness mode C.
G3XDDC_DRM_STATE_MODE_DDRM robustness mode D.

RFBandwidth
Occupied RF bandwidth in kHz. It is zero if it is invalid or this information is not available (yet).
Interleaver
Interleaver length. It can be one of the following:

ValueMeaning
G3XDDC_DRM_STATE_INTERLEAVER_LONGLong interleaver used (2 sec).
G3XDDC_DRM_STATE_INTERLEAVER_SHORTShort interleaver used (400 msec).

SDCQam
Coding of the SDC (QAM). It is zero if this information is not available (yet).
MSCQam
Coding of the MSC (QAM). It is zero if this information is not available (yet).
MSCQamType
Used QAM coding for the MSC. It can be one of the following:

ValueMeaning
G3XDDC_DRM_STATE_QAM_TYPE_STDStandard
G3XDDC_DRM_STATE_QAM_TYPE_HIER_SYMHierarchical symmetrical
G3XDDC_DRM_STATE_QAM_TYPE_HIER_MIXHierarchical mixed

CoderateH
Used code-rate for hierarchical coding, values less than or equal to zero indicate not available or not used.
CoderateA
Used code-rate for protection level A, values less than or equal to zero indicate indicate not available or not used.
CoderateB
Used code-rate for protection level B, values less than or equal to zero indicate indicate not available or not used.
EstimatedSNR
Estimated SNR in dB of the decoded signal.
TextMessage
Decoded text message for the selected service in 16bit Unicode null-terminated string.
ServiceInfo

Array of four structures which contain general information on the services.

Members

Content
Type of the service. It can be combination of the following:

ValueMeaning
G3XDDC_DRM_STATE_SERVICE_CONTENT_EMPTYGiven service is not used, it contains no data, all other members of the structure are invalid.
G3XDDC_DRM_STATE_SERVICE_CONTENT_AUDIOGiven service contains audio data.
G3XDDC_DRM_STATE_SERVICE_CONTENT_TEXTMSGGiven service contains text messages.
G3XDDC_DRM_STATE_SERVICE_CONTENT_MULTIMEDIAGiven service contains multimedia data.
G3XDDC_DRM_STATE_SERVICE_CONTENT_DATAGiven service contains application specific data.

DynamicLabel
16bit Unicode null-terminated string containing dynamic label of the service.
Country
16bit Unicode null-terminated string containing the signaled country for this service.
Language
16bit Unicode null-terminated string containing the signaled language for this service.
ProgramType
16bit Unicode null-terminated string containing the signaled program type for this service.
AudioBitrate
Data rate for the audio content. It is zero if this information is not available.
TextMsgBitrate
Data rate for the text message content. It is zero if this information is not available.
MultimediaBitrate
Data rate for the multimedia content. It is zero if this information is not available.
DataBitrate
Data rate for the data content. It is zero if this information is not available.
AudioDecoderInfo

Array of four structures which contain audio decoder specific information on the services.

Members

Valid
If it is non-zero, audio decoder information are valid, if it is zero, audio decoder information are invalid and all other members of the structure contain no valid data.
AudioCoding
Used audio coding. It can be one of the following:

ValueMeaning
G3XDDC_DRM_STATE_AUDIO_CODING_AACAudio coding for given service is AAC.
G3XDDC_DRM_STATE_AUDIO_CODING_CELPAudio coding for given service is CELP.
G3XDDC_DRM_STATE_AUDIO_CODING_HVXCAudio coding for given service is HVXC.
G3XDDC_DRM_STATE_AUDIO_CODING_RFUReserved for future use.

SBR
If it is non-zero, SBR is used, if it is zero, SBR is not used.
AudioMode
The value depends on audio coding. It can be one of the following:

ValueMeaning
G3XDDC_DRM_STATE_AUDIO_MODE_AAC_MONOMono
G3XDDC_DRM_STATE_AUDIO_MODE_AAC_PARAM_STEREOParametric stereo
G3XDDC_DRM_STATE_AUDIO_MODE_AAC_STEREOStereo
G3XDDC_DRM_STATE_AUDIO_MODE_AAC_RFUReserved for future use
G3XDDC_DRM_STATE_AUDIO_MODE_CELP_NO_CRCAudio data is without CRC
G3XDDC_DRM_STATE_AUDIO_MODE_CELP_CRCCRC used
G3XDDC_DRM_STATE_AUDIO_MODE_CELP_RFU_10Reserved for future use
G3XDDC_DRM_STATE_AUDIO_MODE_CELP_RFU_11Reserved for future use
G3XDDC_DRM_STATE_AUDIO_MODE_HVXC_RFU_00Reserved for future use
G3XDDC_DRM_STATE_AUDIO_MODE_HVXC_RFU_01Reserved for future use
G3XDDC_DRM_STATE_AUDIO_MODE_HVXC_RFU_10Reserved for future use
G3XDDC_DRM_STATE_AUDIO_MODE_HVXC_RFU_11Reserved for future use