dlls/dsound/dsound_private.h

   1 /*                      DirectSound
   2  *
   3  * Copyright 1998 Marcus Meissner
   4  * Copyright 1998 Rob Riggs
   5  * Copyright 2000-2001 TransGaming Technologies, Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 /* Linux does not support better timing than 10ms */
  23 #define DS_TIME_RES 10  /* Resolution of multimedia timer */
  24 #define DS_TIME_DEL 10  /* Delay of multimedia timer callback, and duration of HEL fragment */
  25
  26 #define DS_HEL_FRAGS 48 /* HEL only: number of waveOut fragments in primary buffer
  27                          * (changing this won't help you) */
  28
  29 /* direct sound hardware acceleration levels */
  30 #define DS_HW_ACCEL_FULL        0       /* default on Windows 98 */
  31 #define DS_HW_ACCEL_STANDARD    1       /* default on Windows 2000 */
  32 #define DS_HW_ACCEL_BASIC       2
  33 #define DS_HW_ACCEL_EMULATION   3
  34
  35 extern int ds_emuldriver;
  36 extern int ds_hel_margin;
  37 extern int ds_hel_queue;
  38 extern int ds_snd_queue_max;
  39 extern int ds_snd_queue_min;
  40 extern int ds_hw_accel;
  41 extern int ds_default_playback;
  42 extern int ds_default_capture;
  43
  44 /*****************************************************************************
  45  * Predeclare the interface implementation structures
  46  */
  47 typedef struct IDirectSoundImpl              IDirectSoundImpl;
  48 typedef struct IDirectSound_IUnknown         IDirectSound_IUnknown;
  49 typedef struct IDirectSound_IDirectSound     IDirectSound_IDirectSound;
  50 typedef struct IDirectSound8_IUnknown        IDirectSound8_IUnknown;
  51 typedef struct IDirectSound8_IDirectSound    IDirectSound8_IDirectSound;
  52 typedef struct IDirectSound8_IDirectSound8   IDirectSound8_IDirectSound8;
  53 typedef struct IDirectSoundBufferImpl        IDirectSoundBufferImpl;
  54 typedef struct IDirectSoundCaptureImpl       IDirectSoundCaptureImpl;
  55 typedef struct IDirectSoundCaptureBufferImpl IDirectSoundCaptureBufferImpl;
  56 typedef struct IDirectSoundFullDuplexImpl    IDirectSoundFullDuplexImpl;
  57 typedef struct IDirectSoundNotifyImpl        IDirectSoundNotifyImpl;
  58 typedef struct IDirectSoundCaptureNotifyImpl IDirectSoundCaptureNotifyImpl;
  59 typedef struct IDirectSound3DListenerImpl    IDirectSound3DListenerImpl;
  60 typedef struct IDirectSound3DBufferImpl      IDirectSound3DBufferImpl;
  61 typedef struct IKsBufferPropertySetImpl      IKsBufferPropertySetImpl;
  62 typedef struct IKsPrivatePropertySetImpl     IKsPrivatePropertySetImpl;
  63 typedef struct PrimaryBufferImpl             PrimaryBufferImpl;
  64 typedef struct SecondaryBufferImpl           SecondaryBufferImpl;
  65 typedef struct IClassFactoryImpl             IClassFactoryImpl;
  66 typedef struct DirectSoundDevice             DirectSoundDevice;
  67 typedef struct DirectSoundCaptureDevice      DirectSoundCaptureDevice;
  68
  69 /*****************************************************************************
  70  * IDirectSound implementation structure
  71  */
  72 struct IDirectSoundImpl
  73 {
  74     /* IUnknown fields */
  75     const IDirectSound8Vtbl    *lpVtbl;
  76     LONG                        ref;
  77
  78     DirectSoundDevice          *device;
  79     LPUNKNOWN                   pUnknown;
  80     LPDIRECTSOUND               pDS;
  81     LPDIRECTSOUND8              pDS8;
  82 };
  83
  84 struct DirectSoundDevice
  85 {
  86     LONG                        ref;
  87
  88     GUID                        guid;
  89     PIDSDRIVER                  driver;
  90     DSDRIVERDESC                drvdesc;
  91     DSDRIVERCAPS                drvcaps;
  92     DWORD                       priolevel;
  93     PWAVEFORMATEX               pwfx;
  94     HWAVEOUT                    hwo;
  95     LPWAVEHDR                   pwave[DS_HEL_FRAGS];
  96     UINT                        timerID, pwplay, pwwrite, pwqueue, prebuf, precount;
  97     DWORD                       fraglen;
  98     PIDSDRIVERBUFFER            hwbuf;
  99     LPBYTE                      buffer;
 100     DWORD                       writelead, buflen, state, playpos, mixpos;
 101     BOOL                        need_remix;
 102     int                         nrofbuffers;
 103     IDirectSoundBufferImpl**    buffers;
 104     RTL_RWLOCK                  buffer_list_lock;
 105     CRITICAL_SECTION            mixlock;
 106     PrimaryBufferImpl*          primary;
 107     DSBUFFERDESC                dsbd;
 108     DWORD                       speaker_config;
 109     LPBYTE                      tmp_buffer;
 110     DWORD                       tmp_buffer_len;
 111
 112     /* DirectSound3DListener fields */
 113     IDirectSound3DListenerImpl* listener;
 114     DS3DLISTENER                ds3dl;
 115     BOOL                        ds3dl_need_recalc;
 116 };
 117
 118 /* reference counted buffer memory for duplicated buffer memory */
 119 typedef struct BufferMemory
 120 {
 121     LONG                        ref;
 122     LPBYTE                      memory;
 123 } BufferMemory;
 124
 125 HRESULT IDirectSoundImpl_Create(
 126     LPDIRECTSOUND8 * ppds);
 127
 128 HRESULT DSOUND_Create(
 129     LPDIRECTSOUND *ppDS,
 130     IUnknown *pUnkOuter);
 131
 132 HRESULT DSOUND_Create8(
 133     LPDIRECTSOUND8 *ppDS,
 134     IUnknown *pUnkOuter);
 135
 136 /*****************************************************************************
 137  * IDirectSound COM components
 138  */
 139 struct IDirectSound_IUnknown {
 140     const IUnknownVtbl         *lpVtbl;
 141     LONG                        ref;
 142     LPDIRECTSOUND8              pds;
 143 };
 144
 145 HRESULT IDirectSound_IUnknown_Create(
 146     LPDIRECTSOUND8 pds,
 147     LPUNKNOWN * ppunk);
 148
 149 struct IDirectSound_IDirectSound {
 150     const IDirectSoundVtbl     *lpVtbl;
 151     LONG                        ref;
 152     LPDIRECTSOUND8              pds;
 153 };
 154
 155 HRESULT IDirectSound_IDirectSound_Create(
 156     LPDIRECTSOUND8 pds,
 157     LPDIRECTSOUND * ppds);
 158
 159 /*****************************************************************************
 160  * IDirectSound8 COM components
 161  */
 162 struct IDirectSound8_IUnknown {
 163     const IUnknownVtbl         *lpVtbl;
 164     LONG                        ref;
 165     LPDIRECTSOUND8              pds;
 166 };
 167
 168 HRESULT IDirectSound8_IUnknown_Create(
 169     LPDIRECTSOUND8 pds,
 170     LPUNKNOWN * ppunk);
 171
 172 struct IDirectSound8_IDirectSound {
 173     const IDirectSoundVtbl     *lpVtbl;
 174     LONG                        ref;
 175     LPDIRECTSOUND8              pds;
 176 };
 177
 178 HRESULT IDirectSound8_IDirectSound_Create(
 179     LPDIRECTSOUND8 pds,
 180     LPDIRECTSOUND * ppds);
 181
 182 struct IDirectSound8_IDirectSound8 {
 183     const IDirectSound8Vtbl    *lpVtbl;
 184     LONG                        ref;
 185     LPDIRECTSOUND8              pds;
 186 };
 187
 188 HRESULT IDirectSound8_IDirectSound8_Create(
 189     LPDIRECTSOUND8 pds,
 190     LPDIRECTSOUND8 * ppds);
 191
 192 /*****************************************************************************
 193  * IDirectSoundBuffer implementation structure
 194  */
 195 struct IDirectSoundBufferImpl
 196 {
 197     /* FIXME: document */
 198     /* IUnknown fields */
 199     const IDirectSoundBuffer8Vtbl *lpVtbl;
 200     LONG                        ref;
 201     /* IDirectSoundBufferImpl fields */
 202     SecondaryBufferImpl*        secondary;
 203     IDirectSoundImpl*           dsound;
 204     CRITICAL_SECTION            lock;
 205     PIDSDRIVERBUFFER            hwbuf;
 206     PWAVEFORMATEX               pwfx;
 207     BufferMemory*               buffer;
 208     DWORD                       playflags,state,leadin;
 209     DWORD                       playpos,startpos,writelead,buflen;
 210     DWORD                       nAvgBytesPerSec;
 211     DWORD                       freq;
 212     DSVOLUMEPAN                 volpan, cvolpan;
 213     DSBUFFERDESC                dsbd;
 214     /* used for frequency conversion (PerfectPitch) */
 215     ULONG                       freqAdjust, freqAcc;
 216     /* used for intelligent (well, sort of) prebuffering */
 217     DWORD                       probably_valid_to, last_playpos;
 218     DWORD                       primary_mixpos, buf_mixpos;
 219     BOOL                        need_remix;
 220
 221     /* IDirectSoundNotifyImpl fields */
 222     IDirectSoundNotifyImpl*     notify;
 223     LPDSBPOSITIONNOTIFY         notifies;
 224     int                         nrofnotifies;
 225     PIDSDRIVERNOTIFY            hwnotify;
 226
 227     /* DirectSound3DBuffer fields */
 228     IDirectSound3DBufferImpl*   ds3db;
 229     DS3DBUFFER                  ds3db_ds3db;
 230     LONG                        ds3db_lVolume;
 231     BOOL                        ds3db_need_recalc;
 232
 233     /* IKsPropertySet fields */
 234     IKsBufferPropertySetImpl*   iks;
 235 };
 236
 237 HRESULT IDirectSoundBufferImpl_Create(
 238     IDirectSoundImpl *ds,
 239     IDirectSoundBufferImpl **pdsb,
 240     LPCDSBUFFERDESC dsbd);
 241 HRESULT IDirectSoundBufferImpl_Destroy(
 242     IDirectSoundBufferImpl *pdsb);
 243
 244 /*****************************************************************************
 245  * SecondaryBuffer implementation structure
 246  */
 247 struct SecondaryBufferImpl
 248 {
 249     const IDirectSoundBuffer8Vtbl *lpVtbl;
 250     LONG                        ref;
 251     IDirectSoundBufferImpl*     dsb;
 252 };
 253
 254 HRESULT SecondaryBufferImpl_Create(
 255     IDirectSoundBufferImpl *dsb,
 256     SecondaryBufferImpl **pdsb);
 257 HRESULT SecondaryBufferImpl_Destroy(
 258     SecondaryBufferImpl *pdsb);
 259
 260 /*****************************************************************************
 261  * PrimaryBuffer implementation structure
 262  */
 263 struct PrimaryBufferImpl
 264 {
 265     const IDirectSoundBuffer8Vtbl *lpVtbl;
 266     LONG                        ref;
 267     IDirectSoundImpl*           dsound;
 268 };
 269
 270 HRESULT PrimaryBufferImpl_Create(
 271     IDirectSoundImpl *ds,
 272     PrimaryBufferImpl **pdsb,
 273     LPCDSBUFFERDESC dsbd);
 274
 275 /*****************************************************************************
 276  * IDirectSoundCapture implementation structure
 277  */
 278 struct IDirectSoundCaptureImpl
 279 {
 280     /* IUnknown fields */
 281     const IDirectSoundCaptureVtbl     *lpVtbl;
 282     LONG                               ref;
 283
 284     DirectSoundCaptureDevice          *device;
 285 };
 286
 287 HRESULT IDirectSoundCaptureImpl_Create(
 288     LPDIRECTSOUNDCAPTURE8 * ppds);
 289
 290 /*****************************************************************************
 291  * DirectSoundCaptureDevice implementation structure
 292  */
 293 struct DirectSoundCaptureDevice
 294 {
 295     /* IDirectSoundCaptureImpl fields */
 296     GUID                               guid;
 297     LONG                               ref;
 298
 299     /* DirectSound driver stuff */
 300     PIDSCDRIVER                        driver;
 301     DSDRIVERDESC                       drvdesc;
 302     DSCDRIVERCAPS                      drvcaps;
 303     PIDSCDRIVERBUFFER                  hwbuf;
 304
 305     /* wave driver info */
 306     HWAVEIN                            hwi;
 307
 308     /* more stuff */
 309     LPBYTE                             buffer;
 310     DWORD                              buflen;
 311     DWORD                              read_position;
 312
 313     PWAVEFORMATEX                      pwfx;
 314
 315     IDirectSoundCaptureBufferImpl*     capture_buffer;
 316     DWORD                              state;
 317     LPWAVEHDR                          pwave;
 318     int                                nrofpwaves;
 319     int                                index;
 320     CRITICAL_SECTION                   lock;
 321 };
 322
 323 HRESULT DirectSoundCaptureDevice_Create(
 324     DirectSoundCaptureDevice ** ppDevice);
 325
 326 HRESULT DirectSoundCaptureDevice_Initialize(
 327     DirectSoundCaptureDevice ** ppDevice,
 328     LPCGUID lpcGUID);
 329
 330 ULONG DirectSoundCaptureDevice_AddRef(
 331     DirectSoundCaptureDevice * device);
 332
 333 ULONG DirectSoundCaptureDevice_Release(
 334     DirectSoundCaptureDevice * device);
 335
 336 /*****************************************************************************
 337  * IDirectSoundCaptureBuffer implementation structure
 338  */
 339 struct IDirectSoundCaptureBufferImpl
 340 {
 341     /* IUnknown fields */
 342     const IDirectSoundCaptureBuffer8Vtbl *lpVtbl;
 343     LONG                                ref;
 344
 345     /* IDirectSoundCaptureBufferImpl fields */
 346     DirectSoundCaptureDevice*           device;
 347     /* FIXME: don't need this */
 348     LPDSCBUFFERDESC                     pdscbd;
 349     DWORD                               flags;
 350
 351     /* IDirectSoundCaptureNotifyImpl fields */
 352     IDirectSoundCaptureNotifyImpl*      notify;
 353     LPDSBPOSITIONNOTIFY                 notifies;
 354     int                                 nrofnotifies;
 355     PIDSDRIVERNOTIFY                    hwnotify;
 356 };
 357
 358 HRESULT IDirectSoundCaptureBufferImpl_Create(
 359     DirectSoundCaptureDevice *device,
 360     IDirectSoundCaptureBufferImpl ** ppobj,
 361     LPCDSCBUFFERDESC lpcDSCBufferDesc);
 362
 363 /*****************************************************************************
 364  * IDirectSoundFullDuplex implementation structure
 365  */
 366 struct IDirectSoundFullDuplexImpl
 367 {
 368     /* IUnknown fields */
 369     const IDirectSoundFullDuplexVtbl *lpVtbl;
 370     LONG                        ref;
 371
 372     /* IDirectSoundFullDuplexImpl fields */
 373 };
 374
 375 /*****************************************************************************
 376  * IDirectSoundNotify implementation structure
 377  */
 378 struct IDirectSoundNotifyImpl
 379 {
 380     /* IUnknown fields */
 381     const IDirectSoundNotifyVtbl *lpVtbl;
 382     LONG                        ref;
 383     IDirectSoundBufferImpl*     dsb;
 384 };
 385
 386 HRESULT IDirectSoundNotifyImpl_Create(
 387     IDirectSoundBufferImpl *dsb,
 388     IDirectSoundNotifyImpl **pdsn);
 389 HRESULT IDirectSoundNotifyImpl_Destroy(
 390     IDirectSoundNotifyImpl *pdsn);
 391
 392 /*****************************************************************************
 393  * IDirectSoundCaptureNotify implementation structure
 394  */
 395 struct IDirectSoundCaptureNotifyImpl
 396 {
 397     /* IUnknown fields */
 398     const IDirectSoundNotifyVtbl       *lpVtbl;
 399     LONG                                ref;
 400     IDirectSoundCaptureBufferImpl*      dscb;
 401 };
 402
 403 HRESULT IDirectSoundCaptureNotifyImpl_Create(
 404     IDirectSoundCaptureBufferImpl *dscb,
 405     IDirectSoundCaptureNotifyImpl ** pdscn);
 406
 407 /*****************************************************************************
 408  *  IDirectSound3DListener implementation structure
 409  */
 410 struct IDirectSound3DListenerImpl
 411 {
 412     /* IUnknown fields */
 413     const IDirectSound3DListenerVtbl *lpVtbl;
 414     LONG                        ref;
 415     /* IDirectSound3DListenerImpl fields */
 416     IDirectSoundImpl*           dsound;
 417 };
 418
 419 HRESULT IDirectSound3DListenerImpl_Create(
 420     PrimaryBufferImpl *pb,
 421     IDirectSound3DListenerImpl **pdsl);
 422
 423 /*****************************************************************************
 424  *  IKsBufferPropertySet implementation structure
 425  */
 426 struct IKsBufferPropertySetImpl
 427 {
 428     /* IUnknown fields */
 429     const IKsPropertySetVtbl   *lpVtbl;
 430     LONG                        ref;
 431     /* IKsPropertySetImpl fields */
 432     IDirectSoundBufferImpl*     dsb;
 433 };
 434
 435 HRESULT IKsBufferPropertySetImpl_Create(
 436     IDirectSoundBufferImpl *dsb,
 437     IKsBufferPropertySetImpl **piks);
 438 HRESULT IKsBufferPropertySetImpl_Destroy(
 439     IKsBufferPropertySetImpl *piks);
 440
 441 /*****************************************************************************
 442  *  IKsPrivatePropertySet implementation structure
 443  */
 444 struct IKsPrivatePropertySetImpl
 445 {
 446     /* IUnknown fields */
 447     const IKsPropertySetVtbl   *lpVtbl;
 448     LONG                        ref;
 449 };
 450
 451 HRESULT IKsPrivatePropertySetImpl_Create(
 452     IKsPrivatePropertySetImpl **piks);
 453
 454 /*****************************************************************************
 455  * IDirectSound3DBuffer implementation structure
 456  */
 457 struct IDirectSound3DBufferImpl
 458 {
 459     /* IUnknown fields */
 460     const IDirectSound3DBufferVtbl *lpVtbl;
 461     LONG                        ref;
 462     /* IDirectSound3DBufferImpl fields */
 463     IDirectSoundBufferImpl*     dsb;
 464 };
 465
 466 HRESULT IDirectSound3DBufferImpl_Create(
 467     IDirectSoundBufferImpl *dsb,
 468     IDirectSound3DBufferImpl **pds3db);
 469 HRESULT IDirectSound3DBufferImpl_Destroy(
 470     IDirectSound3DBufferImpl *pds3db);
 471
 472 /*******************************************************************************
 473  * DirectSound ClassFactory implementation structure
 474  */
 475 struct IClassFactoryImpl
 476 {
 477     /* IUnknown fields */
 478     const IClassFactoryVtbl    *lpVtbl;
 479     LONG                        ref;
 480 };
 481
 482 extern IClassFactoryImpl DSOUND_CAPTURE_CF;
 483 extern IClassFactoryImpl DSOUND_FULLDUPLEX_CF;
 484
 485 void DSOUND_RecalcVolPan(PDSVOLUMEPAN volpan);
 486 void DSOUND_AmpFactorToVolPan(PDSVOLUMEPAN volpan);
 487 void DSOUND_RecalcFormat(IDirectSoundBufferImpl *dsb);
 488
 489 /* dsound.c */
 490
 491 HRESULT DSOUND_AddBuffer(IDirectSoundImpl * pDS, IDirectSoundBufferImpl * pDSB);
 492 HRESULT DSOUND_RemoveBuffer(IDirectSoundImpl * pDS, IDirectSoundBufferImpl * pDSB);
 493
 494 /* primary.c */
 495
 496 HRESULT DSOUND_PrimaryCreate(DirectSoundDevice *device);
 497 HRESULT DSOUND_PrimaryDestroy(DirectSoundDevice *device);
 498 HRESULT DSOUND_PrimaryPlay(DirectSoundDevice *device);
 499 HRESULT DSOUND_PrimaryStop(DirectSoundDevice *device);
 500 HRESULT DSOUND_PrimaryGetPosition(DirectSoundDevice *device, LPDWORD playpos, LPDWORD writepos);
 501
 502 /* buffer.c */
 503
 504 DWORD DSOUND_CalcPlayPosition(IDirectSoundBufferImpl *This, DWORD pplay, DWORD pwrite);
 505
 506 /* mixer.c */
 507
 508 void DSOUND_CheckEvent(IDirectSoundBufferImpl *dsb, int len);
 509 void DSOUND_ForceRemix(IDirectSoundBufferImpl *dsb);
 510 void DSOUND_MixCancelAt(IDirectSoundBufferImpl *dsb, DWORD buf_writepos);
 511 void DSOUND_WaveQueue(DirectSoundDevice *device, DWORD mixq);
 512 void DSOUND_PerformMix(DirectSoundDevice *device);
 513 void CALLBACK DSOUND_timer(UINT timerID, UINT msg, DWORD dwUser, DWORD dw1, DWORD dw2);
 514 void CALLBACK DSOUND_callback(HWAVEOUT hwo, UINT msg, DWORD dwUser, DWORD dw1, DWORD dw2);
 515
 516 /* sound3d.c */
 517
 518 void DSOUND_Calc3DBuffer(IDirectSoundBufferImpl *dsb);
 519
 520 #define STATE_STOPPED   0
 521 #define STATE_STARTING  1
 522 #define STATE_PLAYING   2
 523 #define STATE_CAPTURING 2
 524 #define STATE_STOPPING  3
 525
 526 #define DSOUND_FREQSHIFT (14)
 527
 528 extern DirectSoundDevice* DSOUND_renderer[MAXWAVEDRIVERS];
 529 extern GUID DSOUND_renderer_guids[MAXWAVEDRIVERS];
 530
 531 extern DirectSoundCaptureDevice * DSOUND_capture[MAXWAVEDRIVERS];
 532 extern GUID DSOUND_capture_guids[MAXWAVEDRIVERS];
 533
 534 extern HRESULT mmErr(UINT err);
 535 extern void setup_dsound_options(void);
 536 extern const char * get_device_id(LPCGUID pGuid);