README.draft 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. To build this source code, simply type:
  2. % make
  3. If this does not work, or if you want to change the default configuration
  4. (e.g., to compile for a fixed-point architecture), simply edit the options
  5. in the Makefile.
  6. An up-to-date implementation conforming to this standard is available in a
  7. Git repository at https://gitlab.xiph.org/xiph/opus.git or on a website at:
  8. https://opus-codec.org/
  9. However, although that implementation is expected to remain conformant
  10. with the standard, it is the code in this RFC that shall remain normative.
  11. To build from the git repository instead of using this RFC, follow these
  12. steps:
  13. 1) Clone the repository (latest implementation of this standard at the time
  14. of publication)
  15. % git clone https://gitlab.xiph.org/xiph/opus.git
  16. % cd opus
  17. 2) Compile
  18. % ./autogen.sh
  19. % ./configure
  20. % make
  21. Once you have compiled the codec, there will be a opus_demo executable in
  22. the top directory.
  23. Usage: opus_demo [-e] <application> <sampling rate (Hz)> <channels (1/2)>
  24. <bits per second> [options] <input> <output>
  25. opus_demo -d <sampling rate (Hz)> <channels (1/2)> [options]
  26. <input> <output>
  27. mode: voip | audio | restricted-lowdelay
  28. options:
  29. -e : only runs the encoder (output the bit-stream)
  30. -d : only runs the decoder (reads the bit-stream as input)
  31. -cbr : enable constant bitrate; default: variable bitrate
  32. -cvbr : enable constrained variable bitrate; default: unconstrained
  33. -bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband);
  34. default: sampling rate
  35. -framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20
  36. -max_payload <bytes> : maximum payload size in bytes, default: 1024
  37. -complexity <comp> : complexity, 0 (lowest) ... 10 (highest); default: 10
  38. -inbandfec : enable SILK inband FEC
  39. -forcemono : force mono encoding, even for stereo input
  40. -dtx : enable SILK DTX
  41. -loss <perc> : simulate packet loss, in percent (0-100); default: 0
  42. input and output are little endian signed 16-bit PCM files or opus bitstreams
  43. with simple opus_demo proprietary framing.