Update ci.yaml

and again...

.github/workflows/ci.yaml

@@ -9,16 +9,18 @@ on:
   pull_request:
     branches: [ endless ]
 
+
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   test:
     name: ${{ matrix.lisp }} on ${{ matrix.os }}
+    continue-on-error: true
     strategy:
       matrix:
       # current ccl-bin has a flaky zip file, so roswell can't install it.
-      # Specify a version that works for now.
+      # Specify a version that works for now. #- cmucl, allegro, ccl, ecl, clisp
-        lisp: [sbcl-bin, ccl-bin/1.12]
+        lisp: [sbcl-bin, ccl, ecl, allegro, clisp]
-        os: [ windows-latest, ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
 
     # run the job on every combination of "lisp" and "os" above
     runs-on: ${{ matrix.os }}

AUTHORS

@@ -0,0 +1,7 @@
+nik gaffney
+Jamie Forth
+Javier Olaechea
+@boqs
+Erik Ronström
+vincent akkermans
+Matthew Kennedy

CHANGES

@@ -0,0 +1,54 @@
+ 2022-08-26
+    - version 0.7
+    - relicensing LLGPL → GPLv3
+ 2022-08-22
+    - version 0.6
+    - further improvements from jamieforth
+ 2019-04-02
+    - encoder/decoder refactoring from Javier Olaechea @PuercoPop
+ 2017-12-10
+    - osc-examples converted to usocket for portability from @boqs
+ 2015-08-25
+    - support for 64bit ints from Erik Ronström https://github.com/erikronstrom
+ 2015-08-21
+    - implement nested bundles from jamieforth https://github.com/jamieforth
+ 2011-04-19
+    - converted repo from darcs->git
+ 2010-09-25
+    - add osc-devices API from jamieforth
+ 2010-09-10
+    - timetag improvements from jamieforth https://github.com/jamieforth/osc
+ 2007-02-20
+    - version 0.5
+    - Allegro CL float en/decoding from vincent akkermans vincent.akkermans@gmail.com
+ 2006-02-11
+    - version 0.4
+    - partial timetag implementation
+ 2005-12-05
+    - version 0.3
+    - fixed openmcl float bug (decode-uint32)
+ 2005-11-29
+    - version 0.2
+    - openmcl float en/decoding
+ 2005-08-12
+    - corrections from Matthew Kennedy mkennedy@gentoo.org
+ 2005-08-11
+    - version 0.1
+ 2005-03-16
+    - packaged as an asdf installable lump
+ 2005-03-11
+    - bundle and blob en/de- coding
+ 2005-03-05
+    - 'declare' scattering and other optimisations
+ 2005-02-08
+    - in-package'd
+    - basic dispatcher
+ 2005-03-01
+    - fixed address string bug
+ 2005-01-26
+    - fixed string handling bug
+ 2005-01-24
+    - sends and receives multiple arguments
+    - tests in osc-tests.lisp
+ 2004-12-18
+    - initial version, single args only

LGPL.txt

@@ -1,459 +0,0 @@
-GNU LESSER GENERAL PUBLIC LICENSE
-Version 2.1, February 1999
-
-Copyright (C) 1991, 1999 Free Software Foundation, Inc.
-59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-
-[This is the first released version of the Lesser GPL. It also counts
-as the successor of the GNU Library Public License, version 2, hence
-the version number 2.1.]
-
-Preamble
-
-The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-Licenses are intended to guarantee your freedom to share and change
-free software--to make sure the software is free for all its users.
-
-This license, the Lesser General Public License, applies to some
-specially designated software packages--typically libraries--of the
-Free Software Foundation and other authors who decide to use it. You
-can use it too, but we suggest you first think carefully about whether
-this license or the ordinary General Public License is the better
-strategy to use in any particular case, based on the explanations below.
-
-When we speak of free software, we are referring to freedom of use,
-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 and use pieces of
-it in new free programs; and that you are informed that you can do
-these things.
-
-To protect your rights, we need to make restrictions that forbid
-distributors to deny you these rights or to ask you to surrender these
-rights. These restrictions translate to certain responsibilities for
-you if you distribute copies of the library or if you modify it.
-
-For example, if you distribute copies of the library, whether gratis
-or for a fee, you must give the recipients all the rights that we gave
-you. You must make sure that they, too, receive or can get the source
-code. If you link other code with the library, you must provide
-complete object files to the recipients, so that they can relink them
-with the library after making changes to the library and recompiling
-it. And you must show them these terms so they know their rights.
-
-We protect your rights with a two-step method: (1) we copyright the
-library, and (2) we offer you this license, which gives you legal
-permission to copy, distribute and/or modify the library.
-
-To protect each distributor, we want to make it very clear that
-there is no warranty for the free library. Also, if the library is
-modified by someone else and passed on, the recipients should know
-that what they have is not the original version, so that the original
-author's reputation will not be affected by problems that might be
-introduced by others.
-
-Finally, software patents pose a constant threat to the existence of
-any free program. We wish to make sure that a company cannot
-effectively restrict the users of a free program by obtaining a
-restrictive license from a patent holder. Therefore, we insist that
-any patent license obtained for a version of the library must be
-consistent with the full freedom of use specified in this license.
-
-Most GNU software, including some libraries, is covered by the
-ordinary GNU General Public License. This license, the GNU Lesser
-General Public License, applies to certain designated libraries, and
-is quite different from the ordinary General Public License. We use
-this license for certain libraries in order to permit linking those
-libraries into non-free programs.
-
-When a program is linked with a library, whether statically or using
-a shared library, the combination of the two is legally speaking a
-combined work, a derivative of the original library. The ordinary
-General Public License therefore permits such linking only if the
-entire combination fits its criteria of freedom. The Lesser General
-Public License permits more lax criteria for linking other code with
-the library.
-
-We call this license the "Lesser" General Public License because it
-does Less to protect the user's freedom than the ordinary General
-Public License. It also provides other free software developers Less
-of an advantage over competing non-free programs. These disadvantages
-are the reason we use the ordinary General Public License for many
-libraries. However, the Lesser license provides advantages in certain
-special circumstances.
-
-For example, on rare occasions, there may be a special need to
-encourage the widest possible use of a certain library, so that it becomes
-a de-facto standard. To achieve this, non-free programs must be
-allowed to use the library. A more frequent case is that a free
-library does the same job as widely used non-free libraries. In this
-case, there is little to gain by limiting the free library to free
-software only, so we use the Lesser General Public License.
-
-In other cases, permission to use a particular library in non-free
-programs enables a greater number of people to use a large body of
-free software. For example, permission to use the GNU C Library in
-non-free programs enables many more people to use the whole GNU
-operating system, as well as its variant, the GNU/Linux operating
-system.
-
-Although the Lesser General Public License is Less protective of the
-users' freedom, it does ensure that the user of a program that is
-linked with the Library has the freedom and the wherewithal to run
-that program using a modified version of the Library.
-
-The precise terms and conditions for copying, distribution and
-modification follow. Pay close attention to the difference between a
-"work based on the library" and a "work that uses the library". The
-former contains code derived from the library, whereas the latter must
-be combined with the library in order to run.
-
-GNU LESSER GENERAL PUBLIC LICENSE
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-0. This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or
-other authorized party saying it may be distributed under the terms of
-this Lesser General Public License (also called "this License").
-Each licensee is addressed as "you".
-
-A "library" means a collection of software functions and/or data
-prepared so as to be conveniently linked with application programs
-(which use some of those functions and data) to form executables.
-
-The "Library", below, refers to any such software library or work
-which has been distributed under these terms. A "work based on the
-Library" means either the Library or any derivative work under
-copyright law: that is to say, a work containing the Library or a
-portion of it, either verbatim or with modifications and/or translated
-straightforwardly into another language. (Hereinafter, translation is
-included without limitation in the term "modification".)
-
-"Source code" for a work means the preferred form of the work for
-making modifications to it. For a library, 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 library.
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running a program using the Library is not restricted, and output from
-such a program is covered only if its contents constitute a work based
-on the Library (independent of the use of the Library in a tool for
-writing it). Whether that is true depends on what the Library does
-and what the program that uses the Library does.
-
-1. You may copy and distribute verbatim copies of the Library's
-complete 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 distribute a copy of this License along with the
-Library.
-
-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 Library or any portion
-of it, thus forming a work based on the Library, 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) The modified work must itself be a software library.
-
-b) You must cause the files modified to carry prominent notices
-stating that you changed the files and the date of any change.
-
-c) You must cause the whole of the work to be licensed at no
-charge to all third parties under the terms of this License.
-
-d) If a facility in the modified Library refers to a function or a
-table of data to be supplied by an application program that uses
-the facility, other than as an argument passed when the facility
-is invoked, then you must make a good faith effort to ensure that,
-in the event an application does not supply such function or
-table, the facility still operates, and performs whatever part of
-its purpose remains meaningful.
-
-(For example, a function in a library to compute square roots has
-a purpose that is entirely well-defined independent of the
-application. Therefore, Subsection 2d requires that any
-application-supplied function or table used by this function must
-be optional: if the application does not supply it, the square
-root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Library,
-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 Library, 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 Library.
-
-In addition, mere aggregation of another work not based on the Library
-with the Library (or with a work based on the Library) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-3. You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library. To do
-this, you must alter all the notices that refer to this License, so
-that they refer to the ordinary GNU General Public License, version 2,
-instead of to this License. (If a newer version than version 2 of the
-ordinary GNU General Public License has appeared, then you can specify
-that version instead if you wish.) Do not make any other change in
-these notices.
-
-Once this change is made in a given copy, it is irreversible for
-that copy, so the ordinary GNU General Public License applies to all
-subsequent copies and derivative works made from that copy.
-
-This option is useful when you wish to copy part of the code of
-the Library into a program that is not a library.
-
-4. You may copy and distribute the Library (or a portion or
-derivative of it, under Section 2) in object code or executable form
-under the terms of Sections 1 and 2 above provided that you 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.
-
-If distribution of 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 satisfies the requirement to
-distribute the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-5. A program that contains no derivative of any portion of the
-Library, but is designed to work with the Library by being compiled or
-linked with it, is called a "work that uses the Library". Such a
-work, in isolation, is not a derivative work of the Library, and
-therefore falls outside the scope of this License.
-
-However, linking a "work that uses the Library" with the Library
-creates an executable that is a derivative of the Library (because it
-contains portions of the Library), rather than a "work that uses the
-library". The executable is therefore covered by this License.
-Section 6 states terms for distribution of such executables.
-
-When a "work that uses the Library" uses material from a header file
-that is part of the Library, the object code for the work may be a
-derivative work of the Library even though the source code is not.
-Whether this is true is especially significant if the work can be
-linked without the Library, or if the work is itself a library. The
-threshold for this to be true is not precisely defined by law.
-
-If such an object file uses only numerical parameters, data
-structure layouts and accessors, and small macros and small inline
-functions (ten lines or less in length), then the use of the object
-file is unrestricted, regardless of whether it is legally a derivative
-work. (Executables containing this object code plus portions of the
-Library will still fall under Section 6.)
-
-Otherwise, if the work is a derivative of the Library, you may
-distribute the object code for the work under the terms of Section 6.
-Any executables containing that work also fall under Section 6,
-whether or not they are linked directly with the Library itself.
-
-6. As an exception to the Sections above, you may also combine or
-link a "work that uses the Library" with the Library to produce a
-work containing portions of the Library, and distribute that work
-under terms of your choice, provided that the terms permit
-modification of the work for the customer's own use and reverse
-engineering for debugging such modifications.
-
-You must give prominent notice with each copy of the work that the
-Library is used in it and that the Library and its use are covered by
-this License. You must supply a copy of this License. If the work
-during execution displays copyright notices, you must include the
-copyright notice for the Library among them, as well as a reference
-directing the user to the copy of this License. Also, you must do one
-of these things:
-
-a) Accompany the work with the complete corresponding
-machine-readable source code for the Library including whatever
-changes were used in the work (which must be distributed under
-Sections 1 and 2 above); and, if the work is an executable linked
-with the Library, with the complete machine-readable "work that
-uses the Library", as object code and/or source code, so that the
-user can modify the Library and then relink to produce a modified
-executable containing the modified Library. (It is understood
-that the user who changes the contents of definitions files in the
-Library will not necessarily be able to recompile the application
-to use the modified definitions.)
-
-b) Use a suitable shared library mechanism for linking with the
-Library. A suitable mechanism is one that (1) uses at run time a
-copy of the library already present on the user's computer system,
-rather than copying library functions into the executable, and (2)
-will operate properly with a modified version of the library, if
-the user installs one, as long as the modified version is
-interface-compatible with the version that the work was made with.
-
-c) Accompany the work with a written offer, valid for at
-least three years, to give the same user the materials
-specified in Subsection 6a, above, for a charge no more
-than the cost of performing this distribution.
-
-d) If distribution of the work is made by offering access to copy
-from a designated place, offer equivalent access to copy the above
-specified materials from the same place.
-
-e) Verify that the user has already received a copy of these
-materials or that you have already sent this user a copy.
-
-For an executable, the required form of the "work that uses the
-Library" must include any data and utility programs needed for
-reproducing the executable from it. However, as a special exception,
-the materials to be 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.
-
-It may happen that this requirement contradicts the license
-restrictions of other proprietary libraries that do not normally
-accompany the operating system. Such a contradiction means you cannot
-use both them and the Library together in an executable that you
-distribute.
-
-7. You may place library facilities that are a work based on the
-Library side-by-side in a single library together with other library
-facilities not covered by this License, and distribute such a combined
-library, provided that the separate distribution of the work based on
-the Library and of the other library facilities is otherwise
-permitted, and provided that you do these two things:
-
-a) Accompany the combined library with a copy of the same work
-based on the Library, uncombined with any other library
-facilities. This must be distributed under the terms of the
-Sections above.
-
-b) Give prominent notice with the combined library of the fact
-that part of it is a work based on the Library, and explaining
-where to find the accompanying uncombined form of the same work.
-
-8. You may not copy, modify, sublicense, link with, or distribute
-the Library except as expressly provided under this License. Any
-attempt otherwise to copy, modify, sublicense, link with, or
-distribute the Library 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.
-
-9. 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 Library or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Library (or any work based on the
-Library), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Library or works based on it.
-
-10. Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the
-original licensor to copy, distribute, link with or modify the Library
-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 with
-this License.
-
-11. 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 Library at all. For example, if a patent
-license would not permit royalty-free redistribution of the Library 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 Library.
-
-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.
-
-12. If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library 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.
-
-13. The Free Software Foundation may publish revised and/or new
-versions of the Lesser 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 Library
-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 Library does not specify a
-license version number, you may choose any version ever published by
-the Free Software Foundation.
-
-14. If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these,
-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
-
-15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE LIBRARY "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
-LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-16. 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 LIBRARY 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
-LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-END OF TERMS AND CONDITIONS
-

