cysox 0.1.5__cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

cysox-0.1.5.dist-info/METADATA

@@ -0,0 +1,339 @@
+Metadata-Version: 2.4
+Name: cysox
+Version: 0.1.5
+Summary: A Pythonic audio processing library wrapping libsox
+Author-email: Shakeeb Alireza <shakfu@users.noreply.github.com>
+Maintainer-email: Shakeeb Alireza <shakfu@users.noreply.github.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/shakfu/cysox
+Project-URL: Repository, https://github.com/shakfu/cysox
+Project-URL: Documentation, https://github.com/shakfu/cysox#readme
+Project-URL: Issues, https://github.com/shakfu/cysox/issues
+Project-URL: Changelog, https://github.com/shakfu/cysox/releases
+Keywords: audio,sound,sox,libsox,audio-processing,effects,cython,dsp
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Cython
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Classifier: Topic :: Multimedia :: Sound/Audio :: Conversion
+Classifier: Topic :: Multimedia :: Sound/Audio :: Editors
+Classifier: Topic :: Multimedia :: Sound/Audio :: Sound Synthesis
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# cysox
+
+[![PyPI](https://img.shields.io/pypi/v/cysox)](https://pypi.org/project/cysox/)
+[![Python](https://img.shields.io/pypi/pyversions/cysox)](https://pypi.org/project/cysox/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+A Pythonic audio processing library which uses cython to wrap [libsox](https://github.com/chirlu/sox).
+
+## Features
+
+- **Simple API**: Convert, analyze, and play audio with one-liners
+- **Typed Effects**: 28 effect classes with IDE autocomplete and validation
+- **High Performance**: Direct C bindings through Cython
+- **Zero Configuration**: Auto-initialization, no manual setup required
+- **Cross-Platform**: macOS, Linux (Windows placeholder)
+
+## Installation
+
+Note that cysox only works on macOS and Linux.
+
+```sh
+pip install cysox
+```
+
+## Command Line Interface
+
+```sh
+# Show version
+cysox --version
+
+# Get audio file info
+cysox info audio.wav
+
+# Convert audio files
+cysox convert input.wav output.mp3
+cysox convert input.wav output.wav --rate 48000 --channels 1
+
+# Play audio
+cysox play audio.wav
+
+# Concatenate files
+cysox concat intro.wav main.wav outro.wav -o full.wav
+```
+
+## Quick Start
+
+```python
+import cysox
+from cysox import fx
+
+# Get audio file info
+info = cysox.info('audio.wav')
+print(f"Duration: {info['duration']:.2f}s, Sample rate: {info['sample_rate']} Hz")
+
+# Convert with effects
+cysox.convert('input.wav', 'output.mp3', effects=[
+    fx.Normalize(),
+    fx.Reverb(reverberance=60),
+    fx.Fade(fade_in=0.5, fade_out=1.0),
+])
+
+# Play audio (macOS/Linux)
+cysox.play('audio.wav')
+
+# Play with effects
+cysox.play('audio.wav', effects=[fx.Volume(db=-6)])
+```
+
+## Core Functions
+
+### `cysox.info(path) -> dict`
+
+Get audio file metadata:
+
+```python
+info = cysox.info('audio.wav')
+# Returns: {
+#     'path': 'audio.wav',
+#     'format': 'wav',
+#     'duration': 11.5,
+#     'sample_rate': 44100,
+#     'channels': 2,
+#     'bits_per_sample': 16,
+#     'samples': 507150,
+#     'encoding': 'signed-integer',
+# }
+```
+
+### `cysox.convert(input, output, effects=[], **options)`
+
+Convert audio files with optional effects and format options:
+
+```python
+# Simple format conversion
+cysox.convert('input.wav', 'output.mp3')
+
+# With effects
+cysox.convert('input.wav', 'output.wav', effects=[
+    fx.Volume(db=3),
+    fx.Bass(gain=5),
+    fx.Reverb(),
+])
+
+# With format options
+cysox.convert('input.wav', 'output.wav',
+    sample_rate=48000,
+    channels=1,
+    bits=24,
+)
+```
+
+### `cysox.stream(path, chunk_size=8192) -> Iterator[memoryview]`
+
+Stream audio samples for processing:
+
+```python
+import numpy as np
+
+for chunk in cysox.stream('large.wav', chunk_size=8192):
+    arr = np.frombuffer(chunk, dtype=np.int32)
+    process(arr)
+```
+
+### `cysox.play(path, effects=[])`
+
+Play audio to the default audio device:
+
+```python
+cysox.play('audio.wav')
+cysox.play('audio.wav', effects=[fx.Volume(db=-6), fx.Reverb()])
+```
+
+### `cysox.concat(inputs, output)`
+
+Concatenate multiple audio files:
+
+```python
+cysox.concat(['intro.wav', 'main.wav', 'outro.wav'], 'full.wav')
+```
+
+All input files must have the same sample rate and channel count.
+
+## Effects Module
+
+The `cysox.fx` module provides 28 typed effect classes:
+
+### Volume & Dynamics
+```python
+fx.Volume(db=3)                    # Adjust volume in dB
+fx.Gain(db=6)                      # Apply gain
+fx.Normalize(level=-3)             # Normalize to target level
+```
+
+### Equalization
+```python
+fx.Bass(gain=5, frequency=100)     # Boost/cut bass
+fx.Treble(gain=-2, frequency=3000) # Boost/cut treble
+fx.Equalizer(frequency=1000, width=1.0, gain=3)
+```
+
+### Filters
+```python
+fx.HighPass(frequency=200)         # Remove low frequencies
+fx.LowPass(frequency=8000)         # Remove high frequencies
+fx.BandPass(frequency=1000, width=100)
+fx.BandReject(frequency=60, width=10)  # Notch filter
+```
+
+### Spatial & Reverb
+```python
+fx.Reverb(reverberance=50, room_scale=100)
+fx.Echo(gain_in=0.8, gain_out=0.9, delays=[100], decays=[0.5])
+fx.Chorus()
+fx.Flanger()
+```
+
+### Time-Based
+```python
+fx.Trim(start=1.0, end=5.0)        # Extract portion
+fx.Pad(before=0.5, after=1.0)      # Add silence
+fx.Speed(factor=1.5)               # Change speed (affects pitch)
+fx.Tempo(factor=1.5)               # Change tempo (preserves pitch)
+fx.Pitch(cents=100)                # Shift pitch (preserves tempo)
+fx.Reverse()                       # Reverse audio
+fx.Fade(fade_in=0.5, fade_out=1.0) # Fade in/out
+fx.Repeat(count=3)                 # Repeat audio
+```
+
+### Conversion
+```python
+fx.Rate(sample_rate=48000)         # Resample
+fx.Channels(channels=1)            # Change channel count
+fx.Remix(out_spec=[[1, 2]])        # Custom channel mixing
+fx.Dither()                        # Add dither
+```
+
+### Composite Effects
+
+Create reusable effect combinations:
+
+```python
+from cysox.fx import CompositeEffect, HighPass, LowPass, Reverb, Volume
+
+class TelephoneEffect(CompositeEffect):
+    """Simulate telephone audio quality."""
+
+    @property
+    def effects(self):
+        return [
+            HighPass(frequency=300),
+            LowPass(frequency=3400),
+            Volume(db=-3),
+        ]
+
+# Use like any other effect
+cysox.convert('input.wav', 'output.wav', effects=[TelephoneEffect()])
+```
+
+## Low-Level API
+
+For advanced use cases, access the full libsox bindings:
+
+```python
+from cysox import sox
+
+# Manual initialization (high-level API handles this automatically)
+sox.init()
+
+# Open files
+input_fmt = sox.Format('input.wav')
+output_fmt = sox.Format('output.wav', signal=input_fmt.signal, mode='w')
+
+# Build effects chain
+chain = sox.EffectsChain(input_fmt.encoding, output_fmt.encoding)
+
+e = sox.Effect(sox.find_effect("input"))
+e.set_options([input_fmt])
+chain.add_effect(e, input_fmt.signal, input_fmt.signal)
+
+e = sox.Effect(sox.find_effect("vol"))
+e.set_options(["3dB"])
+chain.add_effect(e, input_fmt.signal, input_fmt.signal)
+
+e = sox.Effect(sox.find_effect("output"))
+e.set_options([output_fmt])
+chain.add_effect(e, input_fmt.signal, input_fmt.signal)
+
+# Process
+chain.flow_effects()
+
+# Cleanup
+input_fmt.close()
+output_fmt.close()
+sox.quit()
+```
+
+## Building from Source
+
+### macOS
+
+```sh
+brew install sox libsndfile mad libpng flac lame mpg123 libogg opus opusfile libvorbis
+make
+make test
+```
+
+### Linux
+
+```sh
+sudo apt-get install libsox-dev libsndfile1-dev pkg-config
+make
+make test
+```
+
+## Status
+
+Comprehensive test suite covering all functionality. All libsox C examples ported to Python (effects chains, waveform analysis, trim, concatenation, format conversion).
+
+## Known Issues
+
+- **Memory I/O**: libsox memory I/O functions have platform issues (tests skipped)
+- **Init/Quit Cycles**: Use high-level API to avoid init/quit issues (handled automatically)
+
+See [KNOWN_LIMITATIONS.md](https://github.com/shakfu/cysox/blob/main/KNOWN_LIMITATIONS.md) for details.
+
+## Platform Support
+
+- **macOS**: Full support
+- **Linux**: Full support
+- **Windows**: Placeholder (contributions welcome)
+
+## Building Documentation
+
+```sh
+pip install sphinx furo myst-parser
+make docs
+make docs-serve  # http://localhost:8000
+```
+
+## License
+
+MIT

cysox-0.1.5.dist-info/RECORD

@@ -0,0 +1,27 @@
+cysox/__init__.py,sha256=RkTzTu736ApFJJjQbnqfdVWfvxFxKvljGD01ZmKkMhI,1151
+cysox/__init__.pyi,sha256=zTHi-vJdVHfpp4C7eO7JxODJ3fH4pVJXz8vh5y-K_0g,5738
+cysox/__main__.py,sha256=qJDBNa3EDI-qWlr6eRQL2w4wxKqH3Fjy_5yq4ThpfQY,3147
+cysox/audio.py,sha256=xLs-3N4l5sZw55tKS44DoQAxvFBXwp8cx0h9EMg4ORE,16352
+cysox/sox.cpython-39-x86_64-linux-gnu.so,sha256=4unGZJulY6Z5mG5ONWJtZT2XyhHjwERo9lGNtAdkO0M,4634257
+cysox/utils.py,sha256=PAwDschsI8ExnkQRFtuVrhF0E3sz6Jn70ROSfWHyc6A,1799
+cysox/utils.pyi,sha256=JyDetZf6yE9rJYDkKW2UFHOIRNsQ5sm73X94pQm7Rok,633
+cysox/fx/__init__.py,sha256=d2qqmcYnWf_zwlbAKVJ4aoWNkEXCsM4RS5CGxje8HOE,1618
+cysox/fx/base.py,sha256=J3r0VlDue7zMyuwkQBuASl_xpADn1cVKO_q3H0BhgJA,4749
+cysox/fx/convert.py,sha256=CuK_I7yy8yQv4bYjhk52FJAcnR9hKGj4nIUZMERyATs,3499
+cysox/fx/eq.py,sha256=Sx6Ot1o5pIbQhYbLoIf_MIGcR5H12CCYo9nuazmkrjc,2363
+cysox/fx/filter.py,sha256=yp6jxwnuCrNiT8npHNgzYrWCscOTO3ZBlsoKOW-4hQk,3625
+cysox/fx/reverb.py,sha256=GmfnCB9tEbr24t1fk1Buk6RjBq6_fAGkSBlVgkXMm2w,6193
+cysox/fx/time.py,sha256=Zu-O85zqo4IBgtxh9kV7ucS9j-TOiQELZ_OaG4M3u2c,6618
+cysox/fx/volume.py,sha256=iZZ2bQEIfYSa20i8tpQHGx5MenMjVNwO6hozxKMiQ0Y,2302
+cysox.libs/libgomp-e985bcbb.so.1.0.0,sha256=pDkE5PopcwHUZA3BuzyKNIC0BvmeSY66mxkUtoqrYEo,253289
+cysox.libs/libgsm-6a620b60.so.1.0.17,sha256=HnBXjjid9UZ5ojm6pgtQAJKt8gMIcBm3iFZcyRpOyfM,58649
+cysox.libs/libltdl-dfe8b62f.so.7,sha256=m4lVMxIhbYgPB_yNb8qUaHJCLJGfaArfeCSWhFpHGvI,41121
+cysox.libs/libpng16-2bf8e833.so.16.34.0,sha256=DC6obCG3a-WS4YUzNInyeBz0oGdqGjdSiHV9Ctyzz1k,232865
+cysox.libs/libsox-36efe91a.so.3.0.0,sha256=hO4jFE3e_Zzuw6gO_2Pech6DxA2zHI8CoXx73PQPq1o,834513
+cysox-0.1.5.dist-info/METADATA,sha256=C8g8qm5WB9h9jX5YLSZpji6WIhNYHlXPeu9xu7JAc7c,8743
+cysox-0.1.5.dist-info/WHEEL,sha256=v7ccuw7ENzL5TQ6J27AHIIY_nE__EkpSwTZN_nic4QA,149
+cysox-0.1.5.dist-info/entry_points.txt,sha256=PXkM25bosHowrhva4PFL5UcdtQpGAHEGWOiyAZdFxBc,46
+cysox-0.1.5.dist-info/top_level.txt,sha256=n90tvFrptqXw-CXvLdfcV9ylNEgonvH76ccV_7udOpg,6
+cysox-0.1.5.dist-info/RECORD,,
+cysox-0.1.5.dist-info/licenses/LICENSE,sha256=4rD5kJP4PQ65iwMQtTXEF3f95ZgTo6cD4E68H4v9mqE,1072
+cysox-0.1.5.dist-info/sboms/auditwheel.cdx.json,sha256=raeD-9F395DX8z9S-YL_pobDHIFM_hlFgiYD4qGcCEM,2743

cysox-0.1.5.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.1)
+Root-Is-Purelib: false
+Tag: cp39-cp39-manylinux_2_27_x86_64
+Tag: cp39-cp39-manylinux_2_28_x86_64
+

cysox-0.1.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+cysox = cysox.__main__:main

cysox-0.1.5.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shakeeb Alireza
+
+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.

cysox-0.1.5.dist-info/sboms/auditwheel.cdx.json

@@ -0,0 +1 @@
+{"bomFormat": "CycloneDX", "specVersion": "1.4", "version": 1, "metadata": {"component": {"type": "library", "bom-ref": "pkg:pypi/cysox@0.1.5?file_name=cysox-0.1.5-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", "name": "cysox", "version": "0.1.5", "purl": "pkg:pypi/cysox@0.1.5?file_name=cysox-0.1.5-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl"}, "tools": [{"name": "auditwheel", "version": "6.5.0"}]}, "components": [{"type": "library", "bom-ref": "pkg:pypi/cysox@0.1.5?file_name=cysox-0.1.5-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", "name": "cysox", "version": "0.1.5", "purl": "pkg:pypi/cysox@0.1.5?file_name=cysox-0.1.5-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl"}, {"type": "library", "bom-ref": "pkg:rpm/almalinux/gsm@1.0.17-5.el8#576c6df5b8c2e212f6ae988c74da1d0f103c388063d37feb25f7392bddf3986f", "name": "gsm", "version": "1.0.17-5.el8", "purl": "pkg:rpm/almalinux/gsm@1.0.17-5.el8"}, {"type": "library", "bom-ref": "pkg:rpm/almalinux/sox@14.4.2.0-29.el8#712c0d355206b77431db4488d00b0a2d10d3c4b5dfa6196e1637d6238d28af00", "name": "sox", "version": "14.4.2.0-29.el8", "purl": "pkg:rpm/almalinux/sox@14.4.2.0-29.el8"}, {"type": "library", "bom-ref": "pkg:rpm/almalinux/libpng@1.6.34-9.el8_10#570812db8ef1fc54050fb57a74e7f468cba961a6a9ab4bcd175ead818e7c5bfa", "name": "libpng", "version": "1.6.34-9.el8_10", "purl": "pkg:rpm/almalinux/libpng@1.6.34-9.el8_10"}, {"type": "library", "bom-ref": "pkg:rpm/almalinux/libgomp@8.5.0-28.el8_10.alma.1#c61017c9a24eb6e1e1a3cdc9becd004a6419cbda3d54b4848b98f240a4829571", "name": "libgomp", "version": "8.5.0-28.el8_10.alma.1", "purl": "pkg:rpm/almalinux/libgomp@8.5.0-28.el8_10.alma.1"}], "dependencies": [{"ref": "pkg:pypi/cysox@0.1.5?file_name=cysox-0.1.5-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", "dependsOn": ["pkg:rpm/almalinux/gsm@1.0.17-5.el8#576c6df5b8c2e212f6ae988c74da1d0f103c388063d37feb25f7392bddf3986f", "pkg:rpm/almalinux/sox@14.4.2.0-29.el8#712c0d355206b77431db4488d00b0a2d10d3c4b5dfa6196e1637d6238d28af00", "pkg:rpm/almalinux/libpng@1.6.34-9.el8_10#570812db8ef1fc54050fb57a74e7f468cba961a6a9ab4bcd175ead818e7c5bfa", "pkg:rpm/almalinux/libgomp@8.5.0-28.el8_10.alma.1#c61017c9a24eb6e1e1a3cdc9becd004a6419cbda3d54b4848b98f240a4829571"]}, {"ref": "pkg:rpm/almalinux/gsm@1.0.17-5.el8#576c6df5b8c2e212f6ae988c74da1d0f103c388063d37feb25f7392bddf3986f"}, {"ref": "pkg:rpm/almalinux/sox@14.4.2.0-29.el8#712c0d355206b77431db4488d00b0a2d10d3c4b5dfa6196e1637d6238d28af00"}, {"ref": "pkg:rpm/almalinux/libpng@1.6.34-9.el8_10#570812db8ef1fc54050fb57a74e7f468cba961a6a9ab4bcd175ead818e7c5bfa"}, {"ref": "pkg:rpm/almalinux/libgomp@8.5.0-28.el8_10.alma.1#c61017c9a24eb6e1e1a3cdc9becd004a6419cbda3d54b4848b98f240a4829571"}]}

cysox-0.1.5.dist-info/top_level.txt

@@ -0,0 +1 @@
+cysox