Secret Rabbit Code (aka libsamplerate)

Applications Programming Interface

The publically callable functions of libsamplerate are all listed in the <samplerate.h> header file. The API allows two methods for accessing the capabilies of the library:

  • A simple interface which can sample rate convert a single block of samples (one or more channels) in one go. The simple API is less capable than the full API.
  • A more fully featured interface which allows time varying sample rate conversion on streaming data (again one or more channels).

The parts of the API which are common to both are:

Both versions of the API are restricted to operating on buffers of ISO C Standard float data. Other data types are not supported.

Note: The tests/ and examples/ directories of the source code distribution contain numerous example programs showing the use of the library.