pyaudiohost 0.1.0__tar.gz

pyaudiohost-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pyaudiohost-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md LICENSE THIRD_PARTY_NOTICES.md
+recursive-include pyaudiohost *.py
+recursive-include docs *.md
+prune tests
+prune examples

pyaudiohost-0.1.0/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: pyaudiohost
+Version: 0.1.0
+Summary: Python audio effect and instrument hosting with VST2/VST3/AU plugin editors
+Author-email: Sucial <1584846096@qq.com>
+License-Expression: Apache-2.0
+Project-URL: Source Code, https://github.com/SUC-DriverOld/pyaudiohost
+Project-URL: Bug Tracker, https://github.com/SUC-DriverOld/pyaudiohost/issues
+Project-URL: Documentation, https://github.com/SUC-DriverOld/pyaudiohost/blob/main/docs/README.md
+Keywords: audio,audio-plugins,plugin-host,vst,vst2,vst3,audio-unit
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: Implementation :: CPython
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Sound/Audio :: MIDI
+Classifier: Topic :: Multimedia :: Sound/Audio :: Sound Synthesis
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+Requires-Dist: numpy>=1.24
+Requires-Dist: pywin32>=308; sys_platform == "win32"
+Requires-Dist: python-xlib>=0.33; sys_platform == "linux"
+Requires-Dist: pyobjc-framework-Cocoa>=10; sys_platform == "darwin"
+Requires-Dist: rubicon-objc>=0.5; sys_platform == "darwin"
+Dynamic: license-file
+
+# pyaudiohost
+
+A pure Python audio effect and instrument host with NumPy input/output and native plugin
+editors. Plugin interfaces use `ctypes`; each plugin runs in an isolated Python
+process, with audio processing independent of the editor event loop.
+
+- VST2 and VST3 effects on Windows, macOS, and Linux.
+- Audio Unit v2/v3 effects on macOS.
+- VST2/VST3 and macOS AU instruments with MIDI note-on/off input.
+- Multichannel audio and independent plugin buses, with layout negotiation.
+- Native editors for live adjustment, normalized parameters, and state snapshots.
+- Streaming processing and offline rendering with latency compensation,
+  progress callbacks, and cancellation.
+- AAX module probing is reserved; AAX audio processing and editors are unavailable.
+
+The library handles plugins and arrays. Your application handles audio files,
+playback devices, and saving. Runtime dependencies are NumPy plus native platform
+bridges: pywin32 on Windows, python-xlib on Linux, and PyObjC/Rubicon ObjC on macOS.
+The library installs without compiling a project extension. Playback and file I/O
+dependencies belong to the application.
+
+## Install from source
+
+Python 3.10 or newer is required. In this checkout:
+
+```sh
+uv sync --dev
+```
+
+To use the checkout from another uv project:
+
+```sh
+uv add /path/to/pyaudiohost
+```
+
+See [installation](docs/installation.md) for platform requirements and packaging.
+
+## Process an array
+
+```python
+import numpy as np
+from pyaudiohost import PluginChain
+
+if __name__ == "__main__":
+    # Replace this path with a compatible effect installed on your machine.
+    plugin_path = "/path/to/effect.vst3"
+    audio = np.zeros((2, 48000), dtype=np.float32)  # channels, frames
+    audio[:, 0] = 0.1
+
+    with PluginChain([plugin_path], sample_rate=48000) as chain:
+        processed = chain.render(
+            audio,
+            progress=lambda value: print(f"Rendering: {value:.0%}"),
+        )
+        assert processed.shape == audio.shape
+```
+
+For a plugin bundle, pass the outer bundle directory (such as `Effect.vst3`),
+not a binary inside its `Contents/` directory. Single-file plugins accept the file
+path directly.
+
+Use the `__main__` guard because plugin workers use multiprocessing spawn.
+[Array processing](docs/array-processing.md) covers continuous audio blocks;
+[rendering](docs/rendering.md) covers progress, tails, cancellation, and background
+GUI integration.
+
+## Try the standalone player
+
+```sh
+uv run --script examples/player.py
+```
+
+Open an audio file, add effects, open their native editors, adjust settings during
+playback, and render to WAV. The example declares its own playback/file dependencies
+and is not included in the installed library. See the [player guide](docs/examples.md).
+
+For a single instrument with an on-screen piano keyboard:
+
+```sh
+uv run --script examples/instrument.py
+```
+
+Load an instrument, open its native editor to select a sound, and hold or drag the
+piano keys to play through the default output device. See [instruments](docs/instruments.md)
+for the array/MIDI API and tested scope.
+
+## Documentation
+
+Start with the [documentation index](docs/README.md) for the API reference, plugin
+discovery, editors, parameters/state, platform support, and troubleshooting.
+See [multichannel audio](docs/multichannel.md) for surround layouts, sidechains,
+and instruments with multiple output buses.
+
+See [platform support](docs/platform-support.md) for native plugin verification
+and the remaining platform/format coverage.
+
+License: Apache-2.0. See [LICENSE](LICENSE) and
+[third-party notices](THIRD_PARTY_NOTICES.md).

