code.octet-stream.net Git - m17rt/blob - m17codec2/README.md

   1 # m17codec2
   2
   3 Part of the [M17 Rust Toolkit](https://octet-stream.net/p/m17rt/). Pre-made adapters designed for the `m17app` crate that make it easier to work with Codec2 voice streams.
   4
   5 * `WavePlayer` - transmit a wave file as a stream (8 kHz, mono, 16 bit LE)
   6 * `Codec2Adapter` - receive all incoming streams and attempt to play the decoded audio on the default sound card
   7
   8 **Important licence note:** While `m17codec2` is under the MIT licence, it uses the `codec2` crate as a dependency, which will statically link LGPL code in the build. If you are distributing software in a way where LGPL compliance requires special care (e.g., dynamic linking), consider implementing your own codec2 adapters in a way that is compliant in your scenario.