Metadata-Version: 2.4
Name: audioplane
Version: 1.0.0rc1
Summary: Source-aware bidirectional audio I/O SDK for macOS
Home-page: https://github.com/skanda-vyas-srinivasan/audioplane
Author: AudioPlane contributors
Author-email: AudioPlane contributors <133609115+skanda-vyas-srinivasan@users.noreply.github.com>
License: 		    GNU GENERAL PUBLIC LICENSE
        		       Version 2, June 1991
        
         Copyright (C) 1989, 1991 Free Software Foundation, Inc.
         51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
        
         Everyone is permitted to copy and distribute verbatim copies
         of this license document, but changing it is not allowed.
        
        			    Preamble
        
          The licenses for most software are designed to take away your
        freedom to share and change it.  By contrast, the GNU General Public
        License is intended to guarantee your freedom to share and change free
        software--to make sure the software is free for all its users.  This
        General Public License applies to most of the Free Software
        Foundation's software and to any other program whose authors commit to
        using it.  (Some other Free Software Foundation software is covered by
        the GNU Library General Public License instead.)  You can apply it to
        your programs, too.
        
          When we speak of free software, we are referring to freedom, not
        price.  Our General Public Licenses are designed to make sure that you
        have the freedom to distribute copies of free software (and charge for
        this service if you wish), that you receive source code or can get it
        if you want it, that you can change the software or use pieces of it
        in new free programs; and that you know you can do these things.
        
          To protect your rights, we need to make restrictions that forbid
        anyone to deny you these rights or to ask you to surrender the rights.
        These restrictions translate to certain responsibilities for you if you
        distribute copies of the software, or if you modify it.
        
          For example, if you distribute copies of such a program, whether
        gratis or for a fee, you must give the recipients all the rights that
        you have.  You must make sure that they, too, receive or can get the
        source code.  And you must show them these terms so they know their
        rights.
        
          We protect your rights with two steps: (1) copyright the software, and
        (2) offer you this license which gives you legal permission to copy,
        distribute and/or modify the software.
        
          Also, for each author's protection and ours, we want to make certain
        that everyone understands that there is no warranty for this free
        software.  If the software is modified by someone else and passed on, we
        want its recipients to know that what they have is not the original, so
        that any problems introduced by others will not reflect on the original
        authors' reputations.
        
          Finally, any free program is threatened constantly by software
        patents.  We wish to avoid the danger that redistributors of a free
        program will individually obtain patent licenses, in effect making the
        program proprietary.  To prevent this, we have made it clear that any
        patent must be licensed for everyone's free use or not licensed at all.
        
          The precise terms and conditions for copying, distribution and
        modification follow.
                
        		    GNU GENERAL PUBLIC LICENSE
           TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
        
          0. This License applies to any program or other work which contains
        a notice placed by the copyright holder saying it may be distributed
        under the terms of this General Public License.  The "Program", below,
        refers to any such program or work, and a "work based on the Program"
        means either the Program or any derivative work under copyright law:
        that is to say, a work containing the Program or a portion of it,
        either verbatim or with modifications and/or translated into another
        language.  (Hereinafter, translation is included without limitation in
        the term "modification".)  Each licensee is addressed as "you".
        
        Activities other than copying, distribution and modification are not
        covered by this License; they are outside its scope.  The act of
        running the Program is not restricted, and the output from the Program
        is covered only if its contents constitute a work based on the
        Program (independent of having been made by running the Program).
        Whether that is true depends on what the Program does.
        
          1. You may copy and distribute verbatim copies of the Program's
        source code as you receive it, in any medium, provided that you
        conspicuously and appropriately publish on each copy an appropriate
        copyright notice and disclaimer of warranty; keep intact all the
        notices that refer to this License and to the absence of any warranty;
        and give any other recipients of the Program a copy of this License
        along with the Program.
        
        You may charge a fee for the physical act of transferring a copy, and
        you may at your option offer warranty protection in exchange for a fee.
        
          2. You may modify your copy or copies of the Program or any portion
        of it, thus forming a work based on the Program, and copy and
        distribute such modifications or work under the terms of Section 1
        above, provided that you also meet all of these conditions:
        
            a) You must cause the modified files to carry prominent notices
            stating that you changed the files and the date of any change.
        
            b) You must cause any work that you distribute or publish, that in
            whole or in part contains or is derived from the Program or any
            part thereof, to be licensed as a whole at no charge to all third
            parties under the terms of this License.
        
            c) If the modified program normally reads commands interactively
            when run, you must cause it, when started running for such
            interactive use in the most ordinary way, to print or display an
            announcement including an appropriate copyright notice and a
            notice that there is no warranty (or else, saying that you provide
            a warranty) and that users may redistribute the program under
            these conditions, and telling the user how to view a copy of this
            License.  (Exception: if the Program itself is interactive but
            does not normally print such an announcement, your work based on
            the Program is not required to print an announcement.)
                
        These requirements apply to the modified work as a whole.  If
        identifiable sections of that work are not derived from the Program,
        and can be reasonably considered independent and separate works in
        themselves, then this License, and its terms, do not apply to those
        sections when you distribute them as separate works.  But when you
        distribute the same sections as part of a whole which is a work based
        on the Program, the distribution of the whole must be on the terms of
        this License, whose permissions for other licensees extend to the
        entire whole, and thus to each and every part regardless of who wrote it.
        
        Thus, it is not the intent of this section to claim rights or contest
        your rights to work written entirely by you; rather, the intent is to
        exercise the right to control the distribution of derivative or
        collective works based on the Program.
        
        In addition, mere aggregation of another work not based on the Program
        with the Program (or with a work based on the Program) on a volume of
        a storage or distribution medium does not bring the other work under
        the scope of this License.
        
          3. You may copy and distribute the Program (or a work based on it,
        under Section 2) in object code or executable form under the terms of
        Sections 1 and 2 above provided that you also do one of the following:
        
            a) Accompany it with the complete corresponding machine-readable
            source code, which must be distributed under the terms of Sections
            1 and 2 above on a medium customarily used for software interchange; or,
        
            b) Accompany it with a written offer, valid for at least three
            years, to give any third party, for a charge no more than your
            cost of physically performing source distribution, a complete
            machine-readable copy of the corresponding source code, to be
            distributed under the terms of Sections 1 and 2 above on a medium
            customarily used for software interchange; or,
        
            c) Accompany it with the information you received as to the offer
            to distribute corresponding source code.  (This alternative is
            allowed only for noncommercial distribution and only if you
            received the program in object code or executable form with such
            an offer, in accord with Subsection b above.)
        
        The source code for a work means the preferred form of the work for
        making modifications to it.  For an executable work, complete source
        code means all the source code for all modules it contains, plus any
        associated interface definition files, plus the scripts used to
        control compilation and installation of the executable.  However, as a
        special exception, the source code distributed need not include
        anything that is normally distributed (in either source or binary
        form) with the major components (compiler, kernel, and so on) of the
        operating system on which the executable runs, unless that component
        itself accompanies the executable.
        
        If distribution of executable or object code is made by offering
        access to copy from a designated place, then offering equivalent
        access to copy the source code from the same place counts as
        distribution of the source code, even though third parties are not
        compelled to copy the source along with the object code.
                
          4. You may not copy, modify, sublicense, or distribute the Program
        except as expressly provided under this License.  Any attempt
        otherwise to copy, modify, sublicense or distribute the Program is
        void, and will automatically terminate your rights under this License.
        However, parties who have received copies, or rights, from you under
        this License will not have their licenses terminated so long as such
        parties remain in full compliance.
        
          5. You are not required to accept this License, since you have not
        signed it.  However, nothing else grants you permission to modify or
        distribute the Program or its derivative works.  These actions are
        prohibited by law if you do not accept this License.  Therefore, by
        modifying or distributing the Program (or any work based on the
        Program), you indicate your acceptance of this License to do so, and
        all its terms and conditions for copying, distributing or modifying
        the Program or works based on it.
        
          6. Each time you redistribute the Program (or any work based on the
        Program), the recipient automatically receives a license from the
        original licensor to copy, distribute or modify the Program subject to
        these terms and conditions.  You may not impose any further
        restrictions on the recipients' exercise of the rights granted herein.
        You are not responsible for enforcing compliance by third parties to
        this License.
        
          7. If, as a consequence of a court judgment or allegation of patent
        infringement or for any other reason (not limited to patent issues),
        conditions are imposed on you (whether by court order, agreement or
        otherwise) that contradict the conditions of this License, they do not
        excuse you from the conditions of this License.  If you cannot
        distribute so as to satisfy simultaneously your obligations under this
        License and any other pertinent obligations, then as a consequence you
        may not distribute the Program at all.  For example, if a patent
        license would not permit royalty-free redistribution of the Program by
        all those who receive copies directly or indirectly through you, then
        the only way you could satisfy both it and this License would be to
        refrain entirely from distribution of the Program.
        
        If any portion of this section is held invalid or unenforceable under
        any particular circumstance, the balance of the section is intended to
        apply and the section as a whole is intended to apply in other
        circumstances.
        
        It is not the purpose of this section to induce you to infringe any
        patents or other property right claims or to contest validity of any
        such claims; this section has the sole purpose of protecting the
        integrity of the free software distribution system, which is
        implemented by public license practices.  Many people have made
        generous contributions to the wide range of software distributed
        through that system in reliance on consistent application of that
        system; it is up to the author/donor to decide if he or she is willing
        to distribute software through any other system and a licensee cannot
        impose that choice.
        
        This section is intended to make thoroughly clear what is believed to
        be a consequence of the rest of this License.
                
          8. If the distribution and/or use of the Program is restricted in
        certain countries either by patents or by copyrighted interfaces, the
        original copyright holder who places the Program under this License
        may add an explicit geographical distribution limitation excluding
        those countries, so that distribution is permitted only in or among
        countries not thus excluded.  In such case, this License incorporates
        the limitation as if written in the body of this License.
        
          9. The Free Software Foundation may publish revised and/or new versions
        of the General Public License from time to time.  Such new versions will
        be similar in spirit to the present version, but may differ in detail to
        address new problems or concerns.
        
        Each version is given a distinguishing version number.  If the Program
        specifies a version number of this License which applies to it and "any
        later version", you have the option of following the terms and conditions
        either of that version or of any later version published by the Free
        Software Foundation.  If the Program does not specify a version number of
        this License, you may choose any version ever published by the Free Software
        Foundation.
        
          10. If you wish to incorporate parts of the Program into other free
        programs whose distribution conditions are different, write to the author
        to ask for permission.  For software which is copyrighted by the Free
        Software Foundation, write to the Free Software Foundation; we sometimes
        make exceptions for this.  Our decision will be guided by the two goals
        of preserving the free status of all derivatives of our free software and
        of promoting the sharing and reuse of software generally.
        
        			    NO WARRANTY
        
          11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
        FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
        OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
        PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
        OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
        MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
        TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
        PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
        REPAIR OR CORRECTION.
        
          12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
        WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
        REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
        INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
        OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
        TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
        YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
        PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
        POSSIBILITY OF SUCH DAMAGES.
        
        		     END OF TERMS AND CONDITIONS
        		    GNU GENERAL PUBLIC LICENSE
        		       Version 2, June 1991
        
         Copyright (C) 1989, 1991 Free Software Foundation, Inc.
                                  675 Mass Ave, Cambridge, MA 02139, USA
         Everyone is permitted to copy and distribute verbatim copies
         of this license document, but changing it is not allowed.
        
        			    Preamble
        
          The licenses for most software are designed to take away your
        freedom to share and change it.  By contrast, the GNU General Public
        License is intended to guarantee your freedom to share and change free
        software--to make sure the software is free for all its users.  This
        General Public License applies to most of the Free Software
        Foundation's software and to any other program whose authors commit to
        using it.  (Some other Free Software Foundation software is covered by
        the GNU Library General Public License instead.)  You can apply it to
        your programs, too.
        
          When we speak of free software, we are referring to freedom, not
        price.  Our General Public Licenses are designed to make sure that you
        have the freedom to distribute copies of free software (and charge for
        this service if you wish), that you receive source code or can get it
        if you want it, that you can change the software or use pieces of it
        in new free programs; and that you know you can do these things.
        
          To protect your rights, we need to make restrictions that forbid
        anyone to deny you these rights or to ask you to surrender the rights.
        These restrictions translate to certain responsibilities for you if you
        distribute copies of the software, or if you modify it.
        
          For example, if you distribute copies of such a program, whether
        gratis or for a fee, you must give the recipients all the rights that
        you have.  You must make sure that they, too, receive or can get the
        source code.  And you must show them these terms so they know their
        rights.
        
          We protect your rights with two steps: (1) copyright the software, and
        (2) offer you this license which gives you legal permission to copy,
        distribute and/or modify the software.
        
          Also, for each author's protection and ours, we want to make certain
        that everyone understands that there is no warranty for this free
        software.  If the software is modified by someone else and passed on, we
        want its recipients to know that what they have is not the original, so
        that any problems introduced by others will not reflect on the original
        authors' reputations.
        
          Finally, any free program is threatened constantly by software
        patents.  We wish to avoid the danger that redistributors of a free
        program will individually obtain patent licenses, in effect making the
        program proprietary.  To prevent this, we have made it clear that any
        patent must be licensed for everyone's free use or not licensed at all.
        
          The precise terms and conditions for copying, distribution and
        modification follow.
                
        		    GNU GENERAL PUBLIC LICENSE
           TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
        
          0. This License applies to any program or other work which contains
        a notice placed by the copyright holder saying it may be distributed
        under the terms of this General Public License.  The "Program", below,
        refers to any such program or work, and a "work based on the Program"
        means either the Program or any derivative work under copyright law:
        that is to say, a work containing the Program or a portion of it,
        either verbatim or with modifications and/or translated into another
        language.  (Hereinafter, translation is included without limitation in
        the term "modification".)  Each licensee is addressed as "you".
        
        Activities other than copying, distribution and modification are not
        covered by this License; they are outside its scope.  The act of
        running the Program is not restricted, and the output from the Program
        is covered only if its contents constitute a work based on the
        Program (independent of having been made by running the Program).
        Whether that is true depends on what the Program does.
        
          1. You may copy and distribute verbatim copies of the Program's
        source code as you receive it, in any medium, provided that you
        conspicuously and appropriately publish on each copy an appropriate
        copyright notice and disclaimer of warranty; keep intact all the
        notices that refer to this License and to the absence of any warranty;
        and give any other recipients of the Program a copy of this License
        along with the Program.
        
        You may charge a fee for the physical act of transferring a copy, and
        you may at your option offer warranty protection in exchange for a fee.
        
          2. You may modify your copy or copies of the Program or any portion
        of it, thus forming a work based on the Program, and copy and
        distribute such modifications or work under the terms of Section 1
        above, provided that you also meet all of these conditions:
        
            a) You must cause the modified files to carry prominent notices
            stating that you changed the files and the date of any change.
        
            b) You must cause any work that you distribute or publish, that in
            whole or in part contains or is derived from the Program or any
            part thereof, to be licensed as a whole at no charge to all third
            parties under the terms of this License.
        
            c) If the modified program normally reads commands interactively
            when run, you must cause it, when started running for such
            interactive use in the most ordinary way, to print or display an
            announcement including an appropriate copyright notice and a
            notice that there is no warranty (or else, saying that you provide
            a warranty) and that users may redistribute the program under
            these conditions, and telling the user how to view a copy of this
            License.  (Exception: if the Program itself is interactive but
            does not normally print such an announcement, your work based on
            the Program is not required to print an announcement.)
                
        These requirements apply to the modified work as a whole.  If
        identifiable sections of that work are not derived from the Program,
        and can be reasonably considered independent and separate works in
        themselves, then this License, and its terms, do not apply to those
        sections when you distribute them as separate works.  But when you
        distribute the same sections as part of a whole which is a work based
        on the Program, the distribution of the whole must be on the terms of
        this License, whose permissions for other licensees extend to the
        entire whole, and thus to each and every part regardless of who wrote it.
        
        Thus, it is not the intent of this section to claim rights or contest
        your rights to work written entirely by you; rather, the intent is to
        exercise the right to control the distribution of derivative or
        collective works based on the Program.
        
        In addition, mere aggregation of another work not based on the Program
        with the Program (or with a work based on the Program) on a volume of
        a storage or distribution medium does not bring the other work under
        the scope of this License.
        
          3. You may copy and distribute the Program (or a work based on it,
        under Section 2) in object code or executable form under the terms of
        Sections 1 and 2 above provided that you also do one of the following:
        
            a) Accompany it with the complete corresponding machine-readable
            source code, which must be distributed under the terms of Sections
            1 and 2 above on a medium customarily used for software interchange; or,
        
            b) Accompany it with a written offer, valid for at least three
            years, to give any third party, for a charge no more than your
            cost of physically performing source distribution, a complete
            machine-readable copy of the corresponding source code, to be
            distributed under the terms of Sections 1 and 2 above on a medium
            customarily used for software interchange; or,
        
            c) Accompany it with the information you received as to the offer
            to distribute corresponding source code.  (This alternative is
            allowed only for noncommercial distribution and only if you
            received the program in object code or executable form with such
            an offer, in accord with Subsection b above.)
        
        The source code for a work means the preferred form of the work for
        making modifications to it.  For an executable work, complete source
        code means all the source code for all modules it contains, plus any
        associated interface definition files, plus the scripts used to
        control compilation and installation of the executable.  However, as a
        special exception, the source code distributed need not include
        anything that is normally distributed (in either source or binary
        form) with the major components (compiler, kernel, and so on) of the
        operating system on which the executable runs, unless that component
        itself accompanies the executable.
        
        If distribution of executable or object code is made by offering
        access to copy from a designated place, then offering equivalent
        access to copy the source code from the same place counts as
        distribution of the source code, even though third parties are not
        compelled to copy the source along with the object code.
                
          4. You may not copy, modify, sublicense, or distribute the Program
        except as expressly provided under this License.  Any attempt
        otherwise to copy, modify, sublicense or distribute the Program is
        void, and will automatically terminate your rights under this License.
        However, parties who have received copies, or rights, from you under
        this License will not have their licenses terminated so long as such
        parties remain in full compliance.
        
          5. You are not required to accept this License, since you have not
        signed it.  However, nothing else grants you permission to modify or
        distribute the Program or its derivative works.  These actions are
        prohibited by law if you do not accept this License.  Therefore, by
        modifying or distributing the Program (or any work based on the
        Program), you indicate your acceptance of this License to do so, and
        all its terms and conditions for copying, distributing or modifying
        the Program or works based on it.
        
          6. Each time you redistribute the Program (or any work based on the
        Program), the recipient automatically receives a license from the
        original licensor to copy, distribute or modify the Program subject to
        these terms and conditions.  You may not impose any further
        restrictions on the recipients' exercise of the rights granted herein.
        You are not responsible for enforcing compliance by third parties to
        this License.
        
          7. If, as a consequence of a court judgment or allegation of patent
        infringement or for any other reason (not limited to patent issues),
        conditions are imposed on you (whether by court order, agreement or
        otherwise) that contradict the conditions of this License, they do not
        excuse you from the conditions of this License.  If you cannot
        distribute so as to satisfy simultaneously your obligations under this
        License and any other pertinent obligations, then as a consequence you
        may not distribute the Program at all.  For example, if a patent
        license would not permit royalty-free redistribution of the Program by
        all those who receive copies directly or indirectly through you, then
        the only way you could satisfy both it and this License would be to
        refrain entirely from distribution of the Program.
        
        If any portion of this section is held invalid or unenforceable under
        any particular circumstance, the balance of the section is intended to
        apply and the section as a whole is intended to apply in other
        circumstances.
        
        It is not the purpose of this section to induce you to infringe any
        patents or other property right claims or to contest validity of any
        such claims; this section has the sole purpose of protecting the
        integrity of the free software distribution system, which is
        implemented by public license practices.  Many people have made
        generous contributions to the wide range of software distributed
        through that system in reliance on consistent application of that
        system; it is up to the author/donor to decide if he or she is willing
        to distribute software through any other system and a licensee cannot
        impose that choice.
        
        This section is intended to make thoroughly clear what is believed to
        be a consequence of the rest of this License.
                
          8. If the distribution and/or use of the Program is restricted in
        certain countries either by patents or by copyrighted interfaces, the
        original copyright holder who places the Program under this License
        may add an explicit geographical distribution limitation excluding
        those countries, so that distribution is permitted only in or among
        countries not thus excluded.  In such case, this License incorporates
        the limitation as if written in the body of this License.
        
          9. The Free Software Foundation may publish revised and/or new versions
        of the General Public License from time to time.  Such new versions will
        be similar in spirit to the present version, but may differ in detail to
        address new problems or concerns.
        
        Each version is given a distinguishing version number.  If the Program
        specifies a version number of this License which applies to it and "any
        later version", you have the option of following the terms and conditions
        either of that version or of any later version published by the Free
        Software Foundation.  If the Program does not specify a version number of
        this License, you may choose any version ever published by the Free Software
        Foundation.
        
          10. If you wish to incorporate parts of the Program into other free
        programs whose distribution conditions are different, write to the author
        to ask for permission.  For software which is copyrighted by the Free
        Software Foundation, write to the Free Software Foundation; we sometimes
        make exceptions for this.  Our decision will be guided by the two goals
        of preserving the free status of all derivatives of our free software and
        of promoting the sharing and reuse of software generally.
        
        			    NO WARRANTY
        
          11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
        FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
        OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
        PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
        OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
        MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
        TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
        PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
        REPAIR OR CORRECTION.
        
          12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
        WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
        REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
        INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
        OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
        TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
        YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
        PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
        POSSIBILITY OF SUCH DAMAGES.
        
        		     END OF TERMS AND CONDITIONS
        
