AudioStreamBuilder.h revision 71f35bb687476694882a617ba4a810a0bb56fe23 
1/*
2 * Copyright 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef AAUDIO_AUDIO_STREAM_BUILDER_H
18#define AAUDIO_AUDIO_STREAM_BUILDER_H
19
20#include <stdint.h>
21
22#include <aaudio/AAudio.h>
23
24#include "AudioStream.h"
25
26namespace aaudio {
27
28/**
29 * Factory class for an AudioStream.
30 */
31class AudioStreamBuilder {
32public:
33    AudioStreamBuilder();
34
35    ~AudioStreamBuilder();
36
37    int getSamplesPerFrame() const {
38        return mSamplesPerFrame;
39    }
40
41    /**
42     * This is also known as channelCount.
43     */
44    AudioStreamBuilder* setSamplesPerFrame(int samplesPerFrame) {
45        mSamplesPerFrame = samplesPerFrame;
46        return this;
47    }
48
49    aaudio_direction_t getDirection() const {
50        return mDirection;
51    }
52
53    AudioStreamBuilder* setDirection(aaudio_direction_t direction) {
54        mDirection = direction;
55        return this;
56    }
57
58    int32_t getSampleRate() const {
59        return mSampleRate;
60    }
61
62    AudioStreamBuilder* setSampleRate(int32_t sampleRate) {
63        mSampleRate = sampleRate;
64        return this;
65    }
66
67    aaudio_audio_format_t getFormat() const {
68        return mFormat;
69    }
70
71    AudioStreamBuilder *setFormat(aaudio_audio_format_t format) {
72        mFormat = format;
73        return this;
74    }
75
76    aaudio_sharing_mode_t getSharingMode() const {
77        return mSharingMode;
78    }
79
80    AudioStreamBuilder* setSharingMode(aaudio_sharing_mode_t sharingMode) {
81        mSharingMode = sharingMode;
82        return this;
83    }
84
85    bool isSharingModeMatchRequired() const {
86        return mSharingModeMatchRequired;
87    }
88
89    AudioStreamBuilder* setSharingModeMatchRequired(bool required) {
90        mSharingModeMatchRequired = required;
91        return this;
92    }
93
94    int32_t getBufferCapacity() const {
95        return mBufferCapacity;
96    }
97
98    AudioStreamBuilder* setBufferCapacity(int32_t frames) {
99        mBufferCapacity = frames;
100        return this;
101    }
102
103    int32_t getDeviceId() const {
104        return mDeviceId;
105    }
106
107    AudioStreamBuilder* setDeviceId(int32_t deviceId) {
108        mDeviceId = deviceId;
109        return this;
110    }
111
112    AAudioStream_dataCallback getDataCallbackProc() const {
113        return mDataCallbackProc;
114    }
115
116    AudioStreamBuilder* setDataCallbackProc(AAudioStream_dataCallback proc) {
117        mDataCallbackProc = proc;
118        return this;
119    }
120
121    void *getDataCallbackUserData() const {
122        return mDataCallbackUserData;
123    }
124
125    AudioStreamBuilder* setDataCallbackUserData(void *userData) {
126        mDataCallbackUserData = userData;
127        return this;
128    }
129
130    AAudioStream_errorCallback getErrorCallbackProc() const {
131        return mErrorCallbackProc;
132    }
133
134    AudioStreamBuilder* setErrorCallbackProc(AAudioStream_errorCallback proc) {
135        mErrorCallbackProc = proc;
136        return this;
137    }
138
139    AudioStreamBuilder* setErrorCallbackUserData(void *userData) {
140        mErrorCallbackUserData = userData;
141        return this;
142    }
143
144    void *getErrorCallbackUserData() const {
145        return mErrorCallbackUserData;
146    }
147
148    int32_t getFramesPerDataCallback() const {
149        return mFramesPerDataCallback;
150    }
151
152    AudioStreamBuilder* setFramesPerDataCallback(int32_t sizeInFrames) {
153        mFramesPerDataCallback = sizeInFrames;
154        return this;
155    }
156
157    aaudio_result_t build(AudioStream **streamPtr);
158
159private:
160    int32_t                mSamplesPerFrame = AAUDIO_UNSPECIFIED;
161    int32_t                mSampleRate = AAUDIO_UNSPECIFIED;
162    int32_t                mDeviceId = AAUDIO_DEVICE_UNSPECIFIED;
163    aaudio_sharing_mode_t  mSharingMode = AAUDIO_SHARING_MODE_SHARED;
164    bool                   mSharingModeMatchRequired = false; // must match sharing mode requested
165    aaudio_audio_format_t  mFormat = AAUDIO_FORMAT_UNSPECIFIED;
166    aaudio_direction_t     mDirection = AAUDIO_DIRECTION_OUTPUT;
167    int32_t                mBufferCapacity = AAUDIO_UNSPECIFIED;
168
169    AAudioStream_dataCallback  mDataCallbackProc = nullptr;  // external callback functions
170    void                      *mDataCallbackUserData = nullptr;
171    int32_t                    mFramesPerDataCallback = AAUDIO_UNSPECIFIED; // frames
172
173    AAudioStream_errorCallback mErrorCallbackProc = nullptr;
174    void                      *mErrorCallbackUserData = nullptr;
175};
176
177} /* namespace aaudio */
178
179#endif //AAUDIO_AUDIO_STREAM_BUILDER_H
180