annotate src/portaudio/include/pa_win_ds.h @ 127:7867fa7e1b6b

Current fftw source
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 18 Oct 2016 13:40:26 +0100
parents 8a15ff55d9af
children
rev   line source
cannam@89 1 #ifndef PA_WIN_DS_H
cannam@89 2 #define PA_WIN_DS_H
cannam@89 3 /*
cannam@89 4 * $Id: $
cannam@89 5 * PortAudio Portable Real-Time Audio Library
cannam@89 6 * DirectSound specific extensions
cannam@89 7 *
cannam@89 8 * Copyright (c) 1999-2007 Ross Bencina and Phil Burk
cannam@89 9 *
cannam@89 10 * Permission is hereby granted, free of charge, to any person obtaining
cannam@89 11 * a copy of this software and associated documentation files
cannam@89 12 * (the "Software"), to deal in the Software without restriction,
cannam@89 13 * including without limitation the rights to use, copy, modify, merge,
cannam@89 14 * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@89 15 * and to permit persons to whom the Software is furnished to do so,
cannam@89 16 * subject to the following conditions:
cannam@89 17 *
cannam@89 18 * The above copyright notice and this permission notice shall be
cannam@89 19 * included in all copies or substantial portions of the Software.
cannam@89 20 *
cannam@89 21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@89 22 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@89 23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@89 24 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@89 25 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@89 26 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@89 27 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@89 28 */
cannam@89 29
cannam@89 30 /*
cannam@89 31 * The text above constitutes the entire PortAudio license; however,
cannam@89 32 * the PortAudio community also makes the following non-binding requests:
cannam@89 33 *
cannam@89 34 * Any person wishing to distribute modifications to the Software is
cannam@89 35 * requested to send the modifications to the original developer so that
cannam@89 36 * they can be incorporated into the canonical version. It is also
cannam@89 37 * requested that these non-binding requests be included along with the
cannam@89 38 * license above.
cannam@89 39 */
cannam@89 40
cannam@89 41 /** @file
cannam@89 42 @ingroup public_header
cannam@89 43 @brief DirectSound-specific PortAudio API extension header file.
cannam@89 44 */
cannam@89 45
cannam@89 46 #include "portaudio.h"
cannam@89 47 #include "pa_win_waveformat.h"
cannam@89 48
cannam@89 49 #ifdef __cplusplus
cannam@89 50 extern "C"
cannam@89 51 {
cannam@89 52 #endif /* __cplusplus */
cannam@89 53
cannam@89 54
cannam@89 55 #define paWinDirectSoundUseLowLevelLatencyParameters (0x01)
cannam@89 56 #define paWinDirectSoundUseChannelMask (0x04)
cannam@89 57
cannam@89 58
cannam@89 59 typedef struct PaWinDirectSoundStreamInfo{
cannam@89 60 unsigned long size; /**< sizeof(PaWinDirectSoundStreamInfo) */
cannam@89 61 PaHostApiTypeId hostApiType; /**< paDirectSound */
cannam@89 62 unsigned long version; /**< 2 */
cannam@89 63
cannam@89 64 unsigned long flags;
cannam@89 65
cannam@89 66 /* low-level latency setting support
cannam@89 67 Control the size of host buffers in order to set latency. They will
cannam@89 68 be used instead of the generic parameters to Pa_OpenStream() if
cannam@89 69 flags contains the paWinDirectSoundUseLowLevelLatencyParameters
cannam@89 70 flag.
cannam@89 71
cannam@89 72 If PaWinDirectSoundStreamInfo structures with paWinDirectSoundUseLowLevelLatencyParameters
cannam@89 73 are supplied for both input and output in a full duplex stream, then the
cannam@89 74 input and output framesPerBuffer must be the same, or the larger of the
cannam@89 75 two must be a multiple of the smaller, otherwise a
cannam@89 76 paIncompatibleHostApiSpecificStreamInfo error will be returned from
cannam@89 77 Pa_OpenStream().
cannam@89 78 */
cannam@89 79 unsigned long framesPerBuffer; /* NOT IMPLEMENTED see http://www.portaudio.com/trac/ticket/129 */
cannam@89 80
cannam@89 81 /*
cannam@89 82 support for WAVEFORMATEXTENSIBLE channel masks. If flags contains
cannam@89 83 paWinDirectSoundUseChannelMask this allows you to specify which speakers
cannam@89 84 to address in a multichannel stream. Constants for channelMask
cannam@89 85 are specified in pa_win_waveformat.h
cannam@89 86
cannam@89 87 */
cannam@89 88 PaWinWaveFormatChannelMask channelMask;
cannam@89 89
cannam@89 90 }PaWinDirectSoundStreamInfo;
cannam@89 91
cannam@89 92
cannam@89 93
cannam@89 94 #ifdef __cplusplus
cannam@89 95 }
cannam@89 96 #endif /* __cplusplus */
cannam@89 97
cannam@89 98 #endif /* PA_WIN_DS_H */