Skip to content

Commit 98d5888

Browse files
mgeiermgeier
committed
Initial commit
0 parents  commit 98d5888

File tree

12 files changed

+2691
-0
lines changed

12 files changed

+2691
-0
lines changed

‎LICENSE

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

‎MANIFEST.in

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
include LICENSE
2+
include doc/Makefile
3+
include doc/make.bat
4+
include doc/requirements.txt
5+
recursive-include doc *.rst *.py
6+
recursive-include examples *.py

‎README.rst

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
JACK Audio Connection Kit (JACK) Client for Python
2+
==================================================
3+
4+
This Python module provides bindings for the JACK_ library.
5+
6+
Documentation:
7+
http://jackclient-python.rtfd.org/
8+
9+
Code:
10+
http://github.com/spatialaudio/jackclient-python/
11+
12+
Requirements
13+
------------
14+
15+
Python:
16+
Of course, you'll need Python_.
17+
Any version where CFFI (see below) is supported should work.
18+
If you don't have Python installed yet, you should get one of the
19+
distributions which already include CFFI (and many other useful things),
20+
e.g. Anaconda_.
21+
22+
CFFI:
23+
The `C Foreign Function Interface for Python`_ is used to access the C-API
24+
of the JACK library from within Python. It supports CPython 2.6, 2.7, 3.x;
25+
and is distributed with PyPy_ 2.0 beta2 or later.
26+
You should install it with your package manager (if it's not installed
27+
already), or you can get it with pip_::
28+
29+
pip install cffi --user
30+
31+
JACK library:
32+
The JACK_ library must be installed on your system (and CFFI must be able
33+
to find it). Again, you should use your package manager to install it.
34+
Make sure you install both the JACK daemon (called ``jackd``) and the
35+
development package (``libjack-dev`` or similar).
36+
If you prefer, you can of course also download the sources and compile
37+
everything locally.
38+
39+
setuptools:
40+
This is needed for the installation of the Python module. Most systems will
41+
have this installed already, but if not, you can install it with your
42+
package manager or you can get it with pip_::
43+
44+
pip install setuptools --user
45+
46+
.. _Python: http://www.python.org/
47+
.. _Anaconda: http://docs.continuum.io/anaconda/
48+
.. _C Foreign Function Interface for Python: http://cffi.readthedocs.org/
49+
.. _PyPy: http://pypy.org/
50+
.. _JACK: http://jackaudio.org/
51+
.. _pip: http://www.pip-installer.org/en/latest/installing.html
52+
53+
Installation
54+
------------
55+
56+
Once you have installed the above-mentioned dependencies, you can use pip_
57+
to download and install the latest release with a single command::
58+
59+
pip install JACK-Client --user
60+
61+
If you want to install it system-wide for all users (assuming you have the
62+
necessary rights), you can just drop the ``--user`` option.
63+
64+
To un-install, use::
65+
66+
pip uninstall JACK-Client
67+
68+
If you prefer, you can also download the package from PyPI_, extract it, change
69+
to the main directory and install it using::
70+
71+
python setup.py install --user
72+
73+
.. _PyPI: http://pypi.python.org/pypi/JACK-Client/
74+
75+
If you want to get the newest development version from Github_::
76+
77+
git clone https://github.com/spatialaudio/jackclient-python.git
78+
cd jackclient-python
79+
python setup.py develop --user
80+
81+
.. _Github: http://github.com/spatialaudio/jackclient-python/
82+
83+
This way, your installation always stays up-to-date, even if you pull new
84+
changes from the Github repository.
85+
86+
If you prefer, you can also replace the last command with::
87+
88+
pip install --user -e .
89+
90+
... where ``-e`` stands for ``--editable``.
91+
92+
If you want to avoid installation altogether, you can simply copy ``jack.py``
93+
to your working directory (or to any directory in your Python path).
94+
95+
Usage
96+
-----
97+
98+
First, import the module::
99+
100+
import jack
101+
102+
Then, you most likely want to create a new JACK client::
103+
104+
client = jack.Client("MyGreatClient")
105+
106+
You probably want to create some input and output ports, too::
107+
108+
client.inports.register("input_1")
109+
client.outports.register("output_1")
110+
111+
These functions return the newly created port, so you can save it for later::
112+
113+
in2 = client.inports.register("input_2")
114+
out2 = client.outports.register("output_2")
115+
116+
To see what you can do with the returned objects, have a look at the
117+
documentation of the class :class:`jack.OwnPort`.
118+
119+
You can also check what other JACK ports are available::
120+
121+
portlist = client.get_ports()
122+
123+
If you want, you can also set all kinds of callback functions, for details see
124+
the API documentation for the class :class:`jack.Client`.
125+
126+
Once you are ready to run, you should activate your client::
127+
128+
client.activate()
129+
130+
Once the client is activated, you can make connections (this isn't possible
131+
before activating the client)::
132+
133+
client.connect("system:capture_1", "MyGreatClient:input_1")
134+
client.connect("MyGreatClient:output_1", "system:playback_1")
135+
136+
You can also use the port objects from before instead of port names::
137+
138+
client.connect(out2, "system:playback_2")
139+
in2.connect("system:capture_2")
140+
141+
You can also disconnect ports, there are again several possibilities::
142+
143+
client.disconnect("system:capture_1", "MyGreatClient:input_1")
144+
client.disconnect(out2, "system:playback_2")
145+
# disconnect all connections with in2:
146+
in2.disconnect()
147+
148+
If you don't need your ports anymore, you can un-register them::
149+
150+
in2.unregister()
151+
# unregister all output ports:
152+
client.outports.clear()
153+
154+
Finally, you can de-activate your JACK client and close it::
155+
156+
client.deactivate()
157+
client.close()

