Metadata-Version: 2.4
Name: auditory_models
Version: 0.1.1
Summary: Computation of auditory models
Author-email: Max Zimmermann <max.zimmermann@tugraz.at>
License-Expression: GPL-3.0-or-later
Project-URL: Repository, https://gitlab.tugraz.at/BA9D3CA475A1A669/auditory_models.git
Keywords: audio,quality,speech,perception,intelligibility,model,auditory,stoi,gpsm,snr
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: numpy>=2.2
Requires-Dist: scipy>=1.15
Requires-Dist: soundfile
Dynamic: license-file

# auditory_models

## Description

This repository provides multiple packages to compute auditory models, including
- Short term Objective Intelligibility ([STOI](https://ieeexplore.ieee.org/abstract/document/5713237))
- Generalized Power Spectrum Model for audio quality ([GPSMq](https://ieeexplore.ieee.org/abstract/document/8708700))


## Installation
`pip install auditory_models`

## Usage
```
from auditory_models import STOI, GPSMq
import soundfile as sf

reference, fs_ref = sf.read("reference.wav")
degraded, fs_dgr = sf.read("degraded.wav")
if fs_ref != fs_dgr:
    raise ValueError("Sample rates must be equal!")

stoi = STOI()
gpsmq = GPSMq(binaural=False)

stoi.process(reference, degraded, fs_ref)
gpsmq.process(reference, degraded, fs_ref)

```

## Support
Regarding issues please feel free to contact me via 
<a href="mailto:max.zimmermann@tugraz.at">max.zimmermann@tugraz.at</a>

## Contributing
Any contribution is welcome. 

## Authors and acknowledgment
Author: Max Zimmermann\
Credits to: 
- The developers of the original Matlab implementations
    - STOI: Cees Taal 
    - GPSMq: Thomas Biberger and Jan-Hendrik Fleßner
- Manuel Pariente for the original Python implementation of STOI

## License
This project is licensed under the GNU General Public License v3 (GPLv3). For further info see file `COPYING`.
