audio-validation 0.1.2__tar.gz

audio_validation-0.1.2/.github/workflows/code_checker.yml

@@ -0,0 +1,42 @@
+name: Code-checker
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[dev]
+    - name: Gathering the changed files
+      id: gather
+      run: |
+        git fetch origin
+        files=$(git diff --name-only origin/main -- "*.py" | xargs)
+        echo "Changed files: $files"
+        echo "$files" > changed_files.txt
+        echo "files=$files" >> "$GITHUB_OUTPUT"
+
+    - name: Analysing the code with pylint
+      if: steps.gather.outputs.files != ''
+      run: |
+        files=$(cat changed_files.txt)
+        pylint \
+          --disable duplicate-code \
+          --ignore=$(paste -sd, - < .pylint_ignore) $files
+
+    - name: Analysing the code style with black
+      if: steps.gather.outputs.files != ''
+      run: |
+        files=$(cat changed_files.txt)
+        black --check --diff $files

audio_validation-0.1.2/.github/workflows/publish_to_pypi.yml

@@ -0,0 +1,35 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: python -m twine upload --verbose dist/*

audio_validation-0.1.2/.github/workflows/unit_tests.yml

@@ -0,0 +1,36 @@
+name: Unit-tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[test]
+    - name: Gathering the changed files
+      run: |       
+        pytest -vv --log-level DEBUG \
+        --cov src \
+        --cov-branch \
+        --cov-report html:reports/pytest_coverage \
+        --cov-fail-under 0 \
+        --junitxml=reports/junit/test-results-${{ matrix.python-version }}.xml
+    - name: Upload pytest test results
+      uses: actions/upload-artifact@v4
+      with:
+        name: reports-${{ matrix.python-version }}
+        path: |
+          reports
+      # Use always() to always run this step to publish test results when there are test failures
+      if: ${{ always() }}

audio_validation-0.1.2/.gitignore

@@ -0,0 +1,189 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+# modules are autogenerated on each merge
+docs/modules/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+### VirtualEnv template
+# Virtualenv
+# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
+#[Bb]in
+[Ii]nclude
+[Ll]ib64
+[Ll]ocal
+pyvenv.cfg
+.venv
+pip-selfcheck.json
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+**/.idea/*
+.idea/*
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+#vscode
+.vscode/
+
+**/test_reports
+*~

audio_validation-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 int2code
+
+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.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

audio_validation-0.1.2/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: audio_validation
+Version: 0.1.2
+Summary: Tools for validating audio data, including feature extraction and visualization.
+Maintainer-email: Hubert Stepniewski <hubert.stepniewski@int2code.com>, Marcin Tomiczek <marcin.tomiczek@int2code.com>, Piotr Sznapka <piotr.sznapka@int2code.com>
+License: MIT License
+        
+        Copyright (c) 2026 int2code
+        
+        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.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Requires-Dist: pytest
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-html; extra == "test"
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-html; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: coverage; extra == "docs"
+Requires-Dist: pytest; extra == "docs"
+Requires-Dist: pytest-cov; extra == "docs"
+Requires-Dist: pytest-html; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinxcontrib-programoutput; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Dynamic: license-file
+
+# audio_validation
+
+A Python library for validating and analysing audio data, including feature extraction, bit-exact verification against a reference, and waveform generation utilities.
+
+## Features
+
+- **Feature extraction** — compute RMS, peak/min/max, mean, FFT-based frequency detection, and per-channel audio onset offset for multi-channel captures.
+- **Audio verification** — validate a captured audio stream against a reference WAV file with drift-tolerant re-synchronisation, detailed mismatch reporting, and automatic artefact generation (PNG plots and WAV snippets).
+- **Waveform generation** — generate multi-channel WAV files with configurable waveforms: sine, square, sawtooth, white noise, and pink noise; supports 16-, 24-, and 32-bit PCM output.
+
+## Requirements
+
+- Python ≥ 3.11
+- See [requirements.txt](requirements.txt) for runtime dependencies (`numpy`, `scipy`, `sounddevice`, `pymodbus`, …).
+
+## Installation
+
+```bash
+pip install audio_validation
+```
+
+Or, for development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Usage
+
+### Feature extraction
+
+```python
+from audio_validation.audio_features import AudioFeatures
+
+features = AudioFeatures.compute(
+    samples=raw_samples,           # numpy array, shape (n_samples, n_channels)
+    sample_rate=48000,
+    expected_frequencies=[400, 800],
+    tolerance=50,
+)
+
+for ch_idx, ch in enumerate(features.channels):
+    print(f"Ch {ch_idx}: detected={ch.detected}, rms={ch.rms:.4f}, peaks={ch.peak_frequencies}")
+```
+
+### Audio verification
+
+```python
+from audio_validation.audio_verification import verify_audio
+
+results = verify_audio(
+    reference_path="reference.wav",
+    detected_samples=captured_array,
+    sample_rate=48000,
+    artifacts_dir="test_artifacts/",
+)
+```
+
+### Waveform generation
+
+```python
+from audio_validation.utils.audio_generation import generate_wave_file
+
+generate_wave_file(
+    shape="sine",
+    freq_list=[1000.0],
+    sample_rate=48000,
+    duration=5.0,
+    num_channels=2,
+    active_channels=[0, 1],
+    amplitude=0.05,
+    resolution_bits=16,
+    output_dir="output.wav",
+)
+```
+
+## Maintainers
+
+- Hubert Stepniewski — hubert.stepniewski@int2code.com
+- Marcin Tomiczek — marcin.tomiczek@int2code.com
+- Piotr Sznapka — piotr.sznapka@int2code.com
+
+## License
+
+See [LICENSE](LICENSE).