Project-URL: Documentation, https://github.com/skanda-vyas-srinivasan/audioplane/blob/python-v1.0.0rc1/docs/getting-started.md
Project-URL: Repository, https://github.com/skanda-vyas-srinivasan/audioplane
Project-URL: Issues, https://github.com/skanda-vyas-srinivasan/audioplane/issues
Keywords: audio,coreaudio,macos,realtime,sdk
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
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: Operating System :: MacOS
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: openai
Requires-Dist: openai[realtime]<4,>=3.24.0; python_version >= "3.10" and extra == "openai"
Provides-Extra: gemini
Requires-Dist: google-genai>=1; python_version >= "3.10" and extra == "gemini"
Requires-Dist: webrtcvad-wheels<3,>=2.0.14; extra == "gemini"
Provides-Extra: mcp
Requires-Dist: mcp<3,>=2; python_version >= "3.10" and extra == "mcp"
Provides-Extra: ai
Requires-Dist: openai[realtime]<4,>=3.24.0; python_version >= "3.10" and extra == "ai"
Requires-Dist: google-genai>=1; python_version >= "3.10" and extra == "ai"
Requires-Dist: webrtcvad-wheels<3,>=2.0.14; extra == "ai"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# AudioPlane Python SDK

The source-aware, bidirectional async SDK for the local AudioPlane Runtime. It connects
only to the local Unix-domain Runtime and keeps Core Audio details out of
application code. The core package has no runtime dependencies and supports
Python 3.9+.