pyaudiohost-0.1.0/README.md

@@ -0,0 +1,98 @@
+# pyaudiohost
+
+A pure Python audio effect and instrument host with NumPy input/output and native plugin
+editors. Plugin interfaces use `ctypes`; each plugin runs in an isolated Python
+process, with audio processing independent of the editor event loop.
+
+- VST2 and VST3 effects on Windows, macOS, and Linux.
+- Audio Unit v2/v3 effects on macOS.
+- VST2/VST3 and macOS AU instruments with MIDI note-on/off input.
+- Multichannel audio and independent plugin buses, with layout negotiation.
+- Native editors for live adjustment, normalized parameters, and state snapshots.
+- Streaming processing and offline rendering with latency compensation,
+  progress callbacks, and cancellation.
+- AAX module probing is reserved; AAX audio processing and editors are unavailable.
+
+The library handles plugins and arrays. Your application handles audio files,
+playback devices, and saving. Runtime dependencies are NumPy plus native platform
+bridges: pywin32 on Windows, python-xlib on Linux, and PyObjC/Rubicon ObjC on macOS.
+The library installs without compiling a project extension. Playback and file I/O
+dependencies belong to the application.
+
+## Install from source
+
+Python 3.10 or newer is required. In this checkout:
+
+```sh
+uv sync --dev
+```
+
+To use the checkout from another uv project:
+
+```sh
+uv add /path/to/pyaudiohost
+```
+
+See [installation](docs/installation.md) for platform requirements and packaging.
+
+## Process an array
+
+```python
+import numpy as np
+from pyaudiohost import PluginChain
+
+if __name__ == "__main__":
+    # Replace this path with a compatible effect installed on your machine.
+    plugin_path = "/path/to/effect.vst3"
+    audio = np.zeros((2, 48000), dtype=np.float32)  # channels, frames
+    audio[:, 0] = 0.1
+
+    with PluginChain([plugin_path], sample_rate=48000) as chain:
+        processed = chain.render(
+            audio,
+            progress=lambda value: print(f"Rendering: {value:.0%}"),
+        )
+        assert processed.shape == audio.shape
+```
+
+For a plugin bundle, pass the outer bundle directory (such as `Effect.vst3`),
+not a binary inside its `Contents/` directory. Single-file plugins accept the file
+path directly.
+
+Use the `__main__` guard because plugin workers use multiprocessing spawn.
+[Array processing](docs/array-processing.md) covers continuous audio blocks;
+[rendering](docs/rendering.md) covers progress, tails, cancellation, and background
+GUI integration.
+
+## Try the standalone player
+
+```sh
+uv run --script examples/player.py
+```
+
+Open an audio file, add effects, open their native editors, adjust settings during
+playback, and render to WAV. The example declares its own playback/file dependencies
+and is not included in the installed library. See the [player guide](docs/examples.md).
+
+For a single instrument with an on-screen piano keyboard:
+
+```sh
+uv run --script examples/instrument.py
+```
+
+Load an instrument, open its native editor to select a sound, and hold or drag the
+piano keys to play through the default output device. See [instruments](docs/instruments.md)
+for the array/MIDI API and tested scope.
+
+## Documentation
+
+Start with the [documentation index](docs/README.md) for the API reference, plugin
+discovery, editors, parameters/state, platform support, and troubleshooting.
+See [multichannel audio](docs/multichannel.md) for surround layouts, sidechains,
+and instruments with multiple output buses.
+
+See [platform support](docs/platform-support.md) for native plugin verification
+and the remaining platform/format coverage.
+
+License: Apache-2.0. See [LICENSE](LICENSE) and
+[third-party notices](THIRD_PARTY_NOTICES.md).

