Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pschatzmann/arduino-libopus
The Opus Codec for Arduino
https://github.com/pschatzmann/arduino-libopus
arduino-library audio codec opus
Last synced: 2 months ago
JSON representation
The Opus Codec for Arduino
- Host: GitHub
- URL: https://github.com/pschatzmann/arduino-libopus
- Owner: pschatzmann
- License: other
- Created: 2022-05-04T01:38:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T14:13:50.000Z (10 months ago)
- Last Synced: 2024-10-11T13:36:37.301Z (3 months ago)
- Topics: arduino-library, audio, codec, opus
- Language: C
- Homepage:
- Size: 2.65 MB
- Stars: 17
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The Opus Codec for Arduino
Opus is a codec for interactive speech and audio transmission over the Internet.
Opus can handle a wide range of interactive audio applications, including
Voice over IP, videoconferencing, in-game chat, and even remote live music
performances. It can scale from low bit-rate narrowband speech to very high
quality stereo music.
Opus, when coupled with an appropriate container format, is also suitable
for non-realtime stored-file applications such as music distribution, game
soundtracks, portable music players, jukeboxes, and other applications that
have historically used high latency formats such as MP3, AAC, or Vorbis.
Opus is specified by IETF RFC 6716:
https://tools.ietf.org/html/rfc6716
The Opus format and this implementation of it are subject to the royalty-
free patent and copyright licenses specified in the file COPYING.
Opus packets are not self-delimiting, but are designed to be used inside a __container__ of some sort which supplies the decoder with each packet's length. Opus was originally specified for encapsulation in __Ogg containers__.
This project contains
- [the opus codec](https://opus-codec.org/)
- [libogg](https://xiph.org/ogg/)
- [liboggz](https://www.xiph.org/oggz/)
## Installation in Arduino
You can download the library as zip and call include Library -> zip library. Or you can git clone this project into the Arduino libraries folder e.g. with
```
cd ~/Documents/Arduino/libraries
git clone https://github.com/pschatzmann/arduino-libopus.git
```
## Documentation
I recommend to use this library together with my [Arduino Audio Tools](https://github.com/pschatzmann/arduino-audio-tools).
This is just one of many __codecs__ that I have collected so far: Further details can be found in the [Encoding and Decoding Wiki](https://github.com/pschatzmann/arduino-audio-tools/wiki/Encoding-and-Decoding-of-Audio) of the Audio Tools.
## Design
In order to create an Arduino compatible library I executed the following steps:
- Added the projects to the src directory
- Symlinked the header files into src
- Symlinked additional header subdirectories
- Replaced symlinks with regular files that conain an #include to the originally symlinked location, because Windows does not support symlinks properly
- Moved offending code which was platform specific or contained a main() to the /incompatible directory
- Renamed all config.h to opus_config.h to avoid conflicts with the standard Arduino environment. I disabled the floating point api and activated the fixed point api instead!
- Added a opus_config.h to the src directory
- Replaced #ifdef HAVE_CONFIG_H with #if defined(HAVE_CONFIG_H) || defined(ARDUINO) to make sure the config is used
- Added define guards to .c files in float and fixed directories to prevent compile errors
- The functionality requires a big stack. Fortunately we can use a psydostack implementation with NONTHREADSAFE_PSEUDOSTACK you can fine tune the memory requirement by defining GLOBAL_STACK_SIZE. The default setting is 120000 which is too big for most microcontrollers!