LibXCoder API Version Compatibility

Netint is committed to providing new libxcoder (SW) releases with compatibility for linked applications with code written for a previous version of ibxcoder release. This means, after installing a new version of libxcoder, a linked application does not need code change to work with the new libxcoder. But the linked application will likely need to be recompiled with the new libxcoder’s headers.

libxcoder API version

The libxcoder API version number (e.g. 2.0) has two parts, semantic major and semantic minor. It is found in libxcoder/source/ni_defs.h as the macro LIBXCODER_API_VERSION.

When the semantic major version number changes, a backward incompatible change has been made to libxcoder public API. Linked applications likely need code change to operate with new libxcoder. Netint is unlikely to ever change libxcoder in a backward incompatible manner.

When the semantic minor version number changes, a backward compatible change has been made to libxcoder public API. Linked applications will need to be recompiled to operate with new libxcoder. Linked application code should be changed to cease using any deprecated functions, but this code change is not strictly necessary.

If libxcoder API version does not change in a new Netint SW release, it will not be necessary to recompile application linked to libxcoder.

Reading Various Version Numbers

To read the libxcoder API version number application is compiled with, use the macro LIBXCODER_API_VERSION in ni_defs.h.

To read the libxcoder API version number application is linked with, use the function ni_get_libxcoder_api_ver() in ni_util.h.

To read the compatible FW API version number for the libxcoder linked to by application, use the function ni_get_compat_fw_api_ver() in ni_util.h.

To read the Netint SW release version number for the libxcoder linked to by application, use the function ni_get_libxcoder_release_ver() in ni_util.h.

Libxcoder Public API Deprecation Warnings

New libxcoder releases may deprecate functions/structs/macros. When compiling an application linked to libxcoder, the use of deprecated elements will cause compiler warnings C4995/C4996. It is recommended, but not necessary, to update application code to not use deprecated elements. Check the code comments beside deprecated elements for suggestions on new elements to use; or, check for an element of similar name but with a number suffix in the name.

To disable warning for deprecation from libxcoder elements, add -DNI_WARN_AS_ERROR to your compiler options (e.g. gcc -DNI_WARN_AS_ERROR).