pyaudiohost-0.1.0/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,18 @@
+# Third-party notices
+
+pyaudiohost is distributed under the Apache License, Version 2.0. See [LICENSE](LICENSE).
+Third-party dependencies and plugin SDKs retain their respective licenses.
+
+The package uses NumPy (BSD-3-Clause), pywin32 on Windows, python-xlib
+(LGPL-2.1-or-later) on Linux, and PyObjC (MIT) / Rubicon Objective-C
+(BSD-3-Clause) on macOS. pywin32 includes multiple notices; consult its
+distribution for the licenses of individual components.
+These packages are installed as dependencies;
+their source and binary distributions retain their own license notices.
+
+VST2 and VST3 interface identifiers and ABI signatures describe Steinberg plugin
+interfaces. Apple Audio Unit calls follow the public AudioToolbox APIs.
+No Steinberg or Avid SDK headers or proprietary plugin binaries are distributed.
+
+The standalone examples optionally install SoundDevice (MIT) and SoundFile
+(BSD-3-Clause). They are not dependencies of the pyaudiohost library.

pyaudiohost-0.1.0/docs/README.md

@@ -0,0 +1,25 @@
+# Documentation
+
+pyaudiohost hosts audio effects and instruments and exchanges NumPy arrays with your application.
+Start with the short [project overview](../README.md), then choose the relevant guide.
+
+| Guide | Contents |
+| --- | --- |
+| [Installation](installation.md) | Python, uv, dependencies, and platform prerequisites |
+| [Array processing](array-processing.md) | Array shape, streaming blocks, preparation, and latency |
+| [Multichannel audio](multichannel.md) | Channel negotiation, surround layouts, sidechains, and separate output buses |
+| [Instruments](instruments.md) | MIDI notes, offline score rendering, and the Tk piano example |
+| [Offline rendering](rendering.md) | Snapshots, progress callbacks, cancellation, and tails |
+| [Native editors](editors.md) | OS windows, threading, resizing, and live adjustment |
+| [Parameters and state](parameters-and-state.md) | Normalized parameters, snapshots, restore, and ownership |
+| [Discovery](discovery.md) | Search paths, inspection, multiple classes, AU IDs, and AAX probing |
+| [Player and smoke checks](examples.md) | Standalone playback, WAV export, and installed plugin checks |
+| [API reference](api-reference.md) | Public functions, classes, signatures, and errors |
+| [Platform support](platform-support.md) | Format matrix, implementation scope, and verification limits |
+| [Architecture](architecture.md) | Process isolation, audio/UI threads, ctypes bridges, and builds |
+| [Development](development.md) | Tests, lint, packaging, and CI |
+| [Troubleshooting](troubleshooting.md) | Loading failures, editor issues, timeouts, and playback problems |
+
+All examples that create plugin processes must run from an importable Python
+script under an `if __name__ == "__main__":` guard. Plugin binaries must match the
+operating system and CPU architecture of Python.

pyaudiohost-0.1.0/docs/api-reference.md

