Initial commit

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Matthias Geier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include doc/Makefile
+include doc/make.bat
+include doc/requirements.txt
+recursive-include doc *.rst *.py
+recursive-include examples *.py

README.rst

@@ -0,0 +1,157 @@
+JACK Audio Connection Kit (JACK) Client for Python
+==================================================
+
+This Python module provides bindings for the JACK_ library.
+
+Documentation:
+  http://jackclient-python.rtfd.org/
+
+Code:
+  http://github.com/spatialaudio/jackclient-python/
+
+Requirements
+------------
+
+Python:
+   Of course, you'll need Python_.
+   Any version where CFFI (see below) is supported should work.
+   If you don't have Python installed yet, you should get one of the
+   distributions which already include CFFI (and many other useful things),
+   e.g. Anaconda_.
+
+CFFI:
+   The `C Foreign Function Interface for Python`_ is used to access the C-API
+   of the JACK library from within Python.  It supports CPython 2.6, 2.7, 3.x;
+   and is distributed with PyPy_ 2.0 beta2 or later.
+   You should install it with your package manager (if it's not installed
+   already), or you can get it with pip_::
+
+      pip install cffi --user
+
+JACK library:
+   The JACK_ library must be installed on your system (and CFFI must be able
+   to find it).  Again, you should use your package manager to install it.
+   Make sure you install both the JACK daemon (called ``jackd``) and the
+   development package (``libjack-dev`` or similar).
+   If you prefer, you can of course also download the sources and compile
+   everything locally.
+
+setuptools:
+   This is needed for the installation of the Python module.  Most systems will
+   have this installed already, but if not, you can install it with your
+   package manager or you can get it with pip_::
+
+      pip install setuptools --user
+
+.. _Python: http://www.python.org/
+.. _Anaconda: http://docs.continuum.io/anaconda/
+.. _C Foreign Function Interface for Python: http://cffi.readthedocs.org/
+.. _PyPy: http://pypy.org/
+.. _JACK: http://jackaudio.org/
+.. _pip: http://www.pip-installer.org/en/latest/installing.html
+
+Installation
+------------
+
+Once you have installed the above-mentioned dependencies, you can use pip_
+to download and install the latest release with a single command::
+
+   pip install JACK-Client --user
+
+If you want to install it system-wide for all users (assuming you have the
+necessary rights), you can just drop the ``--user`` option.
+
+To un-install, use::
+
+   pip uninstall JACK-Client
+
+If you prefer, you can also download the package from PyPI_, extract it, change
+to the main directory and install it using::
+
+   python setup.py install --user
+
+.. _PyPI: http://pypi.python.org/pypi/JACK-Client/
+
+If you want to get the newest development version from Github_::
+
+   git clone https://github.com/spatialaudio/jackclient-python.git
+   cd jackclient-python
+   python setup.py develop --user
+
+.. _Github: http://github.com/spatialaudio/jackclient-python/
+
+This way, your installation always stays up-to-date, even if you pull new
+changes from the Github repository.
+
+If you prefer, you can also replace the last command with::
+
+   pip install --user -e .
+
+... where ``-e`` stands for ``--editable``.
+
+If you want to avoid installation altogether, you can simply copy ``jack.py``
+to your working directory (or to any directory in your Python path).
+
+Usage
+-----
+
+First, import the module::
+
+   import jack
+
+Then, you most likely want to create a new JACK client::
+
+   client = jack.Client("MyGreatClient")
+
+You probably want to create some input and output ports, too::
+
+   client.inports.register("input_1")
+   client.outports.register("output_1")
+
+These functions return the newly created port, so you can save it for later::
+
+   in2 = client.inports.register("input_2")
+   out2 = client.outports.register("output_2")
+
+To see what you can do with the returned objects, have a look at the
+documentation of the class :class:`jack.OwnPort`.
+
+You can also check what other JACK ports are available::
+
+   portlist = client.get_ports()
+
+If you want, you can also set all kinds of callback functions, for details see
+the API documentation for the class :class:`jack.Client`.
+
+Once you are ready to run, you should activate your client::
+
+   client.activate()
+
+Once the client is activated, you can make connections (this isn't possible
+before activating the client)::
+
+   client.connect("system:capture_1", "MyGreatClient:input_1")
+   client.connect("MyGreatClient:output_1", "system:playback_1")
+
+You can also use the port objects from before instead of port names::
+
+   client.connect(out2, "system:playback_2")
+   in2.connect("system:capture_2")
+
+You can also disconnect ports, there are again several possibilities::
+
+   client.disconnect("system:capture_1", "MyGreatClient:input_1")
+   client.disconnect(out2, "system:playback_2")
+   # disconnect all connections with in2:
+   in2.disconnect()
+
+If you don't need your ports anymore, you can un-register them::
+
+   in2.unregister()
+   # unregister all output ports:
+   client.outports.clear()
+
+Finally, you can de-activate your JACK client and close it::
+
+   client.deactivate()
+   client.close()

doc/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/JACKAudioConnectionKitJACKClientforPython.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JACKAudioConnectionKitJACKClientforPython.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/JACKAudioConnectionKitJACKClientforPython"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/JACKAudioConnectionKitJACKClientforPython"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."