Open Reality Reference Guide
fbaudiofmt.h
Go to the documentation of this file.
1 #ifndef __FBAUDIOFMT_H__
2 #define __FBAUDIOFMT_H__
3 /**************************************************************************
4  Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
5  All Rights Reserved.
6 
7  The coded instructions, statements, computer programs, and/or related
8  material (collectively the "Data") in these files contain unpublished
9  information proprietary to Autodesk, Inc. and/or its licensors, which is
10  protected by Canada and United States of America federal copyright law
11  and by international treaties.
12 
13  The Data may not be disclosed or distributed to third parties, in whole
14  or in part, without the prior written consent of Autodesk, Inc.
15  ("Autodesk").
16 
17  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
18  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
19  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR
20  ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES
21  OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
22  PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT
23  WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR
24  FREE.
25 
26  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
27  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR
28  EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE
29  DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS
30  OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR
31  DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF
32  LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT
33  LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE
34  DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS
35  BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
36 
37 **************************************************************************/
38 
43 #include <kaydaradef.h>
44 #ifndef FBSDK_DLL
48  #define FBSDK_DLL K_DLLIMPORT
49 #endif
50 
51 #include <fbsdk/fbtypes.h>
52 
56 typedef int FBAudioFmt;
57 
58 #ifdef FBSDKUseNamespace
59  namespace FBSDKNamespace {
60 #endif
61 
68 };
75 };
94 };
95 
100 
137 FBSDK_DLL FBAudioFmt FBAudioFmt_AppendFormat(FBAudioFmt pFormat, int pChannels, int pBits, int pRate);
138 
145 
153 FBSDK_DLL FBAudioFmt FBAudioFmt_RemoveFormat(FBAudioFmt pFormat, int pChannels, int pBits, int pRate);
154 
161 
167 
173 
179 
185 
193 FBSDK_DLL bool FBAudioFmt_TestFormat(const FBAudioFmt pSrcFormat, int pChannels, int pBits, int pRate);
194 
200 
206 
212 
213 #ifdef FBSDKUseNamespace
214  }
215 #endif
216 #endif /* this must be the last line of this file */
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
Definition: fbaudiofmt.h:48
K_DLLIMPORT int FBAudioFmt_GetBytesValue(FBAudioFmt pFormat)
Get the bytes value of the Audio format object.
int FBAudioFmt
Definition: fbaudiofmt.h:56
K_DLLIMPORT FBAudioFmt FBAudioFmt_ConvertRateMode(FBAudioRateMode pRateMode)
Converts an FBAudioRateMode enum value to its FBAudioFmt object equivalent.
FBAudioBitDepthMode
Enum FBAudioBitDepthMode.
Definition: fbaudiofmt.h:70
@ kFBAudioBitDepthMode_8
8 bits, Wave file render support.
Definition: fbaudiofmt.h:71
@ kFBAudioBitDepthMode_24
24 bits, Wave file render support.
Definition: fbaudiofmt.h:73
@ kFBAudioBitDepthMode_16
16 bits, Wave file render support.
Definition: fbaudiofmt.h:72
@ kFBAudioBitDepthMode_FP
FP type audio, Wave file render not support.
Definition: fbaudiofmt.h:74
K_DLLIMPORT int FBAudioFmt_GetChannelValue(FBAudioFmt pFormat)
Get the channel value of the Audio format object.
K_DLLIMPORT bool FBAudioFmt_TestFormat(const FBAudioFmt pSrcFormat, int pChannels, int pBits, int pRate)
Test if the given audio format object contains the channel, bit depth, and rate.
K_DLLIMPORT FBAudioFmt FBAudioFmt_GetDefaultFormat()
Get default audio format.
K_DLLIMPORT FBAudioFmt FBAudioFmt_AppendFormat(FBAudioFmt pFormat, int pChannels, int pBits, int pRate)
Append the rendering audio format using the specified settings.
K_DLLIMPORT int FBAudioFmt_GetRateValue(FBAudioFmt pFormat)
Get the rate value of the Audio format object.
K_DLLIMPORT int FBAudioFmt_GetBitsValue(FBAudioFmt pFormat)
Get the bit depth value of the Audio format object.
FBAudioChannelMode
Enum FBAudioChannelMode.
Definition: fbaudiofmt.h:63
@ kFBAudioChannelModeStereo
2 channels, Wave file render support.
Definition: fbaudiofmt.h:65
@ kFBAudioChannelModeMono
1 channel, Wave file render support.
Definition: fbaudiofmt.h:64
@ kFBAudioChannelMode_8
8 channels, Wave file render not support.
Definition: fbaudiofmt.h:67
@ kFBAudioChannelMode_4
4 channels, Wave file render not support.
Definition: fbaudiofmt.h:66
K_DLLIMPORT FBAudioFmt FBAudioFmt_RemoveFormat(FBAudioFmt pFormat, int pChannels, int pBits, int pRate)
Remove channels, bit depth, or rate from the specified audio format object.
K_DLLIMPORT FBAudioFmt FBAudioFmt_ConvertChannelMode(FBAudioChannelMode pChannelMode)
Converts an FBAudioChannelMode enum value to its FBAudioFmt object equivalent.
FBAudioRateMode
Enum FBAudioRateMode.
Definition: fbaudiofmt.h:77
@ kFBAudioRateMode_24000
24000 hz, Wave file render support.
Definition: fbaudiofmt.h:84
@ kFBAudioRateMode_64000
64000 hz, Wave file render support.
Definition: fbaudiofmt.h:90
@ kFBAudioRateMode_100000
100000 hz, Wave file render not support.
Definition: fbaudiofmt.h:93
@ kFBAudioRateMode_50000
50000 hz, Wave file render not support.
Definition: fbaudiofmt.h:89
@ kFBAudioRateMode_32000
32000 hz, Wave file render support.
Definition: fbaudiofmt.h:86
@ kFBRAudioateMode_11025
11025 hz, Wave file render support.
Definition: fbaudiofmt.h:79
@ kFBAudioRateMode_88200
88200 hz, Wave file render support.
Definition: fbaudiofmt.h:91
@ kFBAudioRateMode_96000
96000 hz, Wave file render support.
Definition: fbaudiofmt.h:92
@ kFBAudioRateMode_44100
44100 hz, Wave file render support.
Definition: fbaudiofmt.h:87
@ kFBAudioRateMode_22050
22050 hz, Wave file render support.
Definition: fbaudiofmt.h:83
@ kFBAudioRateMode_25000
25000 hz, Wave file render not support.
Definition: fbaudiofmt.h:85
@ kFBAudioRateMode_12000
12000 hz, Wave file render support.
Definition: fbaudiofmt.h:80
@ kFBAudioRateMode_48000
48000 hz, Wave file render support.
Definition: fbaudiofmt.h:88
@ kFBAudioRateMode_16000
16000 hz, Wave file render support.
Definition: fbaudiofmt.h:82
@ kFBAudioRateMode_8000
8000 hz, Wave file render support.
Definition: fbaudiofmt.h:78
@ kFBAudioRateMode_12500
12500 hz, Wave file render not support.
Definition: fbaudiofmt.h:81
K_DLLIMPORT FBAudioFmt FBAudioFmt_ConvertBitDepthMode(FBAudioBitDepthMode pBitDepthMode)
Converts an FBAudioBitDepthMode enum value to its FBAudioFmt object equivalent.
Types & macros.