@@ -0,0 +1,179 @@
+# Public API reference
+
+Import public names from `pyaudiohost`. Backend modules and `_worker` are internal.
+`AudioHost` and `Host` are aliases of `PluginChain` and expose the same array API.
+
+All public exports have English docstrings in their defining Python modules.
+Class documentation covers constructor arguments and data fields; method and
+property docstrings describe return values, validation, ownership, and lifecycle.
+The imported names retain this documentation for IDE tooltips and Python help:
+
+```python
+import pyaudiohost
+
+help(pyaudiohost.Plugin)
+help(pyaudiohost.Plugin.prepare)
+help(pyaudiohost.PluginChain.render)
+help(pyaudiohost.scan_plugins)
+```
+
+`Plugin`, `PluginChain`, and their aliases support `with` statements. Leaving a
+context closes its owned workers without suppressing exceptions. Metadata classes
+`PluginDescription` and `ScanResult` use the dataclass-generated constructors.
+
+## Loading and descriptions
+
+```text
+Plugin(path, *, plugin_id=None, timeout=30.0)
+load_plugin(path, *, plugin_id=None, timeout=30.0)
+```
+
+`path` is a string, `Path`, or `PluginDescription`. Passing a description selects
+its native class ID. A handle owns an isolated worker and should be used as a
+context manager or closed explicitly. `timeout` is the default request timeout
+in seconds. AAX loading is rejected; use `probe_aax()` instead.
+
+`PluginDescription` is an immutable dataclass:
+
+| Field | Type | Default |
+| --- | --- | --- |
+| `id` | `str` | Required native class ID |
+| `name` | `str` | Required display name |
+| `path` | `str` | Required resolved path or AU registry ID |
+| `format` | `str` | Required format code |
+| `vendor` | `str` | `""` |
+| `version` | `str` | `""` |
+| `is_instrument` | `bool` | `False` |
+
+`description.to_dict()` returns a serializable dictionary.
+
+## Plugin methods
+
+| Method | Behavior |
+| --- | --- |
+| `prepare(sample_rate=48000, block_size=1024, channels=2, *, offline=False, input_buses=None, output_buses=None)` | Negotiate channels and enabled buses; returns the handle |
+| `audio_buses()` | Query current native bus indices, widths, speaker masks, and activation |
+| `process(audio, sample_rate=None, *, position=0, playing=True, tempo=120.0, midi=())` | Return `(channels, frames)` float32 audio; optionally deliver `MidiNote` events |
+| `process_buses(audio=None, *, frames=None, position=0, playing=True, tempo=120.0, midi=())` | Process independent inputs and return `{output_bus: array}` |
+| `render(duration_seconds, *, midi=(), ...)` | Render an instrument's settings into an independent, latency-compensated audio array |
+| `render_buses(duration_seconds, **kwargs)` | Render every enabled instrument output together; accepts `render()` options except `output_bus` |
+| `parameters()` | Return parameter metadata/value dictionaries |
+| `set_parameter(parameter_id, value)` | Set a normalized finite value in `[0, 1]` |
+| `save_state()` | Return native state as bytes |
+| `load_state(state)` | Restore bytes into the same native class |
+| `snapshot()` | Return description, instance ID, bypass, and base64 state |
+| `clone(*, sample_rate=None, block_size=None, channels=None, offline=True, input_buses=None, output_buses=None)` | Return an independent handle with copied settings and inherited or overridden bus configuration |
+| `reset()` | Reset processing history while preserving plugin settings |
+| `open_editor()` | Open/activate the worker's native plugin view |
+| `close_editor()` | Close only the native view |
+| `close()` | Close editor and plugin worker; safe to repeat |
+
+Properties: `name`, `description`, `id` (instance UUID string), `bypassed` (mutable),
+`closed`, `latency_samples`, `tail_samples`, and `editor_is_open`. Timing properties
+report the worker's latest native timing information. They may briefly lag a GUI
+change until the main thread refreshes/reconfigures the processor.
+
+Audio arrays have 1 through 64 channels. Bus maps select native indices, for
+example `input_buses={0: 6, 1: 2}` and `output_buses={0: 6}`. Values can also be
+`{"channels": 6, "arrangement": 0x3f}` for an explicit VST3 speaker mask. Each
+direction permits up to 64 enabled channels in total; indices range from 0 to 31.
+`process()` uses the main bus, while `process_buses()` preserves each bus's native
+width. Omitted input arrays receive silence; supply `frames` when no arrays are
+given. See [multichannel audio](multichannel.md) for negotiation and format limits.
+
+`MidiNote(note, velocity=1.0, channel=0, sample_offset=0)` is an immutable event.
+Pitches are integers 0–127; channels are zero-based 0–15; velocity is normalized
+to 0–1, with zero meaning note-off. Offsets are nonnegative integers smaller than
+the current process array's frame count. In `render()`, note-offs may also be at
+the score's final frame boundary. Events are sorted stably and translated into
+their native processing blocks. See [instruments](instruments.md).
+
+The instrument rendering signature is:
+
+```text
+Plugin.render(duration_seconds, *, midi=(), sample_rate=None, block_size=None,
+              channels=None, tail_seconds=None, max_tail_seconds=30.0,
+              progress=None, cancel=None, tempo=120.0, input_buses=None,
+              output_buses=None, output_bus=0)
+```
+
+The body contains `round(duration_seconds * sample_rate)` frames. It releases held
+notes at the end and preserves the source instance's processing history. Omitted
+audio configuration uses the source's prepared values or 48000 Hz / 1024 frames /
+stereo. Explicit tails range from 0 to 30 seconds; `None` renders the entire
+`max_tail_seconds` window and trims trailing silence without shortening the body.
+Both render methods share the float progress callback (`0` through `1`, in the
+calling thread), cancellation event, and cleanup contracts. See
+[instrument rendering](instruments.md#high-level-offline-rendering).
+
+`output_bus` selects an enabled output. `None` returns a dictionary containing all
+enabled buses with native widths and aligned frame counts, as does `render_buses()`.
+Bus maps default to the live handle's routing. They affect only the offline copy.
+All outputs share one progress/cancellation stream and common tail trimming.
+
+## PluginChain
+
+```text
+PluginChain(plugins=(), *, sample_rate=48000, block_size=1024, channels=2)
+```
+
+`plugins` is an iterable of paths, descriptions, or existing handles. Paths and
+descriptions create owned handles; existing handles are borrowed.
+
+| Method/property | Behavior |
+| --- | --- |
+| `prepare(sample_rate=48000, block_size=1024, channels=2)` | Reconfigure the chain; returns the chain |
+| `plugins` | Ordered tuple of handles |
+| `add_plugin(path, *, plugin_id=None)` | Prepare/add a handle and return it |
+| `remove_plugin(plugin)` | Remove; close if owned; return the handle |
+| `move_plugin(plugin, index)` | Change order using a Python list insertion index |
+| `latency_samples` | Sum latency of enabled handles |
+| `process(audio, *, reset=False, position=None, tempo=120.0)` | Process a streaming block and retain DSP history/latency |
+| `render(audio, *, tail_seconds=0.0, progress=None, cancel=None, tempo=120.0)` | Render a snapshot with latency compensation and return an array |
+| `reset()` | Reset native DSP history and chain position |
+| `snapshot()` | Return a serializable chain dictionary |
+| `save_state()` | Return UTF-8 JSON bytes |
+| `load_state(state)` | Transactionally replace the chain from bytes or a dictionary |
+| `close()` | Close owned handles and detach borrowed handles |
+
+Configuration attributes: `sample_rate`, `block_size`, and `channels`. Use
+`prepare()` to change them rather than assigning them directly. The chain supports
+context management.
+
+The chain supports 1 through 64 channels on its main path. It does not route
+sidechains or independent auxiliary outputs; use individual `Plugin` bus methods
+for those connections.
+
+`progress` is a synchronous callable receiving a fraction from 0 through 1;
+`cancel` is a `threading.Event`. See [rendering](rendering.md) for their full
+contracts and examples. File names, file objects, and output device arguments are
+not accepted by processing methods.
+
+## Discovery functions
+
+| Function | Result |
+| --- | --- |
+| `default_search_paths()` | Platform-default `Path` list including environment additions |
+| `find_plugin_paths(paths=None)` | Sorted, deduplicated candidate paths without native inspection |
+| `inspect_plugin(path, *, timeout=20.0)` | List of descriptions from one path/registry query |
+| `scan_plugins(paths=None, *, timeout=20.0, include_instruments=False, probe_aax_plugins=False)` | `ScanResult` |
+| `probe_aax(path, *, timeout=20.0)` | Module/export/version dictionary; processing unavailable |
+| `capabilities()` | Implemented formats, probe-only formats, and default search paths |
+
+`ScanResult.plugins` is a list of descriptions. `errors` maps candidate paths to
+error strings; `aax_reports` maps AAX candidate paths to probe dictionaries.
+See [discovery](discovery.md) for search semantics and AU identifiers.
+
+## Errors
+
+| Exception | Meaning |
+| --- | --- |
+| `AudioHostError` | Base host/native-operation failure |
+| `HostCrashedError` | Worker exited or communication failed |
+| `HostTimeoutError` | Operation exceeded its deadline; worker terminated |
+| `UnsupportedFormatError` | Unsupported format, platform, or reserved AAX processing |
+| `ValueError` | Invalid array/configuration, parameter value, or public input |
+
+`HostTimeoutError` also subclasses Python's `TimeoutError`. After a timeout/crash,
+discard the closed handle and load a fresh instance. Native error messages arrive
+as `AudioHostError` with the original error type/message included in the text.