Commit 75d81f5b authored by Timothy B. Terriberry's avatar Timothy B. Terriberry
Browse files

Document how to tell if your build is fixed-point.

This way we won't break this by accident.
parent 45cbdff3
...@@ -280,6 +280,9 @@ const char *opus_strerror(int error) ...@@ -280,6 +280,9 @@ const char *opus_strerror(int error)
const char *opus_get_version_string(void) const char *opus_get_version_string(void)
{ {
return "libopus " PACKAGE_VERSION return "libopus " PACKAGE_VERSION
/* Applications may rely on the presence of this substring in the version
string to determine if they have a fixed-point or floating-point build
at runtime. */
#ifdef FIXED_POINT #ifdef FIXED_POINT
"-fixed" "-fixed"
#endif #endif
......
...@@ -713,6 +713,10 @@ extern "C" { ...@@ -713,6 +713,10 @@ extern "C" {
OPUS_EXPORT const char *opus_strerror(int error); OPUS_EXPORT const char *opus_strerror(int error);
/** Gets the libopus version string. /** Gets the libopus version string.
*
* Applications may look for the substring "-fixed" in the version string to
* determine whether they have a fixed-point or floating-point build at
* runtime.
* *
* @returns Version string * @returns Version string
*/ */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment