Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Branch: master
Fetching contributors…

Cannot retrieve contributors at this time

289 lines (264 sloc) 9.18 kB
/*
* Chromaprint -- Audio fingerprinting toolkit
* Copyright (C) 2010-2012 Lukas Lalinsky <lalinsky@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
* USA
*/
#ifndef CHROMAPRINT_CHROMAPRINT_H_
#define CHROMAPRINT_CHROMAPRINT_H_
#ifdef __cplusplus
extern "C" {
#endif
#if (defined(_WIN32) || defined(_WIN64))
# ifdef CHROMAPRINT_NODLL
# define CHROMAPRINT_API
# else
# ifdef CHROMAPRINT_API_EXPORTS
# define CHROMAPRINT_API __declspec(dllexport)
# else
# define CHROMAPRINT_API __declspec(dllimport)
# endif
# endif
#else
# if __GNUC__ >= 4
# define CHROMAPRINT_API __attribute__ ((visibility("default")))
# else
# define CHROMAPRINT_API
# endif
#endif
typedef void *ChromaprintContext;
#define CHROMAPRINT_VERSION_MAJOR 1
#define CHROMAPRINT_VERSION_MINOR 2
#define CHROMAPRINT_VERSION_PATCH 0
enum ChromaprintAlgorithm {
CHROMAPRINT_ALGORITHM_TEST1 = 0,
CHROMAPRINT_ALGORITHM_TEST2,
CHROMAPRINT_ALGORITHM_TEST3,
CHROMAPRINT_ALGORITHM_TEST4
};
#define CHROMAPRINT_ALGORITHM_DEFAULT CHROMAPRINT_ALGORITHM_TEST2
/**
* Return the version number of Chromaprint.
*/
CHROMAPRINT_API const char *chromaprint_get_version(void);
/**
* Allocate and initialize the Chromaprint context.
*
* Note that when Chromaprint is compiled with FFTW, this function is
* not reentrant and you need to call it only from one thread at a time.
* This is not a problem when using FFmpeg or vDSP.
*
* Parameters:
* - version: Version of the fingerprint algorithm, use
* CHROMAPRINT_ALGORITHM_DEFAULT for the default
* algorithm
*
* Returns:
* - Chromaprint context pointer
*/
CHROMAPRINT_API ChromaprintContext *chromaprint_new(int algorithm);
/**
* Deallocate the Chromaprint context.
*
* Note that when Chromaprint is compiled with FFTW, this function is
* not reentrant and you need to call it only from one thread at a time.
* This is not a problem when using FFmpeg or vDSP.
*
* Parameters:
* - ctx: Chromaprint context pointer
*/
CHROMAPRINT_API void chromaprint_free(ChromaprintContext *ctx);
/**
* Return the fingerprint algorithm this context is configured to use.
*/
CHROMAPRINT_API int chromaprint_get_algorithm(ChromaprintContext *ctx);
/**
* Set a configuration option for the selected fingerprint algorithm.
*
* NOTE: DO NOT USE THIS FUNCTION IF YOU ARE PLANNING TO USE
* THE GENERATED FINGERPRINTS WITH THE ACOUSTID SERVICE.
*
* Parameters:
* - ctx: Chromaprint context pointer
* - name: option name
* - value: option value
*
* Possible options:
* - silence_threshold: threshold for detecting silence, 0-32767
*
* Returns:
* - 0 on error, 1 on success
*/
CHROMAPRINT_API int chromaprint_set_option(ChromaprintContext *ctx, const char *name, int value);
/**
* Restart the computation of a fingerprint with a new audio stream.
*
* Parameters:
* - ctx: Chromaprint context pointer
* - sample_rate: sample rate of the audio stream (in Hz)
* - num_channels: numbers of channels in the audio stream (1 or 2)
*
* Returns:
* - 0 on error, 1 on success
*/
CHROMAPRINT_API int chromaprint_start(ChromaprintContext *ctx, int sample_rate, int num_channels);
/**
* Send audio data to the fingerprint calculator.
*
* Parameters:
* - ctx: Chromaprint context pointer
* - data: raw audio data, should point to an array of 16-bit signed
* integers in native byte-order
* - size: size of the data buffer (in samples)
*
* Returns:
* - 0 on error, 1 on success
*/
CHROMAPRINT_API int chromaprint_feed(ChromaprintContext *ctx, void *data, int size);
/**
* Process any remaining buffered audio data and calculate the fingerprint.
*
* Parameters:
* - ctx: Chromaprint context pointer
*
* Returns:
* - 0 on error, 1 on success
*/
CHROMAPRINT_API int chromaprint_finish(ChromaprintContext *ctx);
/**
* Return the calculated fingerprint as a compressed string.
*
* The caller is responsible for freeing the returned pointer using
* chromaprint_dealloc().
*
* Parameters:
* - ctx: Chromaprint context pointer
* - fingerprint: pointer to a pointer, where a pointer to the allocated array
* will be stored
*
* Returns:
* - 0 on error, 1 on success
*/
CHROMAPRINT_API int chromaprint_get_fingerprint(ChromaprintContext *ctx, char **fingerprint);
/**
* Return the calculated fingerprint as an array of 32-bit integers.
*
* The caller is responsible for freeing the returned pointer using
* chromaprint_dealloc().
*
* Parameters:
* - ctx: Chromaprint context pointer
* - fingerprint: pointer to a pointer, where a pointer to the allocated array
* will be stored
* - size: number of items in the returned raw fingerprint
*
* Returns:
* - 0 on error, 1 on success
*/
CHROMAPRINT_API int chromaprint_get_raw_fingerprint(ChromaprintContext *ctx, void **fingerprint, int *size);
/**
* Return 32-bit hash of the calculated fingerprint.
*
* See chromaprint_hash_fingerprint() for details on how to use the hash.
*
* Parameters:
* - ctx: Chromaprint context pointer
* - hash: pointer to a 32-bit integer where the hash will be stored
*
* Returns:
* - 0 on error, 1 on success
*/
CHROMAPRINT_API int chromaprint_get_fingerprint_hash(ChromaprintContext *ctx, void *hash);
/**
* Compress and optionally base64-encode a raw fingerprint
*
* The caller is responsible for freeing the returned pointer using
* chromaprint_dealloc().
*
* Parameters:
* - fp: pointer to an array of 32-bit integers representing the raw
* fingerprint to be encoded
* - size: number of items in the raw fingerprint
* - algorithm: Chromaprint algorithm version which was used to generate the
* raw fingerprint
* - encoded_fp: pointer to a pointer, where the encoded fingerprint will be
* stored
* - encoded_size: size of the encoded fingerprint in bytes
* - base64: Whether to return binary data or base64-encoded ASCII data. The
* compressed fingerprint will be encoded using base64 with the
* URL-safe scheme if you set this parameter to 1. It will return
* binary data if it's 0.
*
* Returns:
* - 0 on error, 1 on success
*/
CHROMAPRINT_API int chromaprint_encode_fingerprint(const void *fp, int size, int algorithm, void **encoded_fp, int *encoded_size, int base64);
/**
* Uncompress and optionally base64-decode an encoded fingerprint
*
* The caller is responsible for freeing the returned pointer using
* chromaprint_dealloc().
*
* Parameters:
* - encoded_fp: Pointer to an encoded fingerprint
* - encoded_size: Size of the encoded fingerprint in bytes
* - fp: Pointer to a pointer, where the decoded raw fingerprint (array
* of 32-bit integers) will be stored
* - size: Number of items in the returned raw fingerprint
* - algorithm: Chromaprint algorithm version which was used to generate the
* raw fingerprint
* - base64: Whether the encoded_fp parameter contains binary data or
* base64-encoded ASCII data. If 1, it will base64-decode the data
* before uncompressing the fingerprint.
*
* Returns:
* - 0 on error, 1 on success
*/
CHROMAPRINT_API int chromaprint_decode_fingerprint(const void *encoded_fp, int encoded_size, void **fp, int *size, int *algorithm, int base64);
/**
* Generate a single 32-bit hash for a raw fingerprint.
*
* If two fingerprints are similar, their hashes generated by this function
* will also be similar. If they are significantly different, their hashes
* will most likely be significantly different as well, but you can't rely
* on that.
*
* You compare two hashes by counting the bits in which they differ. Normally
* that would be something like POPCNT(hash1 XOR hash2), which returns a
* number between 0 and 32. Anthing above 15 means the hashes are
* completely different.
*
* Parameters:
* - fp: pointer to an array of 32-bit integers representing the raw
* fingerprint to be hashed
* - size: number of items in the raw fingerprint
* - hash: pointer to a 32-bit integer where the hash will be stored
*
* Returns:
* - 0 on error, 1 on success
*/
CHROMAPRINT_API int chromaprint_hash_fingerprint(const void *fp, int size, void *hash);
/**
* Free memory allocated by any function from the Chromaprint API.
*
* Parameters:
* - ptr: Pointer to be deallocated
*/
CHROMAPRINT_API void chromaprint_dealloc(void *ptr);
#ifdef __cplusplus
}
#endif
#endif
Jump to Line
Something went wrong with that request. Please try again.