audio_validation-0.1.2/README.md

@@ -0,0 +1,85 @@
+# audio_validation
+
+A Python library for validating and analysing audio data, including feature extraction, bit-exact verification against a reference, and waveform generation utilities.
+
+## Features
+
+- **Feature extraction** — compute RMS, peak/min/max, mean, FFT-based frequency detection, and per-channel audio onset offset for multi-channel captures.
+- **Audio verification** — validate a captured audio stream against a reference WAV file with drift-tolerant re-synchronisation, detailed mismatch reporting, and automatic artefact generation (PNG plots and WAV snippets).
+- **Waveform generation** — generate multi-channel WAV files with configurable waveforms: sine, square, sawtooth, white noise, and pink noise; supports 16-, 24-, and 32-bit PCM output.
+
+## Requirements
+
+- Python ≥ 3.11
+- See [requirements.txt](requirements.txt) for runtime dependencies (`numpy`, `scipy`, `sounddevice`, `pymodbus`, …).
+
+## Installation
+
+```bash
+pip install audio_validation
+```
+
+Or, for development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Usage
+
+### Feature extraction
+
+```python
+from audio_validation.audio_features import AudioFeatures
+
+features = AudioFeatures.compute(
+    samples=raw_samples,           # numpy array, shape (n_samples, n_channels)
+    sample_rate=48000,
+    expected_frequencies=[400, 800],
+    tolerance=50,
+)
+
+for ch_idx, ch in enumerate(features.channels):
+    print(f"Ch {ch_idx}: detected={ch.detected}, rms={ch.rms:.4f}, peaks={ch.peak_frequencies}")
+```
+
+### Audio verification
+
+```python
+from audio_validation.audio_verification import verify_audio
+
+results = verify_audio(
+    reference_path="reference.wav",
+    detected_samples=captured_array,
+    sample_rate=48000,
+    artifacts_dir="test_artifacts/",
+)
+```
+
+### Waveform generation
+
+```python
+from audio_validation.utils.audio_generation import generate_wave_file
+
+generate_wave_file(
+    shape="sine",
+    freq_list=[1000.0],
+    sample_rate=48000,
+    duration=5.0,
+    num_channels=2,
+    active_channels=[0, 1],
+    amplitude=0.05,
+    resolution_bits=16,
+    output_dir="output.wav",
+)
+```
+
+## Maintainers
+
+- Hubert Stepniewski — hubert.stepniewski@int2code.com
+- Marcin Tomiczek — marcin.tomiczek@int2code.com
+- Piotr Sznapka — piotr.sznapka@int2code.com
+
+## License
+
+See [LICENSE](LICENSE).

audio_validation-0.1.2/RELEASE_NOTES.md

@@ -0,0 +1,3 @@
+### 0.1.0
+
+[MINOR] Initial release.

audio_validation-0.1.2/_ci/is_dev_version.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+version=$(cat version.txt)
+
+if [[ $version =~ ^[0-9]+\.[0-9]+\.[0-9]+\.dev[0-9]+$ ]]; then
+  echo "Valid dev version."
+  exit 0
+else
+  echo "Invalid dev version! Add .dev[xx] suffix in version.txt."
+  exit 1
+fi

audio_validation-0.1.2/docs/Makefile

@@ -0,0 +1,31 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+PACKAGE_NAME = audio_validation
+SRC_DIR = ../src
+MODULES_DIR = modules
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+apidoc:
+	@sphinx-apidoc -f -o $(MODULES_DIR) $(SRC_DIR)/$(PACKAGE_NAME)
+
+html: apidoc
+	$(SPHINXBUILD) -b html $(SOURCEDIR) $(BUILDDIR)/html
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

audio_validation-0.1.2/docs/conf.py

@@ -0,0 +1,46 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+# pylint: skip-file
+from datetime import date
+from pkg_resources import get_distribution
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "audio_validation"
+copyright = f"{date.today().year}, int2code"
+author = "int2code"
+version = release = get_distribution("audio_validation").version
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinxcontrib.programoutput",
+    "myst_parser",
+]
+autosummary_generate = True
+
+# uncomment when _templates won't be empty
+# templates_path = ['._templates']
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+]
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+# uncomment when static content is added
+# html_static_path = ['_static']
+
+# suppress warning from release notes and readme markdown files
+suppress_warnings = ["myst.header"]

audio_validation-0.1.2/docs/contribute.rst

@@ -0,0 +1,18 @@
+
+Contribution
+============
+
+To contribute to the project follow below steps:
+
+    * git clone this project repository
+    * create dev branch using your initials and an descriptive name like `user/feature_name`
+    * modify code as desired
+    * write unittests to cover your changes
+    * verify that pylint, pytest and other checkers pass
+    * update `RELEASE_NOTES.rst` and `version.txt` according to `sematic versioning <https://semver.org/>`_
+    * create a pull request - add at least one reviewer
+    * fix any comments until review is accepted
+    * merge your changes
+
+After your changes are merged to the main branch an automatic pipeline will trigger,
+verify your changes, build the package and finally upload it to artifactory server.

audio_validation-0.1.2/docs/index.rst

@@ -0,0 +1,22 @@
+int2code-audio_validation
+============
+
+.. if needed use .. include:: alias.txt directive
+.. include:: ../README.md
+    :parser: myst_parser.sphinx_
+
+.. toctree::
+    :maxdepth: 3
+
+    Installation <installation.rst>
+    Tutorials <tutorials/index.rst>
+    API <modules/modules.rst>
+    Contributing <contribute.rst>
+    Release Notes <release_notes.rst>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`