1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
Compiling pyo from sources
==========================
Here is how you can compile pyo from sources on Linux and MacOS (if you are
interested in the adventure of compiling pyo from sources on Windows, you can
take a look at my personal notes in `windows-10-64bit-build-routine.txt
<https://github.com/belangeo/pyo/blob/master/scripts/win/windows-10-64bit-build-routine.txt>`_).
See below for complete build routines for Debian/Ubuntu and MacOS.
Dependencies
------------
To compile pyo with all its features, you will need the following dependencies:
- `Python 3.7, 3.8, 3.9, 3.10, or 3.11 <https://www.python.org/downloads/>`_.
- `WxPython Phoenix 4.2.0 or higher <https://www.wxpython.org/pages/downloads/>`_
- `Portaudio <http://www.portaudio.com/>`_
- `Portmidi <http://portmedia.sourceforge.net/portmidi/>`_
- `libsndfile <http://www.mega-nerd.com/libsndfile/>`_
- `liblo <http://liblo.sourceforge.net/>`_
- `git <https://git-scm.com/>`_ (if you want the latest sources)
Please note that under MacOS you will need to install the
**Apple's developer tools** to compile pyo.
Getting sources
---------------
You can download pyo's sources by checking out the source code
`here <https://github.com/belangeo/pyo>`_:
.. code-block:: bash
git clone https://github.com/belangeo/pyo.git
Compilation
---------------
Once you have all the required dependencies, go in pyo's directory:
.. code-block:: bash
cd path/to/pyo
And build the library:
.. code-block:: bash
sudo python setup.py install
You can customize your compilation by giving some flags to the command line.
.. _compilation-flags-label:
Compilation flags
*****************
If you want to be able to use coreaudio (MacOS):
.. code-block:: bash
--use-coreaudio
If you want JACK support (Linux, MacOS):
.. code-block:: bash
--use-jack
If you want to be able to use a 64-bit pyo (All platforms, this is the sample
resolution, not the architecture), this will build both single and double
precisions:
.. code-block:: bash
--use-double
If you want to disable most of messages printed to the console:
.. code-block:: bash
--no-messages
If you want to compile external classes defined in pyo/externals folder:
.. code-block:: bash
--compile-externals
By default, debug symbols are off. If you want to compile pyo with debug symbols:
.. code-block:: bash
--debug
By default, optimizations are activated. If you want to compile pyo without
optimizations:
.. code-block:: bash
--fast-compile
If you want to compile pyo with minimal dependencies (mostly for integrated use
in a host environment):
.. code-block:: bash
--minimal
This will compile pyo without portaudio, portmidi and liblo support.
Compilation scripts
*******************
In the ./scripts folder, there is some alternate scripts to simplify the
compilation process a little bit. These scripts will compile pyo for the
version of python pointed to by the command `python`.
To compile both 32-bit and 64-bit resolutions on linux with jack support:
.. code-block:: bash
sudo sh scripts/compile_linux_withJack.sh
To compile both 32-bit and 64-bit resolutions on macOS without Jack support:
.. code-block:: bash
sudo sh scripts/compile_OSX.sh
To compile both 32-bit and 64-bit resolutions on macOS with Jack support (Jack headers must be present on the system):
.. code-block:: bash
sudo sh scripts/compile_OSX_withJack.sh
Debian & Ubuntu (apt-get)
-------------------------
Under Debian & Ubuntu you can type the following commands to get pyo up and running.
For Python 3.7 and higher
*************************
.. code-block:: bash
sudo apt-get install libjack-jackd2-dev libportmidi-dev portaudio19-dev liblo-dev libsndfile-dev
sudo apt-get install python3-dev python3-tk python3-pil.imagetk python3-pip
git clone https://github.com/belangeo/pyo.git
cd pyo
sudo python3 setup.py install --use-jack --use-double
If you want to be able to use all of pyo's gui widgets, you will need wxPython Phoenix 4.2.0.
- To install wxPython with pip on linux, follow the instructions on the wxPython's `downloads <https://wxpython.org/pages/downloads/>`_ page.
MacOS (Homebrew)
----------------
Under macOS, it is very simple to build pyo from sources with the Homebrew
package manager.
The first step is to install the official Python from `python.org <https://www.python.org/downloads/>`_.
Second step, if you want to be able to use all of pyo's gui widgets, you will need wxPython Phoenix. Install with pip:
.. code-block:: bash
python3 -m pip install --user wxPython
The third step is to install `Homebrew <http://brew.sh/>`_.
Finally, in a terminal window, install pyo's dependencies, clone and build pyo:
.. code-block:: bash
brew install liblo libsndfile portaudio portmidi
git clone https://github.com/belangeo/pyo.git
cd pyo
python setup.py install --use-coreaudio --use-double
|
