include/audioclient.idl

   1 /*
   2  * Core Audio audioclient definitions
   3  *
   4  * Copyright 2009 Maarten Lankhorst
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  *
  20  */
  21
  22 import "wtypes.idl";
  23 import "unknwn.idl";
  24 import "audiosessiontypes.h";
  25
  26 /* Forward declarations */
  27 interface IAudioClient;
  28 interface IAudioRenderClient;
  29 interface IAudioCaptureClient;
  30 interface IAudioClock;
  31 interface IAudioClock2;
  32 interface IAudioClockAdjustment;
  33 interface ISimpleAudioVolume;
  34 interface IAudioStreamVolume;
  35 interface IChannelAudioVolume;
  36
  37 cpp_quote("#if 0")
  38 typedef struct WAVEFORMATEX /*[hidden,restricted]*/
  39 {
  40     WORD wFormatTag;
  41     WORD nChannels;
  42     DWORD nSamplesPerSec;
  43     DWORD nAvgBytesPerSec;
  44     WORD nBlockAlign;
  45     WORD wBitsPerSample;
  46     WORD cbSize;
  47 } WAVEFORMATEX;
  48 cpp_quote("#else")
  49 cpp_quote("#include <mmreg.h>")
  50 cpp_quote("#endif")
  51
  52 cpp_quote("#if 0")
  53 typedef LONGLONG /*[hidden,restricted]*/ REFERENCE_TIME;
  54 cpp_quote("#else")
  55 cpp_quote("#define _IKsControl_")
  56 cpp_quote("#include <ks.h>")
  57 cpp_quote("#include <ksmedia.h>")
  58 cpp_quote("#endif")
  59
  60 enum _AUDCLNT_BUFFERFLAGS
  61 {
  62     AUDCLNT_BUFFERFLAGS_DATA_DISCONTINUITY = 0x1,
  63     AUDCLNT_BUFFERFLAGS_SILENT = 0x2,
  64     AUDCLNT_BUFFERFLAGS_TIMESTAMP_ERROR = 0x4
  65 };
  66
  67 [
  68     local,
  69     pointer_default(unique),
  70     uuid(1cb9ad4c-dbfa-4c32-b178-c2f568a703b2),
  71     object,
  72 ]
  73 interface IAudioClient : IUnknown
  74 {
  75     HRESULT Initialize(
  76         [in] AUDCLNT_SHAREMODE ShareMode,
  77         [in] DWORD StreamFlags,
  78         [in] REFERENCE_TIME hnsBufferDuration,
  79         [in] REFERENCE_TIME hnsPeriodicity,
  80         [in] const WAVEFORMATEX *pFormat,
  81         [in] LPCGUID AudioSessionGuid
  82     );
  83     HRESULT GetBufferSize(
  84         [out] UINT32 *pNumBufferFrames
  85     );
  86     HRESULT GetStreamLatency(
  87         [out] REFERENCE_TIME *phnsLatency
  88     );
  89     HRESULT GetCurrentPadding(
  90         [out] UINT32 *pNumPaddingFrames
  91     );
  92     HRESULT IsFormatSupported(
  93         [in] AUDCLNT_SHAREMODE ShareMode,
  94         [in] const WAVEFORMATEX *pFormat,
  95         [out,unique] WAVEFORMATEX **ppClosestMatch
  96     );
  97     HRESULT GetMixFormat(
  98         [out] WAVEFORMATEX **ppDeviceFormat
  99     );
 100     HRESULT GetDevicePeriod(
 101         [out] REFERENCE_TIME *phnsDefaultDevicePeriod,
 102         [out] REFERENCE_TIME *phnsMinimumDevicePeriod
 103     );
 104     HRESULT Start(void);
 105     HRESULT Stop(void);
 106     HRESULT Reset(void);
 107     HRESULT SetEventHandle([in] HANDLE eventHandle);
 108     HRESULT GetService(
 109         [in] REFIID riid,
 110         [iid_is(riid),out] void **ppv
 111     );
 112 }
 113
 114 typedef enum _AUDCLNT_STREAMOPTIONS
 115 {
 116     AUDCLNT_STREAMOPTIONS_NONE = 0,
 117     AUDCLNT_STREAMOPTIONS_RAW = 1,
 118     AUDCLNT_STREAMOPTIONS_MATCH_FORMAT = 2,
 119 } AUDCLNT_STREAMOPTIONS;
 120
 121 typedef struct _AudioClientProperties
 122 {
 123     UINT32 cbSize;
 124     BOOL bIsOffload;
 125     AUDIO_STREAM_CATEGORY eCategory;
 126     AUDCLNT_STREAMOPTIONS Options;
 127 } AudioClientProperties;
 128
 129 typedef struct _Win8AudioClientProperties
 130 {
 131     UINT32 cbSize;
 132     BOOL bIsOffload;
 133     AUDIO_STREAM_CATEGORY eCategory;
 134     /* Options field added in Win 8.1 */
 135 } Win8AudioClientProperties;
 136
 137 [
 138     local,
 139     pointer_default(unique),
 140     uuid(726778cd-f60a-4eda-82de-e47610cd78aa),
 141     object,
 142 ]
 143 interface IAudioClient2 : IAudioClient
 144 {
 145     HRESULT IsOffloadCapable(
 146         AUDIO_STREAM_CATEGORY category,
 147         [out] BOOL *offload_capable
 148     );
 149
 150     HRESULT SetClientProperties(
 151         [in] const AudioClientProperties *prop
 152     );
 153
 154     HRESULT GetBufferSizeLimits(
 155         [in] const WAVEFORMATEX *format,
 156         BOOL event_driven,
 157         [out] REFERENCE_TIME *min_duration,
 158         [out] REFERENCE_TIME *max_duration
 159     );
 160 }
 161
 162 [
 163     local,
 164     pointer_default(unique),
 165     uuid(7ed4ee07-8e67-4cd4-8c1a-2b7a5987ad42),
 166     object,
 167 ]
 168 interface IAudioClient3 : IAudioClient2
 169 {
 170     HRESULT GetSharedModeEnginePeriod(
 171         [in] const WAVEFORMATEX *format,
 172         [out] UINT32 *default_period_frames,
 173         [out] UINT32 *unit_period_frames,
 174         [out] UINT32 *min_period_frames,
 175         [out] UINT32 *max_period_frames
 176     );
 177
 178     HRESULT GetCurrentSharedModeEnginePeriod(
 179         [out] WAVEFORMATEX **cur_format,
 180         [out] UINT32 *cur_period_frames
 181     );
 182
 183     HRESULT InitializeSharedAudioStream(
 184         [in] DWORD flags,
 185         [in] UINT32 period_frames,
 186         [in] const WAVEFORMATEX *format,
 187         [in] const GUID *session_guid
 188     );
 189 }
 190
 191 [
 192     local,
 193     pointer_default(unique),
 194     uuid(f294acfc-3146-4483-a7bf-addca7c260e2),
 195     object,
 196 ]
 197 interface IAudioRenderClient : IUnknown
 198 {
 199     HRESULT GetBuffer(
 200         [in] UINT32 NumFramesRequested,
 201         [out] BYTE **ppData
 202     );
 203     HRESULT ReleaseBuffer(
 204         [in] UINT32 NumFramesWritten,
 205         [in] DWORD dwFlags
 206     );
 207 }
 208
 209 [
 210     local,
 211     pointer_default(unique),
 212     uuid(c8adbd64-e71e-48a0-a4de-185c395cd317),
 213     object,
 214 ]
 215 interface IAudioCaptureClient : IUnknown
 216 {
 217     HRESULT GetBuffer(
 218         [out] BYTE **ppData,
 219         [out] UINT32 *pNumFramesToRead,
 220         [out] DWORD *pdwFlags,
 221         [unique,out] UINT64 *pu64DevicePosition,
 222         [unique,out] UINT64 *pu64QPCPosition
 223     );
 224     HRESULT ReleaseBuffer(
 225         [in] UINT32 NumFramesRead
 226     );
 227     HRESULT GetNextPacketSize(
 228         [out] UINT32 *pNumFramesInNextPacket
 229     );
 230 }
 231
 232 cpp_quote("#define AUDIOCLOCK_CHARACTERISTIC_FIXED_FREQ 0x00000001")
 233
 234 [
 235     local,
 236     pointer_default(unique),
 237     uuid("cd63314f-3fba-4a1b-812c-ef96358728e7"),
 238     object,
 239 ]
 240 interface IAudioClock : IUnknown
 241 {
 242     HRESULT GetFrequency(
 243         [out] UINT64 *pu64Frequency
 244     );
 245     HRESULT GetPosition(
 246         [out] UINT64 *pu64Position,
 247         [out,unique] UINT64 *pu64QPCPosition
 248     );
 249     HRESULT GetCharacteristics(
 250         [out] DWORD *pdwCharacteristics
 251     );
 252 }
 253
 254 [
 255     local,
 256     pointer_default(unique),
 257     uuid("6f49ff73-6727-49ac-a008-d98cf5e70048"),
 258     object,
 259 ]
 260 interface IAudioClock2 : IUnknown
 261 {
 262     HRESULT GetPosition(
 263         [out] UINT64 *DevicePosition,
 264         [out,unique] UINT64 *QPCPosition
 265     );
 266 }
 267
 268 [
 269     local,
 270     pointer_default(unique),
 271     uuid("f6e4c0a0-46d9-4fb8-be21-57a3ef2b626c"),
 272     object,
 273 ]
 274 interface IAudioClockAdjustment : IUnknown
 275 {
 276     HRESULT SetSampleRate(
 277         [in] float flSampleRate
 278     );
 279 }
 280
 281 [
 282     local,
 283     pointer_default(unique),
 284     uuid("87ce5498-68d6-44e5-9215-6da47ef883d8"),
 285     object,
 286 ]
 287 interface ISimpleAudioVolume : IUnknown
 288 {
 289     HRESULT SetMasterVolume(
 290         [in] float fLevel,
 291         [unique,in] LPCGUID EventContext
 292     );
 293     HRESULT GetMasterVolume(
 294         [out] float *pfLevel
 295     );
 296     HRESULT SetMute(
 297         [in] const BOOL bMute,
 298         [unique,in] LPCGUID EventContext
 299     );
 300     HRESULT GetMute(
 301         [out] BOOL *pbMute
 302     );
 303 }
 304
 305 [
 306     local,
 307     pointer_default(unique),
 308     uuid("93014887-242d-4068-8a15-cf5e93b90fe3"),
 309     object,
 310 ]
 311 interface IAudioStreamVolume : IUnknown
 312 {
 313     HRESULT GetChannelCount(
 314         [out] UINT32 *pdwCount
 315     );
 316     HRESULT SetChannelVolume(
 317         [in] UINT32 dwIndex,
 318         [in] const float fLevel
 319     );
 320     HRESULT GetChannelVolume(
 321         [in] UINT32 dwIndex,
 322         [out] float *pfLevel
 323     );
 324     HRESULT SetAllVolumes(
 325         [in] UINT32 dwCount,
 326         [size_is(dwCount),in] const float *pfVolumes
 327     );
 328     HRESULT GetAllVolumes(
 329         [in] UINT32 dwCount,
 330         [size_is(dwCount),out] float *pfVolumes
 331     );
 332 }
 333
 334 [
 335     local,
 336     pointer_default(unique),
 337     uuid("1c158861-b533-4b30-b1cf-e853e51c59b8"),
 338     object,
 339 ]
 340 interface IChannelAudioVolume : IUnknown
 341 {
 342     HRESULT GetChannelCount(
 343         [out] UINT32 *pdwCount
 344     );
 345     HRESULT SetChannelVolume(
 346         [in] UINT32 dwIndex,
 347         [in] const float fLevel,
 348         [unique,in] LPCGUID EventContext
 349     );
 350     HRESULT GetChannelVolume(
 351         [in] UINT32 dwIndex,
 352         [out] float *pfLevel
 353     );
 354     HRESULT SetAllVolumes(
 355         [in] UINT32 dwCount,
 356         [size_is(dwCount),in] const float *pfVolumes,
 357         [unique,in] LPCGUID EventContext
 358     );
 359     HRESULT GetAllVolumes(
 360         [in] UINT32 dwCount,
 361         [size_is(dwCount),out] float *pfVolumes
 362     );
 363 }
 364
 365 cpp_quote("#define AUDCLNT_ERR(n) MAKE_HRESULT(SEVERITY_ERROR, FACILITY_AUDCLNT, n)")
 366 cpp_quote("#define AUDCLNT_SUCCESS(n) MAKE_SCODE(SEVERITY_SUCCESS, FACILITY_AUDCLNT, n)")
 367 cpp_quote("#define AUDCLNT_E_NOT_INITIALIZED AUDCLNT_ERR(1)")
 368 cpp_quote("#define AUDCLNT_E_ALREADY_INITIALIZED AUDCLNT_ERR(2)")
 369 cpp_quote("#define AUDCLNT_E_WRONG_ENDPOINT_TYPE AUDCLNT_ERR(3)")
 370 cpp_quote("#define AUDCLNT_E_DEVICE_INVALIDATED AUDCLNT_ERR(4)")
 371 cpp_quote("#define AUDCLNT_E_NOT_STOPPED AUDCLNT_ERR(5)")
 372 cpp_quote("#define AUDCLNT_E_BUFFER_TOO_LARGE AUDCLNT_ERR(6)")
 373 cpp_quote("#define AUDCLNT_E_OUT_OF_ORDER AUDCLNT_ERR(7)")
 374 cpp_quote("#define AUDCLNT_E_UNSUPPORTED_FORMAT AUDCLNT_ERR(8)")
 375 cpp_quote("#define AUDCLNT_E_INVALID_SIZE AUDCLNT_ERR(9)")
 376 cpp_quote("#define AUDCLNT_E_DEVICE_IN_USE AUDCLNT_ERR(0x0a)")
 377 cpp_quote("#define AUDCLNT_E_BUFFER_OPERATION_PENDING AUDCLNT_ERR(0x0b)")
 378 cpp_quote("#define AUDCLNT_E_THREAD_NOT_REGISTERED AUDCLNT_ERR(0x0c)")
 379 /* Not defined? cpp_quote("#define AUDCLNT_E_UNKNOWN_XXX1 AUDCLNT_ERR(0x0d)") */
 380 cpp_quote("#define AUDCLNT_E_EXCLUSIVE_MODE_NOT_ALLOWED AUDCLNT_ERR(0x0e)")
 381 cpp_quote("#define AUDCLNT_E_ENDPOINT_CREATE_FAILED AUDCLNT_ERR(0x0f)")
 382 cpp_quote("#define AUDCLNT_E_SERVICE_NOT_RUNNING AUDCLNT_ERR(0x10)")
 383 cpp_quote("#define AUDCLNT_E_EVENTHANDLE_NOT_EXPECTED AUDCLNT_ERR(0x11)")
 384 cpp_quote("#define AUDCLNT_E_EXCLUSIVE_MODE_ONLY AUDCLNT_ERR(0x12)")
 385 cpp_quote("#define AUDCLNT_E_BUFDURATION_PERIOD_NOT_EQUAL AUDCLNT_ERR(0x13)")
 386 cpp_quote("#define AUDCLNT_E_EVENTHANDLE_NOT_SET AUDCLNT_ERR(0x14)")
 387 cpp_quote("#define AUDCLNT_E_INCORRECT_BUFFER_SIZE AUDCLNT_ERR(0x15)")
 388 cpp_quote("#define AUDCLNT_E_BUFFER_SIZE_ERROR AUDCLNT_ERR(0x16)")
 389 cpp_quote("#define AUDCLNT_E_CPUUSAGE_EXCEEDED AUDCLNT_ERR(0x17)")
 390 cpp_quote("#define AUDCLNT_E_BUFFER_ERROR AUDCLNT_ERR(0x18)")
 391 cpp_quote("#define AUDCLNT_E_BUFFER_SIZE_NOT_ALIGNED AUDCLNT_ERR(0x19)")
 392 /* Hex fail */
 393 cpp_quote("#define AUDCLNT_E_INVALID_DEVICE_PERIOD AUDCLNT_ERR(0x20)")
 394 cpp_quote("#define AUDCLNT_E_INVALID_STREAM_FLAG AUDCLNT_ERR(0x021)")
 395 cpp_quote("#define AUDCLNT_E_ENDPOINT_OFFLOAD_NOT_CAPABLE AUDCLNT_ERR(0x022)")
 396 cpp_quote("#define AUDCLNT_E_OUT_OF_OFFLOAD_RESOURCES AUDCLNT_ERR(0x023)")
 397 cpp_quote("#define AUDCLNT_E_OFFLOAD_MODE_ONLY AUDCLNT_ERR(0x024)")
 398 cpp_quote("#define AUDCLNT_E_NONOFFLOAD_MODE_ONLY AUDCLNT_ERR(0x025)")
 399 cpp_quote("#define AUDCLNT_E_RESOURCES_INVALIDATED AUDCLNT_ERR(0x026)")
 400
 401 cpp_quote("#define AUDCLNT_S_BUFFER_EMPTY AUDCLNT_SUCCESS(0x1)")
 402 cpp_quote("#define AUDCLNT_S_THREAD_ALREADY_REGISTERED AUDCLNT_SUCCESS(0x2)")
 403 cpp_quote("#define AUDCLNT_S_POSITION_STALLED AUDCLNT_SUCCESS(0x3)")