‎doc/Makefile

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = _build
9+
10+
# User-friendly check for sphinx-build
11+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12+
$(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/)
13+
endif
14+
15+
# Internal variables.
16+
PAPEROPT_a4 = -D latex_paper_size=a4
17+
PAPEROPT_letter = -D latex_paper_size=letter
18+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19+
# the i18n builder cannot share the environment and doctrees with the others
20+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21+
22+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23+
24+
help:
25+
@echo "Please use \`make <target>' where <target> is one of"
26+
@echo " html to make standalone HTML files"
27+
@echo " dirhtml to make HTML files named index.html in directories"
28+
@echo " singlehtml to make a single large HTML file"
29+
@echo " pickle to make pickle files"
30+
@echo " json to make JSON files"
31+
@echo " htmlhelp to make HTML files and a HTML help project"
32+
@echo " qthelp to make HTML files and a qthelp project"
33+
@echo " devhelp to make HTML files and a Devhelp project"
34+
@echo " epub to make an epub"
35+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
37+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38+
@echo " text to make text files"
39+
@echo " man to make manual pages"
40+
@echo " texinfo to make Texinfo files"
41+
@echo " info to make Texinfo files and run them through makeinfo"
42+
@echo " gettext to make PO message catalogs"
43+
@echo " changes to make an overview of all changed/added/deprecated items"
44+
@echo " xml to make Docutils-native XML files"
45+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
46+
@echo " linkcheck to check all external links for integrity"
47+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
48+
49+
clean:
50+
rm -rf $(BUILDDIR)/*
51+
52+
html:
53+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54+
@echo
55+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56+
57+
dirhtml:
58+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
59+
@echo
60+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61+
62+
singlehtml:
63+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
64+
@echo
65+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66+
67+
pickle:
68+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
69+
@echo
70+
@echo "Build finished; now you can process the pickle files."
71+
72+
json:
73+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
74+
@echo
75+
@echo "Build finished; now you can process the JSON files."
76+
77+
htmlhelp:
78+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
79+
@echo
80+
@echo "Build finished; now you can run HTML Help Workshop with the" \
81+
".hhp project file in $(BUILDDIR)/htmlhelp."
82+
83+
qthelp:
84+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
85+
@echo
86+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
87+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/JACKAudioConnectionKitJACKClientforPython.qhcp"
89+
@echo "To view the help file:"
90+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JACKAudioConnectionKitJACKClientforPython.qhc"
91+
92+
devhelp:
93+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
94+
@echo
95+
@echo "Build finished."
96+
@echo "To view the help file:"
97+
@echo "# mkdir -p $$HOME/.local/share/devhelp/JACKAudioConnectionKitJACKClientforPython"
98+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/JACKAudioConnectionKitJACKClientforPython"
99+
@echo "# devhelp"
100+
101+
epub:
102+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103+
@echo
104+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105+
106+
latex:
107+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108+
@echo
109+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
111+
"(use \`make latexpdf' here to do that automatically)."
112+
113+
latexpdf:
114+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115+
@echo "Running LaTeX files through pdflatex..."
116+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
117+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118+
119+
latexpdfja:
120+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121+
@echo "Running LaTeX files through platex and dvipdfmx..."
122+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124+
125+
text:
126+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127+
@echo
128+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
129+
130+
man:
131+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132+
@echo
133+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134+
135+
texinfo:
136+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137+
@echo
138+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139+
@echo "Run \`make' in that directory to run these through makeinfo" \
140+
"(use \`make info' here to do that automatically)."
141+
142+
info:
143+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144+
@echo "Running Texinfo files through makeinfo..."
145+
make -C $(BUILDDIR)/texinfo info
146+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147+
148+
gettext:
149+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150+
@echo
151+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152+
153+
changes:
154+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155+
@echo
156+
@echo "The overview file is in $(BUILDDIR)/changes."
157+
158+
linkcheck:
159+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160+
@echo
161+
@echo "Link check complete; look for any errors in the above output " \
162+
"or in $(BUILDDIR)/linkcheck/output.txt."
163+
164+
doctest:
165+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166+
@echo "Testing of doctests in the sources finished, look at the " \
167+
"results in $(BUILDDIR)/doctest/output.txt."
168+
169+
xml:
170+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171+
@echo
172+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
173+
174+
pseudoxml:
175+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176+
@echo
177+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

0 commit comments

Comments
 (0)