Debian Codegraph @

xpp/oct612x/include/oct6100api/oct6100_channel_pub.h

raw
1 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
2
3 File: oct6100_channel_pub.h
4
5 Copyright (c) 2001-2007 Octasic Inc.
6
7 Description:
8
9 File containing all defines, macros, and structures pertaining to the file
10 oct6100_channel.c. All elements defined in this file are for public
11 usage of the API. All private elements are defined in the
12 oct6100_channel_priv.h file.
13
14 This file is part of the Octasic OCT6100 GPL API . The OCT6100 GPL API is
15 free software; you can redistribute it and/or modify it under the terms of
16 the GNU General Public License as published by the Free Software Foundation;
17 either version 2 of the License, or (at your option) any later version.
18
19 The OCT6100 GPL API is distributed in the hope that it will be useful, but
20 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
21 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with the OCT6100 GPL API; if not, write to the Free Software
26 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
27
28 $Octasic_Release: OCT612xAPI-01.00-PR49 $
29
30 $Octasic_Revision: 84 $
31
32 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
33
34 #ifndef __OCT6100_CHANNEL_PUB_H__
35 #define __OCT6100_CHANNEL_PUB_H__
36
37 /***************************** INCLUDE FILES *******************************/
38
39
40 /***************************** DEFINES *************************************/
41
42
43 /***************************** TYPES ***************************************/
44
45 /* Channel open structures. */
46 typedef struct _OCT6100_CHANNEL_OPEN_TDM_
47 {
48 UINT32 ulRinNumTssts;
49 UINT32 ulSinNumTssts;
50 UINT32 ulRoutNumTssts;
51 UINT32 ulSoutNumTssts;
52
53 UINT32 ulSinTimeslot;
54 UINT32 ulSinStream;
55 UINT32 ulSinPcmLaw;
56
57 UINT32 ulSoutTimeslot;
58 UINT32 ulSoutStream;
59 UINT32 ulSoutPcmLaw;
60
61 UINT32 ulRinTimeslot;
62 UINT32 ulRinStream;
63 UINT32 ulRinPcmLaw;
64
65 UINT32 ulRoutTimeslot;
66 UINT32 ulRoutStream;
67 UINT32 ulRoutPcmLaw;
68
69 } tOCT6100_CHANNEL_OPEN_TDM, *tPOCT6100_CHANNEL_OPEN_TDM;
70
71 typedef struct _OCT6100_CHANNEL_OPEN_VQE_
72 {
73 BOOL fEnableNlp;
74 BOOL fEnableTailDisplacement;
75 UINT32 ulTailDisplacement;
76 UINT32 ulTailLength;
77
78 BOOL fSinDcOffsetRemoval;
79 BOOL fRinDcOffsetRemoval;
80 BOOL fRinLevelControl;
81 BOOL fSoutLevelControl;
82 BOOL fRinAutomaticLevelControl;
83 BOOL fSoutAutomaticLevelControl;
84 BOOL fRinHighLevelCompensation;
85 BOOL fAcousticEcho;
86 BOOL fSoutAdaptiveNoiseReduction;
87 BOOL fDtmfToneRemoval;
88
89 BOOL fSoutNoiseBleaching;
90 BOOL fSoutConferencingNoiseReduction;
91
92 UINT32 ulComfortNoiseMode;
93 UINT32 ulNonLinearityBehaviorA;
94 UINT32 ulNonLinearityBehaviorB;
95
96 INT32 lRinLevelControlGainDb;
97 INT32 lSoutLevelControlGainDb;
98 INT32 lRinAutomaticLevelControlTargetDb;
99 INT32 lSoutAutomaticLevelControlTargetDb;
100 INT32 lRinHighLevelCompensationThresholdDb;
101 INT32 lDefaultErlDb;
102 INT32 lAecDefaultErlDb;
103 UINT32 ulAecTailLength;
104 UINT32 ulSoutAutomaticListenerEnhancementGainDb;
105 UINT32 ulSoutNaturalListenerEnhancementGainDb;
106 BOOL fSoutNaturalListenerEnhancement;
107 BOOL fRoutNoiseReduction;
108 INT32 lRoutNoiseReductionLevelGainDb;
109 INT32 lAnrSnrEnhancementDb;
110 UINT32 ulAnrVoiceNoiseSegregation;
111 UINT32 ulDoubleTalkBehavior;
112
113 UINT32 ulToneDisablerVqeActivationDelay;
114
115 BOOL fEnableMusicProtection;
116 BOOL fIdleCodeDetection;
117
118
119
120 } tOCT6100_CHANNEL_OPEN_VQE, *tPOCT6100_CHANNEL_OPEN_VQE;
121
122 typedef struct _OCT6100_CHANNEL_OPEN_CODEC_
123 {
124 UINT32 ulAdpcmNibblePosition;
125
126 UINT32 ulEncoderPort;
127 UINT32 ulEncodingRate;
128
129 UINT32 ulDecoderPort;
130 UINT32 ulDecodingRate;
131
132 BOOL fEnableSilenceSuppression;
133 UINT32 ulPhase;
134 UINT32 ulPhasingType;
135 UINT32 ulPhasingTsstHndl;
136
137 } tOCT6100_CHANNEL_OPEN_CODEC, *tPOCT6100_CHANNEL_OPEN_CODEC;
138
139 typedef struct _OCT6100_CHANNEL_OPEN_
140 {
141 PUINT32 pulChannelHndl;
142 UINT32 ulUserChanId;
143
144 UINT32 ulEchoOperationMode;
145
146 BOOL fEnableToneDisabler;
147
148 BOOL fEnableExtToneDetection;
149
150 tOCT6100_CHANNEL_OPEN_TDM TdmConfig;
151 tOCT6100_CHANNEL_OPEN_VQE VqeConfig;
152 tOCT6100_CHANNEL_OPEN_CODEC CodecConfig;
153
154
155
156 } tOCT6100_CHANNEL_OPEN, *tPOCT6100_CHANNEL_OPEN;
157
158 /* Channel close structure. */
159 typedef struct _OCT6100_CHANNEL_CLOSE_
160 {
161 UINT32 ulChannelHndl;
162
163 } tOCT6100_CHANNEL_CLOSE, *tPOCT6100_CHANNEL_CLOSE;
164
165 /* Channel modify structures. */
166 typedef struct _OCT6100_CHANNEL_MODIFY_TDM_
167 {
168 UINT32 ulRinNumTssts;
169 UINT32 ulSinNumTssts;
170 UINT32 ulRoutNumTssts;
171 UINT32 ulSoutNumTssts;
172
173 UINT32 ulSinTimeslot;
174 UINT32 ulSinStream;
175 UINT32 ulSinPcmLaw;
176
177 UINT32 ulSoutTimeslot;
178 UINT32 ulSoutStream;
179 UINT32 ulSoutPcmLaw;
180
181 UINT32 ulRinTimeslot;
182 UINT32 ulRinStream;
183 UINT32 ulRinPcmLaw;
184
185 UINT32 ulRoutTimeslot;
186 UINT32 ulRoutStream;
187 UINT32 ulRoutPcmLaw;
188
189 } tOCT6100_CHANNEL_MODIFY_TDM, *tPOCT6100_CHANNEL_MODIFY_TDM;
190
191 typedef struct _OCT6100_CHANNEL_MODIFY_VQE_
192 {
193 BOOL fEnableNlp;
194 BOOL fEnableTailDisplacement;
195 UINT32 ulTailDisplacement;
196
197 BOOL fSinDcOffsetRemoval;
198 BOOL fRinDcOffsetRemoval;
199 BOOL fRinLevelControl;
200 BOOL fSoutLevelControl;
201 BOOL fRinAutomaticLevelControl;
202 BOOL fSoutAutomaticLevelControl;
203 BOOL fRinHighLevelCompensation;
204 BOOL fAcousticEcho;
205 BOOL fSoutAdaptiveNoiseReduction;
206 BOOL fDtmfToneRemoval;
207
208 BOOL fSoutConferencingNoiseReduction;
209 BOOL fSoutNoiseBleaching;
210
211 UINT32 ulNonLinearityBehaviorA;
212 UINT32 ulNonLinearityBehaviorB;
213 UINT32 ulComfortNoiseMode;
214
215 INT32 lRinLevelControlGainDb;
216 INT32 lSoutLevelControlGainDb;
217 INT32 lRinAutomaticLevelControlTargetDb;
218 INT32 lSoutAutomaticLevelControlTargetDb;
219 INT32 lRinHighLevelCompensationThresholdDb;
220 INT32 lDefaultErlDb;
221 INT32 lAecDefaultErlDb;
222 UINT32 ulAecTailLength;
223 UINT32 ulSoutAutomaticListenerEnhancementGainDb;
224 UINT32 ulSoutNaturalListenerEnhancementGainDb;
225 BOOL fSoutNaturalListenerEnhancement;
226 BOOL fRoutNoiseReduction;
227 INT32 lRoutNoiseReductionLevelGainDb;
228 INT32 lAnrSnrEnhancementDb;
229 UINT32 ulAnrVoiceNoiseSegregation;
230 UINT32 ulDoubleTalkBehavior;
231
232 UINT32 ulToneDisablerVqeActivationDelay;
233
234 BOOL fEnableMusicProtection;
235 BOOL fIdleCodeDetection;
236
237
238
239 } tOCT6100_CHANNEL_MODIFY_VQE, *tPOCT6100_CHANNEL_MODIFY_VQE;
240
241 typedef struct _OCT6100_CHANNEL_MODIFY_CODEC_
242 {
243 UINT32 ulEncoderPort;
244 UINT32 ulEncodingRate;
245
246 UINT32 ulDecoderPort;
247 UINT32 ulDecodingRate;
248
249 BOOL fEnableSilenceSuppression;
250 UINT32 ulPhase;
251 UINT32 ulPhasingType;
252 UINT32 ulPhasingTsstHndl;
253
254 } tOCT6100_CHANNEL_MODIFY_CODEC, *tPOCT6100_CHANNEL_MODIFY_CODEC;
255
256 typedef struct _OCT6100_CHANNEL_MODIFY_
257 {
258 UINT32 ulChannelHndl;
259 UINT32 ulUserChanId;
260 UINT32 ulEchoOperationMode;
261
262 BOOL fEnableToneDisabler;
263
264 BOOL fApplyToAllChannels;
265
266 BOOL fDisableToneDetection;
267 BOOL fStopBufferPlayout;
268 BOOL fRemoveConfBridgeParticipant;
269 BOOL fRemoveBroadcastTssts;
270
271 BOOL fTdmConfigModified; /* TRUE/FALSE */
272 BOOL fVqeConfigModified; /* TRUE/FALSE */
273 BOOL fCodecConfigModified; /* TRUE/FALSE */
274
275
276 tOCT6100_CHANNEL_MODIFY_TDM TdmConfig;
277 tOCT6100_CHANNEL_MODIFY_VQE VqeConfig;
278 tOCT6100_CHANNEL_MODIFY_CODEC CodecConfig;
279
280 } tOCT6100_CHANNEL_MODIFY, *tPOCT6100_CHANNEL_MODIFY;
281
282 typedef struct _OCT6100_CHANNEL_BROADCAST_TSST_ADD_
283 {
284 UINT32 ulChannelHndl;
285
286 UINT32 ulPort;
287 UINT32 ulTimeslot;
288 UINT32 ulStream;
289
290 } tOCT6100_CHANNEL_BROADCAST_TSST_ADD, *tPOCT6100_CHANNEL_BROADCAST_TSST_ADD;
291
292 typedef struct _OCT6100_CHANNEL_BROADCAST_TSST_REMOVE_
293 {
294 UINT32 ulChannelHndl;
295
296 UINT32 ulPort;
297 UINT32 ulTimeslot;
298 UINT32 ulStream;
299
300 BOOL fRemoveAll;
301
302 } tOCT6100_CHANNEL_BROADCAST_TSST_REMOVE, *tPOCT6100_CHANNEL_BROADCAST_TSST_REMOVE;
303
304 /* Channel open structures.*/
305 typedef struct _OCT6100_CHANNEL_STATS_TDM_
306 {
307 UINT32 ulMaxBroadcastTssts;
308 UINT32 ulNumRoutBroadcastTssts;
309 BOOL fMoreRoutBroadcastTssts;
310 UINT32 ulNumSoutBroadcastTssts;
311 BOOL fMoreSoutBroadcastTssts;
312
313 UINT32 ulSinNumTssts;
314 UINT32 ulSoutNumTssts;
315 UINT32 ulRinNumTssts;
316 UINT32 ulRoutNumTssts;
317
318 UINT32 ulSinTimeslot;
319 UINT32 ulSinStream;
320 UINT32 ulSinPcmLaw;
321
322 UINT32 ulSoutTimeslot;
323 UINT32 ulSoutStream;
324 UINT32 ulSoutPcmLaw;
325
326 PUINT32 pulSoutBroadcastTimeslot;
327 PUINT32 pulSoutBroadcastStream;
328
329 UINT32 ulRinTimeslot;
330 UINT32 ulRinStream;
331 UINT32 ulRinPcmLaw;
332
333 UINT32 ulRoutTimeslot;
334 UINT32 ulRoutStream;
335 UINT32 ulRoutPcmLaw;
336
337 PUINT32 pulRoutBroadcastTimeslot;
338 PUINT32 pulRoutBroadcastStream;
339
340 } tOCT6100_CHANNEL_STATS_TDM, *tPOCT6100_CHANNEL_STATS_TDM;
341
342 typedef struct _OCT6100_CHANNEL_STATS_VQE_
343 {
344 BOOL fEnableNlp;
345 BOOL fEnableTailDisplacement;
346 UINT32 ulTailDisplacement;
347 UINT32 ulTailLength;
348
349 BOOL fSinDcOffsetRemoval;
350 BOOL fRinDcOffsetRemoval;
351 BOOL fRinLevelControl;
352 BOOL fSoutLevelControl;
353 BOOL fRinAutomaticLevelControl;
354 BOOL fSoutAutomaticLevelControl;
355 BOOL fRinHighLevelCompensation;
356 BOOL fAcousticEcho;
357 BOOL fSoutAdaptiveNoiseReduction;
358 BOOL fDtmfToneRemoval;
359
360 BOOL fSoutConferencingNoiseReduction;
361 BOOL fSoutNoiseBleaching;
362
363 UINT32 ulComfortNoiseMode;
364 UINT32 ulNonLinearityBehaviorA;
365 UINT32 ulNonLinearityBehaviorB;
366
367 INT32 lRinLevelControlGainDb;
368 INT32 lSoutLevelControlGainDb;
369 INT32 lRinAutomaticLevelControlTargetDb;
370 INT32 lSoutAutomaticLevelControlTargetDb;
371 INT32 lRinHighLevelCompensationThresholdDb;
372 INT32 lDefaultErlDb;
373 INT32 lAecDefaultErlDb;
374 UINT32 ulAecTailLength;
375 UINT32 ulSoutAutomaticListenerEnhancementGainDb;
376 UINT32 ulSoutNaturalListenerEnhancementGainDb;
377 BOOL fSoutNaturalListenerEnhancement;
378 BOOL fRoutNoiseReduction;
379 INT32 lRoutNoiseReductionLevelGainDb;
380 INT32 lAnrSnrEnhancementDb;
381 UINT32 ulAnrVoiceNoiseSegregation;
382 UINT32 ulDoubleTalkBehavior;
383
384 UINT32 ulToneDisablerVqeActivationDelay;
385
386 BOOL fEnableMusicProtection;
387 BOOL fIdleCodeDetection;
388
389
390
391 } tOCT6100_CHANNEL_STATS_VQE, *tPOCT6100_CHANNEL_STATS_VQE;
392
393 typedef struct _OCT6100_CHANNEL_STATS_CODEC_
394 {
395 UINT32 ulAdpcmNibblePosition;
396
397 UINT32 ulEncoderPort;
398 UINT32 ulEncodingRate;
399
400 UINT32 ulDecoderPort;
401 UINT32 ulDecodingRate;
402
403 BOOL fEnableSilenceSuppression;
404 UINT32 ulPhase;
405 UINT32 ulPhasingType;
406 UINT32 ulPhasingTsstHndl;
407
408 } tOCT6100_CHANNEL_STATS_CODEC, *tPOCT6100_CHANNEL_STATS_CODEC;
409
410 typedef struct _OCT6100_CHANNEL_STATS_
411 {
412 BOOL fResetStats;
413
414 UINT32 ulChannelHndl;
415 UINT32 ulUserChanId;
416
417 UINT32 ulEchoOperationMode;
418 BOOL fEnableToneDisabler;
419
420 UINT32 ulMutePortsMask;
421 BOOL fEnableExtToneDetection;
422
423 tOCT6100_CHANNEL_STATS_TDM TdmConfig;
424 tOCT6100_CHANNEL_STATS_VQE VqeConfig;
425 tOCT6100_CHANNEL_STATS_CODEC CodecConfig;
426
427 /* Real stats. */
428 UINT32 ulNumEchoPathChanges;
429 UINT32 ulToneDisablerStatus;
430
431 INT32 lCurrentERL;
432 INT32 lCurrentERLE;
433 UINT32 ulCurrentEchoDelay;
434
435 INT32 lMaxERL;
436 INT32 lMaxERLE;
437 UINT32 ulMaxEchoDelay;
438
439 INT32 lRinLevel;
440 INT32 lSinLevel;
441 INT32 lRinAppliedGain;
442 INT32 lSoutAppliedGain;
443 INT32 lComfortNoiseLevel;
444
445 BOOL fEchoCancellerConverged;
446 BOOL fSinVoiceDetected;
447
448
449
450 } tOCT6100_CHANNEL_STATS, *tPOCT6100_CHANNEL_STATS;
451
452 typedef struct _OCT6100_CHANNEL_CREATE_BIDIR_
453 {
454 PUINT32 pulBiDirChannelHndl;
455
456 UINT32 ulFirstChannelHndl;
457 UINT32 ulSecondChannelHndl;
458
459
460
461 } tOCT6100_CHANNEL_CREATE_BIDIR, *tPOCT6100_CHANNEL_CREATE_BIDIR;
462
463 typedef struct _OCT6100_CHANNEL_DESTROY_BIDIR_
464 {
465 UINT32 ulBiDirChannelHndl;
466
467 } tOCT6100_CHANNEL_DESTROY_BIDIR, *tPOCT6100_CHANNEL_DESTROY_BIDIR;
468
469 typedef struct _OCT6100_CHANNEL_MUTE_
470 {
471 UINT32 ulChannelHndl;
472 UINT32 ulPortMask;
473
474 } tOCT6100_CHANNEL_MUTE, *tPOCT6100_CHANNEL_MUTE;
475
476 typedef struct _OCT6100_CHANNEL_UNMUTE_
477 {
478 UINT32 ulChannelHndl;
479 UINT32 ulPortMask;
480
481 } tOCT6100_CHANNEL_UNMUTE, *tPOCT6100_CHANNEL_UNMUTE;
482
483
484 /************************** FUNCTION PROTOTYPES *****************************/
485
486
487 UINT32 Oct6100ChannelOpenDef(
488 OUT tPOCT6100_CHANNEL_OPEN f_pChannelOpen );
489 UINT32 Oct6100ChannelOpen(
490 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
491 IN OUT tPOCT6100_CHANNEL_OPEN f_pChannelOpen );
492
493 UINT32 Oct6100ChannelCloseDef(
494 OUT tPOCT6100_CHANNEL_CLOSE f_pChannelClose );
495 UINT32 Oct6100ChannelClose(
496 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
497 IN OUT tPOCT6100_CHANNEL_CLOSE f_pChannelClose );
498
499 UINT32 Oct6100ChannelModifyDef(
500 OUT tPOCT6100_CHANNEL_MODIFY f_pChannelModify );
501 UINT32 Oct6100ChannelModify(
502 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
503 IN OUT tPOCT6100_CHANNEL_MODIFY f_pChannelModify );
504
505 UINT32 Oct6100ChannelBroadcastTsstAddDef(
506 OUT tPOCT6100_CHANNEL_BROADCAST_TSST_ADD f_pChannelTsstAdd );
507 UINT32 Oct6100ChannelBroadcastTsstAdd(
508 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
509 IN OUT tPOCT6100_CHANNEL_BROADCAST_TSST_ADD f_pChannelTsstAdd );
510
511 UINT32 Oct6100ChannelBroadcastTsstRemoveDef(
512 OUT tPOCT6100_CHANNEL_BROADCAST_TSST_REMOVE f_pChannelTsstRemove );
513 UINT32 Oct6100ChannelBroadcastTsstRemove(
514 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
515 IN OUT tPOCT6100_CHANNEL_BROADCAST_TSST_REMOVE f_pChannelTsstRemove );
516
517 UINT32 Oct6100ChannelGetStatsDef(
518 OUT tPOCT6100_CHANNEL_STATS f_pChannelStats );
519 UINT32 Oct6100ChannelGetStats(
520 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
521 IN OUT tPOCT6100_CHANNEL_STATS f_pChannelStats );
522
523 UINT32 Oct6100ChannelCreateBiDirDef(
524 OUT tPOCT6100_CHANNEL_CREATE_BIDIR f_pChannelCreateBiDir );
525 UINT32 Oct6100ChannelCreateBiDir(
526 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
527 IN OUT tPOCT6100_CHANNEL_CREATE_BIDIR f_pChannelCreateBiDir );
528
529 UINT32 Oct6100ChannelDestroyBiDirDef(
530 OUT tPOCT6100_CHANNEL_DESTROY_BIDIR f_pChannelDestroyBiDir );
531 UINT32 Oct6100ChannelDestroyBiDir(
532 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
533 IN OUT tPOCT6100_CHANNEL_DESTROY_BIDIR f_pChannelDestroyBiDir );
534
535 UINT32 Oct6100ChannelMuteDef(
536 OUT tPOCT6100_CHANNEL_MUTE f_pChannelMute );
537 UINT32 Oct6100ChannelMute(
538 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
539 IN OUT tPOCT6100_CHANNEL_MUTE f_pChannelMute );
540
541 UINT32 Oct6100ChannelUnMuteDef(
542 OUT tPOCT6100_CHANNEL_UNMUTE f_pChannelUnMute );
543 UINT32 Oct6100ChannelUnMute(
544 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
545 IN OUT tPOCT6100_CHANNEL_UNMUTE f_pChannelUnMute );
546
547 #endif /* __OCT6100_CHANNEL_PUB_H__ */