LICENCE.txt

@@ -1,56 +0,0 @@
-Preamble to the Gnu Lesser General Public License 
-
-Copyright (c) 2000 Franz Incorporated, Berkeley, CA 94704
-
-The concept of the GNU Lesser General Public License version 2.1 ("LGPL") has
-been adopted to govern the use and distribution of above-mentioned
-application. However, the LGPL uses terminology that is more appropriate for a
-program written in C than one written in Lisp. Nevertheless, the LGPL can still
-be applied to a Lisp program if certain clarifications are made. This document
-details those clarifications. Accordingly, the license for the open-source Lisp
-applications consists of this document plus the LGPL. Wherever there is a
-conflict between this document and the LGPL, this document takes precedence over
-the LGPL.
-
-A "Library" in Lisp is a collection of Lisp functions, data and foreign
-modules. The form of the Library can be Lisp source code (for processing by an
-interpreter) or object code (usually the result of compilation of source code or
-built with some other mechanisms). Foreign modules are object code in a form
-that can be linked into a Lisp executable. When we speak of functions we do so
-in the most general way to include, in addition, methods and unnamed
-functions. Lisp "data" is also a general term that includes the data structures
-resulting from defining Lisp classes. A Lisp application may include the same
-set of Lisp objects as does a Library, but this does not mean that the
-application is necessarily a "work based on the Library" it contains.
-
-The Library consists of everything in the distribution file set before any
-modifications are made to the files. If any of the functions or classes in the
-Library are redefined in other files, then those redefinitions ARE considered a
-work based on the Library. If additional methods are added to generic functions
-in the Library, those additional methods are NOT considered a work based on the
-Library. If Library classes are subclassed, these subclasses are NOT considered
-a work based on the Library. If the Library is modified to explicitly call other
-functions that are neither part of Lisp itself nor an available add-on module to
-Lisp, then the functions called by the modified Library ARE considered a work
-based on the Library. The goal is to ensure that the Library will compile and
-run without getting undefined function errors.
-
-It is permitted to add proprietary source code to the Library, but it must be
-done in a way such that the Library will still run without that proprietary code
-present. Section 5 of the LGPL distinguishes between the case of a library being
-dynamically linked at runtime and one being statically linked at build
-time. Section 5 of the LGPL states that the former results in an executable that
-is a "work that uses the Library." Section 5 of the LGPL states that the latter
-results in one that is a "derivative of the Library", which is therefore covered
-by the LGPL. Since Lisp only offers one choice, which is to link the Library
-into an executable at build time, we declare that, for the purpose applying the
-LGPL to the Library, an executable that results from linking a "work that uses
-the Library" with the Library is considered a "work that uses the Library" and
-is therefore NOT covered by the LGPL.
-
-Because of this declaration, section 6 of LGPL is not applicable to the
-Library. However, in connection with each distribution of this executable, you
-must also deliver, in accordance with the terms and conditions of the LGPL, the
-source code of Library (or your derivative thereof) that is incorporated into
-this executable.
-

LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  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
+them 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 prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  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.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey 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;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If 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 convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU 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 that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  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.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+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.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,21 +1,26 @@
 # Open Sound Control
 
-This is a common lisp implementation of the Open Sound Control Protocol aka OSC. The code should be close to the ansi standard, and does not rely on any external code/ffi/etc+ to do the basic encoding and decoding of packets. since OSC does not specify a transport layer, messages can be send using TCP or UDP (or carrier pigeons), however it seems UDP is more common amongst the programmes that communicate using the OSC protocol. the osc-examples.lisp file contains a few simple examples of how to send and recieve OSC via UDP, and so far seems reasonably compatible with the packets send from/to max-msp, pd, supercollider and liblo. more details about OSC can be found at http://www.cnmat.berkeley.edu/OpenSoundControl/
+This is a common lisp implementation of the Open Sound Control Protocol aka OSC. The code should be close to the ansi standard, and does not rely on any external code/ffi/etc+ to do the basic encoding and decoding of packets. since OSC does not specify a transport layer, messages can be send using TCP or UDP (or carrier pigeons), however it seems UDP is more common amongst the programmes that communicate using the OSC protocol. the osc-examples.lisp file contains a few simple examples of how to send and recieve OSC via UDP, and so far seems reasonably compatible with the packets send from/to max-msp, pd, supercollider and liblo. more details about OSC can be found at https://opensoundcontrol.org/
+
+
+## installation & usage
 
 the current version of this code is avilable from github
 
-    git clone https://github.com/zzkt/osc 
+`git clone https://github.com/zzkt/osc`
 
 or via quicklisp.. .
 
-    (ql:quickload "osc")
+`(ql:quickload "osc")`
+
+There are some basic examples in `osc-examples.lisp` and the `devices/examples/osc-device-examples.lisp` file shows how to use a higher-level API for sending and receiving OSC messages.
 
 ## limitations
 
-  - doesn't send nested bundles or syncronisable timetags
+  - will raise an exception if input is malformed
-  - will raise an exception if the input is malformed
+  - no pattern matching on addresses
-  - doesn't do any pattern matching on addresses
   - float en/decoding only tested on sbcl, cmucl, openmcl and allegro
+  - the `devices` module only works on sbcl
   - only supports the type(tag)s specified in the OSC spec
 
 ## things to do in :osc
@@ -24,54 +29,8 @@ or via quicklisp.. .
   - data checking and error handling
   - portable en/decoding of floats -=> ieee754 tests
   - doubles and other defacto typetags
-  - correct en/decoding of timetags
 
 ## things to do in :osc-ex[tensions|tras]
 
-  - liblo like network wrapping 
+  - liblo like network wrapping (and devices)
-  - add namespace exploration using cl-zeroconf
+  - add namespace exploration using cl-zeroconf (or similar)
-
-# changes
-  - 2019-04-02
-     - encoder/decoder refactoring from Javier Olaechea @PuercoPop
-  - 2017-12-10
-     - osc-examples use usocket for portability from @boqs
-  - 2015-08-25
-     - support for 64bit ints from Erik Ronström https://github.com/erikronstrom
-  - 2011-04-19
-     - converted repo from darcs->git
-  - 2007-02-20
-     - version 0.5
-     - Allegro CL float en/decoding from vincent akkermans <vincent.akkermans@gmail.com> 
-  - 2006-02-11
-     - version 0.4
-     - partial timetag implemetation 
-  - 2005-12-05
-     - version 0.3
-     - fixed openmcl float bug (decode-uint32)
-  - 2005-11-29 
-     - version 0.2
-     - openmcl float en/decoding
-  - 2005-08-12
-     - corrections from Matthew Kennedy <mkennedy@gentoo.org>
-  - 2005-08-11
-     - version 0.1
-  - 2005-03-16
-     - packaged as an asdf installable lump
-  - 2005-03-11
-     - bundle and blob en/de- coding
-  - 2005-03-05
-     - 'declare' scattering and other optimisations
-  - 2005-02-08  
-     - in-package'd
-     - basic dispatcher
-  - 2005-03-01
-     - fixed address string bug
-  - 2005-01-26 
-     - fixed string handling bug
-  - 2005-01-24 
-     - sends and receives multiple arguments
-     - tests in osc-tests.lisp
-  - 2004-12-18 
-     - initial version, single args only
-

devices/client.lisp

