https://github.com/arlodotexe/owlcore.storage.openal
Handle your audio devices like simple files and folders
https://github.com/arlodotexe/owlcore.storage.openal
Last synced: 5 months ago
JSON representation
Handle your audio devices like simple files and folders
- Host: GitHub
- URL: https://github.com/arlodotexe/owlcore.storage.openal
- Owner: Arlodotexe
- Created: 2024-04-28T09:15:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-23T01:41:17.000Z (6 months ago)
- Last Synced: 2024-11-23T02:27:27.670Z (6 months ago)
- Language: C#
- Size: 39.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# OwlCore.Storage.OpenAL [](https://www.nuget.org/packages/OwlCore.Storage.OpenAL)
Handle your audio devices like simple files and folders.
## Featuring:
- Capture devices via OpenALCaptureDeviceFolder. Contains files corresponding to available capture devices whose Stream continuously reads samples from the capture device.
## Install
Published releases are available on [NuGet](https://www.nuget.org/packages/OwlCore.Storage.OpenAL). To install, run the following command in the [Package Manager Console](https://docs.nuget.org/docs/start-here/using-the-package-manager-console).
PM> Install-Package OwlCore.Storage.OpenAL
Or using [dotnet](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet)
> dotnet add package OwlCore.Storage.OpenAL
## Usage
```cs
var captureDevicesFolder = new OpenALCaptureDevicesFolder();
// Iterate through all capture devices
await foreach (var captureDevice in captureDevicesFolder.GetFilesAsync(cancellationToken))
Console.WriteLine($"Capture device: {captureDevice.Name}");
// Get default capture device
var defaultDevice = (OpenALCaptureDeviceFile)await captureDevicesFolder.GetItemAsync($"{captureDevicesFolder.Id}/default");
// Change buffer format or sample rate as needed
defaultDevice.Format = BufferFormat.Mono8;
// Open device stream
await using var deviceStream = (OpenALCaptureDeviceStream)await deviceFile.OpenReadAsync(cancellationToken);
// Create wav buffer helper (via Naudio.Wave)
// Because the stream buffer can only be so large, we use the BufferedWaveProvider to collect enough buffered samples to fill a TimeSpan.
var captureBufferInterval = TimeSpan.FromSeconds(5);
var wavBufferProvider = new BufferedWaveProvider(deviceStream.WaveFormat)
{
BufferDuration = captureBufferInterval,
};
// Read device file stream continuously until cancelled
while (!cancellationToken.IsCancellationRequested)
{
// Read samples from stream
// OpenALCaptureDeviceStream should fill it with as many samples as it can given the provided buffer size. The rest is padded with zeros.
var sampleBuffer = new byte[deviceStream.WaveFormat.ConvertLatencyToByteSize(500)];
var sampleBufferBytesRead = await deviceStream.ReadAsync(sampleBuffer, 0, sampleBuffer.Length, cancellationToken);
if (sampleBufferBytesRead == 0)
continue;
// Ignore empty buffers
if (sampleBuffer.All(static x => x == default))
continue;
// Copy buffered samples from device stream into our BufferedWaveProvider
wavBufferProvider.AddSamples(sampleBuffer, 0, sampleBufferBytesRead);
// When the full duration has been reached, do something with the full buffer.
if (wavBufferProvider.BufferedDuration >= wavBufferProvider.BufferDuration)
{
// For example
// Buffer is full, reset buffered provider and continue;
var currentProvider = wavBufferProvider;
buffersToProcessLoop.Add(currentProvider);
wavBufferProvider = new BufferedWaveProvider(deviceStream.WaveFormat)
{
BufferDuration = captureBufferInterval,
};
}
}
```
## Financing
We accept donations [here](https://github.com/sponsors/Arlodotexe) and [here](https://www.patreon.com/arlodotexe), and we do not have any active bug bounties.
## Versioning
Version numbering follows the Semantic versioning approach. However, if the major version is `0`, the code is considered alpha and breaking changes may occur as a minor update.
## License
All OwlCore code is licensed under the MIT License. OwlCore is licensed under the MIT License. See the [LICENSE](./src/LICENSE.txt) file for more details.