Metadata-Version: 2.1
Name: Conch-sounds
Version: 0.4.0
Summary: Analyze acoustic similarity in Python
Home-page: https://github.com/mmcauliffe/Conch-sounds
Author: Michael McAuliffe
Author-email: michael.e.mcauliffe@gmail.com
Maintainer: Michael McAuliffe
Maintainer-email: michael.e.mcauliffe@gmail.com
License: MIT
Keywords: phonetics,acoustics,acoustic similarity
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: librosa
Requires-Dist: pysoundfile
Requires-Dist: scipy
Requires-Dist: praatio
Requires-Dist: pyraat
Provides-Extra: dev
Requires-Dist: coverage; extra == "dev"
Requires-Dist: coveralls; extra == "dev"
Requires-Dist: interrogate; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-mypy; extra == "dev"
Requires-Dist: setuptools-scm; extra == "dev"
Requires-Dist: tomli; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: tox-conda; extra == "dev"
Provides-Extra: docs
Requires-Dist: interrogate; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Provides-Extra: testing
Requires-Dist: coverage; extra == "testing"
Requires-Dist: coveralls; extra == "testing"
Requires-Dist: pytest; extra == "testing"

Conch
=====

[![Build Status](https://travis-ci.org/mmcauliffe/Conch-sounds.svg?branch=master)](https://travis-ci.org/mmcauliffe/Conch-sounds)
[![Coverage Status](https://coveralls.io/repos/github/mmcauliffe/Conch-sounds/badge.svg?branch=master)](https://coveralls.io/github/mmcauliffe/Conch-sounds?branch=master)
[![Documentation Status](https://readthedocs.org/projects/conch-sounds/badge/?version=latest)](http://conch-sounds.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/conch_sounds.svg)](https://badge.fury.io/py/conch_sounds)
[![DOI](https://zenodo.org/badge/9966944.svg)](https://zenodo.org/badge/latestdoi/9966944)

This package contains functions for converting wav files into auditory 
representations and calculating distance between them.

Auditory representations currently supported are mel-frequency cepstrum
coefficients (MFCCs) and amplitude envelopes.

Distance metrics currently implemented are dynamic time warping and
cross-correlation.

Installation
==================

The latest released version can be installed via:

`pip install conch_sounds`

Higher level wrappers
==================

In `conch/main.py` there are several wrapper functions for convenience.

Each of these functions takes keyword arguments corresponding to how auditory
representations should be constructed and what distance function to use.

**acoustic_similarity_mapping** takes a mapping of paths as its argument.
This argument should be a list of pairs or triplets of fully specified file names.
Pairs will compute the distance between the two files, and triplets will compute
an AXB style design, where distances are computed between the first element and the second and
between the third element and the second.  In this case, the numerical output
will be a ratio of the third element's distance to the second divided by the
first element's distance to the second.  The return value is a dictionary
with the pairs/triplets as keys, and the numerical output as the values.

**acoustic_similarity_directories** takes two arguments which are fully specified paths
to two directories.  It then constructs a path mapping of all the files in
the first directory to all the files in the second directory.  The return
value is a single value, which the average distance of all those calculated.

**analyze_directory** takes a single directory as an argument and creates a
path mapping of all the files compared to all other files. The return value is a dictionary
with the file pairs as keys, and the numerical output as the values.