Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hendriks73/ffsampledsp
FFmpeg based service provider for javax.sound.sampled.
https://github.com/hendriks73/ffsampledsp
audio audio-decoder ffmpeg java java-library macos sound ubuntu windows
Last synced: 30 days ago
JSON representation
FFmpeg based service provider for javax.sound.sampled.
- Host: GitHub
- URL: https://github.com/hendriks73/ffsampledsp
- Owner: hendriks73
- License: lgpl-2.1
- Created: 2013-06-21T10:18:48.000Z (over 11 years ago)
- Default Branch: dev
- Last Pushed: 2024-09-03T21:34:02.000Z (2 months ago)
- Last Synced: 2024-09-30T18:43:10.565Z (about 1 month ago)
- Topics: audio, audio-decoder, ffmpeg, java, java-library, macos, sound, ubuntu, windows
- Language: Java
- Homepage:
- Size: 20 MB
- Stars: 24
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html)
[](https://maven-badges.herokuapp.com/maven-central/com.tagtraum/ffsampledsp)
[](https://github.com/hendriks73/ffsampledsp/actions)
[](https://codecov.io/gh/hendriks73/ffsampledsp/branch/main)
# FFSampledSP
*FFSampledSP* is an implementation of the
[javax.sound.sampled](https://docs.oracle.com/javase/10/docs/api/javax/sound/sampled/spi/package-summary.html)
service provider interfaces based on [FFmpeg](https://www.ffmpeg.org), a complete, cross-platform solution to record,
convert and stream audio and video.
FFSampledSP is part of the [SampledSP](https://www.tagtraum.com/sampledsp.html) collection of `javax.sound.sampled`
libraries.
Its main purpose is to decode audio files or streams to signed
[linear PCM](https://en.wikipedia.org/wiki/Pulse-code_modulation).
Supported platforms are currently:
- macOS x64 (>=10.8) and aarch64 (>=11)
- Windows i686 and x64
- Linux (Ubuntu 20) x64 and aarch64 (arm64)
FFSampledSP makes use of the [tagtraum FFmpeg package](https://www.tagtraum.com/ffmpeg).
Binaries and more info can be found at its [tagtraum home](https://www.tagtraum.com/ffsampledsp/).
## Installation
FFSampledSP is released via [Maven](https://maven.apache.org).
You can install it via the following dependency:
```xml
com.tagtraum
ffsampledsp-complete
```
## Usage
To use the library, simply use
[javax.sound.sampled](https://docs.oracle.com/javase/10/docs/api/javax/sound/sampled/spi/package-summary.html)
like you normally would.
Note that opening an `AudioInputStream` of compressed audio (e.g. mp3), does
*not* decode the stream. To obtain PCM you still have to transcode to PCM like this:
```java
import javax.sound.sampled.AudioFormat;
import javax.sound.sampled.AudioInputStream;
import javax.sound.sampled.AudioSystem;
public class DecodeExample {
public static void main(final String[] args) {
// compressed stream
final AudioInputStream mp3In = AudioSystem.getAudioInputStream(new File(args[0]));
// AudioFormat describing the compressed stream
final AudioFormat mp3Format = mp3In.getFormat();
// AudioFormat describing the desired decompressed stream
final AudioFormat pcmFormat = new AudioFormat(
AudioFormat.Encoding.PCM_SIGNED,
mp3Format.getSampleRate(),
16,
mp3Format.getChannels(),
16 * mp3Format.getChannels() / 8,
mp3Format.getSampleRate(),
mp3Format.isBigEndian()
);
// actually decompressed stream (signed PCM)
final AudioInputStream pcmIn = AudioSystem.getAudioInputStream(mp3In, pcmFormat);
// do something with the raw audio stream pcmIn...
}
}
```
## Build
You can build this library locally on macOS, Windows, or Linux (Ubuntu is tested).
When doing so, only the appropriate native libraries are included in the "complete" jar.
The GitHub-based build also adds native libraries for other platforms.
To do so, you also need:
- [Maven](https://maven.apache.org/)
- For macOS: [Apple Command Line Tools](https://developer.apple.com/)
or [XCode](https://developer.apple.com/xcode/)
- For Windows: [MSYS2](https://www.msys2.org) with GCC etc.
- a JDK (to run Maven and get the JNI headers)
- [Doxygen](https://www.doxygen.nl), available via [MacPorts](https://www.macports.org), [HomeBrew](https://brew.sh) or [MSYS2](https://www.msys2.org).
Note, that the C sources in the `ffsampledsp-x86_64-macos` module are expected to compile
on all supported platforms. In fact, the very same sources *are* compiled in the modules
for other platforms.
## Release Notes
You can find the release notes/history [here](NOTES.md).