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
138
143 std::shared_ptr<AudioStreamPresentationCallback> getPresentationCallback() const {
144 return mSharedPresentationCallback;
145 }
146
151 return mDataCallback != nullptr;
152 }
153
158 return mPartialDataCallback != nullptr;
159 }
160
167
174 return mErrorCallback != nullptr;
175 }
176
181 return mSharedPresentationCallback != nullptr;
182 }
183
187 Usage getUsage() const { return mUsage; }
188
192 ContentType getContentType() const { return mContentType; }
193
197 InputPreset getInputPreset() const { return mInputPreset; }
198
202 SessionId getSessionId() const { return mSessionId; }
203
208
212 SpatializationBehavior getSpatializationBehavior() const { return mSpatializationBehavior; }
213
224 AllowedCapturePolicy getAllowedCapturePolicy() const { return mAllowedCapturePolicy; }
225
237 PrivacySensitiveMode getPrivacySensitiveMode() const { return mPrivacySensitiveMode; }
238
248 std::string getPackageName() const { return mPackageName; }
249
259 std::string getAttributionTag() const { return mAttributionTag; }
260
265 return mChannelConversionAllowed;
266 }
267
272 return mFormatConversionAllowed;
273 }
274
278 SampleRateConversionQuality getSampleRateConversionQuality() const {
279 return mSampleRateConversionQuality;
280 }
281
285 ChannelMask getChannelMask() const {
286 return mChannelMask;
287 }
288
293
297 int32_t getHardwareSampleRate() const { return mHardwareSampleRate; }
298
302 AudioFormat getHardwareFormat() const { return mHardwareFormat; }
303
304protected:
307 std::shared_ptr<AudioStreamDataCallback> mSharedDataCallback;
308
311 std::shared_ptr<AudioStreamPartialDataCallback> mSharedPartialDataCallback;
312
315 std::shared_ptr<AudioStreamErrorCallback> mSharedErrorCallback;
316
317 std::shared_ptr<AudioStreamPresentationCallback> mSharedPresentationCallback;
318
320 int32_t mFramesPerCallback = kUnspecified;
322 int32_t mChannelCount = kUnspecified;
324 int32_t mSampleRate = kUnspecified;
326 int32_t mBufferCapacityInFrames = kUnspecified;
328 int32_t mBufferSizeInFrames = kUnspecified;
330 ChannelMask mChannelMask = ChannelMask::Unspecified;
331
333 SharingMode mSharingMode = SharingMode::Shared;
335 AudioFormat mFormat = AudioFormat::Unspecified;
337 Direction mDirection = Direction::Output;
339 PerformanceMode mPerformanceMode = PerformanceMode::None;
340
342 Usage mUsage = Usage::Media;
344 ContentType mContentType = ContentType::Music;
348 InputPreset mInputPreset = InputPreset::VoiceRecognition;
350 SessionId mSessionId = SessionId::None;
351
353 AllowedCapturePolicy mAllowedCapturePolicy = AllowedCapturePolicy::Unspecified;
354
356 PrivacySensitiveMode mPrivacySensitiveMode = PrivacySensitiveMode::Unspecified;
357
359 std::string mPackageName;
361 std::string mAttributionTag;
362
366 SpatializationBehavior mSpatializationBehavior = SpatializationBehavior::Unspecified;
367
369 int32_t mHardwareChannelCount = kUnspecified;
371 int32_t mHardwareSampleRate = kUnspecified;
373 AudioFormat mHardwareFormat = AudioFormat::Unspecified;
374
375 // Control whether Oboe can convert channel counts to achieve optimal results.
376 bool mChannelConversionAllowed = false;
377 // Control whether Oboe can convert data formats to achieve optimal results.
378 bool mFormatConversionAllowed = false;
379 // Control whether and how Oboe can convert sample rates to achieve optimal results.
380 SampleRateConversionQuality mSampleRateConversionQuality = SampleRateConversionQuality::Medium;
381
382 std::vector<int32_t> mDeviceIds;
383
385 virtual Result isValidConfig() {
386 switch (mFormat) {
387 case AudioFormat::Unspecified:
388 case AudioFormat::I16:
389 case AudioFormat::Float:
390 case AudioFormat::I24:
391 case AudioFormat::I32:
392 case AudioFormat::IEC61937:
393 case AudioFormat::MP3:
394 case AudioFormat::AAC_LC:
395 case AudioFormat::AAC_HE_V1:
396 case AudioFormat::AAC_HE_V2:
397 case AudioFormat::AAC_ELD:
398 case AudioFormat::AAC_XHE:
399 case AudioFormat::OPUS:
400 break;
401
402 default:
403 return Result::ErrorInvalidFormat;
404 }
405
406 switch (mSampleRateConversionQuality) {
407 case SampleRateConversionQuality::None:
408 case SampleRateConversionQuality::Fastest:
409 case SampleRateConversionQuality::Low:
410 case SampleRateConversionQuality::Medium:
411 case SampleRateConversionQuality::High:
412 case SampleRateConversionQuality::Best:
413 return Result::OK;
414 default:
415 return Result::ErrorIllegalArgument;
416 }
417 }
418};
419
420} // namespace oboe
421
422#endif /* OBOE_STREAM_BASE_H_ */
Definition AudioStreamBase.h:31
bool isPartialDataCallbackSpecified() const
Definition AudioStreamBase.h:157
int32_t mHardwareSampleRate
Definition AudioStreamBase.h:371
int32_t getDeviceId() const
Definition AudioStreamBase.h:107
Usage getUsage() const
Definition AudioStreamBase.h:187
AudioFormat mHardwareFormat
Definition AudioStreamBase.h:373
SpatializationBehavior mSpatializationBehavior
Definition AudioStreamBase.h:366
AudioStreamDataCallback * getDataCallback() const
Definition AudioStreamBase.h:119
SampleRateConversionQuality getSampleRateConversionQuality() const
Definition AudioStreamBase.h:278
InputPreset mInputPreset
Definition AudioStreamBase.h:348
SharingMode getSharingMode() const
Definition AudioStreamBase.h:97
std::string getAttributionTag() const
Definition AudioStreamBase.h:259
Direction mDirection
Definition AudioStreamBase.h:337
PerformanceMode getPerformanceMode() const
Definition AudioStreamBase.h:102
int32_t mFramesPerCallback
Definition AudioStreamBase.h:320
int32_t mBufferSizeInFrames
Definition AudioStreamBase.h:328
PrivacySensitiveMode getPrivacySensitiveMode() const
Definition AudioStreamBase.h:237
AudioFormat getHardwareFormat() const
Definition AudioStreamBase.h:302
Usage mUsage
Definition AudioStreamBase.h:342
InputPreset getInputPreset() const
Definition AudioStreamBase.h:197
virtual Result isValidConfig()
Definition AudioStreamBase.h:385
ContentType mContentType
Definition AudioStreamBase.h:344
int32_t mChannelCount
Definition AudioStreamBase.h:322
PrivacySensitiveMode mPrivacySensitiveMode
Definition AudioStreamBase.h:356
int32_t getHardwareSampleRate() const
Definition AudioStreamBase.h:297
AudioStreamDataCallback * mDataCallback
Definition AudioStreamBase.h:306
AllowedCapturePolicy mAllowedCapturePolicy
Definition AudioStreamBase.h:353
Direction getDirection() const
Definition AudioStreamBase.h:59
AudioStreamErrorCallback * getErrorCallback() const
Definition AudioStreamBase.h:135
bool anyDataCallbackSpecified() const
Definition AudioStreamBase.h:164
AudioFormat mFormat
Definition AudioStreamBase.h:335
std::shared_ptr< AudioStreamPresentationCallback > getPresentationCallback() const
Definition AudioStreamBase.h:143
int32_t mHardwareChannelCount
Definition AudioStreamBase.h:369
int32_t getChannelCount() const
Definition AudioStreamBase.h:54
int32_t getFramesPerCallback() const
Definition AudioStreamBase.h:69
ChannelMask getChannelMask() const
Definition AudioStreamBase.h:285
int32_t mSampleRate
Definition AudioStreamBase.h:324
bool isDataCallbackSpecified() const
Definition AudioStreamBase.h:150
bool mIsContentSpatialized
Definition AudioStreamBase.h:364
bool isContentSpatialized() const
Definition AudioStreamBase.h:207
SessionId getSessionId() const
Definition AudioStreamBase.h:202
ChannelMask mChannelMask
Definition AudioStreamBase.h:330
bool isChannelConversionAllowed() const
Definition AudioStreamBase.h:264
AudioStreamBase(const AudioStreamBase &)=default
ContentType getContentType() const
Definition AudioStreamBase.h:192
virtual int32_t getBufferCapacityInFrames() const
Definition AudioStreamBase.h:92
AudioFormat getFormat() const
Definition AudioStreamBase.h:79
PerformanceMode mPerformanceMode
Definition AudioStreamBase.h:339
bool isPresentationCallbackSpecified() const
Definition AudioStreamBase.h:180
int32_t getFramesPerDataCallback() const
Definition AudioStreamBase.h:74
SessionId mSessionId
Definition AudioStreamBase.h:350
std::string mPackageName
Definition AudioStreamBase.h:359
int32_t mBufferCapacityInFrames
Definition AudioStreamBase.h:326
bool isFormatConversionAllowed() const
Definition AudioStreamBase.h:271
AllowedCapturePolicy getAllowedCapturePolicy() const
Definition AudioStreamBase.h:224
int32_t getHardwareChannelCount() const
Definition AudioStreamBase.h:292
std::string getPackageName() const
Definition AudioStreamBase.h:248
AudioStreamErrorCallback * mErrorCallback
Definition AudioStreamBase.h:314
AudioStreamPartialDataCallback * getPartialDataCallback() const
Definition AudioStreamBase.h:127
SpatializationBehavior getSpatializationBehavior() const
Definition AudioStreamBase.h:212
AudioStreamBase & operator=(const AudioStreamBase &)=default
AudioStreamPartialDataCallback * mPartialDataCallback
Definition AudioStreamBase.h:310
std::string mAttributionTag
Definition AudioStreamBase.h:361
SharingMode mSharingMode
Definition AudioStreamBase.h:333
int32_t getSampleRate() const
Definition AudioStreamBase.h:64
bool isErrorCallbackSpecified() const
Definition AudioStreamBase.h:173
virtual int32_t getBufferSizeInFrames()
Definition AudioStreamBase.h:87
Definition AudioStreamCallback.h:34
Definition AudioStreamCallback.h:102
Definition AudioStreamCallback.h:210