Skip to content

Releases: google/oboe

1.8.1

13 Feb 23:47
86165b8
Compare
Choose a tag to compare
  • Fixes a bug where the wrong stream type was used for OpenSL Ringtone streams. (#1946)
  • Added I8_24 to Oboe flowgraph. Note this is not used anywhere in Oboe currently. (#1943)
  • Improved OboeTester glitch (#1956), latency (#1940), and disconnect (#1933, #1961) tests.

1.8.0

12 Oct 21:49
Compare
Choose a tag to compare

API changes

  • Deprecated AudioStreamBuilder.setCallback. Please use setDataCallback and setErrorCallback
  • Added getHardwareChannelCount, getHardwareSampleRate, and getHardwareFormat to audio streams. They are supported in AAudio in API 34+. (#1744)
  • Added privacy sensitive mode APIs. They are supported in AAudio in API 30+. (#1751)
  • Added release to audio streams. They are supported in AAudio in API 30+. (#1755)
  • Added IEC61937 support. They are supported in AAudio in API 34+. (#1758)
  • Added allow capture policy APIs. They are supported in AAudio in API 29+. (#1768)
  • Added APIs to declare spatialization behavior. They are supported in AAudio in API 32+. (#1776)
  • Added ADPF support in Oboe. (#1788)
  • Added full duplex stream to Oboe. (#1920)

Bug fixes

  • Fixed an issue where Oboe was waiting for more frames than could be possibly available (#1702, Fixes #1701)
  • AAudio could sometimes return a positive number as an error code. Oboe now changes these to ErrorInternal. (#1711)
  • Fixed an issue where the resampler was causing sound the be muffled. (#1813, Fixes #1673, #1625)
  • Fixed an issue where some parameters were not copied in FilterAudioStream. (#1898, Fixes #1897)

OboeTester

  • Routing crash test (#1760)
  • CPU load test (#1788)
  • Cold start latency test (#1887)
  • Various bug fixes and improvements

1.7.0

15 Dec 01:23
8740d0f
Compare
Choose a tag to compare

API changes

  • Channel mask support is supported for AAudio in API 32 and above (#1548)
  • Add methods setDelayBeforeCloseMillis and getDelayBeforeCloseMillis to audio streams (#1593)
  • Add OboeExtensions (#1602). These will allow you to query for, enable, and disable MMAP support.
  • Add shared_ptr support for setDataCallback and setErrorCallback (#1626). The equivalent for raw pointers is now deprecated. This helps avoid crashes by preventing the callback from being deleted while the error callback is still active.

OpenSL ES bug fixes

  • Fixed an issue with OpenSL ES queuing only one callback buffer (#1245, Fixes #1165)
  • Fixed an issue with OpenSL ES volume not working if Usage was Unspecified (#1537, Fixes #1536)
  • Fixed an issue with OpenSL ES where resources were not closed if open failed (#1550, Fixes #1550)
  • Fixed an issue with OpenSL ES not handling processBufferCallback() from multiple threads correctly (#1570, #1621, Fixes #1567)
  • Fixed an issue with OpenSL ES returning 0 from getBufferSizeInFrames() if callbacks are not used (#1582, Fixes #1581)
  • Fixed an issue with OpenSL ES not handling large buffers gracefully (#1601, Fixes #744, #952)
  • Fixed an issue with OpenSL ES input streams not checking buffer depths (#1621, Fixes #1431)
  • Fixed an issue with OpenSL ES returning ErrorInternal for invalid formats (#1634)

Other bug fixes

  • Fixed an issue with AAudio segfaults if closed while reading or writing (#1497, Fixes #1484)
  • Fixed resampler glitches for some configurations (#1624, Fixes #1622)

Workarounds

  • Add Quirk to disable MMAP on Exynos SDM8150 (#1381, Fixes #1381)
  • Add Quirks for Vivo devices (#1590, Fixes #201)
  • Check for workaround flag for automatic INT16 to FLOAT conversion when FLOAT is not supported (#1590, Fixes #1589)

Code samples

Non core changes

  • Many OboeTester updates
  • API reference docs are automatically updated after API changes
  • Add RISC-V support to StablizedCallback.h (#1586)
  • Updated Oboe to support API 33 (#1618)

1.6.1

22 Jul 19:22
855ea84
Compare
Choose a tag to compare

API changes

  • Add methods setPackageName and setAttributionTag (#1332). These methods allow you to pass your package name and/or a tag when creating an audio stream. Android will output these strings in system logs to make it easier to attribute system calls back to your application.

Bug fixes and workarounds

  • Fixed an issue where an incorrect audio device ID could be used if sample rate conversion is also used (#1310)
  • flowgraph: Start linear ramps at the initial volume set (#1318)
  • fix unused-parameter warnings (#1331)
  • Add workaround for Samsung Galaxy S9 recording silence sometimes. Fixes #1110
  • Improve callback stop handling on pre-R devices (#1351, Fixes #1230)
  • Remove include of ndk-version.h (#1359, #Fixes #1358)

Binary changes

  • The Oboe libraries are now built with debug information to assist with debugging. This information is stripped automatically by Android Studio in release builds so there's no APK bloat. Fixes #1301.

Non core changes

  • Many updates to OboeTester
  • Code samples now use Float to Int16 conversion on API <21
  • Github repo default branch renamed from master to main

1.6.0

18 May 12:38
Compare
Choose a tag to compare
  • Add support for 24 and 32 bit sample formats. Support in AAudio will be added to Android 12. This was added to support some codecs that generate 24-bit output. We still recommend using Float format for most high-resolution use cases. (8041b38)
  • Add support for float output streams on pre-L devices (#1267)
  • Fix calculation related to sample rate conversion (#1256, thanks to @flamme and @chrismanchester)
  • Check for nullptr in FilterAudioStream::getTimestamp() (#1171, Fixes #1166)
  • Android TV improvements (a65df53, thanks to @ftsui)
  • Oboe now requires C++17 to be built from source (binaries available on https://maven.google.com/)
  • Add quirk for S20 input (Fixes #892)
  • Add quirk for Exynos850 devices (2c06e95)
  • Remove call to dlclose, avoids possible segfault (2ca99f6)
  • Fix possible, but very unlikely, race on close (#1200)

1.5.0

26 Nov 13:15
Compare
Choose a tag to compare

API changes

New callback classes

Added new classes AudioStreamDataCallback and AudioStreamErrorCallback. These classes replace AudioStreamCallback which is now deprecated. The new callback classes separate the responsibilities of data handling and error handling.

Additionally, AudioStreamErrorCallback includes a new onError method. This allows you to override the default error handling and stop/close the audio stream yourself. More details.

New features

  • Channel count conversion. Oboe now includes a ChannelCountConverter. This is part of the flowgraph library. It can be used directly for performing channel count conversion. Internally this class is used to handle situations where opening a stream with a specific channel count results in suboptimal performance. For example, some devices cannot obtain a low latency mono input stream so Oboe opens the stream in stereo and performs a seamless stereo->mono conversion for the application. [commit, PR]
  • Set a minimum buffer size for LatencyTuner. Added method LatencyTuner::setMinimumBufferSize which allows you to set the minimum buffer size in frames. This stops the LatencyTuner from reducing the buffer size below a user-defined threshold. Note that the value specified for the minimum buffer size should be an integer multiple of the burst size. [PR]

Bug fixes / workarounds

  • If you attempt to open an AAudio input stream without the relevant permission Oboe will now output a more useful error message. [commit]
  • Fixed a race condition that could cause a crash during close() if a callback was still running. [PR]
  • Fixed an issue with the sample rate converter which could cause input streams using callbacks to stall. [issue, commit]
  • Fixed several crashes associated with using setFramesPerCallback. [commit]
  • Fixed a bug that could cause stop() of an OpenSL ES stream with a non-zero timeout value to spin forever. [original issue]
  • In cases where the VoicePerformance input preset is not supported (OpenSL ES and Android P and below) Oboe will use the VoiceRecognition preset instead. [commit, commit]
  • In Android RQ1A a regression was introduced which meant that when a stream disconnects (e.g. headphones unplugged) a TIMEOUT error code was supplied rather than the expected DISCONNECT. This only affects SHARED AAudio MMAP streams. Oboe works around this by returning a DISCONNECT error code if a TIMEOUT error code is received on RQ1A. [commit]
  • Fixed a potential race condition when closing an OpenSL ES stream. [PR]
  • Fixed a problem where AAudio might accidentally call the flowgraph units in Oboe instead of in AAudio. [PR]
  • Added a workaround for broken mono recording on Samsung S9. [PR]

Documentation and samples updates

  • [docs] Added the OpenSL ES migration guide.
  • [all samples] Standardise package name to com.google.oboe.samples
  • [hello-oboe] Save user settings, use shared stream, use locks to prevent race conditions [commit]
  • [RhythmGame] Updates to the FFmpeg extractor and decoder [commit, commit]
  • [DrumThumper] Audio is resampled on app load to avoid resampling penalty during playback [commit]
  • [DrumThumper] App is now published on Play Store.
  • [parselib] Fixed a problem with parsing unexpected chunks in a WAV file. [issue]
  • [OboeTester] can now print a device and microphone report.

All commits since 1.4.3: 1.4.3...1.5.0

How to update existing code

On previous version of Oboe you implement AudioStreamCallback and override onAudioReady for data handling and the onError* methods for error handling.

In Oboe 1.5 data callbacks and error callbacks have been split into 2 separate classes. To migrate your code, create an AudioStreamDataCallback and an AudioStreamErrorCallback. Then copy the code from your existing AudioStreamCallback implementation to the new methods, as per the following table:

Deprecated method New method
AudioStreamCallback::onAudioReady AudioStreamDataCallback::onAudioReady
AudioStreamCallback::onErrorBeforeClose AudioStreamErrorCallback::onErrorBeforeClose
AudioStreamCallback::onErrorAfterClose AudioStreamErrorCallback::onErrorAfterClose

Corresponding setDataCallback and setErrorCallback methods have been added to AudioStreamBuilder and you must use these in place of setCallback.

The term "callback" within Oboe is now ambiguous so the following methods have been renamed to refer specifically to the data callback. If you're using any *FramesPerCallback methods, you should use the new methods instead.

Deprecated method New method
AudioStreamBuilder::setFramesPerCallback AudioStreamBuilder::setFramesPerDataCallback
AudioStream::getFramesPerCallback AudioStream::setFramesPerDataCallback

For further guidance take a look at this PR which updates the Oboe sample code.

1.4.3

05 Aug 10:51
Compare
Choose a tag to compare

Fixes issue where Oboe would fail to link with recent NDK versions.

Oboe bug: #966
NDK bug: android/ndk#1166

1.4.2

01 Jun 20:47
Compare
Choose a tag to compare

We fixed issue #535, which caused an intermittent crash in releaseBuffer() when a headset was plugged in. This mostly affected OpenSL ES. But it could affect AAudio if you called stream->getFramesRead() or stream->getTimeStamp() from an output stream callback. This was a serious crash that affected many apps. So we strongly recommend upgrading to Oboe 1.4.2. Here is a Tech Note that describes the issue in more detail.

We fixed issue #820, which could cause a stream to get deleted while it was in use by an onError callback. We now use a std::shared_ptr to hold the stream and strongly recommend using the following technique to open a stream:

std::shared_ptr<oboe::AudioStream> oboeStream; // hold onto this, maybe in an instance variable

Result result = builder.openStream(oboeStream);

Oboe error, warning and information log messages are now enabled in release builds.

We updated QuirksManager to handle specific device requirements. Some devices, for example, may require a different minimum number of bursts in their buffer. #734

Added “DrumThumper”, an interactive drum pad sample app. It demonstrates how to load drum sounds from WAV files, and how to mix multiple drums to one stream. See samples/DrumThumper.

For OpenSL ES, we now scale the buffer size by the sample rate so that it will better match the internal buffer sizes. The default is based on a 20 msec period common on Android. This will reduce glitching when using OpenSL ES.
#762

The LiveEffect sample app now handles a failure to open the stream. It used to crash. #796

1.3.0

15 Nov 17:37
Compare
Choose a tag to compare

Oboe now features resampling and format conversion so you can request a stream with a specific sample rate, channel count or format and still receive a low latency stream. Do this using the following methods:

AudioStreamBuilder builder;
builder.setSampleRateConversionQuality(SampleRateConversionQuality::Medium);
builder.setChannelConversionAllowed(true);
builder.setFormatConversionAllowed(true);`

The new ManagedStream class takes care of a stream lifecycle for you. Open one using the following code:

 ManagedStream myStream;
 AudioStreamBuilder builder;
 b.openManagedStream(myStream);

Many other bug fixes.

Full list of changes: 1.2.0...1.3-stable

1.2.0

23 Apr 17:53
Compare
Choose a tag to compare

New features

  • When creating a stream with PerformanceMode::LowLatency the buffer size is now set automatically to twice the burst size.

Behaviour changes

  • AudioStream::waitForStateChange now returns Result::ErrorTimeout if a timeout of zero is specified and the stream's state does not change. Previously it would return Result::OK.
  • AudioStream::getTimestamp now returns Result::ErrorInvalidState if called when the stream is not in the Started state. Previously the timestamp would continue to advance resulting in inaccurate latency measurements.

Bug fixes/workarounds

  • Fix crash caused caused by error callback running on a blocking read/write stream that does not use a data callback. #364
  • Avoid issue with recursive locking in AudioOutputStreamOpenSLES::requestFlush(). #378
  • Stop the stream when callback returns DataCallbackResult::Stop. Workaround for some AAudio bugs. #323
  • #406 Crash when headset plugs in/out
  • After opening an AAudio stream the stream state would stuck in the Starting state. Oboe now includes a workaround for this.
  • Many other bug fixes (see: https://github.com/google/oboe/issues?q=is%3Aclosed+milestone%3Av1.2)

Code samples

  • Codebase updated to use floats throughout
  • Added shared folder which contains shared code used by samples (for Oscillator, Mixer objects etc)
  • RhythmGame sample updated with ability to extract compressed audio assets using NDK media codec and FFmpeg

Plus many improvements in OboeTester.

Diff with previous release