@@ -0,0 +1,87 @@
+(cl:in-package #:osc)
+
+(defun make-osc-client (&key (protocol :udp) debug-mode
+                        (buffer-size *default-osc-buffer-size*)
+                        address-tree cleanup-fun)
+  (ecase protocol
+    (:udp (make-instance 'osc-client-udp
+                         :debug-mode debug-mode
+                         :socket-buffer (make-socket-buffer
+                                         buffer-size)
+                         :address-tree (if address-tree
+                                           address-tree
+                                           (make-osc-tree))
+                         :cleanup-fun cleanup-fun))
+    (:tcp (make-instance 'osc-client-tcp
+                         :debug-mode debug-mode
+                         :socket-buffer (make-socket-buffer
+                                         buffer-size)
+                         :address-tree (if address-tree
+                                           address-tree
+                                           (make-osc-tree))
+                         :cleanup-fun cleanup-fun))))
+
+(defmethod initialize-instance :after ((client osc-client-udp) &key)
+  (make-client-responders client))
+
+(defgeneric make-client-responders (server))
+
+(defmethod make-client-responders ((client osc-client-udp))
+  (add-osc-responder client "/cl-osc/server/registered"
+      (cmd args device address port timetag bundle)
+    (format t "Registered with server at ~A~%"
+            (make-addr+port-string address port)))
+  (add-osc-responder client "/cl-osc/server/quit"
+      (cmd args device address port timetag bundle)
+    (format t "Server ~A has quit~%"
+            (make-addr+port-string address port))))
+
+(defgeneric register (client)
+  (:method ((client osc-client-udp))
+    (send-msg client "/cl-osc/register" (port client))))
+
+(defmethod osc-device-cleanup ((device osc-client-udp))
+  (send-msg device "/cl-osc/quit")
+  (call-next-method))
+
+(defun make-osc-client-endpoint-tcp (socket debug-mode buffer-size
+                                     address-tree clients &optional
+                                     cleanup-fun)
+  (socket-make-stream socket
+                      :input nil :output t
+                      :element-type '(unsigned-byte 8)
+                      :buffering :full)
+  (let ((client (make-instance 'osc-client-endpoint-tcp
+                               :debug-mode debug-mode
+                               :address-tree address-tree
+                               :socket-buffer (make-socket-buffer
+                                               buffer-size)
+                               :clients clients
+                               :cleanup-fun cleanup-fun)))
+    (set-socket socket client)
+    (set-listening-thread (make-listening-thread client) client)
+    client))
+
+(defmethod make-listening-thread ((receiver osc-client-tcp))
+  "Creates a listening thread for tcp clients."
+  (sb-thread:make-thread
+   (lambda ()
+     (unwind-protect
+          (loop
+             do (multiple-value-bind (buffer length address port)
+                    (socket-receive (socket receiver)
+                                    (socket-buffer receiver) nil)
+                  (when (eq length 0)   ; Closed by remote
+                    (sb-thread:terminate-thread
+                     sb-thread:*current-thread*))
+                  (multiple-value-bind (data timetag)
+                      (decode-bundle buffer :end length)
+                    (when (debug-mode receiver)
+                      (print-osc-debug-msg receiver data length
+                                           (peer-address receiver)
+                                           (peer-port receiver) timetag))
+                    (dispatch (address-tree receiver) data receiver
+                              address port))))
+       (osc-device-cleanup receiver)))
+   :name (format nil "osc-client-tcp-connection: ~A~%"
+                 (name receiver))))

devices/device.lisp

@@ -0,0 +1,129 @@
+(cl:in-package #:osc)
+
+;;;=====================================================================
+;;; OSC device base class
+;;;=====================================================================
+
+(defclass osc-device ()
+  ((socket
+    :reader socket
+    :writer set-socket
+    :initform nil)
+   (debug-mode
+    :reader debug-mode
+    :writer set-debug-mode
+    :initarg :debug-mode)
+   (cleanup-fun
+    :reader cleanup-fun
+    :initarg :cleanup-fun
+    :initform nil)))
+
+;;;=====================================================================
+;;; OSC device mixin classes
+;;;=====================================================================
+
+(defclass udp-device (osc-device) ())
+
+(defclass tcp-device (osc-device) ())
+
+(defclass listening-device (osc-device)
+  ((listening-thread
+    :reader listening-thread
+    :writer set-listening-thread
+    :initform nil)))
+
+(defclass receiving-device (listening-device)
+  ((socket-buffer
+    :reader socket-buffer
+    :initarg :socket-buffer)))
+
+(defclass dispatching-device (listening-device)
+  ((address-tree
+    :reader address-tree
+    :initarg :address-tree
+    :initform (make-osc-tree))))
+
+(defclass dispatching-device-udp (dispatching-device receiving-device
+                                                     udp-device) ())
+
+
+;;;=====================================================================
+;;; OSC device abstract classes
+;;;=====================================================================
+
+(defclass osc-transmitter (osc-device) ())
+
+(defclass osc-client (dispatching-device receiving-device
+                                         osc-transmitter) ())
+
+(defclass osc-server (dispatching-device osc-transmitter)
+  ((buffer-size
+    :reader buffer-size
+    :initarg :buffer-size)
+   (clients
+    :reader clients
+    :initarg :clients
+    :initform (make-clients-hash))))
+
+(defclass osc-client-endpoint (osc-client)
+  ((clients
+    :reader clients
+    :initarg :clients)))
+
+
+;;;=====================================================================
+;;; OSC device concrete classes
+;;;=====================================================================
+
+(defclass osc-transmitter-udp (osc-transmitter udp-device) ())
+
+(defclass osc-client-udp (osc-client dispatching-device-udp) ())
+
+(defclass osc-client-tcp (osc-client tcp-device) ())
+
+(defclass osc-server-udp (osc-server dispatching-device-udp
+                                     osc-transmitter-udp) ())
+
+(defclass osc-server-tcp (osc-server osc-transmitter tcp-device) ())
+
+(defclass osc-client-endpoint-tcp (osc-client-endpoint
+                                   osc-client-tcp) ())
+
+
+;;;=====================================================================
+;;; Device generic functions
+;;;=====================================================================
+
+(defgeneric protocol (osc-device)
+  (:method ((osc-device udp-device))
+    :udp)
+  (:method ((osc-device tcp-device))
+    :tcp))
+
+(defgeneric name (osc-device)
+  (:method ((osc-device osc-device))
+    (concatenate 'string
+                 (symbol-name (class-name (class-of osc-device)))
+                 "-"
+                 (make-name-string osc-device))))
+
+(defmethod buffer-size ((osc-device dispatching-device))
+  (length (socket-buffer osc-device)))
+
+(defgeneric quit (osc-device))
+
+(defgeneric osc-device-cleanup (device)
+  (:method :before ((osc-device osc-device))
+           (when (cleanup-fun osc-device)
+             (funcall (cleanup-fun osc-device) osc-device)))
+  (:method ((osc-device osc-device))
+    (when (debug-mode osc-device)
+      (format t "~%OSC device stopped: ~A~%"
+              (name osc-device)))
+    (when (socket osc-device)
+      (handler-case
+          (socket-close (socket osc-device) :abort t)
+        (sb-int:simple-stream-error ()
+          (when (debug-mode osc-device)
+            (warn "Device ~A gone away." (name osc-device)))))
+      (set-socket nil osc-device))))

devices/dispatching-device.lisp

@@ -0,0 +1,39 @@
+(cl:in-package #:osc)
+
+(defmethod make-listening-thread ((receiver dispatching-device-udp))
+  "Creates a listening thread for udp devices (client and server)."
+  (sb-thread:make-thread
+   (lambda ()
+     (unwind-protect
+          (loop
+             do (multiple-value-bind (buffer length address port)
+                    (socket-receive (socket receiver)
+                                    (socket-buffer receiver) nil)
+                  (multiple-value-bind (data timetag)
+                      (osc:decode-bundle buffer :end length)
+                    (when (debug-mode receiver)
+                      (print-osc-debug-msg receiver data length
+                                           address port timetag))
+                    (dispatch (address-tree receiver) data receiver
+                              address port))))
+       (osc-device-cleanup receiver)))
+   :name (format nil "osc-receiver-udp: ~A~%" (name receiver))))
+
+
+;;;=====================================================================
+;;; OSC Responders
+;;;=====================================================================
+
+(defmacro add-osc-responder (dispatcher cmd-name
+                             (cmd args device address port timetag bundle)
+                             &body body)
+  `(dp-register (address-tree ,dispatcher) ,cmd-name
+                (lambda (,cmd ,args ,device ,address ,port ,timetag
+                         ,bundle)
+                  (declare (ignorable ,cmd ,args ,device ,address
+                                      ,port ,timetag ,bundle))
+                  ,@body)))
+
+(defgeneric remove-osc-responder (dispatcher address)
+  (:method ((dispatcher dispatching-device) address)
+    (dp-remove (address-tree dispatcher) address)))

devices/examples/osc-device-examples.lisp

@@ -0,0 +1,294 @@
+(cl:in-package #:osc)
+
+(ql:quickload "osc")
+
+;;;=====================================================================
+;;; OSC UDP transmitter -> server
+;;;=====================================================================
+
+(defparameter *osc-server* (make-osc-server :protocol :udp
+                                            :debug-mode t))
+
+(boot *osc-server* 57127)
+
+(defparameter *osc-transmitter* (make-osc-transmitter
+                                 :debug-mode t))
+
+(connect *osc-transmitter* 57127 :host-name "localhost")
+(device-active-p *osc-transmitter*)
+(device-socket-name *osc-transmitter*)
+(address *osc-transmitter*)
+(port *osc-transmitter*)
+(device-socket-peername *osc-transmitter*)
+(peer-address *osc-transmitter*)
+(peer-port *osc-transmitter*)
+
+(send-msg *osc-transmitter* "/bar" 1 2 9)
+
+(send-bundle *osc-transmitter*
+             :time ; current real time
+             "/foo" 1 2 3)
+
+(send-bundle *osc-transmitter*
+             :now ; immediately
+             "/foo" 1 2 3)
+
+(send-bundle *osc-transmitter*
+             (unix-time->timetag 1234567890.1234567d0)
+             "/foo" 1 2 3)
+
+;; The lower-level send function can be used to send message and
+;; bundle objects directly. This allows more complex (nested) bundles
+;; to be created.
+
+(send *osc-transmitter* (message "/foo" 1 2 3))
+
+(send *osc-transmitter* (bundle :now
+                                (message "/foo" 1 2 3)))
+
+(let ((bundle
+       (bundle :now
+               (message "/foo" '(1 2 3))
+               (bundle :now
+                       (bundle :now
+                               (message "/bar"
+                                        '(10 20 30)))))))
+  (send *osc-transmitter* bundle))
+
+(quit *osc-transmitter*)
+(quit *osc-server*)
+
+
+;;;=====================================================================
+;;; OSC UDP client <-> server
+;;;=====================================================================
+
+(defparameter *osc-server* (make-osc-server :protocol :udp
+                                            :debug-mode t))
+
+(boot *osc-server* 57127)
+
+(defparameter *osc-client* (make-osc-client
+                            :protocol :udp
+                            :debug-mode t))
+
+(connect *osc-client* 57127 :host-name "localhost")
+
+;; A UDP server can't know about a client unless it registers.
+(print-clients *osc-server*)
+(register *osc-client*)
+(print-clients *osc-server*)
+(quit *osc-client*)                     ; quit notifies the server
+(print-clients *osc-server*)
+
+(connect *osc-client* 57127 :host-name "localhost")
+
+(send-msg *osc-client* "/foo" 2 99)
+
+(send-bundle *osc-client*
+             (unix-time->timetag 1234567890.1234567d0)
+             "/foo" 1 2 3)
+
+(send-bundle *osc-client* :now "/foo" 1)
+
+(send-bundle *osc-client* :time "/foo" 1)
+
+;; Using the server as a transmitter.
+(send-msg-to *osc-server*
+             (address *osc-client*) (port *osc-client*)
+             "/bar" 1 2 3)
+
+(send-bundle-to *osc-server*
+                (address *osc-client*) (port *osc-client*)
+                :now "/bar" 1 2 3)
+
+;; If a client is registered...
+(send-msg-to-client *osc-server* (make-name-string *osc-client*)
+                    "/bar" 2 99)
+
+(register *osc-client*)
+
+(send-msg-to-client *osc-server* (make-name-string *osc-client*)
+                    "/bar" 2 99)
+
+(send-bundle-to-client *osc-server*
+                       (make-name-string *osc-client*)
+                       :time "/bar" 2 99)
+
+(add-osc-responder *osc-server* "/echo-sum"
+    (cmd args dev addr port timetag bundle)
+  (send-msg-to dev addr port
+           "/echo-answer" (apply #'+ args)))
+
+(add-osc-responder *osc-client* "/echo-answer"
+    (cmd args dev addr port timetag bundle)
+  (format t "Sum is ~a~%" (car args)))
+
+(send-msg *osc-client* "/echo-sum" 1 2 3 4)
+
+(add-osc-responder *osc-server* "/timetag+1"
+    (cmd args dev addr port timetag bundle)
+  (send-bundle-to dev addr port (timetag+ timetag 1) "/the-future"))
+
+(send-bundle *osc-client* (get-current-timetag)
+             "/timetag+1")
+
+;; Send a messages to all registered clients.
+(send-msg-all *osc-server* "/foo" 1 2 3)
+
+(send-bundle-all *osc-server* :now "/foo" 1 2 3)
+
+(defparameter *osc-client2* (make-osc-client
+                             :protocol :udp
+                             :debug-mode t))
+
+(connect *osc-client2* 57127)
+(register *osc-client2*)
+
+(add-osc-responder *osc-server* "/echo-sum"
+    (cmd args dev addr port timetag bundle)
+  (send-msg-all dev "/echo-answer" (apply #'+ args)))
+
+(send-msg *osc-client* "/echo-sum" 1 2 3 4)
+
+(quit *osc-client*)
+(quit *osc-client2*)
+(quit *osc-server*)
+
+
+;;;=====================================================================
+;;; OSC TCP client <-> server
+;;;=====================================================================
+
+(defparameter *osc-server* (make-osc-server :protocol :tcp
+                                            :debug-mode t))
+
+(boot *osc-server* 57127)
+
+(defparameter *osc-client* (make-osc-client
+                            :protocol :tcp
+                            :debug-mode t))
+
+(connect *osc-client* 57127 :host-name "localhost")
+
+(device-active-p *osc-client*)
+(device-socket-name *osc-client*)
+(device-socket-peername *osc-client*)
+
+(send-msg *osc-client* "/foo" 1 2 3)
+
+(send-msg-to-client *osc-server* (make-name-string
+                                  *osc-client*)
+                    "/foo" 1 2 3)
+
+(defparameter *osc-client2* (make-osc-client
+                             :protocol :tcp
+                             :debug-mode t))
+
+(connect *osc-client2* 57127
+         :host-address "127.0.0.1"
+         :port 57666) ; choose local port
+
+(device-socket-name *osc-client2*)
+
+(send-msg *osc-client2* "/bar" 4 5 6 9)
+
+(print-clients *osc-server*)
+
+(add-osc-responder *osc-server* "/print-sum"
+    (cmd args dev addr port timetag bundle)
+  (format t "Sum = ~A~%" (apply #'+ args)))
+
+(send-msg *osc-client2* "/print-sum" 4 5 6 9)
+
+(add-osc-responder *osc-server* "/echo-sum"
+    (cmd args dev addr port timetag bundle)
+  (send-msg dev cmd (apply #'+ args)))
+
+(send-msg *osc-client2* "/echo-sum" 4 5 6 9)
+
+(send-msg-all *osc-server* "/bar" 1 2 3) ; send to all peers
+
+(add-osc-responder *osc-server* "/echo-sum-all"
+    (cmd args dev addr port timetag bundle)
+  (send-msg-all dev cmd (apply #'+ args)))
+
+; Send to all peers (including self).
+(send-msg *osc-client2* "/echo-sum-all" 1 2 3)
+
+(quit *osc-client*)
+(quit *osc-client2*)
+(quit *osc-server*)
+
+
+;;;=====================================================================
+;;; OSC UDP client <-> sclang
+;;;=====================================================================
+
+(defparameter *osc-client* (make-osc-client
+                            :protocol :udp
+                            :debug-mode t))
+
+(connect *osc-client* 57120 :host-name "localhost" :port 57127)
+(address *osc-client*)
+(port *osc-client*)
+(peer-address *osc-client*)
+(peer-port *osc-client*)
+
+;;---------------------------------------------------------------------
+;; run in sc
+c=OSCresponder(nil,
+               '/foo',
+               {|t,r,msg,addr| [t,r,msg,addr].postln}).add
+;;---------------------------------------------------------------------
+
+(send-msg *osc-client* "/foo" 1 2 3)
+
+(send-bundle *osc-client*
+             (get-current-timetag)
+             "/foo" 3)
+
+(add-osc-responder *osc-client* "/echo-sum"
+    (cmd args dev addr port timetag bundle)
+  (send-msg dev cmd (apply #'+ args)))
+
+;;---------------------------------------------------------------------
+;; Send /echo-sum from sc, and lisp returns the sum.
+n=NetAddr("localhost", 57127)
+
+e=OSCresponder(nil,
+               '/echo-sum',
+               {|t,r,msg,addr|
+                   [t,r,msg,addr].postln;
+               }).add
+
+n.sendMsg('/echo-sum', 1, 2, 3) // send numbers, lisp returns sum.
+;;---------------------------------------------------------------------
+
+(quit *osc-client*)
+
+
+;;;=====================================================================
+;;; OSC UDP client <-> scsynth
+;;;=====================================================================
+
+(defparameter *osc-client* (make-osc-client
+                            :protocol :udp
+                            :debug-mode t))
+
+(connect *osc-client* 57110 :host-name "localhost" :port 57127)
+
+(send-msg *osc-client* "/s_new" "default" 1001 0 0 "freq" 500)
+
+(send-msg *osc-client* "/n_free" 1001)
+
+(send-bundle *osc-client*
+             (timetag+ (get-current-timetag) 2) ; 2 secs later
+             "/s_new" "default" 1001 0 0 "freq" 500)
+
+(send-msg *osc-client* "/n_free" 1001)
+
+(quit *osc-client*) ; Sends default /quit notification which scsynth
+                    ; ignores. Ideally osc-client should be subclassed
+                    ; to allow scsynth specific behaviour to be
+                    ; implemented.

devices/listening-device.lisp

@@ -0,0 +1,31 @@
+(cl:in-package #:osc)
+
+(defgeneric make-listening-thread (listening-device))
+
+(defmethod connect progn ((listening-device listening-device)
+                          host-port &key host-address host-name port)
+  (declare (ignore host-port host-address host-name port))
+  (set-listening-thread (make-listening-thread listening-device)
+                        listening-device))
+
+(defmethod quit ((device listening-device))
+  (sb-thread:terminate-thread (listening-thread device)))
+
+(defmethod osc-device-cleanup ((device listening-device))
+  (set-listening-thread nil device)
+  (call-next-method))
+
+(defmethod osc-device-cleanup ((device receiving-device))
+  (fill (socket-buffer device) 0)
+  (call-next-method))
+
+(defun print-osc-debug-msg (receiver data length address port
+                            timetag &optional (stream t))
+  (format stream
+          "~&~a~%bytes rx:~a~a~%from:~a~a~a ~a~%timetag:~a~a~%unix-time:~a~f~%data:~a~a"
+          (name receiver) #\Tab length #\Tab #\Tab
+          address port #\Tab timetag #\Tab
+          (when timetag (timetag->unix-time timetag))
+          #\Tab #\Tab)
+  (format-osc-data data :stream stream)
+  (format stream "~%"))

devices/server.lisp

@@ -0,0 +1,224 @@
+(cl:in-package #:osc)
+
+(defun make-osc-server (&key (protocol :udp) debug-mode
+                          (buffer-size *default-osc-buffer-size*)
+                          cleanup-fun)
+  (ecase protocol
+    (:udp (make-instance 'osc-server-udp
+                         :debug-mode debug-mode
+                         :cleanup-fun cleanup-fun
+                         :buffer-size buffer-size
+                         :socket-buffer (make-socket-buffer buffer-size)))
+    (:tcp (make-instance 'osc-server-tcp
+                         :debug-mode debug-mode
+                         :cleanup-fun cleanup-fun
+                         :buffer-size buffer-size))))
+
+(defgeneric boot (osc-server port))
+
+(defmethod boot :around ((server osc-server) port)
+  (if (device-active-p server)
+      (warn "~%Server ~A already running" (machine-instance)))
+  (set-socket (make-socket (protocol server)) server)
+  (socket-bind (socket server) #(0 0 0 0) port)
+  (call-next-method)
+  (format t "~%Server ~A listening on port ~A~%"
+          (machine-instance) port))
+
+(defmethod boot ((server osc-server-udp) port)
+  (declare (ignore port))
+  "UDP server sockets are used for receiving and unconnected sending."
+  (set-listening-thread (make-listening-thread server) server))
+
+(defmethod boot ((server osc-server-tcp) port)
+  (declare (ignore port))
+  (set-listening-thread
+   (sb-thread:make-thread
+    (lambda ()
+      (unwind-protect
+           (progn (socket-listen (socket server) 10)
+                  (loop for socket = (socket-accept (socket server))
+                     for endpoint = (make-osc-client-endpoint-tcp
+                                     socket
+                                     (debug-mode server)
+                                     (buffer-size server)
+                                     (address-tree server)
+                                     (clients server)
+                                     (make-unregister-self-fun server))
+                     do (register-tcp-client server endpoint)))
+        (osc-device-cleanup server)))
+    :name (format nil "osc-server-tcp: ~A" (name server)))
+   server)
+  server)
+
+(defmethod osc-device-cleanup ((device osc-server-udp))
+  (loop for client-name being the hash-key in (clients device)
+     using (hash-value addr+port)
+     do (notify-quit device client-name)
+     do (unregister-udp-client device
+                               (first addr+port)
+                               (second addr+port)))
+  (call-next-method))
+
+(defmethod osc-device-cleanup ((device osc-server-tcp))
+  (loop for client being the hash-value in (clients device)
+     do (quit client))
+  (call-next-method))
+
+(defun make-clients-hash ()
+  (make-hash-table :test 'equal))
+
+
+;;;=====================================================================
+;;; UDP server functions
+;;;=====================================================================
+
+(defmethod initialize-instance :after ((server osc-server-udp) &key)
+  (make-server-responders server))
+
+(defgeneric make-server-responders (server))
+
+(defmethod make-server-responders ((server osc-server-udp))
+  (add-osc-responder server "/cl-osc/register"
+      (cmd args device address port timetag bundle)
+    (let ((listening-port (car args))) ; Optional port for sending
+                                       ; return messages.
+      (register-udp-client device address
+                           (if listening-port listening-port port))))
+  (add-osc-responder server "/cl-osc/quit"
+      (cmd args device address port timetag bundle)
+    (unregister-udp-client device address port)))
+
+(defun register-udp-client (server addr port)
+  (let ((client-name (make-addr+port-string addr port)))
+    (format t "Client registered: ~A~%" client-name)
+    (setf (gethash client-name (clients server))
+          (list addr port))
+    (post-register-hook server client-name)))
+
+(defun unregister-udp-client (server addr port)
+  (let ((client-name (make-addr+port-string addr port)))
+    (format t "Client quit: ~A~%" client-name)
+    (remhash client-name (clients server))))
+
+(defgeneric post-register-hook (server client-name)
+  (:method ((server osc-server-udp) client-name)
+    (format t "Post-register hook for client: ~A~%" client-name)
+    (notify-registered server client-name)))
+
+(defun notify-registered (server client-name)
+  (send-msg-to-client server client-name "/cl-osc/server/registered"))
+
+(defun notify-quit (server client-name)
+  (send-msg-to-client server client-name "/cl-osc/server/quit"))
+
+
+;;;=====================================================================
+;;; TCP server functions
+;;;=====================================================================
+
+(defun register-tcp-client (server transmitter)
+  (setf (gethash (make-peername-string transmitter)
+		 (clients server))
+	transmitter))
+
+(defun unregister-tcp-client (server transmitter)
+  (remhash (make-peername-string transmitter)
+	   (clients server)))
+
+(defun make-unregister-self-fun (server)
+  #'(lambda (client)
+      (unregister-tcp-client server client)))
+
+(defun get-tcp-client (server socket-peername)
+  (gethash socket-peername (clients server)))
+
+(defgeneric print-clients (server))
+
+(defmethod print-clients ((server osc-server-udp))
+  (loop for addr+port being the hash-value in (clients server)
+     for i from 1
+     do (format t "~A. Connected to: ~A~%" i (make-addr+port-string
+                                              (first addr+port)
+                                              (second addr+port)))))
+
+(defmethod print-clients ((server osc-server-tcp))
+  (loop for endpoint being the hash-value in (clients server)
+     for i from 1
+     do (format t "~A. Connected to: ~A~%" i (make-addr+port-string
+                                              (peer-address endpoint)
+                                              (peer-port endpoint)))))
+
+;;;=====================================================================
+;;; Server sending functions
+;;;=====================================================================
+
+;; Send to a client
+
+(defgeneric send-to-client (server client-name data)
+  (:method :around ((server osc-server) client-name data)
+           (let ((client (gethash client-name (clients server))))
+             (if client
+                 (call-next-method server client data)
+                 (warn "No client called ~A~%" client-name)))))
+
+(defmethod send-to-client ((server osc-server-udp) client-name data)
+  (send-to server (first client-name) (second client-name) data))
+
+(defmethod send-to-client ((server osc-server-tcp) client data)
+  (send client data))
+
+(defgeneric send-msg-to-client (server client-name command &rest args)
+  (:method ((server osc-server) client-name command &rest args)
+    (let ((message (make-message command args)))
+      (send-to-client server client-name message))))
+
+(defgeneric send-bundle-to-client (server client-name timetag command
+                                   &rest args)
+  (:method ((server osc-server) client-name timetag command &rest
+                                                              args)
+    (let ((bundle (bundle timetag
+                          (make-message command args))))
+      (send-to-client server client-name bundle))))
+
+;; Send all
+
+(defgeneric send-all (server data))
+
+(defmethod send-all ((server osc-server-udp) data)
+  (loop for addr+port being the hash-value in (clients server)
+     do (send-to server (first addr+port) (second addr+port) data)))
+
+(defmethod send-all ((server osc-server-tcp) data)
+  (loop for endpoint being the hash-value in (clients server)
+     do (send endpoint data)))
+
+(defmethod send-all ((client-endpoint osc-client-endpoint) data)
+  (loop for endpoint being the hash-value in (clients client-endpoint)
+     ;; FIXME: Don't not reply to the sender in this case so that the
+     ;; behaviour of send-all is uniform for both UDP and TCP. But
+     ;; could be useful to have a means of broadcasting messages to
+     ;; all clients of a server except the client that generated the
+     ;; message.
+     ;;
+     ;; unless (eq endpoint client-endpoint) ; don't send to sender
+     do (send endpoint data)))
+
+(defgeneric send-msg-all (server command &rest args)
+  (:method ((server osc-server) command &rest args)
+    (let ((message (make-message command args)))
+      (send-all server message)))
+  (:method ((client-endpoint osc-client-endpoint) command &rest args)
+    (let ((message (make-message command args)))
+      (send-all client-endpoint message))))
+
+(defgeneric send-bundle-all (server timetag command &rest args)
+  (:method ((server osc-server) timetag command &rest args)
+    (let ((bundle (bundle timetag
+                          (make-message command args))))
+      (send-all server bundle)))
+  (:method ((client-endpoint osc-client-endpoint) timetag command
+            &rest args)
+    (let ((bundle (bundle timetag
+                          (make-message command args))))
+      (send-all client-endpoint bundle))))

devices/socket-functions.lisp

@@ -0,0 +1,84 @@
+(cl:in-package #:osc)
+
+(defparameter *default-osc-buffer-size* 1024)
+
+(defun make-socket-buffer (&optional (size *default-osc-buffer-size*))
+  (make-sequence '(vector (unsigned-byte 8)) size))
+
+(defun make-socket (protocol)
+  (ecase protocol
+    (:udp (make-udp-socket))
+    (:tcp (make-tcp-socket))))
+
+(defun make-tcp-socket ()
+  (make-instance 'inet-socket :type :stream :protocol :tcp))
+
+(defun make-udp-socket ()
+  (make-instance 'inet-socket :type :datagram :protocol :udp))
+
+(defun make-peername-string (osc-device)
+  (when (socket osc-device)
+    (multiple-value-bind (addr port)
+        (socket-peername (socket osc-device))
+      (make-addr+port-string addr port))))
+
+(defun make-name-string (osc-device)
+  (when (socket osc-device)
+    (multiple-value-bind (addr port)
+        (socket-name (socket osc-device))
+      (make-addr+port-string addr port))))
+
+(defun make-addr+port-string (addr port)
+  (format nil "~{~A~^.~}:~A" (coerce addr 'list) port))
+
+(defun device-active-p (osc-device)
+  (when (socket osc-device)
+    (socket-open-p (socket osc-device))))
+
+(defun device-socket-name (osc-device)
+  (socket-name (socket osc-device)))
+
+(defun port (osc-device)
+  (if (device-active-p osc-device)
+      (multiple-value-bind (addr port)
+          (device-socket-name osc-device)
+        (declare (ignore addr))
+        port)
+      (warn "Device not active.")))
+
+(defun address (osc-device)
+  (if (device-active-p osc-device)
+      (multiple-value-bind (addr port)
+          (device-socket-name osc-device)
+        (declare (ignore port))
+        addr)
+      (warn "Device not active.")))
+
+(defun device-socket-peername (osc-device)
+  (socket-peername (socket osc-device)))
+
+(defun peer-port (osc-device)
+  (if (device-active-p osc-device)
+      (handler-case
+          (multiple-value-bind (addr port)
+              (device-socket-peername osc-device)
+            (declare (ignore addr))
+            port)
+        (sb-bsd-sockets:not-connected-error ()
+          (warn "Device ~a not connected: device removed."
+                (device-socket-name osc-device))
+          (osc-device-cleanup osc-device)))
+      (warn "Device not active.")))
+
+(defun peer-address (osc-device)
+  (if (device-active-p osc-device)
+      (handler-case
+          (multiple-value-bind (addr port)
+              (device-socket-peername osc-device)
+            (declare (ignore port))
+            addr)
+        (sb-bsd-sockets:not-connected-error ()
+          (warn "Device ~a not connected: device removed."
+                (device-socket-name osc-device))
+          (osc-device-cleanup osc-device)))
+      (warn "Device not active.")))

devices/transmitter.lisp

@@ -0,0 +1,99 @@
+(cl:in-package #:osc)
+
+;; Only UDP devices can be transmitters.
+
+(defun make-osc-transmitter (&key debug-mode cleanup-fun)
+  (make-instance 'osc-transmitter-udp
+                 :debug-mode debug-mode
+                 :cleanup-fun cleanup-fun))
+
+(defgeneric connect (osc-transmitter host-port &key host-address
+                                                 host-name port)
+  (:method-combination progn :most-specific-last))
+
+(defmethod connect progn ((transmitter osc-transmitter) host-port
+                          &key (host-address nil addr)
+                            (host-name "localhost" name) port)
+  (when (and addr name)
+    (error "Supplied both :host-address and :host-name to connect"))
+  (cond (addr
+         (when (typep host-address 'string)
+           (setf host-address
+                 (sb-bsd-sockets:make-inet-address host-address))))
+        (t
+         (setf host-address
+               (sb-bsd-sockets:host-ent-address
+                (sb-bsd-sockets:get-host-by-name
+                 host-name)))))
+  (if (not (device-active-p transmitter))
+      (progn
+        (let ((socket (make-socket (protocol transmitter))))
+          (if port
+              (socket-bind socket #(127 0 0 1) port)
+              (socket-bind socket))
+          (socket-connect socket host-address host-port)
+          (socket-make-stream socket
+                              :input nil :output t
+                              :element-type '(unsigned-byte 8)
+                              :buffering :full)
+          (set-socket socket transmitter))
+        (when (debug-mode transmitter)
+          (format t "~%Device connected: ~A~%~A -> ~A~%"
+                  (name transmitter) #\Tab
+                  (make-addr+port-string (peer-address transmitter)
+                                         (peer-port transmitter)))))
+      (warn "Already connected"))
+  transmitter)
+
+(defmethod quit ((transmitter osc-transmitter-udp))
+  (if (device-active-p transmitter)
+      (osc-device-cleanup transmitter)
+      (warn "Not connected: ~A" (name transmitter))))
+
+
+;;;=====================================================================
+;;; Sending functions
+;;;=====================================================================
+
+(defmacro osc-write-to-stream (stream &body msg)
+  `(progn (write-sequence ,@msg ,stream)
+          (finish-output ,stream)))
+
+(defgeneric send (transmitter data)
+  (:method ((transmitter osc-transmitter) data)
+    (let ((bytes (encode-osc-data data)))
+      (osc-write-to-stream
+          (slot-value (socket transmitter) 'stream) bytes))))
+
+(defgeneric send-msg (transmitter command &rest args)
+  (:method ((transmitter osc-transmitter) command &rest args)
+    (let ((message (make-message command args)))
+      (send transmitter message))))
+
+(defgeneric send-bundle (transmitter timetag command &rest args)
+  (:method ((transmitter osc-transmitter) timetag command &rest args)
+    (let ((bundle (bundle timetag
+                          (make-message command args))))
+      (send transmitter bundle))))
+
+;; Unconnected sending (UDP only)
+
+(defgeneric send-to (transmitter address port data)
+  (:method ((transmitter osc-transmitter-udp) address port data)
+    (socket-send (socket transmitter)
+                 (encode-osc-data data) nil
+                 :address (list address port))))
+
+(defgeneric send-msg-to (transmitter address port command &rest args)
+  (:method ((transmitter osc-transmitter-udp) address port command
+            &rest args)
+    (let ((message (make-message command args)))
+      (send-to transmitter address port message))))
+
+(defgeneric send-bundle-to (transmitter address port timetag command
+                            &rest args)
+  (:method ((transmitter osc-transmitter-udp) address port timetag
+            command &rest args)
+    (let ((bundle (bundle timetag
+                          (make-message command args))))
+      (send-to transmitter address port bundle))))

osc-data.lisp

@@ -0,0 +1,66 @@
+(cl:in-package #:osc)
+
+;; Classes
+
+(defclass osc-data () ())
+
+(defclass message (osc-data)
+  ((command
+    :reader command
+    :initarg :command)
+   (args
+    :reader args
+    :initarg :args
+    :initform nil)))
+
+(defclass bundle (osc-data)
+  ((timetag
+    :reader timetag
+    :initarg :timetag
+    :initform :now)
+   (elements
+    :reader elements
+    :initarg :elements
+    :initform nil)))
+
+;; Constructors
+
+(defun make-message (command args)
+  (unless (listp args)
+    (setf args (list args)))
+  (make-instance 'message
+                 :command command
+                 :args args))
+
+(defun message (command &rest args)
+  (make-message command args))
+
+(defun make-bundle (timetag elements)
+  (unless (listp elements)
+    (setf elements (list elements)))
+  (make-instance 'bundle
+                 :timetag timetag
+                 :elements elements))
+
+(defun bundle (timetag &rest elements)
+  (make-bundle timetag elements))
+
+(defgeneric format-osc-data (data &key stream width))
+
+(defmethod format-osc-data ((message message) &key (stream t)
+                                                (width 80))
+  (let ((args-string (format nil "~{~a~^ ~}" (args message))))
+    (when (> (length args-string) width)
+      (setf args-string
+            (concatenate 'string
+                         (subseq args-string 0 width)
+                         "...")))
+    (format stream "~a ~a~%"
+            (command message)
+            args-string)))
+
+(defmethod format-osc-data ((bundle bundle) &key (stream t) (width 80))
+  (format stream "~&[ ~a~%" (timetag bundle))
+  (dolist (element (elements bundle))
+    (format-osc-data element :stream stream :width width))
+  (format stream "~&]~%"))

osc-dispatch.lisp

@@ -47,26 +47,41 @@
 ;;;;  ; ; ;   ;;
 
 (defun dp-register (tree address function)
-  "registers a function to respond to incoming osc message. since
+  "Registers a function to respond to incoming osc messages. Since
    only one function should be associated with an address, any
-   previous registration will be overwritten"
+   previous registration will be overwritten."
   (setf (gethash address tree)
-	function))
+        function))
 
 (defun dp-remove (tree address)
-  "removes the function associated with the given address.."
+  "Removes the function associated with the given address."
   (remhash address tree))
 
 (defun dp-match (tree pattern)
-"returns a list of functions which are registered for
+  "Returns a list of functions which are registered for dispatch for a
- dispatch for a given address pattern.."
+given address pattern."
   (list (gethash pattern tree)))
 
-(defun dispatch (tree osc-message)
+(defgeneric dispatch (tree data device address port &optional timetag
-  "calls the function(s) matching the address(pattern) in the osc 
+                                                      parent-bundle))
-   message with the data contained in the message"
+
-  (let ((pattern (car osc-message)))
+(defmethod dispatch (tree (data message) device address port &optional
+                                                               timetag
+                                                               parent-bundle)
+  "Calls the function(s) matching the address(pattern) in the osc
+message passing the message object, the recieving device, and
+optionally in the case where a message is part of a bundle, the
+timetag of the bundle and the enclosing bundle."
+  (let ((pattern (command data)))
     (dolist (x (dp-match tree pattern))
       (unless (eq x NIL)
-        (apply #'x (cdr osc-message))))))
+        (funcall x (command data) (args data) device address port
+                 timetag parent-bundle)))))
 
+(defmethod dispatch (tree (data bundle) device address port &optional
+                                                              timetag
+                                                              parent-bundle)
+  "Dispatches each bundle element in sequence."
+  (declare (ignore timetag parent-bundle))
+  (dolist (element (elements data))
+    (dispatch tree element device address port (timetag data) data)))

osc-examples.lisp

@@ -5,7 +5,7 @@
 ;; Copyright (C) 2004 FoAM vzw
 ;;
 ;; Authors
-;;  - nik gaffney <nik@f0.am>
+;;  - nik gaffney <nik@fo.am>
 ;;
 ;;;;; ;; ;     ;    ;;    ;             ;
 
@@ -14,18 +14,19 @@
 ;; Commentry
 ;;
 ;;  These examples are currently sbcl specific, but should be easily ported to
-;;  work with trivial-sockets, acl-compat or something similar. They should be
+;;  work with trivial-sockets, acl-compat or something similar.
-;;  able to explain enough to get you started. ..
+;;  They should be enough to get you started.
 ;;
-;;  eg. listen on port 6667 for incoming msgs
+;;  eg. listen on port 6667 for incoming messages
 ;;
 ;;   (osc-receive-test 6667)
-;;  eg. send a test message to localhost port 6668
+;;
+;;  send a test message to localhost port 6668
 ;;
 ;;   (osc-send-test #(127 0 0 1) 6668)
 ;;
-;;  eg. listen on port 6667 and send to 10.0.89:6668
+;;  listen on port 6667 and send to 10.0.89:6668
-;;     note the ip# is formatted as a vector
+;;                     (note the ip# is formatted as a vector)
 ;;
 ;;   (osc-reflector-test 6667 #(10 0 0 89) 6668)
 ;;
@@ -41,52 +42,53 @@
   "a basic test function which attempts to decode an osc message on given port.
   note ip#s need to be in the format #(127 0 0 1) for now.. ."
   (let ((s (socket-connect nil nil
-			   :local-port port
+                           :local-port port
-			   :local-host #(127 0 0 1)
+                           :local-host #(127 0 0 1)
-			   :protocol :datagram
+                           :protocol :datagram
-			   :element-type '(unsigned-byte 8)))
+                           :element-type '(unsigned-byte 8)))
-	(buffer (make-sequence '(vector (unsigned-byte 8)) 1024)))
+        (buffer (make-sequence '(vector (unsigned-byte 8)) 1024)))
     (format t "listening on localhost port ~A~%~%" port)
     (unwind-protect
-	 (loop do
+         (loop do
-	      (socket-receive s buffer (length buffer))
+               (socket-receive s buffer (length buffer))
-	      (format t "received -=> ~S~%" (osc:decode-bundle buffer)))
+               (format t "received -=> ~S~%" (osc:decode-bundle buffer)))
       (when s (socket-close s)))))
 
+
 (defun osc-send-test (host port)
   "a basic test function which sends osc test message to a given port/hostname.
   note ip#s need to be in the format #(127 0 0 1) for now.. ."
   (let ((s (socket-connect host port
-			   :protocol :datagram
+                           :protocol :datagram
-			   :element-type '(unsigned-byte 8)))
+                           :element-type '(unsigned-byte 8)))
-	(b (osc:encode-message "/foo/bar" "baz" 1 2 3 (coerce PI 'single-float))))
+        (b (osc:encode-message "/foo/bar" "baz" 1 2 3 (coerce PI 'single-float))))
     (format t "sending to ~a on port ~A~%~%" host port)
     (unwind-protect
-	 (socket-send s b (length b))
+         (socket-send s b (length b))
       (when s (socket-close s)))))
 
+
 (defun osc-reflector-test (listen-port send-host send-port)
-  "reflector.. . listens on a given port and sends out on another
+  "reflector. listens on a given port and sends out on another.
-  note ip#s need to be in the format #(127 0 0 1) for now.. ."
+   note ip#s need to be in the format #(127 0 0 1) for now.. ."
   (let ((in (socket-connect nil nil
-			    :local-port listen-port
+                            :local-port listen-port
-			    :local-host #(127 0 0 1)
+                            :protocol :datagram
-			    :protocol :datagram
+                            :element-type '(unsigned-byte 8)))
-			    :element-type '(unsigned-byte 8)))
+        (out (socket-connect send-host send-port
-	(out (socket-connect send-host send-port
+                             :protocol :datagram
-			     :protocol :datagram
+                             :element-type '(unsigned-byte 8)))
-			     :element-type '(unsigned-byte 8)))
+        (buffer (make-sequence '(vector (unsigned-byte 8)) 1024)))
-	(buffer (make-sequence '(vector (unsigned-byte 8)) 1024)))
     (unwind-protect
-	 (loop do
+         (loop do
-	      (socket-receive in buffer (length buffer))
+               (socket-receive in buffer (length buffer))
-	      (format t "glonked -=> message: ~{~A, ~}~%"
+               (format t "glonked -=> message: ~{~A, ~}~%"
-		      (osc:decode-bundle buffer))
+                       (osc:decode-bundle buffer))
-	      (let ((mess (apply #'osc:encode-message
+               (let ((mess (apply #'osc:encode-message
-				 (cons "/echo"
+                                  (cons "/echo"
-				       (osc:decode-message buffer)))))
+                                        (osc:decode-message buffer)))))
-		(socket-send out mess (length mess))))
+                 (socket-send out mess (length mess))))
       (when in (socket-close in))
       (when out (socket-close out)))))
 
-;end
+;;end

osc-tests.lisp

@@ -0,0 +1,216 @@
+;; -*- mode: lisp -*-
+;;
+;; Quick and dirty tests for cl-osc
+;;
+;; You are granted the rights to distribute and use this software
+;; as governed by the terms of GNU Public License (aka the GPL)
+;; see the LICENCE file.
+
+;; Authors
+;;  - nik gaffney <nik@fo.am>
+
+(in-package :osc)
+
+#+sbcl (require 'sb-bsd-sockets)
+
+#+sbcl (defun osc-write ()
+  "a basic test function which sends various osc stuff on port 5555"
+  (let ((sock (sb-bsd-sockets::make-instance
+               'inet-socket
+               :type :datagram
+               :protocol :udp)))
+    (sb-bsd-sockets::socket-connect sock #(127 0 0 1) 5555)
+    (let ((stream
+            (sb-bsd-sockets::socket-make-stream
+             sock
+             :input t
+             :output t
+             :element-type '(unsigned-byte 8)
+             :buffering :full)))
+      (prin1 "int? ")
+      (write-sequence (oti) stream)
+      (force-output stream)
+      (prin1 "float? ")
+      (write-sequence (otf) stream)
+      (force-output stream)
+      (prin1 "string?")
+      (write-sequence (ots) stream)
+      (force-output stream)
+      (prin1 "mutliple args?")
+      (write-sequence (otm) stream)
+      (force-output stream)
+      (sb-bsd-sockets::socket-close sock)
+      )))
+
+(defun oti () (osc:encode-message "/test/int" 3))
+(defun otf () (osc:encode-message "/test/float" 4.337))
+(defun ots () (osc:encode-message "/test/string" "wonky_stringpuk"))
+(defun otbl () (osc:encode-message "/test/blob" #(0 0 0 0 0 0 0 0 0 0 0 0 0 0)))
+(defun otm ()  (osc:encode-message "/test/multi 5.78 1" "five point seven eight" "and one"))
+(defun otbn () (osc-encode-bundle (osc-make-test-bundle)))
+
+;; test todo
+;;  - negative floats
+;;  - bignums
+;;  - blobs, and long args
+;;  - byte aligning 0,1,2,3,4 mod
+;;  - error catching, junk data
+
+(defun osc-test ()
+  (format t "some osc tests: ~a"
+          (list
+           (osc-t2) (osc-t3) (osc-t4)
+           (osc-t5) (osc-t6) (osc-t7)
+           (osc-t8) (osc-t9) (osc-t10)
+           (osc-t11) (osc-t12) (osc-t13)))
+  T)
+
+(defun osc-t2 ()
+  (equalp '("/dip/lop" 666)
+          (osc:decode-message #(47 100 105 112 47 108 111 112 0 0 0 0 44 105 0 0 0 0 2 154))))
+
+(defun osc-t3 ()
+  (equalp '#(0 0 0 3 116 101 115 116 0 0 0 0 0 0 0 2 0 0 0 1 64 159 92 41)
+          (osc::encode-data '(3 "test" 2 1 4.98))))
+
+(defun osc-t4 ()
+  (equalp #(44 105 115 102 0 0 0 0)
+          (osc::encode-typetags '(1 "terrr" 3.4))))
+
+(defun osc-t5 ()
+  (equalp #(44 105 105 102 0 0 0 0)
+          (osc::encode-typetags '(1 2 3.3))))
+
+(defun osc-t6 ()
+  (equal '("/test/one" 1 2 3.3)
+         (osc:decode-message #(47 116 101 115 116 47 111 110 101 0 0 0 44 105 105 102 0 0 0 0 0 0 0 1 0 0 0 2 64 83 51 51))))
+
+(defun osc-t7 ()
+  (equalp '(#(0 0 0 0 0 0 0 1) ("/voices/0/tm/start" 0.0)
+            ("/foo/stringmessage" "a" "few" "strings") ("/documentation/all-messages"))
+          (osc:decode-bundle
+           #(#x23 #x62 #x75 #x6e
+             #x64 #x6c #x65 0
+             0    0    0    0
+             0    0    0    #x1
+             0    0    0    #x20
+             #x2f #x64 #x6f #x63
+             #x75 #x6d #x65 #x6e
+             #x74 #x61 #x74 #x69
+             #x6f #x6e #x2f #x61
+             #x6c #x6c #x2d #x6d
+             #x65 #x73 #x73 #x61
+             #x67 #x65 #x73 0
+             #x2c 0    0    0
+             0    0    0    #x2c
+             #x2f #x66 #x6f #x6f
+             #x2f #x73 #x74 #x72
+             #x69 #x6e #x67 #x6d
+             #x65 #x73 #x73 #x61
+             #x67 #x65 0    0
+             #x2c #x73 #x73 #x73
+             0    0    0    0
+             #x61 0    0    0
+             #x66 #x65 #x77 0
+             #x73 #x74 #x72 #x69
+             #x6e #x67 #x73 0
+             0    0    0    #x1c
+             #x2f #x76 #x6f #x69
+             #x63 #x65 #x73 #x2f
+             #x30 #x2f #x74 #x6d
+             #x2f #x73 #x74 #x61
+             #x72 #x74 0    0
+             #x2c #x66 0    0
+             0    0    0    0))))
+
+(defun osc-t8 ()
+  (equalp (osc:encode-message "/blob/x" #(1 2 3 4 5 6 7 8 9))
+          #(47 98 108 111 98 47 120 0 44 98 0 0 0 0 0 9 1 2 3 4 5 6 7 8 9 0 0 0)))
+
+(defun osc-t9 ()
+  (equalp '("/blob/x" #(1 2 3 4 5 6 7 8 9))
+          (osc:decode-message
+           #(47 98 108 111 98 47 120 0 44 98 0 0 0 0 0 9 1 2 3 4 5 6 7 8 9 0 0 0))))
+
+(defun osc-t10 ()
+  (equalp '("/t/x" #(1 29 32 43 54 66 78 81) 2 "lop")
+          (osc:decode-message
+            #(47 116 47 120 0 0 0 0 44 98 105 115 0 0 0 0 0 0 0 8 1 29 32 43 54
+              66 78 81 0 0 0 2 108 111 112 0))))
+
+(defun osc-t11 ()
+  (equalp '(#(0 0 0 0 0 0 0 1) ("/string/a/ling" "slink" "slonk" "slank")
+            ("/we/wo/w" 1 2 3.4) ("/blob" #(1 29 32 43 54 66 78 81 90) "lop" -0.44))
+          (osc:decode-bundle
+           #(35 98 117 110 100 108 101 0 0 0 0 0 0 0 0 1 0 0 0 40 47 98 108 111 98 0 0 0
+             44 98 115 102 0 0 0 0 0 0 0 9 1 29 32 43 54 66 78 81 90 0 0 0 108 111 112 0
+             190 225 71 174 0 0 0 32 47 119 101 47 119 111 47 119 0 0 0 0 44 105 105 102 0
+             0 0 0 0 0 0 1 0 0 0 2 64 89 153 154 0 0 0 48 47 115 116 114 105 110 103 47 97
+             47 108 105 110 103 0 0 44 115 115 115 0 0 0 0 115 108 105 110 107 0 0 0 115
+             108 111 110 107 0 0 0 115 108 97 110 107 0 0 0))))
+
+
+
+#+sbcl (defun osc-read (port)
+  "a basic test function which attempts to decode osc stuff on PORT."
+  (let ((s (make-instance 'inet-socket
+                          :type :datagram
+                          :protocol (get-protocol-by-name "udp")))
+        (buffer (make-sequence '(vector (unsigned-byte 8)) 512)))
+    (format t "Socket type is ~A on port ~A~%" (sockopt-type s) port)
+    (socket-bind s #(127 0 0 1) port)
+    (socket-receive s buffer nil :waitall t)
+    (socket-close s)
+    (osc:decode-message buffer)
+    ))
+
+;;(osc-decode-message data)
+
+(defun osc-ft ()
+  (and (eql (osc::DECODE-FLOAT32 #(63 84 32 93))  0.8286188)
+       (eql (osc::DECODE-FLOAT32 #(190 124 183 78)) -0.246793)))
+
+
+;; equalp but not eql
+(defun osc-t12 ()
+  (equalp (osc:encode-message "/asdasd" 3.6 4.5)
+          #(47 97 115 100 97 115 100 0 44 102 102 0 64 102 102 102 64 144 0 0)))
+
+;; equal but not eql
+(defun osc-t13 ()
+  (equal (osc:decode-message #(47 97 115 100 97 115 100 0 44 102 102 0 64 102 102 102 64 144 0 0))
+         (list "/asdasd" 3.6 4.5)))
+
+;; not symmetrical?  how much of a problem is this?
+(defun osc-asym-t1 ()
+  "this test will fail"
+  (osc:decode-message
+   (osc:encode-message
+    (osc:decode-message #(47 97 115 100 97 115 100 0 44 102 102 0 64 102 102 102 64 144 0 0)))))
+
+(defun osc-asym-t2 ()
+  "testing the assumptions about representations of messages"
+  (setf packed-msg #(47 97 115 100 97 115 100 0 44 102 102 0 64 102 102 102 64 144 0 0))
+  (setf cons-msg (osc:decode-message packed-msg))
+  (osc:encode-message (values-list cons-msg)))
+
+
+#|
+sc3 server
+
+32 byte message:
+2f (/)  6e (n)  5f (_)  73 (s)
+65 (e)  74 (t)  0 ()    0 ()
+2c (,)  69 (i)  73 (s)  66 (f)
+0 ()    0 ()    0 ()    0 ()
+0 ()    0 ()    1 ()    fffffff6 (?)
+66 (f)  72 (r)  65 (e)  71 (q)
+0 ()    0 ()    0 ()    0 ()
+3f (?)  ffffff80 (?)    0 ()    0 ()
+
+/n_set 502 "freq" 1.000000
+
+|#
+
+(defun run-tests ()
+  (osc-test))

osc-time.lisp

@@ -0,0 +1,79 @@
+(in-package #:osc)
+
+(defconstant +unix-epoch+ (encode-universal-time 0 0 0 1 1 1970 0))
+(defconstant +2^32+ (expt 2 32))
+(defconstant +2^32/million+ (/ +2^32+ (expt 10 6)))
+(defconstant +usecs+ (expt 10 6))
+
+(deftype timetag () '(unsigned-byte 64))
+
+(defun timetagp (object)
+  (typep object 'timetag))
+
+(defun unix-secs+usecs->timetag (secs usecs)
+  (let ((sec-offset (+ secs +unix-epoch+))) ; Seconds from 1900.
+    (setf sec-offset (ash sec-offset 32))   ; Make seconds the top 32
+                                            ; bits.
+    (let ((usec-offset
+           (round (* usecs +2^32/MILLION+)))) ; Fractional part.
+      (the timetag (+ sec-offset usec-offset)))))
+
+(defun get-current-timetag ()
+  "Returns a fixed-point 64 bit NTP-style timetag, where the top 32
+bits represent seconds since midnight 19000101, and the bottom 32 bits
+represent the fractional parts of a second."
+  #+sbcl (multiple-value-bind (secs usecs)
+             (sb-ext:get-time-of-day)
+           (the timetag (unix-secs+usecs->timetag secs usecs)))
+  #-sbcl (error "Can't encode timetags using this implementation."))
+
+(defun timetag+ (original seconds-offset)
+  (declare (type timetag original))
+  (let ((offset (round (* seconds-offset +2^32+))))
+    (the timetag (+ original offset))))
+
+
+;;;=====================================================================
+;;; Functions for using double-float unix timestamps.
+;;;=====================================================================
+
+(defun get-unix-time ()
+  "Returns a a double-float representing real-time now in seconds,
+with microsecond precision, relative to 19700101."
+  #+sbcl (multiple-value-bind (secs usecs)
+             (sb-ext:get-time-of-day)
+           (the double-float (+ secs (microseconds->subsecs usecs))))
+  #-sbcl (error "Can't encode timetags using this implementation."))
+
+(defun unix-time->timetag (unix-time)
+  (multiple-value-bind (secs subsecs)
+      (floor unix-time)
+    (the timetag
+         (unix-secs+usecs->timetag secs
+                                   (subsecs->microseconds subsecs)))))
+
+(defun timetag->unix-time (timetag)
+  (if (= timetag 1)
+      1                                 ; immediate timetag
+      (let* ((secs (ash timetag -32))
+             (subsec-int32 (- timetag (ash secs 32))))
+        (the double-float (+ (- secs +unix-epoch+)
+                             (int32->subsecs subsec-int32))))))
+
+(defun microseconds->subsecs (usecs)
+  (declare (type (integer 0 1000000) usecs))
+  (coerce (/ usecs  +usecs+) 'double-float))
+
+(defun subsecs->microseconds (subsecs)
+  (declare (type (float 0.0 1.0) subsecs))
+  (round (* subsecs +usecs+)))
+
+(defun int32->subsecs (int32)
+  "This maps a 32 bit integer, representing subsecond time, to a
+double float in the range 0-1."
+  (declare (type (unsigned-byte 32) int32))
+  (coerce (/ int32 +2^32+) 'double-float))
+
+(defun print-as-double (time)
+  (format t "~%~F" (coerce time 'double-float))
+  time)

osc.asd

@@ -1,11 +1,34 @@
 ;; -*- mode: lisp -*-
 
-(in-package #:asdf)
+(in-package #:cl-user)
 
-(defsystem osc
+(asdf:defsystem osc
-    :name "osc"
+  :name "osc"
-    :author "nik gaffney <nik@fo.am>"
+  :author "nik gaffney <nik@fo.am>"
-    :licence "LLGPL"
+  :licence "GPL v3"
-    :description "The Open Sound Control protocol, aka OSC"
+  :description "The Open Sound Control protocol aka OSC"
-    :version "0.5"
+  :version "0.7"
-    :components ((:file "osc")))
+  :depends-on (:usocket)
+  :components
+  ((:file "osc" :depends-on ("osc-data" "osc-time"))
+   (:file "osc-data" :depends-on ("package"))
+   (:file "osc-dispatch" :depends-on ("osc"))
+   (:file "osc-time" :depends-on ("package"))
+   (:file "osc-tests" :depends-on ("osc"))
+   (:file "package")
+   (:module "devices"
+    :if-feature :sbcl
+    :depends-on ("package" "osc-data")
+    :components
+            ((:file "socket-functions")
+             (:file "device")
+             (:file "transmitter"
+              :depends-on ("device"
+                           "socket-functions"))
+             (:file "listening-device"
+              :depends-on ("transmitter"))
+             (:file "dispatching-device"
+              :depends-on ("listening-device"))
+             (:file "client"
+              :depends-on ("dispatching-device"))
+             (:file "server" :depends-on ("client"))))))

osc.lisp

@@ -40,17 +40,9 @@
 ;;;     an error
 ;;;
 
-(defpackage :osc
-  (:use :cl)
-  (:documentation "OSC aka the 'open sound control' protocol")
-  (:export :encode-message
-	   :encode-bundle
-	   :decode-message
-	   :decode-bundle))
-
 (in-package :osc)
 
-;(declaim (optimize (speed 3) (safety 1) (debug 3)))
+;;(declaim (optimize (speed 3) (safety 1) (debug 3)))
 
 ;;;;;; ;    ;;    ;     ; ;     ; ; ;         ;
 ;;
@@ -58,28 +50,41 @@
 ;;
 ;;;; ;;  ;;   ; ; ;;           ;      ;  ;                  ;
 
-(defun encode-bundle (data &optional timetag)
+(defparameter *debug* 0
-  "will encode an osc message, or list of messages as a bundle
+  "Set debug verbosity for core library functions. Currently levels
-   with an optional timetag (symbol or 64bit int).
+  are 0-3.")
-   doesnt handle nested bundles"
-  (cat '(35 98 117 110 100 108 101 0)	; #bundle
-       (if timetag
-           (encode-timetag timetag)
-           (encode-timetag :now))
-       (if (listp (car data))
-	   (apply #'cat (mapcar #'encode-bundle-elt data))
-	 (encode-bundle-elt data))))
 
-(defun encode-bundle-elt (data)
+(defgeneric encode-osc-data (data))
-  (let ((message (apply #'encode-message data)))
-    (cat (encode-int32 (length message)) message)))      
 
-(defun encode-message (address &rest data)
+(defmethod encode-osc-data ((data message))
-  "encodes an osc message with the given address and data."
+  "Encode an osc message with the given address and args."
-  (concatenate '(vector (unsigned-byte 8))
+  (with-slots (command args) data
-	       (encode-address address)
+    (concatenate '(vector (unsigned-byte 8))
-	       (encode-typetags data)
+                 (encode-address command)
-	       (encode-data data)))
+                 (encode-typetags args)
+                 (encode-args args))))
+
+(defmethod encode-osc-data ((data bundle))
+  "Encode an osc bundle. A bundle contains a timetag (symbol or 64bit
+  int) and a list of message or nested bundle elements."
+  (with-slots (timetag elements) data
+    (cat '(35 98 117 110 100 108 101 0)    ; #bundle
+         (if timetag
+             (encode-timetag timetag)
+             (encode-timetag :now))
+         (apply #'cat (mapcar #'encode-bundle-elt elements)))))
+
+(defgeneric encode-bundle-elt (data))
+
+(defmethod encode-bundle-elt ((data message))
+  (let ((bytes (encode-osc-data data)))
+    (cat (encode-int32 (length bytes)) bytes)))
+
+(defmethod encode-bundle-elt ((data bundle))
+  (let ((bytes (encode-osc-data data)))
+    (cat (encode-int32 (length bytes)) bytes)))
+
+;; Auxilary functions
 
 (defun encode-address (address)
   (cat (map 'vector #'char-code address)
@@ -100,7 +105,7 @@
   and considers non int/float/string data to be a blob."
 
   (let ((lump (make-array 0 :adjustable t
-			  :fill-pointer t)))
+                          :fill-pointer t)))
     (macrolet ((write-to-vector (char)
                  `(vector-push-extend
                    (char-code ,char) lump)))
@@ -110,21 +115,22 @@
           (integer (if (>= x 4294967296) (write-to-vector #\h) (write-to-vector #\i)))
           (float (write-to-vector #\f))
           (simple-string (write-to-vector #\s))
-	  (t (write-to-vector #\b)))))
+          (keyword (write-to-vector #\s))
+          (t (write-to-vector #\b)))))
     (cat lump
          (pad (padding-length (length lump))))))
 
-(defun encode-data (data)
+(defun encode-args (args)
-  "encodes data in a format suitable for an OSC message"
+  "encodes args in a format suitable for an OSC message"
   (let ((lump (make-array 0 :adjustable t :fill-pointer t)))
     (macrolet ((enc (f)
                  `(setf lump (cat lump (,f x)))))
-      (dolist (x data) 
+      (dolist (x args)
         (typecase x
           (integer (if (>= x 4294967296) (enc encode-int64) (enc encode-int32)))
           (float (enc encode-float32))
           (simple-string (enc encode-string))
-	  (t (enc encode-blob))))
+          (t (enc encode-blob))))
       lump)))
 
 
@@ -134,40 +140,98 @@
 ;;
 ;;; ;;    ;;     ; ;     ;      ;      ; ;
 
-(defun decode-bundle (data)
+(defun bundle-p (buffer &optional (start 0))
-  "decodes an osc bundle into a list of decoded-messages, which has
+  "A bundle begins with '#bundle' (8 bytes). The start argument should
-   an osc-timetagas its first element"
+index the beginning of a bundle in the buffer."
-  (let ((contents '()))
+  (= 35 (elt buffer start)))
-    (if (equalp 35 (elt data 0))	; a bundle begins with '#'
+
-	(let ((timetag (subseq data 8 16)) 
+(defun get-timetag (buffer &optional (start 0))
-	      (i 16)
+  "Bytes 8-15 are the bundle timestamp. The start argument should
-	      (bundle-length (length data)))
+index the beginning of a bundle in the buffer."
-	  (loop while (< i bundle-length)
+  (decode-timetag (subseq buffer
-	     do (let ((mark (+ i 4))
+                          (+ 8 start)
-		      (size (decode-int32
+                          (+ 16 start))))
-			     (subseq data i (+ i 4)))))
+
-		  (if (eq size 0)
+(defun get-bundle-element-length (buffer &optional (start 16))
-		      (setf bundle-length 0)
+  "Bytes 16-19 are the size of the bundle element. The start argument
-		      (push (decode-bundle
+should index the beginning of the bundle element (length, content)
-			     (subseq data mark (+ mark size)))
+pair in the buffer."
-			    contents))
+  (decode-int32 (subseq buffer start (+ 4 start))))
-		  (incf i (+ 4 size))))
+
-	  (push timetag contents))
+(defun get-bundle-element (buffer &optional (start 16))
-	(decode-message data))))
+  "Bytes 20 upto to the length of the content (defined by the
+preceding 4 bytes) are the content of the bundle. The start argument
+should index the beginning of the bundle element (length, content)
+pair in the buffer."
+  (let ((length (get-bundle-element-length buffer start)))
+    (subseq buffer
+            (+ 4 start)
+            (+ (+ 4 start)
+               (+ length)))))
+
+(defun split-sequence-by-n (sequence n)
+  (loop :with length := (length sequence)
+        :for start :from 0 :by n :below length
+        :collecting (coerce
+                     (subseq sequence start (min length (+ start n)))
+                     'list)))
+
+(defun print-buffer (buffer &optional (n 8))
+  (format t "~%~{~{ ~5d~}~%~}Total: ~a bytes~2%"
+          (split-sequence-by-n buffer n)
+          (length buffer)))
+
+(defun decode-bundle (buffer &key (start 0) end)
+  "Decodes an osc bundle/message into a bundle/message object. Bundles
+  comprise an osc-timetag and a list of elements, which may be
+  messages or bundles recursively. An optional end argument can be
+  supplied (i.e. the length value returned by socket-receive, or the
+  element length in the case of nested bundles), otherwise the entire
+  buffer is decoded - in which case, if you are reusing buffers, you
+  are responsible for ensuring that the buffer does not contain stale
+  data."
+  (unless end
+    (setf end (- (length buffer) start)))
+  (when (>= *debug* 2)
+    (format t "~%Buffer start: ~a end: ~a~%" start end)
+    (print-buffer (subseq buffer start end)))
+  (if (bundle-p buffer start)
+      ;; Bundle
+      (let ((timetag (get-timetag buffer start)))
+        (incf start (+ 8 8))            ; #bundle, timetag bytes
+        (loop while (< start end)
+              for element-length = (get-bundle-element-length
+                                    buffer start)
+              do (incf start 4)            ; length bytes
+              when (>= *debug* 1)
+              do (format t "~&Bundle element length: ~a~%" element-length)
+              collect (decode-bundle buffer
+                                     :start start
+                                     :end (+ start element-length))
+              into elements
+              do (incf start (+ element-length))
+              finally (return
+                        (values (make-bundle timetag elements)
+                                timetag))))
+      ;; Message
+      (let ((message
+             (decode-message
+              (subseq buffer start (+ start end)))))
+        (make-message (car message) (cdr message)))))
 
 (defun decode-message (message)
   "reduces an osc message to an (address . data) pair. .."
   (declare (type (vector *) message))
   (let ((x (position (char-code #\,) message)))
-    (if (eq x NIL)
+    (if (eq x nil)
         (format t "message contains no data.. ")
-	(cons (decode-address (subseq message 0 x))
+        (cons (decode-address (subseq message 0 x))
-	      (decode-taged-data (subseq message x))))))
+              (decode-taged-data (subseq message x))))))
 
 (defun decode-address (address)
   (coerce (map 'vector #'code-char
-	       (delete 0 address))
+               (delete 0 address))
-	  'string))
+          'string))
 
 (defun decode-taged-data (data)
   "decodes data encoded with typetags...
@@ -185,32 +249,34 @@
       (map 'vector
            #'(lambda (x)
                (cond
-                ((eq x (char-code #\i))
+                 ((eq x (char-code #\i))
-                 (push (decode-int32 (subseq acc 0 4)) 
+                  (push (decode-int32 (subseq acc 0 4))
-                       result)
+                        result)
-                 (setf acc (subseq acc 4)))
+                  (setf acc (subseq acc 4)))
-                ((eq x (char-code #\h))
+                 ((eq x (char-code #\h))
-                 (push (decode-uint64 (subseq acc 0 8))
+                  (push (decode-uint64 (subseq acc 0 8))
-                       result)
+                        result)
-                 (setf acc (subseq acc 8)))
+                  (setf acc (subseq acc 8)))
-                ((eq x (char-code #\f))
+                 ((eq x (char-code #\f))
-                 (push (decode-float32 (subseq acc 0 4)) 
+                  (push (decode-float32 (subseq acc 0 4))
-                       result)
+                        result)
-                 (setf acc (subseq acc 4)))
+                  (setf acc (subseq acc 4)))
-                ((eq x (char-code #\s))
+                 ((eq x (char-code #\s))
-                 (let ((pointer (padded-length (position 0 acc))))
+                  (let ((pointer (padded-length (position 0 acc))))
-                   (push (decode-string 
+                    (push (decode-string
-                          (subseq acc 0 pointer))
+                           (subseq acc 0 pointer))
-                         result)
+                          result)
-                   (setf acc (subseq acc pointer))))
+                    (setf acc (subseq acc pointer))))
-                ((eq x (char-code #\b)) 
+                 ((eq x (char-code #\b))
-                 (let* ((size (decode-int32 (subseq acc 0 4)))
+                  (let* ((size (decode-int32 (subseq acc 0 4)))
-                        (bl (+ 4 size))
+                         (bl (+ 4 size))
-                        (end (+ bl (mod (- 4 bl) 4)))) ; NOTE: cannot use (padded-length bl), as it is not the same algorithm. Blobs of 4, 8, 12 etc bytes should not be padded!
+                         (end (+ bl (mod (- 4 bl) 4))))
-                   (push (decode-blob (subseq acc 0 end)) 
+                    ;; NOTE: cannot use (padded-length bl), as it is not the same algorithm.
-                         result)
+                    ;; Blobs of 4, 8, 12 etc bytes should not be padded!
-                   (setf acc (subseq acc end))))
+                    (push (decode-blob (subseq acc 0 end))
-                (t (error "unrecognised typetag ~a" x))))
+                          result)
+                    (setf acc (subseq acc end))))
+                 (t (error "unrecognised typetag ~a" x))))
            tags)
       (nreverse result))))
 
@@ -219,50 +285,45 @@
 ;;
 ;; timetags
 ;;
-;; - timetags can be encoded using a value, or the :now and :time keywords. the
+;; - timetags can be encoded using a value, or the :now and :time
-;;   keywords enable either a tag indicating 'immediate' execution, or
+;;   keywords. the keywords enable either a tag indicating 'immediate'
-;;   a tag containing the current time (which will most likely be in the past
+;;   execution, or a tag containing the current time (which will most
-;;   of anyt receiver) to be created.
+;;   likely be in the past of any receiver) to be created.
-;;
-;; - note: not well tested, and probably not accurate enough for syncronisation.
-;;   see also: CLHS 25.1.4 Time, and the ntp timestamp format. also needs to
-;;   convert from 2 32bit ints to 64bit fixed point value.
 ;;
 ;; - see this c.l.l thread to sync universal-time and internal-time
 ;;   http://groups.google.com/group/comp.lang.lisp/browse_thread/thread/c207fef63a78d720/adc7442d2e4de5a0?lnk=gst&q=internal-real-time-sync&rnum=1#adc7442d2e4de5a0
+
+;; - In SBCL, using sb-ext:get-time-of-day to get accurate seconds and
+;;   microseconds from OS.
 ;;
 ;;;; ;; ; ;
 
-(defconstant +unix-epoch+ (encode-universal-time 0 0 0 1 1 1970 0))
+(defun encode-timetag (timetag)
-
+  "From the spec: `Time tags are represented by a 64 bit fixed point
-(defun encode-timetag (utime &optional subseconds)
+number. The first 32 bits specify the number of seconds since midnight
-  "encodes an osc timetag from a universal-time and 32bit 'sub-second' part.
+on January 1, 1900, and the last 32 bits specify fractional parts of a
-   for an 'instantaneous' timetag use (encode-timetag :now) 
+second to a precision of about 200 picoseconds. This is the
-   for a timetag with the current time use (encode-timetag :time)"
+representation used by Internet NTP timestamps'. For an
+'instantaneous' timetag use (encode-timetag :now), and for a timetag
+with the current time use (encode-timetag :time)."
   (cond
-    ;; a 1bit timetag will be interpreted as 'imediately' 
+    ((equalp timetag :now)
-    ((equalp utime :now)
+     ;; a 1 bit timetag will be interpreted as 'immediately'
      #(0 0 0 0 0 0 0 1))
-    ;; converts seconds since 19000101 to seconds since 19700101
+    ((equalp timetag :time)
-    ;; note: fractions of a second is accurate, but not syncronised.
+     ;; encode timetag with current real time
-    ((equalp utime :time)
+     (encode-int64 (get-current-timetag)))
-     (cat (encode-int32 (- (get-universal-time) +unix-epoch+))
+    ((timetagp timetag)
-          (encode-int32 
+     ;; encode osc timetag
-           (round (* internal-time-units-per-second
+     (encode-int64 timetag))
-                     (second (multiple-value-list  
+    (t (error "Argument given is not one of :now, :time, or timetagp."))))
-                              (floor (/ (get-internal-real-time) 
-                                        internal-time-units-per-second)))))))))
-    ((integerp utime)
-     (cat (encode-int32 (+ utime +unix-epoch+))
-          (encode-int32 subseconds)))
-    (t (error "the time or subsecond given is not an integer"))))
 
 (defun decode-timetag (timetag)
-  "decomposes a timetag into unix-time and a subsecond,. . ."
+  "Return a 64 bit timetag from a vector of 8 bytes in network byte
-  (list
+  order."
-   (decode-int32 (subseq timetag 0 4))
+  (if (equalp timetag #(0 0 0 0 0 0 0 1))
-   (decode-int32 (subseq timetag 4 8))))
+      1 ; A timetag of 1 is defined as immediately.
-
+      (decode-uint64 timetag)))
 
 ;;;;; ; ; ;;    ;; ; ;
 ;;
@@ -274,13 +335,13 @@
 ;; particulaly portable, but 'works for now'.
 
 (defun encode-float32 (f)
-  "encode an ieee754 float as a 4 byte vector. currently sbcl/cmucl specifc"
+  "encode an ieee754 float as a 4 byte vector. currently sbcl/cmucl specific"
   #+sbcl (encode-int32 (sb-kernel:single-float-bits f))
   #+cmucl (encode-int32 (kernel:single-float-bits f))
   #+openmcl (encode-int32 (CCL::SINGLE-FLOAT-BITS f))
   #+allegro (encode-int32 (multiple-value-bind (x y) (excl:single-float-to-shorts f)
-			    (+ (ash x 16) y)))
+                            (+ (ash x 16) y)))
-  #-(or sbcl cmucl openmcl allegro) (error "cant encode floats using this implementation"))
+  #-(or sbcl cmucl openmcl allegro) (error "Can't encode floats using this implementation."))
 
 (defun decode-float32 (s)
   "ieee754 float from a vector of 4 bytes in network byte order"
@@ -288,8 +349,8 @@
   #+cmucl (kernel:make-single-float (decode-int32 s))
   #+openmcl (CCL::HOST-SINGLE-FLOAT-FROM-UNSIGNED-BYTE-32 (decode-uint32 s))
   #+allegro (excl:shorts-to-single-float (ldb (byte 16 16) (decode-int32 s))
-				    (ldb (byte 16 0) (decode-int32 s)))
+                                         (ldb (byte 16 0) (decode-int32 s)))
-  #-(or sbcl cmucl openmcl allegro) (error "cant decode floats using this implementation"))
+  #-(or sbcl cmucl openmcl allegro) (error "Can't decode floats using this implementation."))
 
 (defmacro defint-decoder (num-of-octets &optional docstring)
   (let ((decoder-name (intern (format nil "~:@(decode-uint~)~D" (* 8 num-of-octets))))
@@ -305,8 +366,13 @@
                                       ,int))))
          ,int))))
 
-(defint-decoder 4 "4 byte -> 32 bit unsigned int")
+(defun decode-uint32 (s)
-(defint-decoder 8 "8 byte -> 64 bit unsigned int")
+  "4 byte -> 32 bit unsigned int"
+  (let ((i (+ (ash (elt s 0) 24)
+              (ash (elt s 1) 16)
+              (ash (elt s 2) 8)
+              (elt s 3))))
+    i))
 
 (defmacro defint-encoder (num-of-octets &optional docstring)
   (let ((enc-name (intern (format nil "~:@(encode-int~)~D" (* 8 num-of-octets))))
@@ -317,59 +383,61 @@
            (list docstring))
        (let ((,buf (make-array ,num-of-octets :element-type '(unsigned-byte 8))))
          ,@(loop
-             for n below num-of-octets
+                 for n below num-of-octets
-             collect `(setf (aref ,buf ,n)
+                 collect `(setf (aref ,buf ,n)
-                            (ldb (byte 8 (* 8 (- (1- ,num-of-octets) ,n)))
+                                (ldb (byte 8 (* 8 (- (1- ,num-of-octets) ,n)))
-                                 ,int)))
+                                     ,int)))
          ,buf))))
 
-(defint-encoder 4 "Convert an integer into a sequence of 4 bytes in network byte order.")
+(defint-encoder 4 "Convert an integer into a sequence of 4 bytes in network byte order (32 bit).")
-(defint-encoder 8 "Convert an integer into a sequence of 8 bytes in network byte order.")
+(defint-encoder 8 "Convert an integer into a sequence of 8 bytes in network byte order (64 bit).")
 
 (defun decode-int32 (s)
   "4 byte -> 32 bit int -> two's complement (in network byte order)"
   (let ((i (decode-uint32 s)))
     (if (>= i #.(1- (expt 2 31)))
         (- (- #.(expt 2 32) i))
-	i)))
+        i)))
 
 (defun decode-int64 (s)
   "8 byte -> 64 bit int -> two's complement (in network byte order)"
   (let ((i (decode-uint64 s)))
     (if (>= i #.(1- (expt 2 63)))
         (- (- #.(expt 2 64) i))
-	i)))
+        i)))
 
 ;; osc-strings are unsigned bytes, padded to a 4 byte boundary
 
-(defun decode-string (data)
-  "converts a binary vector to a string and removes trailing #\nul characters"
-  (string-trim '(#\nul) (coerce (map 'vector #'code-char data) 'string)))
-
 (defun encode-string (string)
   "encodes a string as a vector of character-codes, padded to 4 byte boundary"
   (cat (map 'vector #'char-code string)
        (string-padding string)))
 
+(defun decode-string (data)
+  "converts a binary vector to a string and removes trailing #\nul characters"
+  (string-trim '(#\nul) (coerce (map 'vector #'code-char data) 'string)))
+
+
 ;; blobs are binary data, consisting of a length (int32) and bytes which are
 ;; osc-padded to a 4 byte boundary.
 
-(defun decode-blob (blob)
-  "decode a blob as a vector of unsigned bytes."
-  (let ((size (decode-int32
-	       (subseq blob 0 4))))
-    (subseq blob 4 (+ 4 size)))) 
-
 (defun encode-blob (blob)
   "encodes a blob from a given vector"
   (let ((bl (length blob)))
     (cat (encode-int32 bl) blob
-	 (pad (mod (- 4 bl) 4))))) ; NOTE: cannot use (padding-length bl), as it is not the same algorithm. Blobs of 4, 8, 12 etc bytes should not be padded!
+         <<<<<<< HEAD
+         (pad (padding-length bl)))))
+
+(defun decode-blob (blob)
+  "decode a blob as a vector of unsigned bytes."
+  (let ((size (decode-int32
+               (subseq blob 0 4))))
+    (subseq blob 4 (+ 4 size))))
 
 ;; utility functions for osc-string/padding slonking
 
 (defun cat (&rest catatac)
-  (apply #'concatenate '(vector *) catatac))
+  (apply #'concatenate '(vector (unsigned-byte 8)) catatac))
 
 (defun padding-length (s)
   "returns the length of padding required for a given length of string"
@@ -392,4 +460,5 @@
   (make-array n :initial-element 0 :fill-pointer n))
 
 (provide :osc)
+
 ;; end

package.lisp

@@ -0,0 +1,81 @@
+(defpackage :osc
+  (:use :cl)
+  (:documentation "OSC, the 'Open Sound Control' protocol.")
+  (:export
+   #:make-message
+   #:message
+   #:make-bundle
+   #:bundle
+   #:format-osc-data
+   #:command
+   #:args
+   #:timetag
+   #:elements
+   #:encode-message
+   #:encode-bundle
+   #:decode-message
+   #:decode-bundle
+   #:make-osc-tree
+   #:dp-register
+   #:dp-remove
+   #:dp-match
+   #:dispatch
+
+   #:get-current-timetag            ; osc-time
+   #:timetag+
+   #:get-unix-time
+   #:unix-time->timetag
+   #:timetag->unix-time
+   #:print-as-double
+
+   #:osc-transmitter                ; osc-devices
+   #:osc-transmitter-udp
+   #:osc-client
+   #:osc-client-udp
+   #:osc-client-tcp
+   #:osc-server
+   #:osc-server-udp
+   #:osc-server-tcp
+   #:protocol
+   #:name
+   #:buffer-size
+   #:quit
+   #:osc-device-cleanup
+   #:make-listening-thread          ; listening
+   #:add-osc-responder              ; dispatching
+   #:remove-osc-responder
+   #:make-osc-transmitter           ; transmitters
+   #:connect
+   #:send
+   #:send-msg
+   #:send-bundle
+   #:send-to
+   #:send-msg-to
+   #:send-bundle-to
+   #:send-all
+   #:send-msg-all
+   #:send-bundle-all
+   #:make-osc-client                ; clients
+   #:make-client-responders
+   #:register
+   #:make-osc-server                ; servers
+   #:boot
+   #:make-server-responders
+   #:register-udp-client
+   #:unregister-udp-client
+   #:register-tcp-client
+   #:unregister-tcp-client
+   #:post-register-hook
+   #:get-tcp-client
+   #:print-clients
+   #:send-to-client
+   #:send-bundle-to-client
+   #:*default-osc-buffer-size*      ; sockets
+   #:make-name-string
+   #:device-active-p
+   #:device-socket-name
+   #:address
+   #:port
+   #:peer-address
+   #:peer-port
+   #:run-tests))