SlimDXc_Jun2010(VC++2008)/source/directsound/CapabilitiesDS.h

   1 /*\r
   2 * Copyright (c) 2007-2010 SlimDX Group\r
   3 * \r
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy\r
   5 * of this software and associated documentation files (the "Software"), to deal\r
   6 * in the Software without restriction, including without limitation the rights\r
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
   8 * copies of the Software, and to permit persons to whom the Software is\r
   9 * furnished to do so, subject to the following conditions:\r
  10 * \r
  11 * The above copyright notice and this permission notice shall be included in\r
  12 * all copies or substantial portions of the Software.\r
  13 * \r
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  20 * THE SOFTWARE.\r
  21 */\r
  22 #pragma once\r
  23 \r
  24 namespace SlimDX\r
  25 {\r
  26         namespace DirectSound\r
  27         {\r
  28                 /// <summary>\r
  29                 /// Describes the capabilities of a DirectSound device.\r
  30                 /// </summary>\r
  31                 /// <unmanaged>DSCAPS</unmanaged>\r
  32                 public ref class Capabilities\r
  33                 {\r
  34                 internal:\r
  35                         Capabilities( const DSCAPS& caps );\r
  36 \r
  37                 public:\r
  38                         /// <summary>\r
  39                         /// The driver has been tested and certified by Microsoft. This flag is always set for WDM drivers.\r
  40                         /// </summary>\r
  41                         property bool Certified;\r
  42 \r
  43                         /// <summary>\r
  44                         /// The device supports all sample rates between the MinSecondarySampleRate and MaxSecondarySampleRate member values. Typically, this means that the actual output rate will be within +/- 10 hertz (Hz) of the requested frequency.\r
  45                         /// </summary>\r
  46                         property bool ContinuousRate;\r
  47 \r
  48                         /// <summary>\r
  49                         /// The device does not have a DirectSound driver installed, so it is being emulated through the waveform-audio functions. Performance degradation should be expected.\r
  50                         /// </summary>\r
  51                         property bool EmulatedDriver;\r
  52 \r
  53                         /// <summary>\r
  54                         /// Number of unallocated 3-D buffers.\r
  55                         /// </summary>\r
  56                         property int FreeHardware3DAllBuffers;\r
  57 \r
  58                         /// <summary>\r
  59                         /// Number of unallocated static 3-D buffers.\r
  60                         /// </summary>\r
  61                         property int FreeHardware3DStaticBuffers;\r
  62 \r
  63                         /// <summary>\r
  64                         /// Number of unallocated streaming 3-D buffers.\r
  65                         /// </summary>\r
  66                         property int FreeHardware3DStreamingBuffers;\r
  67 \r
  68                         /// <summary>\r
  69                         /// Size, in bytes, of the free memory on the sound card.\r
  70                         /// </summary>\r
  71                         property int FreeHardwareMemory;\r
  72 \r
  73                         /// <summary>\r
  74                         /// Number of unallocated buffers. On WDM drivers, this includes FreeHardware3DAllBuffers.\r
  75                         /// </summary>\r
  76                         property int FreeHardwareMixingAllBuffers;\r
  77 \r
  78                         /// <summary>\r
  79                         /// Number of unallocated static buffers.\r
  80                         /// </summary>\r
  81                         property int FreeHardwareMixingStaticBuffers;\r
  82 \r
  83                         /// <summary>\r
  84                         /// Number of unallocated streaming buffers.\r
  85                         /// </summary>\r
  86                         property int FreeHardwareMixingStreamingBuffers;\r
  87 \r
  88                         /// <summary>\r
  89                         /// Size, in bytes, of the largest contiguous block of free memory on the sound card.\r
  90                         /// </summary>\r
  91                         property int MaxContiguousFreeHardwareMemoryBytes;\r
  92 \r
  93                         /// <summary>\r
  94                         /// Maximum number of 3-D buffers.\r
  95                         /// </summary>\r
  96                         property int MaxHardware3DAllBuffers;\r
  97 \r
  98                         /// <summary>\r
  99                         /// Maximum number of static 3-D buffers.\r
 100                         /// </summary>\r
 101                         property int MaxHardware3DStaticBuffers;\r
 102 \r
 103                         /// <summary>\r
 104                         /// Maximum number of streaming 3-D buffers.\r
 105                         /// </summary>\r
 106                         property int MaxHardware3DStreamingBuffers;\r
 107 \r
 108                         /// <summary>\r
 109                         /// Number of buffers that can be mixed in hardware. This member can be less than the sum of MaxHardwareMixingStaticBuffers and MaxHardwareMixingStreamingBuffers. Resource tradeoffs frequently occur.\r
 110                         /// </summary>\r
 111                         property int MaxHardwareMixingAllBuffers;\r
 112 \r
 113                         /// <summary>\r
 114                         /// Maximum number of static buffers.\r
 115                         /// </summary>\r
 116                         property int MaxHardwareMixingStaticBuffers;\r
 117 \r
 118                         /// <summary>\r
 119                         /// Maximum number of streaming sound buffers.\r
 120                         /// </summary>\r
 121                         property int MaxHardwareMixingStreamingBuffers;\r
 122 \r
 123                         /// <summary>\r
 124                         /// Maximum sample rate specifications that are supported by this device's hardware secondary sound buffers.\r
 125                         /// </summary>\r
 126                         property int MaxSecondarySampleRate;\r
 127 \r
 128                         /// <summary>\r
 129                         /// Minimum sample rate specifications that are supported by this device's hardware secondary sound buffers.\r
 130                         /// </summary>\r
 131                         property int MinSecondarySampleRate;\r
 132 \r
 133                         /// <summary>\r
 134                         /// The processing overhead, as a percentage of main processor cycles, needed to mix software buffers. This varies according to the bus type, the processor type, and the clock speed.\r
 135                         /// </summary>\r
 136                         property int PlayCpuOverheadSoftwareBuffers;\r
 137 \r
 138                         /// <summary>\r
 139                         /// The device supports a primary buffer with 16-bit samples.\r
 140                         /// </summary>\r
 141                         property bool Primary16Bit;\r
 142 \r
 143                         /// <summary>\r
 144                         /// The device supports primary buffers with 8-bit samples.\r
 145                         /// </summary>\r
 146                         property bool Primary8Bit;\r
 147 \r
 148                         /// <summary>\r
 149                         /// Number of primary buffers supported. This value will always be 1.\r
 150                         /// </summary>\r
 151                         property int PrimaryBuffers;\r
 152 \r
 153                         /// <summary>\r
 154                         /// The device supports monophonic primary buffers.\r
 155                         /// </summary>\r
 156                         property bool PrimaryMono;\r
 157 \r
 158                         /// <summary>\r
 159                         /// The device supports stereo primary buffers.\r
 160                         /// </summary>\r
 161                         property bool PrimaryStereo;\r
 162 \r
 163                         /// <summary>\r
 164                         /// The device supports hardware-mixed secondary sound buffers with 16-bit samples.\r
 165                         /// </summary>\r
 166                         property bool Secondary16Bit;\r
 167 \r
 168                         /// <summary>\r
 169                         /// The device supports hardware-mixed secondary sound buffers with 8-bit samples.\r
 170                         /// </summary>\r
 171                         property bool Secondary8Bit;\r
 172 \r
 173                         /// <summary>\r
 174                         /// The device supports hardware-mixed monophonic secondary buffers.\r
 175                         /// </summary>\r
 176                         property bool SecondaryMono;\r
 177 \r
 178                         /// <summary>\r
 179                         /// The device supports hardware-mixed stereo secondary buffers.\r
 180                         /// </summary>\r
 181                         property bool SecondaryStereo;\r
 182 \r
 183                         /// <summary>\r
 184                         /// Size, in bytes, of the amount of memory on the sound card that stores static sound buffers.\r
 185                         /// </summary>\r
 186                         property int TotalHardwareMemory;\r
 187 \r
 188                         /// <summary>\r
 189                         /// The rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers. This and the number of bytes transferred determines the duration of a call to the Buffer.Read or Buffer.Write method.\r
 190                         /// </summary>\r
 191                         property int UnlockTransferRateHardwareBuffers;\r
 192                 };\r
 193         }\r
 194 }