**Developer preview (`1.0.0rc1`). Native macOS Runtime required.** The Python
package does not install the Runtime or virtual audio driver. Start with the
[installation and first-audio guide](https://github.com/skanda-vyas-srinivasan/audioplane/blob/python-v1.0.0rc1/docs/getting-started.md)
before attempting capture or playback. Core audio I/O needs Python 3.9+;
Gemini, OpenAI and MCP integrations need Python 3.10+.

## Install in your Python application

The prepared PyPI release uses an explicit prerelease version:

```sh
python3 -m venv .venv
. .venv/bin/activate
python -m pip install audioplane==1.0.0rc1
```

Until that release is available on PyPI, install from a repository checkout:
`python -m pip install ./SDKs/python`.
For provider support after publication, use
`python -m pip install 'audioplane[gemini]==1.0.0rc1'` or
`python -m pip install 'audioplane[openai]==1.0.0rc1'`.
Provider credentials are external; no cloud provider is required for basic I/O.

Documentation:

- [Getting started and permissions](https://github.com/skanda-vyas-srinivasan/audioplane/blob/python-v1.0.0rc1/docs/getting-started.md)
- [Realtime streaming vs. capture-and-review](https://github.com/skanda-vyas-srinivasan/audioplane/blob/python-v1.0.0rc1/docs/developer-workflows.md)
- [AI integration](https://github.com/skanda-vyas-srinivasan/audioplane/blob/python-v1.0.0rc1/docs/ai-integration.md)
- [Playback, loopback and duplex output](https://github.com/skanda-vyas-srinivasan/audioplane/blob/python-v1.0.0rc1/docs/output-audio.md)
- [Current qualification and outstanding manual checks](https://github.com/skanda-vyas-srinivasan/audioplane/blob/python-v1.0.0rc1/docs/developer-workflows-validation.md)

These links reference a fixed documentation revision so they also work on PyPI
and outside a repository checkout. Installation, cloud model availability and
hardware behavior are not guarantees of unattended production qualification.

## Install the command-line client with pipx

Once the prepared prerelease is available, install the CLI separately:

```sh
pipx install 'audioplane==1.0.0rc1'

audioplane version
audioplane doctor
audioplane sources
```

Before publication, the source install is:

```sh
pipx install \
  "git+https://github.com/skanda-vyas-srinivasan/audioplane.git@python-v1.0.0rc1#subdirectory=SDKs/python"
```

This installs the `audioplane` client and `audioplane-mcp` control server in an
isolated Python environment. It does **not** install or sign the native macOS
Runtime; Process Tap permission belongs to that native executable. Build and
start the signed Runtime using the repository quickstart before running commands
that connect to it.

With the first-party `AudioPlane Input` device installed, the CLI can keep one
virtual-microphone session open and speak each line entered at the prompt:

```sh
audioplane speak
```

Type `/quit` to stop. The command uses the local macOS `say` voice by default;
`audioplane speak --voice Samantha --rate 190` selects a voice and speech rate.

When an application uses AudioPlane Input instead of a physical microphone,
keep the current macOS microphone in the mix with:

```sh
audioplane mic-through
```

This resolves the annotated default microphone and forwards 48 kHz mono PCM
through the Runtime until `Ctrl-C`. `audioplane speak` and model response audio
can run concurrently. Use `--source ID_OR_NAME` for a different physical input;
the SDK rejects a source/destination pair that is the same Core Audio device.

For local development against a checkout:

```sh
pipx install --editable SDKs/python
```

New Python code can use the AudioPlane name:

```python
from audioplane import AudioPlane

async with AudioPlane() as audio:
    for source in await audio.sources():
        print(source.name)
```

The existing `sonexis` import remains available for compatibility with v1.0
applications and examples.

## Install for repository development

```sh
cd /path/to/audioplane
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -e ./SDKs/python
python -c 'import audioplane; print(audioplane.__version__)'
```

The editable install is the normal repository-development path. Release
engineering also builds a wheel and source distribution locally; install the
wheel into a clean environment with `python -m pip install PATH_TO_WHEEL`.
The package contains the SDK and CLI, not a separately installed native Runtime.

For completely offline testing, installation is unnecessary:

```sh
PYTHONPATH="$PWD/SDKs/python/src" /usr/bin/python3 -m unittest discover \
  -s SDKs/python/tests -p 'test_*.py' -v
```

## Capture one application

Start with [getting started](https://github.com/skanda-vyas-srinivasan/audioplane/blob/python-v1.0.0rc1/docs/getting-started.md) for permissions and
separate Runtime installation. Choose [realtime or capture-then-analysis](https://github.com/skanda-vyas-srinivasan/audioplane/blob/python-v1.0.0rc1/docs/developer-workflows.md)
based on your application; neither requires implementing Core Audio.

```python
import asyncio
from audioplane import AudioPlane

async def main():
    async with AudioPlane() as sx:
        async with await sx.capture("Discord") as stream:
            async for frame in stream:
                print(frame.source.name, frame.timestamp_ns, len(frame.data))

asyncio.run(main())
```

## Async ownership

Use context managers as the canonical ownership boundary:

- `async with AudioPlane() as sx` owns the control connection and closes every
  capture, output, and event subscription it created.
- Capture and playback perform an asynchronous Runtime request first, so write
  `async with await sx.capture(...)` and
  `async with await sx.playback(...)`.
- `sx.session()` and `sx.duplex(...)` return convenience context managers
  directly, so do not add `await` after `async with` for those calls.
- Breaking an `async for` loop does not replace explicit ownership. Keep the
  stream inside its context, especially when cancellation or exceptions can
  leave the loop early.
- `reconnect()` creates only a new control connection. It never revives or
  silently replaces resources owned by an earlier Runtime instance.

Cancellation of a mutating request closes its owning control connection when
the result is ambiguous, allowing Runtime cleanup to remain authoritative.
Read-only request cancellation leaves an otherwise healthy connection usable.
Control requests have a 10-second deadline covering socket backpressure and the
response wait. Set `AudioPlane(request_timeout=30.0)` to change it. A timeout
raises `SonexisConnectionError` with code `request_timeout`; timed-out mutating
requests reconcile ownership by closing the control connection.
Positive source/destination wait timeouts also cover an in-flight discovery
lookup. For compatibility, a zero timeout performs one snapshot lookup under
the normal control-request deadline and raises a wait-timeout error if no match exists.

`capture` accepts a Runtime source ID, bundle identifier, PID passed as a Python
`int`, exact application name, or `AudioSource`. A numeric string remains a
string selector. A name must resolve uniquely; the SDK raises
`AmbiguousSourceError` rather than guessing. Use `find_sources`, `get_source`,
or `wait_for_source` for discovery and applications that launch later.
Physical inputs use stable `microphone:<Core Audio UID>` IDs, kind
`"microphone"`, and optional `is_default` metadata. `default_microphone()`
resolves the current default without guessing when metadata is ambiguous.

Every delivered `AudioFrame` includes its immutable source snapshot, session and
stream IDs, sequence, format, session-relative timestamp, discontinuity/drop
state, and SDK receipt time. `estimated_capture_at_ns` is an approximate Runtime
presentation coordinate—not a preserved Core Audio host timestamp.

## Play realtime audio

The Runtime, rather than the Python process, owns the selected output device:

```python
import asyncio
from audioplane import AudioFormat, AudioPlane

async def play(model_audio):
    async with AudioPlane() as sx:
        async with await sx.playback(
            destination="default",
            format=AudioFormat.openai_realtime_output(),
            target_buffer_milliseconds=60,
        ) as output:
            async for pcm_chunk in model_audio:
                await output.write(pcm_chunk)

# Call `await play(model_audio)` from your application's async entry point.
```

`write()` accepts `bytes`, `bytearray`, or `memoryview` containing whole,
interleaved PCM sample frames. Each nonempty write must contain at least 1 ms
of audio; coalesce smaller model fragments first. It serializes concurrent callers and splits
large chunks into protocol packets no longer than 200 ms. Awaiting `write()`
applies Unix-socket backpressure; the SDK does not add an unbounded queue.
Supply `timestamp_ns=` when a producer has a stream-relative presentation
timestamp. Otherwise the SDK derives continuous timestamps from frames sent.

Normal context-manager exit rejects new and waiting writes, finishes the active
write, then sends EOS and waits for the Runtime to drain. The three-second drain
deadline includes the active write; expiry discards remaining output.
`await output.cancel()` can override graceful close immediately: it closes the stream
without EOS and asks the Runtime to discard buffered playback. `flush()`
discards queued audio while keeping the logical session, attaches the new
stream epoch returned by the Runtime, and resets sequence/timestamp state.

Use `await sx.output_destinations()` to enumerate typed
`AudioOutputDestination` values. `await output.refresh()` or
`await sx.output_status(output.info.id)` returns `OutputInfo` and
`OutputMetrics`, including input/rendered/dropped frames, underruns, overruns,
queue depth, buffered duration, conversion work, route changes, and whether a
producer is attached. The `default` destination follows the current macOS
default output device. A Runtime without the v0.4 `output_sessions` capability
fails these calls with `unsupported_capability` instead of sending unsupported
commands.

Use `find_output_destinations()`, `get_output_destination()`, and
`wait_for_output_destination()` to search snapshots, resolve an exact ID or
name, or wait for a device to appear. `"loopback"` and `"virtual_input"` are
accepted only when they identify one unambiguous installed loopback. The SDK
raises typed not-found/ambiguity errors rather than choosing silently.

Installed loopback HAL devices are returned as `virtual_input` destinations
when recognizable and can be selected by their `coreaudio:<UID>` ID or exact
name. AudioPlane includes a source-built first-party driver, but installation
remains explicit; destination enumeration is the authoritative source of
availability. `await output.refresh()` updates the
creation-time destination snapshot after a default-device change.

Capture and output can also be owned together without imposing agent policy:

```python
async with AudioPlane() as sx:
    async with sx.duplex(
        "Discord",
        input_format=AudioFormat.gemini_live(),
        output_format=AudioFormat.gemini_live_output(),
    ) as session:
        async for frame in session.input:
            ...
            await session.output.write(response_pcm)
```

The application still decides turn-taking and feedback behavior. Call
`await session.output.flush()` to discard a partial response while keeping the
duplex session, or `cancel()` to tear output down immediately.

For a public-API-only loop with a fake passthrough model, negotiate the same
format on both sides. Real model output must instead match `output_format`:

```python
import asyncio
from audioplane import AudioFormat, AudioPlane

async def main():
    format = AudioFormat.speech_16k()
    async with AudioPlane() as sx:
        async with sx.duplex(
            "Discord", input_format=format, output_format=format
        ) as session:
            async for frame in session.input:
                # Replace this passthrough with a model producing `format`.
                await session.output.write(frame.data)

asyncio.run(main())
```

Use headphones for passthrough/duplex experiments; AudioPlane does not implement
acoustic echo cancellation.

The output data plane uses the same 64-byte SXPC v2 PCM envelope as capture,
but in the client-to-Runtime direction. Continuous audio never travels in JSON
control requests.

## Multiple labeled sources

```python
async with AudioPlane() as sx:
    async with sx.session() as group:
        await group.add("conversation", "Discord")
        await group.add("media", "Spotify")

        async for item in group.frames():
            print(item.label, item.source.name, item.timestamp_ns)
```

Captures remain independent and are never mixed. Every label has a fair queue
bounded to `max_queue_packets` complete `AudioFrame` packets. `group.dropped_frames` and
`dropped_frames_by_label` count lost PCM sample frames; the next retained frame
reports a local discontinuity. Independent Process Taps do not promise sample-accurate
cross-application synchronization.

`fail_fast=True` is the default: one member failure raises from `frames()` and
the context manager closes the group. Use `fail_fast=False` for independent
long-running members and inspect `errors_by_label` when one source ends.

## Format presets

```python
from audioplane import AudioFormat

AudioFormat.speech_16k()
AudioFormat.openai_realtime()  # PCM16 mono, 24 kHz
AudioFormat.gemini_live()      # PCM16 mono, 16 kHz
AudioFormat.openai_realtime_output()  # PCM16 mono, 24 kHz
AudioFormat.gemini_live_output()      # PCM16 mono, 24 kHz
```

These are convenience values. The Runtime handshake remains authoritative for
supported formats.

## Optional realtime providers

Provider adapters are isolated above the SDK and require opt-in dependencies:

The dependency-free core supports Python 3.9. Provider and MCP extras require
Python 3.10 or newer because their official upstream SDKs do. Create a separate
environment with any installed 3.10+ interpreter before installing an extra:

```sh
python3.10 -m venv .venv-ai
. .venv-ai/bin/activate
python -m pip install -e 'SDKs/python[openai]'
```

```sh
python -m pip install -e 'SDKs/python[openai]'
python -m pip install -e 'SDKs/python[gemini]'
```

```python
from audioplane import AudioFormat, AudioPlane
from audioplane.providers import GeminiLiveSink, GeminiTurnDetectionConfig

async with AudioPlane() as sx:
    turns = GeminiTurnDetectionConfig(silence_duration_ms=1200)
    async with await GeminiLiveSink.connect(model="gemini-3.8-live", turn_detection=turns) as model:
        async with await sx.capture(
            "Google Chrome", format=AudioFormat.gemini_live()
        ) as stream:
            async for frame in stream:
                await model.send_audio(frame)
```

This fragment shows the send path only. Consume `model.events()` concurrently
to receive text/audio and surface provider failures; the [runnable streaming
example](https://github.com/skanda-vyas-srinivasan/audioplane/blob/python-v1.0.0rc1/docs/developer-workflows.md#realtime-process-while-the-source-plays)
and packaged `audioplane agent` do that. A provider stall can backpressure direct
forwarding; use the packaged bounded pipeline for conversational behavior.

For a complete recording review, run
`python Examples/capture-and-review.py --source "Google Chrome" --duration 205`
from a checkout with the Gemini extra installed and the key exported. It uses
captured audio directly, not a website transcript, and retains PCM in memory.

OpenAI reads `OPENAI_API_KEY`; Gemini reads `GEMINI_API_KEY` and optionally
`GEMINI_LIVE_MODEL`. Each sink accepts one ordered AudioPlane stream; create one
sink per source label. No adapter logs or persists audio or credentials. Network
behavior must be validated with the developer's own provider account.

Gemini uses hybrid VAD by default: server automatic VAD remains enabled while
the adapter buffers a short activity onset and sends one `audio_stream_end`
after a debounced local pause. Silence after finalization is not transmitted,
and new meaningful activity reopens the stream. Configure start/end RMS,
minimum activity, and silence duration with `GeminiTurnDetectionConfig`, or
inject the SDK's `VoiceActivityDetector` extension for speech-aware detection.
`WebRTCVoiceActivityDetector` is a provided optional classifier, installed with
the Gemini extra. The packaged Gemini agent uses it by default to avoid waiting
for literal silence in a noisy room. It confirms 100 ms of speech, tolerates
100 ms onset gaps, and ends after 1,200 ms of non-speech. Configure it with
`--gemini-vad-mode`, `--gemini-min-activity-ms`, `--gemini-onset-gap-ms`, and
`--gemini-silence-ms`. Choose `--gemini-vad energy` for the legacy RMS detector;
RMS start/end options affect only that mode. For direct sink usage:

```python
from audioplane import WebRTCVoiceActivityDetector
from audioplane.providers import GeminiLiveSink

model = await GeminiLiveSink.connect(
    voice_activity_detector=WebRTCVoiceActivityDetector(mode=2),
)
```

`--debug` prints input levels and detector state once per second. The classifier
retains less than one 10 ms block and runs outside the Runtime/audio callback.

For the complete packaged capture/provider/playback lifecycle, use the same
entry point installed by the wheel:

```sh
audioplane agent \
  --provider gemini \
  --gemini-model gemini-3.8-live \
  --source "Google Chrome" \
  --response-output coreaudio:com.audioplane.input.device \
  --gemini-barge-in \
  --validate-live \
  --debug
```

The base `audioplane` commands remain usable without provider extras. The
agent imports provider integrations lazily and reports missing optional
dependencies or credentials as structured, actionable failures.

## Replay, activity, and diagnostics

`ReplayStream.from_wav(...)` and `ReplayStream.from_pcm(...)` yield normal
source-aware frames, with optional realtime pacing, for deterministic adapter
tests. `measure_activity(frame)` reports RMS/peak and non-silence activity; it
does not claim to detect speech. Applications may implement the
`VoiceActivityDetector` protocol with their chosen VAD.

`AudioActivityDetector(ActivityDetectionConfig(...))` provides debounced
`activity_started` / `activity_ended` edges with source/session/stream context.
It runs on the consuming task, resets on discontinuities, and accepts an
optional `VoiceActivityDetector` for speech-aware classification. Use one
detector per AudioPlane stream; `reset()` clears debounce state but deliberately
retains stream affinity.

`LatencyTracker` keeps a bounded sample window and reports p50/p95/p99 estimates
from Runtime session presentation time to SDK receipt. These estimates exclude
provider response/network latency and are not live Process Tap capture latency.

## MCP control plane

The optional MCP server requires Python 3.10+ and the `mcp` extra:

```sh
python -m pip install -e 'SDKs/python[mcp]'
python -m sonexis.mcp_server
```

Runtime/source/diagnostic/output-destination tools are local and low-bandwidth.
Capture tools are not registered unless the server is launched with
`--allow-capture`. MCP
never carries PCM. Attach an audio process through the binary data plane:

```python
async with AudioPlane() as sx:
    async with await sx.attach_capture(session_id) as stream:
        async for frame in stream:
            ...
```

The MCP process owns sessions it creates, cannot inspect another client's
capture, and must remain running. Session results omit binary socket paths;
closing its
Runtime control connection stops those captures.

## Failure and reconnect behavior

Errors preserve a stable `code`, `message`, `retryable`, and `details` mapping.
Specialized exceptions cover missing/ambiguous/unavailable sources, permission,
formats, session limits, slow consumers, protocol failures, connection failures,
capture failures, and provider failures. `reconnect()` creates a fresh control
connection but never silently recreates captures or binds to a relaunched app.

`PermissionDeniedError` maps an explicit `permission_denied` Runtime response.
Core Audio does not consistently distinguish a denied Process Tap from other
initialization failures, so missing permission may instead raise
`CaptureFailedError` with code `capture_initialization_failed` and actionable
permission guidance. In either case, enable `sonexis-runtime` in **System
Settings > Privacy & Security > Screen & System Audio Recording**, restart the
Runtime, and retry live capture; source enumeration alone does not verify it.
