Comparisonics API: CS_create_sample

Comparisonics API

CS_create_sample_processor( ) allocates and initializes an internal data structure used in the indexing process.

CS_Sample_Processor CS_create_sample_processor(
CS_Sample_Rate rate /* sample rate */
);

Parameter

rate

Specifies the sample rate in number of samples per second (e.g., 44100). This value must be at least 8000.

Return Values

If the function succeeds, the return value is a valid pointer to an internal data structure. This pointer may be passed in subsequent calls of CS_process_sample( ), CS_get_signature( ), and CS_destroy_sample_processor( ).

If the function fails, the return value is NULL. The function will fail if the rate parameter is less than 8000, or if the function is unable to allocate the data structure.

Remarks

Any sample rate of at least 8000 samples per second may be specified. This parameter is not limited to common sample rates such as 8000, 11025, 22050, and 44100 samples per second.

This function calls calloc( ) to allocate the data structure, which is about 1024 bytes in size.