sysmocom
/
pjproject
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Re #1833: Support bdSound's bdiMad v2.0.0 

git-svn-id: https://svn.pjsip.org/repos/pjproject/trunk@5037 74dad513-b988-da41-8d7b-12977e46ad98
This commit is contained in:
Riza Sulistyo 2015-03-27 08:47:20 +00:00
parent 92be094078
commit 5cbf7aaba5
2 changed files with 557 additions and 244 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
pjmedia/src/pjmedia-audiodev/bdimad_dev.c
View File

@ -4,10 +4,10 @@
Author: bdSound Development Team (techsupport@bdsound.com)
Date: 30/10/2012
Version 1.0.206
Date: 12/03/2015
Version 2.0.0 rev.1618
Copyright (c) 2012 bdSound s.r.l. (www.bdsound.com)
Copyright (c) 2015 bdSound s.r.l. (www.bdsound.com)
All Rights Reserved.
*******************************************************/
@ -36,7 +36,7 @@
#define BD_IMAD_MAX_DEV_LENGTH_NAME 256
/* Only mono mode */
#define BD_IMAD_MAX_CHANNELS 1
/* Frequency default value (admitted 8000 Hz, 16000 Hz, 32000 Hz and 48000Hz) */
/* Frequency default value (admitted 8000 Hz, 16000 Hz, 32000 Hz, 44100 Hz and 48000 Hz) */
#define BD_IMAD_DEFAULT_FREQ 48000
/* Default milliseconds per buffer */
#define BD_IMAD_MSECOND_PER_BUFFER 16
@ -45,10 +45,12 @@
/* Only for supported systems */
#define BD_IMAD_STARTING_OUTPUT_VOLUME 100
/* Diagnostic Enable/Disable */
#define BD_IMAD_DIAGNOSTIC BD_IMAD_DIAGNOSTIC_DISABLE
#define BD_IMAD_DIAGNOSTIC BD_IMAD_DIAGNOSTIC_DISABLE
/* Diagnostic folder path */
wchar_t * bdImadPjDiagnosticFolderPath = L"";
#define BD_IMAD_DIAGNOSTIC_PATH "/mnt/sdcard/MUSIC/"
static wchar_t bdImadPjDiagnosticFolderPath[200];
#define THIS_FILE "bdimad_dev.c"
@ -302,8 +304,7 @@ static pj_status_t factory_refresh(pjmedia_aud_dev_factory *f)
// Capture device properties
for(i=0;i<captureDeviceCount;i++) {
wf->dev_info[i].deviceId = i;
wf->dev_info[i].info.caps = PJMEDIA_AUD_DEV_CAP_INPUT_VOLUME_SETTING |
PJMEDIA_AUD_DEV_CAP_EC;
bdIMADpj_getDeviceCapabilities(BD_IMAD_CAPTURE_DEVICES,&wf->dev_info[i].info.caps);
wf->dev_info[i].info.default_samples_per_sec = BD_IMAD_DEFAULT_FREQ;
strcpy(wf->dev_info[i].info.driver, "BD_IMAD");
wf->dev_info[i].info.ext_fmt_cnt = 0;
@ -317,8 +318,7 @@ static pj_status_t factory_refresh(pjmedia_aud_dev_factory *f)
// Playback device properties
for(i=0;i<playbackDeviceCount;i++) {
wf->dev_info[captureDeviceCount+i].deviceId = captureDeviceCount+i;
wf->dev_info[captureDeviceCount+i].info.caps =
PJMEDIA_AUD_DEV_CAP_OUTPUT_VOLUME_SETTING | PJMEDIA_AUD_DEV_CAP_OUTPUT_ROUTE;
bdIMADpj_getDeviceCapabilities(BD_IMAD_PLAYBACK_DEVICES,&wf->dev_info[captureDeviceCount+i].info.caps);
wf->dev_info[captureDeviceCount+i].info.default_samples_per_sec =
BD_IMAD_DEFAULT_FREQ;
strcpy(wf->dev_info[captureDeviceCount+i].info.driver, "BD_IMAD");
@ -706,14 +706,14 @@ static pj_status_t init_streams(struct bd_factory *wf,
strm->bdIMADpjSettingsPtr->FrameSize_ms = ptime;
strm->bdIMADpjSettingsPtr->DiagnosticEnable = BD_IMAD_DIAGNOSTIC;
strm->bdIMADpjSettingsPtr->DiagnosticFolderPath =
bdImadPjDiagnosticFolderPath;
mbstowcs(bdImadPjDiagnosticFolderPath, BD_IMAD_DIAGNOSTIC_PATH, strlen(BD_IMAD_DIAGNOSTIC_PATH));
strm->bdIMADpjSettingsPtr->DiagnosticFolderPath = bdImadPjDiagnosticFolderPath;
strm->bdIMADpjSettingsPtr->validate = (void *)manage_code;
if(prm->clock_rate != 8000 && prm->clock_rate != 16000
&& prm->clock_rate != 32000 && prm->clock_rate != 48000) {
&& prm->clock_rate != 32000 && prm->clock_rate != 44100 && prm->clock_rate != 48000) {
PJ_LOG(4, (THIS_FILE,
"BDIMAD support 8000 Hz, 16000 Hz, 32000 Hz and 48000 Hz "
"BDIMAD support 8000 Hz, 16000 Hz, 32000 Hz, 44100 Hz and 48000 Hz "
"frequency."));
}
strm->bdIMADpjSettingsPtr->SamplingFrequency = prm->clock_rate;
@ -766,6 +766,9 @@ static pj_status_t init_streams(struct bd_factory *wf,
bdIMADpj_setParameter(strm->bdIMADpjInstance,
BD_PARAM_IMAD_PJ_MIC_CONTROL_ENABLE,
&auxInt);
// Enable GUI Socket Communication [default->disabled]
bdIMADpj_enableGuiSocketCommunication(strm->bdIMADpjInstance,27000,0);
}
if(errorInitAEC != BD_PJ_OK &&
@ -933,8 +936,7 @@ static pj_status_t stream_set_capBDIMAD(pjmedia_aud_stream *s,
if(cap == PJMEDIA_AUD_DEV_CAP_OUTPUT_ROUTE) {
pjmedia_aud_dev_route outputRoute = *(pjmedia_aud_dev_route*)pval;
if(strm->param.output_route!=outputRoute)
res = bdIMADpj_setRouteOutputDevice(strm->bdIMADpjInstance, (bdIMADpj_out_dev_route) outputRoute, &strm->bdIMADpjWarningPtr);
res = bdIMADpj_setRouteOutputDevice(strm->bdIMADpjInstance, (bdIMADpj_out_dev_route) outputRoute, &strm->bdIMADpjWarningPtr);
if(res == BD_PJ_OK) {
strm->param.output_route = outputRoute;
return PJ_SUCCESS;
@ -1219,14 +1221,9 @@ static pj_status_t stream_start(pjmedia_aud_stream *s)
}
#if defined (_MSC_VER)
#ifdef _DEBUG
#pragma comment ( lib, "bdClientValidationd.lib" )
#pragma comment ( lib, "bdIMADpjd.lib" )
#else
#pragma comment ( lib, "bdClientValidation.lib" )
#pragma comment ( lib, "bdIMADpj.lib" )
#endif
#endif
#endif /* PJMEDIA_AUDIO_DEV_HAS_BDIMAD */

762
third_party/bdsound/include/bdimad.h vendored
View File

@ -7,7 +7,7 @@
* @defgroup bd_IMAD bdIMADpj bdSound IMproved Audio Device for PJSIP.
* @ingroup audio_device_api
*
* <b>bdSound IMproved Audio Device</b> is a multiplatform audio interface
* <b>bdSound IMproved Audio Device</b> is a multi-platform audio interface
* created to integrate in <b>PJSIP</b> library with no effort.
* \n Porting <b>bdIMADpj</b> across the main operating systems is
* straightforward, without the need of change a single line of code.
@ -37,26 +37,19 @@
*
* - <b>Integration</b>
* \n Using <b>bdIMAD</b> within <b>PJSIP</b> is simple:
* -# Request for bdIMADpj library to
* <a href="http:/www.bdsound.com" target="new">bdSound</a>:
* bdSound will provide instruction to integrate the library depending on
* the platform / O.S. / toolchain;
* -# Add the <code>bdimad_dev.c</code> file to
* <code>pjmedia/src/pjmedia-audiodev</code> folder;
* -# Enable the bdIMAD audio device defining the periferal in the
* <code>pj/config_site.h</code> and disabling all other devices:
* <pre>
* #define PJMEDIA_AUDIO_DEV_HAS_BDIMAD 1
* </pre>
* -# Download trial bdIMADpj library from
* <a href="http:/www.bdsound.com" target="new">bdSound</a>;
* -# Follow the integration instructions at
* <a href="http:/www.bdsound.com/support" target="new">bdSound</a>:
*
* - <b>Usage</b>
* \n There are only a couple of things the customer have to pay attention on
* <EFBFBD>when using bdIMAD library.
* when using bdIMAD library.
*
* - <b>Initialization</b>
* \n Since the bdIMAD library provide itself the echo cancellation
* \n Since the bdIMAD library provides itself the echo cancellation
* and the latency management, is necessary to disable these features
* in the PJSIP librariy applications.
* in the PJSIP library applications.
* \n For example in PJSUA sample application there is the need
* to provide the following commands:
* <pre>
@ -70,17 +63,19 @@
* - <code>PJMEDIA_AUD_DEV_CAP_OUTPUT_VOLUME_SETTING</code>
* \n Setting speaker volume.
* - <code>PJMEDIA_AUD_DEV_CAP_INPUT_VOLUME_SETTING</code>
* \n Setting michrophone volume.
* \n Setting microphone volume.
* - <code>PJMEDIA_AUD_DEV_CAP_EC</code>
* \n Enable/disable echo cancellation.
* - <code>PJMEDIA_AUD_DEV_CAP_OUTPUT_ROUTE</code>
* \n Support for audio output routing in mobile application(e.g. loudspeaker vs earpiece).
*
* For additional information visit
* <a href="http:/www.bdsound.com" target="new">www.bdsound.com</a>
* or write to info@bdsound.com
*
* @author bdSound
* @version 1.0.1
* @copyright 2012 bdSound srl. All rights reserved.
* @version 2.0.0 rev.1618
* @copyright 2015 bdSound srl. All rights reserved.
*
*/
@ -99,7 +94,7 @@
*/
/**
* @defgroup groupStructEnum Structs and Enums
* @defgroup groupStructEnum Structs and Enums
* @ingroup bd_IMAD
*
* Struct and Enum defined in bdIMAD.
@ -139,12 +134,15 @@ typedef void* bdIMADpj;
/**
* @brief Callback used to fill the playback buffer of bdIMAD.
* The function is called by bdIMAD each time are required sample to be played.
* @param[in] *buffer pointer to the buffer with the audio
* samples to be played(short type).
* @param[in] nSamples number of samples required.
* @param[in] user_data pointer to the user data structure
* defined in the bdIMADpj_Setting_t
* structure.
*
* @param[in] *buffer pointer to the buffer with the audio
* samples to be played (short type).
*
* @param[in] nSamples number of samples required.
*
* @param[in] user_data pointer to the user data structure
* defined in the bdIMADpj_Setting_t structure.
*
* @return none.
*/
@ -152,13 +150,17 @@ typedef int (* cb_fillPlayBackB_t) (void *buffer, int nSamples,
void *user_data);
/**
* @brief Callback used to retrive the caputre buffer of bdIMAD. The function
* is called by bdIMAD each time processed mic samples are available.
* @param[out] *buffer pointer to the buffer with the audio
* samples to download(short type).
* @param[in] nSamples number of samples processed to download.
* @param[in] user_data pointer to the user data structure
* defined in the MainSet structure.
* @brief Callback used to retrieve the capture buffer of bdIMAD. The function
* is called by bdIMAD each time processed microphone samples are available.
*
* @param[out] *buffer pointer to the buffer with the audio
* samples to be downloaded (short type).
*
* @param[in] nSamples number of samples processed to be downloaded.
*
* @param[in] user_data pointer to the user data structure
* defined in the bdIMADpj_Setting_t structure.
*
* @return none.
*/
@ -177,50 +179,50 @@ typedef void (* cb_emptyCaptureB_t) (void *buffer, int nSamples,
* @brief Error status returned by some functions in the library.
*/
typedef enum bdIMADpj_Status{
/**< No error. */
typedef enum bdIMADpj_Status {
/** No error. */
BD_PJ_OK = 0,
/**< Watch bdIMADpj_Warnings_t structure to find the warnings. */
/** The warnings can be find in the bdIMADpj_Warnings_t structure . */
BD_PJ_WARN_BDIMAD_WARNING_ASSERTED = 1,
/**< Error not identified. */
/** Error not identified. */
BD_PJ_ERROR_GENERIC = 2,
/**< The pointer passed is NULL. */
/** The pointer passed is NULL. */
BD_PJ_ERROR_NULL_POINTER = 3,
/**< Allocation procedure failed. */
/** Allocation procedure failed. */
BD_PJ_ERROR_ALLOCATION = 4,
/**< The parameter is not existent or the set/get function is not active. */
/** The parameter is not existent or the set/get function is not active. */
BD_PJ_ERROR_PARAMETER_NOT_FOUND = 5,
/**< No capture device found. */
/** No capture device found. */
BD_PJ_ERROR_IMAD_NONE_CAPTURE_DEV = 10,
/**< No play device found. */
/** No play device found. */
BD_PJ_ERROR_IMAD_NONE_PLAY_DEV = 11,
/**< Frame size not allowed. */
/** Frame size not allowed. */
BD_PJ_ERROR_IMAD_FRAME_SIZE = 12,
/**< Sample frequency not allowed. */
/** Sample frequency not allowed. */
BD_PJ_ERROR_IMAD_SAMPLE_FREQ = 13,
/**< Samples missing. */
/** Samples missing. */
BD_PJ_ERROR_IMAD_MISSING_SAMPLES = 14,
/**< Device list is empty. */
/** Device list is empty. */
BD_PJ_ERROR_IMAD_DEVICE_LIST_EMPTY = 15,
/**< Library not authorized, entering demo mode. */
/** Library not authorized, entering demo mode. */
BD_PJ_ERROR_IMAD_LIB_NOT_AUTHORIZED = 16,
/**< The input channel memory has not been allocated. */
/** The input channel memory has not been allocated. */
BD_PJ_ERROR_IMAD_INPUT_CH_NOT_ALLOCATED = 17,
/**< The library has expired, entering demo mode. */
/** The library has expired, entering demo mode. */
BD_PJ_ERROR_IMAD_LICENSE_EXPIRED = 18,
/**< Open of capture device failed. */
/** Open of capture device failed. */
BD_PJ_ERROR_IMAD_OPEN_CAPTURE_DEV_FAILED = 19,
/**< Open of play device failed. */
/** Open of play device failed. */
BD_PJ_ERROR_IMAD_OPEN_PLAY_DEV_FAILED = 20,
/**< Start of play device failed. */
/** Start of play device failed. */
BD_PJ_ERROR_IMAD_START_PLAY_DEV_FAILED = 21,
/**< Start of capture device failed. */
/** Start of capture device failed. */
BD_PJ_ERROR_IMAD_START_CAPTURE_DEV_FAILED = 22,
/**< Start of time process failed. */
/** Start of time process failed. */
BD_PJ_ERROR_IMAD_START_TIME_PROCESS_FAILED = 23,
/**< Start of thread process failed. */
/** Start of thread process failed. */
BD_PJ_ERROR_IMAD_THREAD_PROCESS_FAILED = 24,
/**< No volume control available. */
/** No volume control available. */
BD_PJ_ERROR_IMAD_NO_VOL_CONTROL_AVAILABLE = 25,
} bdIMADpj_Status;
@ -231,62 +233,190 @@ typedef enum bdIMADpj_Status{
* on that parameter (set and get).
*/
typedef enum bdIMADpj_Parameter{
/**< int* \n set/get \n 1 enable / 0 disable echo cancellation. */
BD_PARAM_IMAD_PJ_AEC_ENABLE = 1,
/**< int* \n set/get \n 1 enable / 0 disable microphone control
typedef enum bdIMADpj_Parameter {
/** int* \n set/get \n 1 enable / 0 disable echo cancellation. */
BD_PARAM_IMAD_PJ_AEC_ENABLE = 0,
/** int* \n set/get \n 0 -> 256 ms of echo tail. */
BD_PARAM_IMAD_PJ_AEC_ECHO_TAIL_MS = 1,
/** int* \n set/get \n 0 -> 400 ms of delay offset. */
BD_PARAM_IMAD_PJ_AEC_DELAY_OFFSET_MS = 2,
/** int* \n set/get \n 1 enable / 0 disable automatic delay estimation. */
BD_PARAM_IMAD_PJ_AEC_AUTO_DELAY_ESTIMATION_ENABLE = 3,
/** int* \n get \n estimated delay in ms. */
BD_PARAM_IMAD_PJ_AEC_AUTO_DELAY_ESTIMATION_VALUE = 4,
/** int* \n get \n 1 is stable / 0 not yet stable estimated delay. */
BD_PARAM_IMAD_PJ_AEC_AUTO_DELAY_ESTIMATION_IS_STABLE = 5,
/** int* \n set/get \n 1 enable / 0 disable Noise Reduction. */
BD_PARAM_IMAD_PJ_NR_ENABLE = 6,
/** int* \n set/get \n 0 low / 1 medium / 2 high / 3 very high / 4 adaptive level of Noise Reduction. */
BD_PARAM_IMAD_PJ_NR_LEVEL = 7,
/** int* \n set/get \n 1 enable / 0 disable Comfort Noise Generator. */
BD_PARAM_IMAD_PJ_CNG_ENABLE = 8,
/** int* \n set/get \n 1 adaptive / 0 not adaptive mode of Comfort Noise Generator. */
BD_PARAM_IMAD_PJ_CNG_SET_ADAPTIVE = 9,
/** int* \n set/get \n -40 -> -100 dBFS fixed power level of Comfort Noise Generator, when adaptive mode is disabled. */
BD_PARAM_IMAD_PJ_CNG_FIXED_LEVEL_DB = 10,
/** int* \n set/get \n 0 minimal / 1 low / 2 intermediate / 3 high / 4 aggressive effort level of Residual Echo Canceller. */
BD_PARAM_IMAD_PJ_REC_EFFORT_LEVEL = 11,
/** int* \n set/get \n 1 enable / 0 disable Non Linear Processor. */
BD_PARAM_IMAD_PJ_NLP_ENABLE = 12,
/** float* \n set/get \n 6.0f -> 24.0f dB Double Talk Detector sensitivity. */
BD_PARAM_IMAD_PJ_NLP_DTD_SENSITIVITY = 13,
/** float* \n set/get \n -50.0f -> 0.0f dB maximum applicable gain by the Non Linear Processor. */
BD_PARAM_IMAD_PJ_NLP_GAIN = 14,
/** int* \n set/get \n 1 enable / 0 disable microphone control
* (when possible). */
BD_PARAM_IMAD_PJ_MIC_CONTROL_ENABLE = 2,
/**< int* \n set/get \n 1 ebable / 0 disable noise reduction. */
BD_PARAM_IMAD_PJ_NOISE_REDUCTION_ENABLE = 3,
/**< int* \n set \n number of channel to reset. Used to reset
* the input channel statistics. To be used when the same channel
* is assigned to another partecipant. */
BD_PARAM_IMAD_PJ_RESET_STATISTIC_IN_CH = 4,
/**< float* \n set/get \n 0.0f -> 1.0f volume of
BD_PARAM_IMAD_PJ_MIC_CONTROL_ENABLE = 15,
/** float* \n set/get \n 0.0f -> 1.0f volume of
* the microphone(when possible). */
BD_PARAM_IMAD_PJ_MIC_VOLUME = 5,
/**< int* \n set/get \n 0 mute / 1 not mute on microphone
BD_PARAM_IMAD_PJ_MIC_VOLUME = 16,
/** int* \n set/get \n 0 mute / 1 not mute on microphone
* (when possible). */
BD_PARAM_IMAD_PJ_MIC_MUTE = 6,
/**< float* \n set/get \n 0.0f -> 1.0f volume of the speaker. */
BD_PARAM_IMAD_PJ_SPK_VOLUME = 7,
/**< int* \n set/get \n 0 mute / 1 not mute on speaker. */
BD_PARAM_IMAD_PJ_SPK_MUTE = 8,
BD_PARAM_IMAD_PJ_MIC_MUTE = 17,
/** float* \n set/get \n 0.0f -> 1.0f volume of the speaker. */
BD_PARAM_IMAD_PJ_SPK_VOLUME = 18,
/** int* \n set/get \n 0 mute / 1 not mute on speaker. */
BD_PARAM_IMAD_PJ_SPK_MUTE = 19,
} bdIMADpj_Parameter;
/**
* @brief Direction path of the parameter to be used in set and get audio process parameter functions.
*
*/
typedef enum bdIMADpj_DirPath {
/** Indicates the send direction path (microphone). */
BD_IMAD_PJ_DIR_PATH_SEND = 0,
/** Indicates the receive direction path (speaker). */
BD_IMAD_PJ_DIR_PATH_RECV = 1,
} bdIMADpj_DirPath;
/**
* @brief Audio processing parameter to pass to set and get audio processing parameter functions.
*
* For each enumeration are defined the data type and the supported operations
* on that parameter (set and get).
*/
typedef enum bdIMADpj_AudioProcessParameter {
/** int* \n set/get \n 1 enable / 0 disable whole audio processing chain. */
BD_AP_PARAM_IMAD_PJ_AUDIO_PROC_ENABLE = 200,
/** int* \n set/get \n 1 enable / 0 disable digital gain. */
BD_AP_PARAM_IMAD_PJ_GAIN_ENABLE = 201,
/** float* \n set/get \n 0.0f -> 20.0f dB digital gain value. */
BD_AP_PARAM_IMAD_PJ_GAIN_VALUE_DB = 202,
/** int* \n set/get \n 1 enable / 0 disable Automatic Gain Control. */
BD_AP_PARAM_IMAD_PJ_AGC_ENABLE = 203,
/** float* \n set/get \n 0.0f -> -30.0f dBFS target RMS power of the Automatic Gain Control. */
BD_AP_PARAM_IMAD_PJ_AGC_TARGET_RMS_DB = 204,
/** float* \n set/get \n 0.0f -> 15.0f dB maximum applicable gain by the Automatic Gain Control. */
BD_AP_PARAM_IMAD_PJ_AGC_MAX_GAIN_DB = 205,
/** int* \n set/get \n 1 enable / 0 disable Graphic Equalizer (10 bands). */
BD_AP_PARAM_IMAD_PJ_GEQ_ENABLE = 206,
/** float* \n set/get \n Graphic Equalizer (10 bands) frequencies and gains. \n
Float array of 30 elements, composed by 10 triplets (enable, frequency, gain_dB). \n
First field, enable: 1.0f enable / 0.0f disable the frequency filter. \n
Second field, frequency: 0.0f -> Fs/2 Hz centre frequency of the filter. \n
Third field, gain_dB: -18.0f -> 18.0f dB gain of the filter.
Frequency values in ascending order. \n */
BD_AP_PARAM_IMAD_PJ_GEQ_FREQ_GAIN = 207,
/** int* \n set/get \n 1 enable / 0 disable Compander. */
BD_AP_PARAM_IMAD_PJ_CMP_ENABLE = 208,
/** float* \n set/get \n 0.0f -> 5000.0f ms attack time of gain processor of the Compander. */
BD_AP_PARAM_IMAD_PJ_CMP_ATTACK_TIME_GAIN_MS = 209,
/** float* \n set/get \n 0.0f -> 5000.0f ms release time of gain processor of the Compander. */
BD_AP_PARAM_IMAD_PJ_CMP_RELEASE_TIME_GAIN_MS = 210,
/** float* \n set/get \n 0.0f -> 5000.0f ms attack time of level measurement of the Compander. */
BD_AP_PARAM_IMAD_PJ_CMP_ATTACK_TIME_LEVEL_MS = 211,
/** float* \n set/get \n 0.0f -> 5000.0f ms release time of level measurement of the Compander. */
BD_AP_PARAM_IMAD_PJ_CMP_RELEASE_TIME_LEVEL_MS = 212,
/** int* \n set/get \n 0 -> 10 ms lookahead time of the Compander. */
BD_AP_PARAM_IMAD_PJ_CMP_LOOK_AHEAD_MS = 213,
/** int* \n set/get \n 1 RMS / 0 peak detector of the Compander selected. */
BD_AP_PARAM_IMAD_PJ_CMP_RMS_DETECTOR = 214,
/** float* \n set/get \n 0.0f -> 12.0f dB compensation gain of the Compander. */
BD_AP_PARAM_IMAD_PJ_CMP_COMPENSATION_GAIN_DB = 215,
/** float* \n set/get \n Float sorted array of static gain curve points in dB - up to 4 points: input0, output0, … , input3, output3.
Gain values: 0.0f -> -100.0f dB. */
BD_AP_PARAM_IMAD_PJ_CMP_TABLE = 216,
/** int* \n set/get \n 1 enable / 0 disable Limiter. */
BD_AP_PARAM_IMAD_PJ_LIM_ENABLE = 217,
/** float* \n set/get \n 0.0f -> -40.0f dBFS threshold value of the Limiter. */
BD_AP_PARAM_IMAD_PJ_LIM_THRESHOLD = 218,
} bdIMADpj_AudioProcessParameter;
/**
* @brief Instance structure for the information regarding the aec engine.
* @brief Test signal type to be used in set and get test parameter functions.
*
*/
typedef enum bdIMADpj_TestSignalType {
/** Indicates a sine wave. */
BD_IMAD_PJ_TS_SINE = 0,
/** Indicates a White Gaussian Noise. */
BD_IMAD_PJ_TS_WGN = 1,
} bdIMADpj_TestSignalType;
/**
* @brief Test parameter to pass to set and get test parameter functions.
*
* For each enumeration are defined the data type and the supported operations
* on that parameter (set and get).
*/
typedef enum bdIMADpj_TestParameter {
/** int* \n set/get \n 1 enable / 0 disable Test Signal. */
BD_TEST_PARAM_IMAD_PJ_TEST_SIGNAL_ENABLE = 400,
/** bdIMADpj_TestSignalType* \n set/get \n Test Signal type: sine or Wgn. */
BD_TEST_PARAM_IMAD_PJ_TEST_SIGNAL_TYPE = 401,
/** int* \n set/get \n 0 -> -100 dBFS amplitude of Test Signal. */
BD_TEST_PARAM_IMAD_PJ_TEST_SIGNAL_AMPLITUDE = 402,
/** float* \n set/get \n 0 -> Fs/2 Hz frequency of sine Test Signal . */
BD_TEST_PARAM_IMAD_PJ_TEST_SIGNAL_FREQUENCY = 403,
} bdIMADpj_TestParameter;
/**
* @brief Side to be used in get VU meter level value function.
*
*/
typedef enum bdIMADpj_Side {
/** Indicates the input side of a direction path. */
BD_IMAD_PJ_SIDE_INPUT = 0,
/** Indicates the output side of a direction path. */
BD_IMAD_PJ_SIDE_OUTPUT = 1,
} bdIMADpj_Side;
/**
* @brief Instance structure for the information regarding the AEC engine.
*/
typedef struct bdIMADpj_Setting_t{
/**< Sample frequency (8kHz or 16kHz). */
typedef struct bdIMADpj_Setting_t {
/** Sample frequency (8kHz - 16kHz - 32kHz - 44.1kHz - 48kHz). */
int SamplingFrequency;
/**< Audio buffer managed by the aec bdIMAD functions.
/** Audio buffer managed by the AEC bdIMAD functions.
* (from 16ms to 80ms, 16ms recommended). */
int FrameSize_ms;
/**< Points to the validation functions in the validation library. */
/** Pointer to the validation functions in the validation library. */
void *validate;
/**< Points to the the callback function used for filling
/** Pointer to the the callback function used for filling
* the playback buffer of bdIMAD. */
cb_fillPlayBackB_t cb_fillPlayBackBuffer;
/**< Points to user data to pass to the callback. */
/** Pointer to user data to pass to the callback (playback). */
void *cb_fillPlayBackBuffer_user_data;
/**< Points to the callback function used for retreive the processed
/** Pointer to the callback function used for retrieve the processed
* audio present in the capture buffer of bdIMAD. */
cb_emptyCaptureB_t cb_emptyCaptureBuffer;
/**< Points to user data to pass to the callback. */
/** Pointer to user data to pass to the callback (capture). */
void *cb_emptyCaptureBuffer_user_data;
/**< Is a wide char pointer to the capture device name. */
/** Is a wide char pointer to the capture device name. */
wchar_t *CaptureDevice;
/**< Is a wide char pointer to the play device name. */
/** Is a wide char pointer to the play device name. */
wchar_t *PlayDevice;
/**< True to enable diagnostic, false to disable. */
/** True to enable diagnostic, false to disable. */
int DiagnosticEnable;
/**< Directory which will contains the files generated for diagnostic. */
/** Directory which will contains the files generated for diagnostic. */
wchar_t *DiagnosticFolderPath;
/**< Is an auxiliary settings pointer used internally by bdIMAD. */
/** Is an auxiliary settings pointer used internally by bdIMAD. */
void *bdIMADwr_SettingsData;
} bdIMADpj_Setting_t;
@ -295,35 +425,35 @@ typedef struct bdIMADpj_Setting_t{
* functions.
*/
typedef struct bdIMADpj_Warnings_t{
/**< The capture device indicated can't be opened, has been selected
* the default capture device. */
typedef struct bdIMADpj_Warnings_t {
/** The capture device indicated can't be opened, then the default capture device
* has been selected. */
int DefaultCaptureDeviceAutomaticallySelected;
/**< The capture device opened has not volume control. */
/** The capture device opened has not volume control. */
int CaptureDeviceWithoutVolumeControl;
/**< The play device indicated can't be opened, has been selected
* the default play device. */
/** The play device indicated can't be opened, then the default play device
* has been selected. */
int DefaultPlayDeviceAutomaticallySelected;
/**< The number of channel requested is out of range. The number of
* channel opened is equal to the maximum. */
/** The number of channels requested is out of range. The number of
* channels opened is equal to the maximum. */
int NumberOfChannelsOutOfRange;
/**< The diagnostic files could not be saved. */
/** The diagnostic files could not be saved. */
int DiagnosticSaveNotAllowed;
/**< The nlp level requested is not allowed, it has been automatically
* changed to the default value. */
/** The nlp level requested is not allowed, it has been automatically
* changed to the default value. */
int nlpLevelChangeSettting;
/**< No capture device is present. Anyway the bdSES has been
* istantiated only for playback. */
/** No capture device is present. Anyway the bdSES has been instantiated
* only for playback. */
int NoCaptureDevicePresent;
/**< The cpu is not adapt to run the aec engine, the aec has been disabled.
* This appens for very old cpu like pentium III. */
/** The CPU is not adapt to run the AEC engine, the AEC has been disabled.
* This happens for very old CPU like pentium III. */
int oldCPUdetected_AECdisable;
/**< Windows Direct Sound error. */
/** Windows Direct Sound error. */
long directSoundError;
/**< Windows Direct Sound volume error. */
/** Windows Direct Sound volume error. */
long directSoundLevel;
/**< No play device is present. Anyway the bdSES has been istantiated
* only for capture. */
/** No play device is present. Anyway the bdSES has been instantiated
* only for capture. */
int NoPlayDevicePresent;
} bdIMADpj_Warnings_t;
@ -331,7 +461,7 @@ typedef struct bdIMADpj_Warnings_t{
* @brief Instance structure for the library version
*/
typedef struct bdIMADpj_libVersion_t{
typedef struct bdIMADpj_libVersion_t {
int major; /**< major version. */
int minor; /**< minor version. */
int build; /**< build number. */
@ -344,15 +474,15 @@ typedef struct bdIMADpj_libVersion_t{
/**
* @brief Audio output routing setting to pass to set and get route output device functions.
*/
typedef enum bdIMADpj_out_dev_route{
/** Default route. */
BD_AUD_DEV_ROUTE_DEFAULT = 0,
typedef enum bdIMADpj_out_dev_route {
/** Default route */
BD_AUD_DEV_ROUTE_DEFAULT = 0,
/** Route to loudspeaker */
BD_AUD_DEV_ROUTE_LOUDSPEAKER = 1,
BD_AUD_DEV_ROUTE_LOUDSPEAKER = 1,
/** Route to earpiece */
BD_AUD_DEV_ROUTE_EARPIECE = 2
BD_AUD_DEV_ROUTE_EARPIECE = 2
}bdIMADpj_out_dev_route;
@ -375,19 +505,22 @@ extern "C" {
* @brief Must be used to allocate and set to default parameter the memory
* for the bdIMAD.
*
* The function generate a structure bdIMADpj_Setting_t filled with the
* The function generates a structure bdIMADpj_Setting_t filled with the
* default settings.
* \n The user can change this settings according to the need and then
* launch the ::bdIMADpj_InitAEC.
* \n The function generate also a warning structure (::bdIMADpj_Warnings_t)
* \n The function generates also a warning structure (::bdIMADpj_Warnings_t)
* that could be used in ::bdIMADpj_InitAEC to handle eventual warnings.
* @param[out] **ppSettings Points to the pointer of the
* allocated ::bdIMADpj_Setting_t.
* @param[out] **ppWarningMessages Points to the pointer of the
* allocated ::bdIMADpj_Warnings_t.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*
* @param[out] **ppSettings Pointer to the pointer of the
* allocated ::bdIMADpj_Setting_t.
*
* @param[out] **ppWarningMessages Pointer to the pointer of the
* allocated ::bdIMADpj_Warnings_t.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_CreateStructures(
bdIMADpj_Setting_t **ppSettings,
@ -397,17 +530,19 @@ BDIMADPJ_API bdIMADpj_Status bdIMADpj_CreateStructures(
* @brief Is used to free the memory for the ::bdIMADpj_Setting_t structure and
* ::bdIMADpj_Warnings_t structure allocated with
* the ::bdIMADpj_CreateStructures.
* @param[in] **ppSettings Pointer to a memory location filled
* with the address of the
* ::bdIMADpj_Setting_t structure to free.
* This address will be set to NULL.
* @param[in] **ppWarningMessages Pointer to a memory location filled
* with the address of the allocated
* ::bdIMADpj_Warnings_t structure to free.
* This address will be set to NULL.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
* @param[in] **ppSettings Pointer to a memory location filled
* with the address of the
* ::bdIMADpj_Setting_t structure to free.
* This address will be set to NULL.
*
* @param[in] **ppWarningMessages Pointer to a memory location filled
* with the address of the allocated
* ::bdIMADpj_Warnings_t structure to free.
* This address will be set to NULL.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_FreeStructures(
bdIMADpj_Setting_t **ppSettings,
@ -416,28 +551,32 @@ BDIMADPJ_API bdIMADpj_Status bdIMADpj_FreeStructures(
/**
* @brief Is used to initialize the memory for bdIMAD with the settings
* contained in the <code>ppSettings</code>.
* @param[out] *pBdIMADInstance Is the pointer to the bdIMAD object.
* @param[in] **ppSettings Pointer to pointer to a
* ::bdIMADpj_Setting_t structure, filled
* with initialization settings to be
* applied to the bdIMAD.
* \n Note, the <code>pBdIMADInstance</code>
* is modified with the applied settings.
* @param[out] **ppWarningMessages Pointer to pointer to a
* ::bdIMADpj_Warnings_t structure,
* which reports the warnings after the
* initialization.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
* \n If the error is
* ::BD_PJ_WARN_BDIMAD_WARNING_ASSERTED
* the init has been performed with success,
* but with a different settings
* respect to the ones required.
* This mainly happens if the audio
* device opened is different to the
* one requested.
*
* @param[out] *pBdIMADInstance Is the pointer to the bdIMAD object.
*
* @param[in] **ppSettings Pointer to pointer to a
* ::bdIMADpj_Setting_t structure, filled
* with initialization settings to be
* applied to the bdIMAD.
* \n Note, the <code>pBdIMADInstance</code>
* is modified with the applied settings.
*
* @param[out] **ppWarningMessages Pointer to pointer to a
* ::bdIMADpj_Warnings_t structure,
* which reports the warnings after the
* initialization.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
* \n If the error is
* ::BD_PJ_WARN_BDIMAD_WARNING_ASSERTED
* the init function has been performed with success,
* but with a different settings
* respect to the ones required.
* This mainly happens if the audio
* device opened is different to the
* one requested.
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_InitAEC(bdIMADpj *pBdIMADInstance,
bdIMADpj_Setting_t **ppSettings,
@ -446,25 +585,30 @@ BDIMADPJ_API bdIMADpj_Status bdIMADpj_InitAEC(bdIMADpj *pBdIMADInstance,
/**
* @brief Is used to free the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
* @param[in] *pBdIMADInstance Pointer to the bdIMAD object to free.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*
* @param[in] *pBdIMADInstance Pointer to the bdIMAD object to free.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_FreeAEC(bdIMADpj *pBdIMADInstance);
/**
* @brief Is used to make a list of capure and play devices available
* @brief Is used to make a list of capture and play devices available
* on the system.
* @param[in] captureDevice Set to 1 to get the list of capture
* devices. Set to 0 to get the list of
* play devices.
* @param[in] **deviceName Pointer to pointer to a wide char
* containing the names of capture/play
* devices.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*
* @param[in] captureDevice Set to 1 to get the list of capture
* devices. Set to 0 to get the list of
* play devices.
*
* @param[in] **deviceName Pointer to pointer to a wide char
* containing the names of capture/play
* devices.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_getDeviceName(int captureDevice,
wchar_t **deviceName);
@ -472,11 +616,12 @@ BDIMADPJ_API bdIMADpj_Status bdIMADpj_getDeviceName(int captureDevice,
/**
* @brief Is used to freeze the bdIMAD, stopping the audio playback
* and recording.
* @param[in] bdIMADInstance bdIMAD object.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise
* return an error (refer to
* ::bdIMADpj_Status).
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_stop(bdIMADpj bdIMADInstance);
@ -493,24 +638,26 @@ BDIMADPJ_API bdIMADpj_Status bdIMADpj_run(bdIMADpj bdIMADInstance);
/**
* @brief Print on a standard output the warning messages.
* @param[in] *pWarningMessages Pointer to the warning structure
* to be printed.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise
* return an error
* (refer to ::bdIMADpj_Status).
*
* @param[in] *pWarningMessages Pointer to the warning structure
* to be printed.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_DisplayWarnings(
bdIMADpj_Warnings_t *pWarningMessages);
/**
* @brief Clear the warning structure after being read.
* @param[out] **ppWarningMessages Pointer to pointer to the warning
* structure to be cleared.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise
* return an error (refer to
* ::bdIMADpj_Status).
*
* @param[out] **ppWarningMessages Pointer to pointer to the warning
* structure to be cleared.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_ClearAllWarnings(
bdIMADpj_Warnings_t **ppWarningMessages);
@ -518,18 +665,20 @@ BDIMADPJ_API bdIMADpj_Status bdIMADpj_ClearAllWarnings(
/**
* @brief Is used to set a parameter of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
* @param[in] bdIMADInstance bdIMAD object.
* @param[in] parameterName Indicate the parameter to set.
* @param[in] *pValue Is a pointer to the value to set
* cast to void.
* \n In the ::bdIMADpj_Parameter
* declaration is indicated the real type of
* the value, depending on the
* <code>parameterName</code>.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise
* return an error (refer to
* <EFBFBD>::bdIMADpj_Status).
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @param[in] parameterName Indicates the parameter to be set.
*
* @param[in] *pValue Is a pointer to the value to be set.
* \n In the ::bdIMADpj_Parameter
* declaration is indicated the type of
* the value, depending on the
* <code>parameterName</code>.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_setParameter(bdIMADpj bdIMADInstance,
bdIMADpj_Parameter parameterName, void *pValue);
@ -537,47 +686,214 @@ BDIMADPJ_API bdIMADpj_Status bdIMADpj_setParameter(bdIMADpj bdIMADInstance,
/**
* @brief Is used to get a parameter of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
* @param[in] bdIMADInstance bdIMAD object.
* @param[in] parameterName Indicate the parameter to get.
* @param[out] *pValue Is a pointer to the value to get cast
* to void. \n In the
* ::bdIMADpj_Parameter declaration is
* indicated the real type of the value,
* depending on the
* <code>parameterName</code>.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @param[in] parameterName Indicates the parameter to be get.
*
* @param[out] *pValue Is a pointer to the value to be get.
* \n In the ::bdIMADpj_Parameter
* declaration is indicated the type of
* the value, depending on the
* <code>parameterName</code>.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_getParameter(bdIMADpj bdIMADInstance,
bdIMADpj_Parameter parameterName, void *pValue);
/**
* @brief Is used to set an audio processing parameter of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @param[in] parameterName Indicates the parameter to be set.
*
* @param[in] directionPath Indicates the send/receive direction path.
* The parameter will be set to the audio process block
* located in the selected path.
*
* @param[in] *pValue Is a pointer to the value to be set.
* \n In the ::bdIMADpj_AudioProcessParameter
* declaration is indicated the real type of
* the value, depending on the
* <code>parameterName</code>.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_setAudioProcessParameter(bdIMADpj bdIMADInstance,
bdIMADpj_AudioProcessParameter parameterName, bdIMADpj_DirPath directionPath, void *pValue);
/**
* @brief Is used to get an audio processing parameter of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @param[in] parameterName Indicates the parameter to be get.
*
* @param[in] directionPath Indicates the send/receive direction path.
* The parameter will be get from the audio process block
* located in the selected path.
*
* @param[out] *pValue Is a pointer to the value to be get.
* \n In the ::bdIMADpj_AudioProcessParameter
* declaration is indicated the real type of
* the value, depending on the
* <code>parameterName</code>.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_getAudioProcessParameter(bdIMADpj bdIMADInstance,
bdIMADpj_AudioProcessParameter parameterName, bdIMADpj_DirPath directionPath, void *pValue);
/**
* @brief Is used to set a test parameter of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @param[in] parameterName Indicates the parameter to be set.
*
* @param[in] directionPath Indicates the send/receive direction path.
* The parameter will be set to the test generator block
* located in the selected path.
*
* @param[in] *pValue Is a pointer to the value to be set.
* \n In the ::bdIMADpj_TestParameter
* declaration is indicated the real type of
* the value, depending on the
* <code>parameterName</code>.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_setTestParameter(bdIMADpj bdIMADInstance, bdIMADpj_TestParameter parameterName, bdIMADpj_DirPath directionPath, void* pValue);
/**
* @brief Is used to get a test parameter of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @param[in] parameterName Indicates the parameter to be get.
*
* @param[in] directionPath Indicates the send/receive direction path.
* The parameter will be get from the test generator block
* located in the selected path.
*
* @param[out] *pValue Is a pointer to the value to be get.
* \n In the ::bdIMADpj_TestParameter
* declaration is indicated the real type of
* the value, depending on the
* <code>parameterName</code>.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_getTestParameter(bdIMADpj bdIMADInstance, bdIMADpj_TestParameter parameterName, bdIMADpj_DirPath directionPath, void* pValue);
/**
* @brief Is used to get the VU meter level value located at the input/output
* of the send/receive path of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @param[in] directionPath Indicates the send/receive direction path.
* The level value will be get from
* the VU meter located in the selected path.
*
* @param[in] side Indicates the input/output side.
* The level value will be get from
* the VU meter located at the selected
* side of the selected path.
*
* @param[out] *pValue Is a pointer to the float level value to be get.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_getVuMeterLevelValue(bdIMADpj bdIMADInstance, bdIMADpj_DirPath directionPath, bdIMADpj_Side side, float* pValue);
/**
* @brief Is used to enable/disable socket communication with GUI of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @param[in] port Receive port number to be used for socket communication (bdController).
*
* @param[in] enable Set 1 to enable, 0 to disable the socket communication [default=disabled].
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_enableGuiSocketCommunication(bdIMADpj bdIMADInstance, int port, int enable);
/**
* @brief Is used to set the route of the output device of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
* @param[in] bdIMADInstance bdIMAD object.
* @param[in] outputRoute Indicate the route of the output device to set.
* @param[out] **ppWarningMessages Pointer to pointer to a
* ::bdIMADpj_Warnings_t structure,
* which reports the warnings after the
* set function.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @param[in] outputRoute Indicates the route of the output device to be set.
*
* @param[out] **ppWarningMessages Pointer to pointer to a
* ::bdIMADpj_Warnings_t structure,
* which reports the warnings after the
* set function.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_setRouteOutputDevice(bdIMADpj bdIMADInstance, bdIMADpj_out_dev_route outputRoute, bdIMADpj_Warnings_t **ppWarningMessages);
/**
* @brief Is used to get the route of the output device of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
* @param[in] bdIMADInstance bdIMAD object.
* @param[out] *outputRoute Is a pointer to the route of the output device currently setted.
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*
* @param[in] bdIMADInstance bdIMAD object.
*
* @param[out] *outputRoute Pointer to the route of the output device currently set.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_getRouteOutputDevice(bdIMADpj bdIMADInstance, bdIMADpj_out_dev_route *outputRoute);
/**
* @brief Is used to get the device capabilities of capture/playback device of the bdIMAD object pointed by the
* <code>pBdIMADInstance</code>.
*
* @param[in] captureDevice Set to 1 to get the capabilities of capture
* devices. Set to 0 to get the capabilities of
* play devices.
*
* @caps[out] *caps Is a pointer to the device capabilities,
* as bitmask combination of #pjmedia_aud_dev_cap.
*
* @return ::BD_PJ_OK if the function has been
* performed successfully, otherwise return
* an error (refer to ::bdIMADpj_Status).
*/
BDIMADPJ_API bdIMADpj_Status bdIMADpj_getDeviceCapabilities(int captureDevice, unsigned *caps);
#ifdef __cplusplus
}
#endif