C API¶

C-compatible interface for accessing KFR functionality.

C¶

• enum constant ::KFR_DFT_PACK_FORMAT::CCs Conjugate-complex symmetric format (N/2 + 1 complex values).

K¶

• function ::kfr_allocate_aligned(size_t, size_t)
• function ::kfr_allocate(size_t)
• macro KFR_API_SPEC
• enum constant (Unnamed enum at capi.h:119:1)::KFR_ARCH_AVX AVX.
• enum constant (Unnamed enum at capi.h:119:1)::KFR_ARCH_AVX2 AVX2.
• enum constant (Unnamed enum at capi.h:119:1)::KFR_ARCH_AVX512 AVX-512.
• macro KFR_ARCH_IS_X86
• enum constant (Unnamed enum at capi.h:119:1)::KFR_ARCH_SSE2 SSE2.
• enum constant (Unnamed enum at capi.h:119:1)::KFR_ARCH_SSE3 SSE3.
• enum constant (Unnamed enum at capi.h:119:1)::KFR_ARCH_SSE41 SSE4.1.
• enum constant (Unnamed enum at capi.h:119:1)::KFR_ARCH_SSE42 SSE4.2.
• enum constant (Unnamed enum at capi.h:119:1)::KFR_ARCH_SSSE3 SSSE3.
• enum constant (Unnamed enum at capi.h:119:1)::KFR_ARCH_X86 Baseline x86 (no SIMD).
• typedef ::kfr_bool Boolean type used throughout the CAPI. Maps to
• typedef ::kfr_c32 Single-precision complex type.
• typedef ::kfr_c64 Double-precision complex type.
• macro KFR_CDECL
• macro KFR_COMPLEX_SIZE_MULTIPLIER
• function ::kfr_current_arch() Returns the current architecture in use.
• function ::kfr_dct_create_plan_f32(size_t) Creates a DCT-II plan (single precision).
• function ::kfr_dct_create_plan_f64(size_t) Creates a DCT-II plan (double precision).
• function ::kfr_dct_delete_plan_f32(KFR_DCT_PLAN_F32 *) Deletes a DCT plan.
• function ::kfr_dct_delete_plan_f64(KFR_DCT_PLAN_F64 *) Deletes a DCT plan.
• function ::kfr_dct_dump_f32(KFR_DCT_PLAN_F32 *) Dumps details of the DCT plan to stdout for inspection.
• function ::kfr_dct_dump_f64(KFR_DCT_PLAN_F64 *) Dumps details of the DCT plan to stdout for inspection.
• function ::kfr_dct_execute_f32(KFR_DCT_PLAN_F32 *, kfr_f32 *, const kfr_f32 *, uint8_t *)
• function ::kfr_dct_execute_f64(KFR_DCT_PLAN_F64 *, kfr_f64 *, const kfr_f64 *, uint8_t *)
• function ::kfr_dct_execute_inverse_f32(KFR_DCT_PLAN_F32 *, kfr_f32 *, const kfr_f32 *, uint8_t *)
• function ::kfr_dct_execute_inverse_f64(KFR_DCT_PLAN_F64 *, kfr_f64 *, const kfr_f64 *, uint8_t *)
• function ::kfr_dct_get_size_f32(KFR_DCT_PLAN_F32 *) Returns the size of a DCT plan.
• function ::kfr_dct_get_size_f64(KFR_DCT_PLAN_F64 *) Returns the size of a DCT plan.
• function ::kfr_dct_get_temp_size_f32(KFR_DCT_PLAN_F32 *) Returns the temporary (scratch) buffer size required by the DCT plan.
• function ::kfr_dct_get_temp_size_f64(KFR_DCT_PLAN_F64 *) Returns the temporary (scratch) buffer size required by the DCT plan.
• struct ::KFR_DCT_PLAN_F32
• typedef ::KFR_DCT_PLAN_F32
• struct ::KFR_DCT_PLAN_F64
• typedef ::KFR_DCT_PLAN_F64
• function ::kfr_deallocate(void *)
• macro KFR_DEFAULT_ALIGNMENT
• function ::kfr_dft_create_2d_plan_f32(size_t, size_t) Creates a 2D complex DFT plan (single precision).
• function ::kfr_dft_create_2d_plan_f64(size_t, size_t) Creates a 2D complex DFT plan (double precision).
• function ::kfr_dft_create_3d_plan_f32(size_t, size_t, size_t) Creates a 3D complex DFT plan (single precision).
• function ::kfr_dft_create_3d_plan_f64(size_t, size_t, size_t) Creates a 3D complex DFT plan (double precision).
• function ::kfr_dft_create_md_plan_f32(size_t, const unsigned int *) Creates an N-dimensional complex DFT plan (single precision).
• function ::kfr_dft_create_md_plan_f64(size_t, const unsigned int *) Creates an N-dimensional complex DFT plan (double precision).
• function ::kfr_dft_create_plan_f32(size_t) Creates a complex DFT plan (single precision).
• function ::kfr_dft_create_plan_f64(size_t) Creates a complex DFT plan (double precision).
• function ::kfr_dft_delete_plan_f32(KFR_DFT_PLAN_F32 *) Deletes a complex DFT plan.
• function ::kfr_dft_delete_plan_f64(KFR_DFT_PLAN_F64 *) Deletes a complex DFT plan.
• function ::kfr_dft_dump_f32(KFR_DFT_PLAN_F32 *) Dumps details of the DFT plan to stdout for inspection.
• function ::kfr_dft_dump_f64(KFR_DFT_PLAN_F64 *) Dumps details of the DFT plan to stdout for inspection.
• function ::kfr_dft_execute_f32(KFR_DFT_PLAN_F32 *, kfr_c32 *, const kfr_c32 *, uint8_t *)
• function ::kfr_dft_execute_f64(KFR_DFT_PLAN_F64 *, kfr_c64 *, const kfr_c64 *, uint8_t *)
• function ::kfr_dft_execute_inverse_f32(KFR_DFT_PLAN_F32 *, kfr_c32 *, const kfr_c32 *, uint8_t *)
• function ::kfr_dft_execute_inverse_f64(KFR_DFT_PLAN_F64 *, kfr_c64 *, const kfr_c64 *, uint8_t *)
• function ::kfr_dft_get_size_f32(KFR_DFT_PLAN_F32 *) Returns the size of the DFT plan, in complex numbers.
• function ::kfr_dft_get_size_f64(KFR_DFT_PLAN_F64 *) Returns the size of the DFT plan, in complex numbers.
• function ::kfr_dft_get_temp_size_f32(KFR_DFT_PLAN_F32 *) Returns the temporary (scratch) buffer size required by the DFT plan.
• function ::kfr_dft_get_temp_size_f64(KFR_DFT_PLAN_F64 *) Returns the temporary (scratch) buffer size required by the DFT plan.
• enum ::KFR_DFT_PACK_FORMAT DFT packing format for real DFTs. See https://www.kfr.dev/docs/latest/dft_format/ for details.
• typedef ::KFR_DFT_PACK_FORMAT DFT packing format for real DFTs. See https://www.kfr.dev/docs/latest/dft_format/ for details.
• struct ::KFR_DFT_PLAN_F32
• typedef ::KFR_DFT_PLAN_F32
• struct ::KFR_DFT_PLAN_F64
• typedef ::KFR_DFT_PLAN_F64
• function ::kfr_dft_real_create_2d_plan_f32(size_t, size_t, kfr_bool) Creates a 2D real DFT plan (single precision).
• function ::kfr_dft_real_create_2d_plan_f64(size_t, size_t, kfr_bool) Creates a 2D real DFT plan (double precision).
• function ::kfr_dft_real_create_3d_plan_f32(size_t, size_t, size_t, kfr_bool) Creates a 3D real DFT plan (single precision).
• function ::kfr_dft_real_create_3d_plan_f64(size_t, size_t, size_t, kfr_bool) Creates a 3D real DFT plan (double precision).
• function ::kfr_dft_real_create_md_plan_f32(size_t, const unsigned int *, kfr_bool) Creates an N-dimensional real DFT plan (single precision).
• function ::kfr_dft_real_create_md_plan_f64(size_t, const unsigned int *, kfr_bool) Creates an N-dimensional real DFT plan (double precision).
• function ::kfr_dft_real_create_plan_f32(size_t, KFR_DFT_PACK_FORMAT) Creates a real DFT plan (single precision).
• function ::kfr_dft_real_create_plan_f64(size_t, KFR_DFT_PACK_FORMAT) Creates a real DFT plan (double precision).
• function ::kfr_dft_real_delete_plan_f32(KFR_DFT_REAL_PLAN_F32 *) Deletes a real DFT plan.
• function ::kfr_dft_real_delete_plan_f64(KFR_DFT_REAL_PLAN_F64 *) Deletes a real DFT plan.
• function ::kfr_dft_real_dump_f32(KFR_DFT_REAL_PLAN_F32 *) Dumps details of the real DFT plan to stdout for inspection.
• function ::kfr_dft_real_dump_f64(KFR_DFT_REAL_PLAN_F64 *) Dumps details of the real DFT plan to stdout for inspection.
• function ::kfr_dft_real_execute_f32(KFR_DFT_REAL_PLAN_F32 *, kfr_c32 *, const kfr_f32 *, uint8_t *)
• function ::kfr_dft_real_execute_f64(KFR_DFT_REAL_PLAN_F64 *, kfr_c64 *, const kfr_f64 *, uint8_t *)
• function ::kfr_dft_real_execute_inverse_f32(KFR_DFT_REAL_PLAN_F32 *, kfr_f32 *, const kfr_c32 *, uint8_t *)
• function ::kfr_dft_real_execute_inverse_f64(KFR_DFT_REAL_PLAN_F64 *, kfr_f64 *, const kfr_c64 *, uint8_t *)
• function ::kfr_dft_real_get_size_f32(KFR_DFT_REAL_PLAN_F32 *) Returns the size of a real DFT plan.
• function ::kfr_dft_real_get_size_f64(KFR_DFT_REAL_PLAN_F64 *) Returns the size of a real DFT plan.
• function ::kfr_dft_real_get_temp_size_f32(KFR_DFT_REAL_PLAN_F32 *) Returns the temporary (scratch) buffer size required by the real DFT plan (single precision).
• function ::kfr_dft_real_get_temp_size_f64(KFR_DFT_REAL_PLAN_F64 *) Returns the temporary (scratch) buffer size required by the real DFT plan (double precision).
• struct ::KFR_DFT_REAL_PLAN_F32
• typedef ::KFR_DFT_REAL_PLAN_F32
• struct ::KFR_DFT_REAL_PLAN_F64
• typedef ::KFR_DFT_REAL_PLAN_F64
• function ::kfr_enabled_archs() Returns the list of enabled architectures as a string.
• typedef ::kfr_f32 Single-precision floating-point type.
• typedef ::kfr_f64 Double-precision floating-point type.
• macro KFR_FALSE
• struct ::KFR_FILTER_C32
• typedef ::KFR_FILTER_C32
• struct ::KFR_FILTER_C64
• typedef ::KFR_FILTER_C64
• function ::kfr_filter_create_convolution_plan_f32(const kfr_f32 *, size_t, size_t) Creates a convolution filter plan (single precision).
• function ::kfr_filter_create_convolution_plan_f64(const kfr_f64 *, size_t, size_t) Creates a convolution filter plan (double precision).
• function ::kfr_filter_create_fir_plan_f32(const kfr_f32 *, size_t) Creates a FIR filter plan (single precision).
• function ::kfr_filter_create_fir_plan_f64(const kfr_f64 *, size_t) Creates a FIR filter plan (double precision).
• function ::kfr_filter_create_iir_plan_f32(const kfr_f32 *, size_t) Creates an IIR filter plan (single precision) from a cascade of second-order sections.
• function ::kfr_filter_create_iir_plan_f64(const kfr_f64 *, size_t) Creates an IIR filter plan (double precision) from a cascade of second-order sections.
• function ::kfr_filter_delete_plan_f32(KFR_FILTER_F32 *) Deletes a filter plan.
• function ::kfr_filter_delete_plan_f64(KFR_FILTER_F64 *) Deletes a filter plan.
• struct ::KFR_FILTER_F32
• typedef ::KFR_FILTER_F32
• struct ::KFR_FILTER_F64
• typedef ::KFR_FILTER_F64
• function ::kfr_filter_process_f32(KFR_FILTER_F32 *, kfr_f32 *, const kfr_f32 *, size_t) Processes input data with a filter.
• function ::kfr_filter_process_f64(KFR_FILTER_F64 *, kfr_f64 *, const kfr_f64 *, size_t) Processes input data with a filter.
• function ::kfr_filter_reset_f32(KFR_FILTER_F32 *) Resets the internal state of a filter plan, including its delay line.
• function ::kfr_filter_reset_f64(KFR_FILTER_F64 *) Resets the internal state of a filter plan, including its delay line.
• macro KFR_HEADERS_VERSION
• function ::kfr_last_error() Returns the last error message.
• macro KFR_OPAQUE_STRUCT
• macro KFR_TRUE
• function ::kfr_version() Returns the library version as an integer.
• function ::kfr_version_string() Returns the library version as a string.

O¶

• variable ::KFR_DFT_PLAN_F32::opaque
• variable ::KFR_DFT_PLAN_F64::opaque
• variable ::KFR_DFT_REAL_PLAN_F32::opaque
• variable ::KFR_DFT_REAL_PLAN_F64::opaque
• variable ::KFR_DCT_PLAN_F32::opaque
• variable ::KFR_DCT_PLAN_F64::opaque
• variable ::KFR_FILTER_F32::opaque
• variable ::KFR_FILTER_F64::opaque
• variable ::KFR_FILTER_C32::opaque
• variable ::KFR_FILTER_C64::opaque

P¶

• enum constant ::KFR_DFT_PACK_FORMAT::Perm Permuted format (N/2 complex values).

U¶

• enum (Unnamed enum at capi.h:119:1) Supported architectures enumeration.