Files
music-tag-web/component/mz/fpcalc.py

320 lines
11 KiB
Python

#!/usr/bin/env python
# This file is part of pyacoustid.
# Copyright 2012, Lukas Lalinsky.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
"""Simple script for calculating audio fingerprints, using the same
arguments/output as the fpcalc utility from Chromaprint."""
from __future__ import division
from __future__ import absolute_import
from __future__ import print_function
import argparse
import sys
import acoustid
# Copyright (C) 2011 Lukas Lalinsky
# (Minor modifications by Adrian Sampson.)
# Distributed under the MIT license, see the LICENSE file for details.
"""Low-level ctypes wrapper from the chromaprint library."""
import sys
import ctypes
import ctypes.util
if sys.version_info[0] >= 3:
BUFFER_TYPES = (memoryview, bytearray,)
BYTES_TYPE = bytes
elif sys.version_info[1] >= 7:
BUFFER_TYPES = (buffer, memoryview, bytearray,) # noqa: F821
BYTES_TYPE = str
else:
BUFFER_TYPES = (buffer, bytearray,) # noqa: F821
BYTES_TYPE = str
# Find the base library and declare prototypes.
def _guess_lib_name():
if sys.platform == 'darwin':
return ('libchromaprint.1.dylib', 'libchromaprint.0.dylib')
elif sys.platform == 'win32':
return ('chromaprint.dll', 'libchromaprint.dll')
elif sys.platform == 'cygwin':
return ('libchromaprint.dll.a', 'cygchromaprint-1.dll',
'cygchromaprint-0.dll')
return ('libchromaprint.so.1', 'libchromaprint.so.0')
def _load_library(name):
"""Try to load a dynamic library with ctypes, or return None if the
library is not available.
"""
if sys.platform == 'win32':
# On Windows since Python 3.8, we need an extra call to
# `find_library` to search standard library paths.
name = ctypes.util.find_library(name)
if not name:
return None
try:
return ctypes.cdll.LoadLibrary(name)
except OSError:
return None
for name in _guess_lib_name():
_libchromaprint = _load_library(name)
if _libchromaprint:
break
else:
raise ImportError("couldn't find libchromaprint")
_libchromaprint.chromaprint_get_version.argtypes = ()
_libchromaprint.chromaprint_get_version.restype = ctypes.c_char_p
_libchromaprint.chromaprint_new.argtypes = (ctypes.c_int,)
_libchromaprint.chromaprint_new.restype = ctypes.c_void_p
_libchromaprint.chromaprint_free.argtypes = (ctypes.c_void_p,)
_libchromaprint.chromaprint_free.restype = None
_libchromaprint.chromaprint_start.argtypes = \
(ctypes.c_void_p, ctypes.c_int, ctypes.c_int)
_libchromaprint.chromaprint_start.restype = ctypes.c_int
_libchromaprint.chromaprint_feed.argtypes = \
(ctypes.c_void_p, ctypes.POINTER(ctypes.c_char), ctypes.c_int)
_libchromaprint.chromaprint_feed.restype = ctypes.c_int
_libchromaprint.chromaprint_finish.argtypes = (ctypes.c_void_p,)
_libchromaprint.chromaprint_finish.restype = ctypes.c_int
_libchromaprint.chromaprint_get_fingerprint.argtypes = \
(ctypes.c_void_p, ctypes.POINTER(ctypes.c_char_p))
_libchromaprint.chromaprint_get_fingerprint.restype = ctypes.c_int
_libchromaprint.chromaprint_decode_fingerprint.argtypes = \
(ctypes.POINTER(ctypes.c_char), ctypes.c_int,
ctypes.POINTER(ctypes.POINTER(ctypes.c_uint32)),
ctypes.POINTER(ctypes.c_int), ctypes.POINTER(ctypes.c_int), ctypes.c_int)
_libchromaprint.chromaprint_decode_fingerprint.restype = ctypes.c_int
_libchromaprint.chromaprint_encode_fingerprint.argtypes = \
(ctypes.POINTER(ctypes.c_int32), ctypes.c_int, ctypes.c_int,
ctypes.POINTER(ctypes.POINTER(ctypes.c_char)),
ctypes.POINTER(ctypes.c_int), ctypes.c_int)
_libchromaprint.chromaprint_encode_fingerprint.restype = ctypes.c_int
_libchromaprint.chromaprint_hash_fingerprint.argtypes = \
(ctypes.POINTER(ctypes.c_int32), ctypes.c_int,
ctypes.POINTER(ctypes.c_uint32))
_libchromaprint.chromaprint_hash_fingerprint.restype = ctypes.c_int
_libchromaprint.chromaprint_dealloc.argtypes = (ctypes.c_void_p,)
_libchromaprint.chromaprint_dealloc.restype = None
# Main interface.
class FingerprintError(Exception):
"""Raised when a call to the underlying library fails."""
def _check(res):
"""Check the result of a library call, raising an error if the call
failed.
"""
if res != 1:
raise FingerprintError()
class Fingerprinter(object):
ALGORITHM_TEST1 = 0
ALGORITHM_TEST2 = 1
ALGORITHM_TEST3 = 2
ALGORITHM_DEFAULT = ALGORITHM_TEST2
def __init__(self, algorithm=ALGORITHM_DEFAULT):
self._ctx = _libchromaprint.chromaprint_new(algorithm)
def __del__(self):
_libchromaprint.chromaprint_free(self._ctx)
del self._ctx
def start(self, sample_rate, num_channels):
"""Initialize the fingerprinter with the given audio parameters.
"""
_check(_libchromaprint.chromaprint_start(
self._ctx, sample_rate, num_channels
))
def feed(self, data):
"""Send raw PCM audio data to the fingerprinter. Data may be
either a bytestring or a buffer object.
"""
if isinstance(data, BUFFER_TYPES):
data = BYTES_TYPE(data)
elif not isinstance(data, bytes):
raise TypeError('data must be bytes, buffer, or memoryview')
_check(_libchromaprint.chromaprint_feed(
self._ctx, data, len(data) // 2
))
def finish(self):
"""Finish the fingerprint generation process and retrieve the
resulting fignerprint as a bytestring.
"""
_check(_libchromaprint.chromaprint_finish(self._ctx))
fingerprint_ptr = ctypes.c_char_p()
_check(_libchromaprint.chromaprint_get_fingerprint(
self._ctx, ctypes.byref(fingerprint_ptr)
))
fingerprint = fingerprint_ptr.value
_libchromaprint.chromaprint_dealloc(fingerprint_ptr)
return fingerprint
def decode_fingerprint(data, base64=True):
"""Uncompress and optionally decode a fingerprint.
Args:
data: An encoded fingerprint in bytes.
base64: Whether to base64-decode the fingerprint.
Returns:
A tuple containing the decoded raw fingerprint as an array
of unsigned 32-bit integers, and an int representing the chromaprint
algorithm used to generate the fingerprint.
"""
result_ptr = ctypes.POINTER(ctypes.c_uint32)()
result_size = ctypes.c_int()
algorithm = ctypes.c_int()
_check(_libchromaprint.chromaprint_decode_fingerprint(
data, len(data), ctypes.byref(result_ptr), ctypes.byref(result_size),
ctypes.byref(algorithm), 1 if base64 else 0
))
result = result_ptr[:result_size.value]
_libchromaprint.chromaprint_dealloc(result_ptr)
return result, algorithm.value
def encode_fingerprint(fingerprint, algorithm, base64=True):
"""Compress and optionally encode a fingerprint.
Args:
fingerprint: A bytestring with the fingerprint.
algorithm: An int flag choosing the algorithm to use.
base64: Whether to base64-encode the fingerprint.
Returns:
A bytestring with the encoded fingerprint.
"""
fp_array = (ctypes.c_int * len(fingerprint))()
for i in range(len(fingerprint)):
fp_array[i] = fingerprint[i]
result_ptr = ctypes.POINTER(ctypes.c_char)()
result_size = ctypes.c_int()
_check(_libchromaprint.chromaprint_encode_fingerprint(
fp_array, len(fingerprint), algorithm, ctypes.byref(result_ptr),
ctypes.byref(result_size), 1 if base64 else 0
))
result = result_ptr[:result_size.value]
_libchromaprint.chromaprint_dealloc(result_ptr)
return result
def hash_fingerprint(fingerprint):
"""Generate a single 32-bit hash for a raw, decoded 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 clients should not rely on this).
Compare two hashes with their Hamming distance, i.e., by counting
the bits in which they differ.
Args:
fingerprint: A list of ints for the raw, decoded fingerprint.
Returns:
A 32-bit integer hash.
Example usage:
audio_fingerprint = <get fingerprint with Fingerprinter>
decoded_fingerprint, algo = decode_fingerprint(audio_fingerprint)
first_fingerprint_hash = hash_fingerprint(decoded_fingerprint)
second_fingerprint_hash = <repeat steps for second audio file>
# Compare the binary strings using Hamming distance.
first_fp_binary = format(first_fingerprint_hash, 'b')
second_fp_binary = format(second_fingerprint_hash, 'b')
# This value will be between 0 and 32 and represent the POPCNT.
# A value > 15 indicates the two fingerprints are very different.
bin(int(first_fp_binary,2)^int(second_fp_binary,2)).count
"""
fp_array = (ctypes.c_int * len(fingerprint))()
for i in range(len(fingerprint)):
fp_array[i] = fingerprint[i]
result_hash = ctypes.c_uint32()
_check(_libchromaprint.chromaprint_hash_fingerprint(
fp_array, len(fingerprint), ctypes.byref(result_hash)
))
return result_hash.value
def main():
parser = argparse.ArgumentParser()
parser.add_argument('-length', metavar='SECS', type=int, default=120,
help='length of the audio data used for fingerprint '
'calculation (default 120)')
parser.add_argument('-raw', action='store_true',
help='output the raw uncompressed fingerprint')
parser.add_argument('paths', metavar='FILE', nargs='+',
help='audio file to be fingerprinted')
args = parser.parse_args()
# make gst not try to parse the args
del sys.argv[1:]
first = True
for i, path in enumerate(args.paths):
try:
duration, fp = acoustid.fingerprint_file(path, args.length)
except Exception:
print("ERROR: unable to calculate fingerprint "
"for file %s, skipping" % path, file=sys.stderr)
continue
if args.raw:
raw_fp = chromaprint.decode_fingerprint(fp)[0]
fp = ','.join(map(str, raw_fp))
if not first:
print
first = False
print('FILE=%s' % path)
print('DURATION=%d' % duration)
print('FINGERPRINT=%s' % fp.decode('utf8'))
if __name__ == '__main__':
main()