Oboe
A library for creating real-time audio apps on Android
Loading...
Searching...
No Matches
AudioStreamBase.h
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 OBOE_STREAM_BASE_H_
18#define OBOE_STREAM_BASE_H_
19
20#include <memory>
21#include <string>
22#include <vector>
23#include "oboe/AudioStreamCallback.h"
24#include "oboe/Definitions.h"
25
26namespace oboe {
27
32
33public:
34
36
37 virtual ~AudioStreamBase() = default;
38
39 // This class only contains primitives so we can use default constructor and copy methods.
40
45
50
54 int32_t getChannelCount() const { return mChannelCount; }
55
59 Direction getDirection() const { return mDirection; }
60
64 int32_t getSampleRate() const { return mSampleRate; }
65
69 int32_t getFramesPerCallback() const { return getFramesPerDataCallback(); }
70
74 int32_t getFramesPerDataCallback() const { return mFramesPerCallback; }
75
79 AudioFormat getFormat() const { return mFormat; }
80
87 virtual int32_t getBufferSizeInFrames() { return mBufferSizeInFrames; }
88
92 virtual int32_t getBufferCapacityInFrames() const { return mBufferCapacityInFrames; }
93
97 SharingMode getSharingMode() const { return mSharingMode; }
98
102 PerformanceMode getPerformanceMode() const { return mPerformanceMode; }
103
107 int32_t getDeviceId() const {
108 return mDeviceIds.empty() ? kUnspecified : mDeviceIds[0];
109 }
110
111 std::vector<int32_t> getDeviceIds() const {
112 return mDeviceIds;
113 }
114
122
130
135 std::shared_ptr<AudioStreamPresentationCallback> getPresentationCallback() const {
136 return mSharedPresentationCallback;
137 }
138
143 return mDataCallback != nullptr;
144 }
145
152 return mErrorCallback != nullptr;
153 }
154
159 return mSharedPresentationCallback != nullptr;
160 }
161
165 Usage getUsage() const { return mUsage; }
166
170 ContentType getContentType() const { return mContentType; }
171
175 InputPreset getInputPreset() const { return mInputPreset; }
176
180 SessionId getSessionId() const { return mSessionId; }
181
186
190 SpatializationBehavior getSpatializationBehavior() const { return mSpatializationBehavior; }
191
202 AllowedCapturePolicy getAllowedCapturePolicy() const { return mAllowedCapturePolicy; }
203
215 PrivacySensitiveMode getPrivacySensitiveMode() const { return mPrivacySensitiveMode; }
216
226 std::string getPackageName() const { return mPackageName; }
227
237 std::string getAttributionTag() const { return mAttributionTag; }
238
243 return mChannelConversionAllowed;
244 }
245
250 return mFormatConversionAllowed;
251 }
252
256 SampleRateConversionQuality getSampleRateConversionQuality() const {
257 return mSampleRateConversionQuality;
258 }
259
263 ChannelMask getChannelMask() const {
264 return mChannelMask;
265 }
266
271
275 int32_t getHardwareSampleRate() const { return mHardwareSampleRate; }
276
280 AudioFormat getHardwareFormat() const { return mHardwareFormat; }
281
282protected:
285 std::shared_ptr<AudioStreamDataCallback> mSharedDataCallback;
286
289 std::shared_ptr<AudioStreamErrorCallback> mSharedErrorCallback;
290
291 std::shared_ptr<AudioStreamPresentationCallback> mSharedPresentationCallback;
292
294 int32_t mFramesPerCallback = kUnspecified;
296 int32_t mChannelCount = kUnspecified;
298 int32_t mSampleRate = kUnspecified;
300 int32_t mBufferCapacityInFrames = kUnspecified;
302 int32_t mBufferSizeInFrames = kUnspecified;
304 ChannelMask mChannelMask = ChannelMask::Unspecified;
305
307 SharingMode mSharingMode = SharingMode::Shared;
309 AudioFormat mFormat = AudioFormat::Unspecified;
311 Direction mDirection = Direction::Output;
313 PerformanceMode mPerformanceMode = PerformanceMode::None;
314
316 Usage mUsage = Usage::Media;
318 ContentType mContentType = ContentType::Music;
322 InputPreset mInputPreset = InputPreset::VoiceRecognition;
324 SessionId mSessionId = SessionId::None;
325
327 AllowedCapturePolicy mAllowedCapturePolicy = AllowedCapturePolicy::Unspecified;
328
330 PrivacySensitiveMode mPrivacySensitiveMode = PrivacySensitiveMode::Unspecified;
331
333 std::string mPackageName;
335 std::string mAttributionTag;
336
340 SpatializationBehavior mSpatializationBehavior = SpatializationBehavior::Unspecified;
341
343 int32_t mHardwareChannelCount = kUnspecified;
345 int32_t mHardwareSampleRate = kUnspecified;
347 AudioFormat mHardwareFormat = AudioFormat::Unspecified;
348
349 // Control whether Oboe can convert channel counts to achieve optimal results.
350 bool mChannelConversionAllowed = false;
351 // Control whether Oboe can convert data formats to achieve optimal results.
352 bool mFormatConversionAllowed = false;
353 // Control whether and how Oboe can convert sample rates to achieve optimal results.
354 SampleRateConversionQuality mSampleRateConversionQuality = SampleRateConversionQuality::Medium;
355
356 std::vector<int32_t> mDeviceIds;
357
359 virtual Result isValidConfig() {
360 switch (mFormat) {
361 case AudioFormat::Unspecified:
362 case AudioFormat::I16:
363 case AudioFormat::Float:
364 case AudioFormat::I24:
365 case AudioFormat::I32:
366 case AudioFormat::IEC61937:
367 case AudioFormat::MP3:
368 case AudioFormat::AAC_LC:
369 case AudioFormat::AAC_HE_V1:
370 case AudioFormat::AAC_HE_V2:
371 case AudioFormat::AAC_ELD:
372 case AudioFormat::AAC_XHE:
373 case AudioFormat::OPUS:
374 break;
375
376 default:
377 return Result::ErrorInvalidFormat;
378 }
379
380 switch (mSampleRateConversionQuality) {
381 case SampleRateConversionQuality::None:
382 case SampleRateConversionQuality::Fastest:
383 case SampleRateConversionQuality::Low:
384 case SampleRateConversionQuality::Medium:
385 case SampleRateConversionQuality::High:
386 case SampleRateConversionQuality::Best:
387 return Result::OK;
388 default:
389 return Result::ErrorIllegalArgument;
390 }
391 }
392};
393
394} // namespace oboe
395
396#endif /* OBOE_STREAM_BASE_H_ */
Definition AudioStreamBase.h:31
int32_t mHardwareSampleRate
Definition AudioStreamBase.h:345
int32_t getDeviceId() const
Definition AudioStreamBase.h:107
Usage getUsage() const
Definition AudioStreamBase.h:165
AudioFormat mHardwareFormat
Definition AudioStreamBase.h:347
SpatializationBehavior mSpatializationBehavior
Definition AudioStreamBase.h:340
AudioStreamDataCallback * getDataCallback() const
Definition AudioStreamBase.h:119
SampleRateConversionQuality getSampleRateConversionQuality() const
Definition AudioStreamBase.h:256
InputPreset mInputPreset
Definition AudioStreamBase.h:322
SharingMode getSharingMode() const
Definition AudioStreamBase.h:97
std::string getAttributionTag() const
Definition AudioStreamBase.h:237
Direction mDirection
Definition AudioStreamBase.h:311
PerformanceMode getPerformanceMode() const
Definition AudioStreamBase.h:102
int32_t mFramesPerCallback
Definition AudioStreamBase.h:294
int32_t mBufferSizeInFrames
Definition AudioStreamBase.h:302
PrivacySensitiveMode getPrivacySensitiveMode() const
Definition AudioStreamBase.h:215
AudioFormat getHardwareFormat() const
Definition AudioStreamBase.h:280
Usage mUsage
Definition AudioStreamBase.h:316
InputPreset getInputPreset() const
Definition AudioStreamBase.h:175
virtual Result isValidConfig()
Definition AudioStreamBase.h:359
ContentType mContentType
Definition AudioStreamBase.h:318
int32_t mChannelCount
Definition AudioStreamBase.h:296
PrivacySensitiveMode mPrivacySensitiveMode
Definition AudioStreamBase.h:330
int32_t getHardwareSampleRate() const
Definition AudioStreamBase.h:275
AudioStreamDataCallback * mDataCallback
Definition AudioStreamBase.h:284
AllowedCapturePolicy mAllowedCapturePolicy
Definition AudioStreamBase.h:327
Direction getDirection() const
Definition AudioStreamBase.h:59
AudioStreamErrorCallback * getErrorCallback() const
Definition AudioStreamBase.h:127
AudioFormat mFormat
Definition AudioStreamBase.h:309
std::shared_ptr< AudioStreamPresentationCallback > getPresentationCallback() const
Definition AudioStreamBase.h:135
int32_t mHardwareChannelCount
Definition AudioStreamBase.h:343
int32_t getChannelCount() const
Definition AudioStreamBase.h:54
int32_t getFramesPerCallback() const
Definition AudioStreamBase.h:69
ChannelMask getChannelMask() const
Definition AudioStreamBase.h:263
int32_t mSampleRate
Definition AudioStreamBase.h:298
bool isDataCallbackSpecified() const
Definition AudioStreamBase.h:142
bool mIsContentSpatialized
Definition AudioStreamBase.h:338
bool isContentSpatialized() const
Definition AudioStreamBase.h:185
SessionId getSessionId() const
Definition AudioStreamBase.h:180
ChannelMask mChannelMask
Definition AudioStreamBase.h:304
bool isChannelConversionAllowed() const
Definition AudioStreamBase.h:242
AudioStreamBase(const AudioStreamBase &)=default
ContentType getContentType() const
Definition AudioStreamBase.h:170
virtual int32_t getBufferCapacityInFrames() const
Definition AudioStreamBase.h:92
AudioFormat getFormat() const
Definition AudioStreamBase.h:79
PerformanceMode mPerformanceMode
Definition AudioStreamBase.h:313
bool isPresentationCallbackSpecified() const
Definition AudioStreamBase.h:158
int32_t getFramesPerDataCallback() const
Definition AudioStreamBase.h:74
SessionId mSessionId
Definition AudioStreamBase.h:324
std::string mPackageName
Definition AudioStreamBase.h:333
int32_t mBufferCapacityInFrames
Definition AudioStreamBase.h:300
bool isFormatConversionAllowed() const
Definition AudioStreamBase.h:249
AllowedCapturePolicy getAllowedCapturePolicy() const
Definition AudioStreamBase.h:202
int32_t getHardwareChannelCount() const
Definition AudioStreamBase.h:270
std::string getPackageName() const
Definition AudioStreamBase.h:226
AudioStreamErrorCallback * mErrorCallback
Definition AudioStreamBase.h:288
SpatializationBehavior getSpatializationBehavior() const
Definition AudioStreamBase.h:190
AudioStreamBase & operator=(const AudioStreamBase &)=default
std::string mAttributionTag
Definition AudioStreamBase.h:335
SharingMode mSharingMode
Definition AudioStreamBase.h:307
int32_t getSampleRate() const
Definition AudioStreamBase.h:64
bool isErrorCallbackSpecified() const
Definition AudioStreamBase.h:151
virtual int32_t getBufferSizeInFrames()
Definition AudioStreamBase.h:87
Definition AudioStreamCallback.h:34
Definition AudioStreamCallback.h:102