INSTALL.txt

# Installing Pure Data

This README file contains info for installing Pure Data from source.

Pd is built on the commandline using traditional Unix-style tools. The source
distribution comes with two build systems:

* autotools: easy to use, many compilation options, recommended for most users
* makefile: smaller & simpler, used for Pd binary downloads

## Requirements

Core build requirements:

* Unix command shell: bash, dash, etc
* C compiler chain: gcc/clang & make

Core runtime requirements:

* Tcl/Tk: Tk wish shell

Optional features:

* autotools: autconf, automake, & libtool (if building with the autotools)
* gettext: build localizations in the po directory
* JACK: audio server support
* FFTW: use the optimized FFTW Fast Fourier Transform library

## Autotools Build (recommended)

Building Pd using the GNU autotools involves the following steps:

1. configure: detect & set library and platform options
2. make: compile Pd, associated tools, and resource files (ie. translations)
3. install: install the Pd binaries and resources onto your system

Overview:

    cd path/to/pd
    ./autogen.sh
    ./configure
    make

Start by opening a commandline shell and navigating to the Pd source directory:

    cd path/to/pd

First generate the configure script and various build files by running:

    ./autogen.sh

Next configure Pd with the default options for your platform:

    ./configure

You can verify the configuration options that the configure step script prints:

    pd 0.47.1 is now configured

    Platform:             Mac OSX
    Debug build:          no
    Universal build:      no
    Localizations:        no
    Source directory:     .
    Installation prefix:  /usr/local

    ...

    audio APIs:           PortAudio
    midi APIs:            PortMidi

If you want to change these options, you can specify/override the configure
script settings on the commandline:

    # change install prefix to /usr
    ./configure --prefix /usr

    # build Pd with the JACK audio server backend
    ./configure --enable-jack 

    # build Pd using a system installed PortAudio
    ./configure --without-local-portaudio

An important configure option is --enable-universal which allows you to specify
the desired architecture(s) when building Pd. For Intel/AMD processors, 32 bit
is called "i386" and 64 bit is "x86_64". By default, Pd is built for the
architecture of the current system, however you may want a 32 bit Pd to work
with existing 32 bit externals on a 64 bit system. You can override the defaults
with --enable-universal:

    # build 32 bit Pd
    ./configure --enable-universal=i386

    # build 64 bit Pd
    ./configure --with-universal=x86_64

    # build a "fat" Pd for both 32 and 64 bit (not useful on all platforms)
    ./configure --enable-universal=i386,x86_64

    # build a "fat" Pd for all detected architectures (macOS: i386, x86_64, ppc)
    ./configure --enable-universal

The full list of available configuration options can printed by running: 

    ./configure --help

Now that Pd is configured, build by running:

    make

Building should take a minute or two. If compilation was successful, you can
run Pd from the build directory without installing it:

    cd bin
    ./pd

To install to your system using the configuration prefix (default /usr/local):

    sudo make install

You can also to a custom location via:

    make install DESTDIR=~/pd-xxx prefix=/

Once installed, you should now be able to run Pd from the commandline:

    pd

If want to uninstall, make sure Pd is configured and then run:

    sudo make uninstall

If you compiled Pd using the --enable-universal configure option and want to
double check which architectures Pd was built with, use the "file" command:

    # examine binary in the src directory
    file src/pd
    ...
    src/pd: Mach-O 64-bit executable x86_64

    # look at pd inside a macOS .app bundle
    file Pd.app/Contents/Resources/bin/pd
    ...
    Pd-0.47.1.app/Contents/Resources/bin/pd: Mach-O 64-bit executable x86_64

### Linux & BSD

Platform requirements:

* ALSA: Linux sound library (recommended)
* OSS: historical precursor to ALSA, generally not used
* JACK: JACK audio server (optional)

Install the core build requirements using your distribution's package manager.
For Debian, you can install the compiler chain, autotools, & gettext with:

    sudo apt-get install build-essential automake autoconf libtool gettext

For libraries, you will need to install the "development" versions which include
the source code header files. In Debian, the ALSA development package is called
"libasound2-dev":

    sudo apt-get install libasound2-dev

Similarly, optional development libraries can be also be installed to for
additional features. Install the JACK development files on Debian:

    sudo apt-get install libjack-jackd2-dev

In case you are using jackd1 instead of jackd2, use:

    sudo apt-get install libjack-dev

Most distributions come with Tcl/Tk installed, so you should be able to run Pd
after it is built.

### macOS

macOS is built on top of a BSD system and the bash commandline can be accessed
with the Terminal application in the /Applications/Utility directory.

The clang compiler and associated tools are provided by Apple. If you are
running macOS 10.9+, you *do not* need to install the full Xcode application and
can install the Commandline Tools Package only by running the following:

    xcode-select --install

If you are running macOS 10.6 - 10.8, you will need to install Xcode
from the Mac App Store or downloaded from http://developer.apple.com

Tcl/Tk is already included macOS.

To install the autotools, gettext, and libraries for additional features,
you can use one of the open source package managers for macOS:

* homebrew: https://brew.sh (recommended)
* macports: https://www.macports.org

Follow the package manager set up instructions and then install the software you
need. For example, to install the autotools & gettext using Homebrew:

    brew install automake autoconf libtool pkg-config gettext
    brew link --force gettext

By default, Pd is built for the current system architecture, usually 64 bit. If
you want to override this you can use the --enable-universal configure option,
as mentioned in the main Autotools Build section. On macOS, running this option
without arguments will build Pd for all architectures supported by the compiler:

* 10.6: i386, x86_64, ppc
* 10.7+: i386, x86_64

The JACK audio server is supported by Pd on macOS. By default, Pd can use the
Jack OS X runtime framework from http://www.jackosx.com if it is installed on
the system. Optionally, Pd can also be built with Jack installed via Homebrew or
Macports, however the runtime framework support must be disabled:

    brew install jack
    ./configure --without-jack-framework

You should now be ready to build Pd. Once built, there are two options for
installation:

* build a standalone macOS application (recommended)
* install to your system as a commandline program

To build the Pd macOS application, simply run:

    make app

This builds Pd-#.#.#.app in the Pd source directory which can be then be
double-clicked and/or copied to /Applications. For more info &
options regarding the Pd .app bundle, see mac/README.txt

If you want to have both the Pd application *and* use Pd from the commandline,
add command aliases to the binaries inside the .app to your ~/.bash_profile:

# pd commandline
WHICHPD="Pd-0.47-1"
alias pd="/Applications/$WHICHPD.app/Contents/Resources/bin/pd"
alias pdsend="/Applications/$WHICHPD.app/Contents/Resources/bin/pdsend"
alias pdreceive="/Applications/$WHICHPD.app/Contents/Resources/bin/pdreceive"

Next, reload the profile by either opening a new Terminal window or running:

    source ~/.bash_profile

If you install Pd to your system with "make install", the Tk 8.5.9
currently included with the system is buggy and should *not* be used. It is
recommended to install a newer version, either via Homebrew or from the
ActiveState Tcl/Tk downloads.

To see which version the Pd GUI is using: set the log level to 3 & look for the
Tk version log line in the Pd window.

Another option is to set the Tk Wish command Pd uses to launch the GUI. At
start, Pd does a quick search in the "usual places" for Wish and chooses the
first path that exists. Versions of macOS up to 10.12 also ship with Tcl/Tk 8.4
which works fine and this wish can be invoked by Pd using the full path
"/usr/bin/wish8.4". You can configure Pd to use this search path first with:

    ./configure --with-wish=/usr/bin/wish8.4

To see Pd's path search info, run Pd with the -verbose flag:

    pd -verbose

Note: Pd installed to your system or run from the build/bin directory will not
use the default font and will be missing the various macOS GUI hints (such as
retina rendering) which are specified by the Info.plist file inside the .app
bundle. Again, it is recommended to build a .app and use the aforementioned
aliases to provide the pd command.

### Windows

Pd on Windows can be built with either MinGW or Cygwin which provide the
core build requirements: a compiler chain & shell environment.

It is recommended to use the Msys2 distribution which provides both a Unix
command shell and MinGW. Download the Msys2 "x86_64" 64 bit installer (or "i686"
if you are using 32 bit Windows) from:

    http://www.msys2.org/

Then install to the default location (C:\msys32 or C:\msys64) and follow the
setup/update info on the Msys2 webpage.

Msys2 provides both 32 and 64 MinGW and command shells. Currently, the Pd
release is 32 bit for Windows, so it is recommended to set up and use the MinGW
32 bit shell. If you want to build a 64 bit Pd, similarly use the MinGW 64 bit
shell however this is currently considered *experimental*. Due to how MinGW is
designed, you cannot build a 64 bit Pd with a 32 bit MinGW and vice versa. This
also means the Pd configure --enable-universal build option has no effect in
MinGW.

Note: Msys2 development seems to change frequently, so some of the package names
      below may have changed after this document was written.

Open an Msys2 shell and install the compiler chain, autotools, & gettext via:

    # 32 bit
    pacman -S mingw-w64-i686-toolchain mingw-w64-i686-clang \
              make pkgconfig autoconf automake libtool \
              mingw-w64-i686-gettext

    # 64 bit
    pacman -S mingw-w64-x86_64-toolchain mingw-w64-x86_64-clang \
              make pkgconfig autoconf automake libtool \
              mingw-w64-x86_64-gettext 

Install git if you want to clone the Pd sources from Github, etc:

    pacman -S git

and/or the nsis installer tool if you want to build the Pd Windows installer:

    # 32 bit
    pacman -S mingw-w64-i686-nsis

    # 64 bit
    pacman -S mingw-w64-x86_64-nsis

Note: You can also search for packages in Msys2 with:

    pacman -S -s <searchterm>

Once the packages are installed, you should now be ready to build Pd.

The following audio APIS are available on Windows and can be enabled/disabled
via their configure flags:

* MMIO: --enable-mmio or --disable-mmio (default enabled)
* ASIO: --enable-asio or --disable-asio (default enabled, if found)
* JACK: --enable-jack or --disable-jack

For example, to build Pd without MMIO support:

    ./configure --disable-mmio

Note: Because of license restrictions, Pd cannot distribute the ASIO SDK source
files. If you want to build Pd with ASIO support, see asio/README.txt for
further instructions.

You should now be ready to build Pd. Once built, you can either:

* build a Pd application directory for Windows (recommended)
* build a Windows installer

A Pd application directory is essentially a self-contained Pd package which
should run out of the box. To build, simply use:

    make app

This will create a "pd-VERSION" directory (ie. pd-0.48.1) which can then be used
by running pd.exe in the bin directory and placed wherever on your system. For
more info & options regarding the Pd app directory, see msw/README.txt

To build a .msi Windows installer for Pd, see msw/build-nsi.sh.

Note: The standard "make install" requires Tcl/Tk and won't work outside your
Cygwin/Msys2 environment (if at all).

### Cross-compilation for Windows on Linux

You can also build a Windows binary of Pd on a Linux system, using a
cross-compilation toolchain.

For Debian based systems (e.g. Ubuntu), you can install the toolchain with:

    sudo apt-get install build-essential automake autoconf libtool gettext
    sudo apt-get install mingw-w64 mingw-w64-tools
    sudo apt-get install nsis

The "mingw-w64" package will install the cross compilation toolchains for both
32bit (g++-mingw-w64-i686, binutils-mingw-w64-i686) and
64bit (g++-mingw-w64-x86-64, binutils-mingw-w64-x86-64).

The "nsis" package is purely optional, and only needed if you want to build the
installer.

You must tell configure that you want to cross-compile for a given architecture
via the "--host" configure flag.

For example, to build a 32 bit Pd:

    ./configure --host=i686-w64-mingw32

Similarily, to build a 64 bit Pd without ASIO support:

    ./configure --disable-asio --host=x86_64-w64-mingw32 CPPFLAGS=-DPD_LONGINTTYPE=__int64

(Currently you need to override the PD_LONGINTTYPE for Windows 64bit builds).

If all went well, you should now be ready to build Pd, as explained in the
instructions above in the "Windows" section:

    make app

## Makefile Build

Alternatively, and often more simply, to the autotools build, you can use the
fallback makefiles in the src directory:

* src/makefile.gnu: GNU/Linux
* src/makefile.mac: macOS
* src/makefile.msvc: Windows with Microsoft Visual C
* src/makefile.mingw: Windows with MinGW GCC

On Linux, for example, run the GNU-specific makefile in the src directory:

    cd src
    make -f makefile.gnu

You can then run directly out of the bin directory without installing:

    cd ../bin
    ./pd

For Microsoft Visual C, first build Pd with the MS VC makefile and then build
each external in the extra directory:

    cd src
    make -f makefile.msvc
    cd ../extra/bob~
    make pd_nt
    cd ../bonk~ && make pd_nt
    cd ../choice && make pd_nt
    cd ../fiddle~ && make pd_nt
    ...

To install Pd to your system on Linux, macOS, & MinGW (Windows), use the
"install" makefile target. For Linux, this is:

    make -f makefile.gnu install

Once installed, you should now be able to run Pd from the commandline:

    pd

If want to uninstall, simply run the "uninstall" makefile target:

    make -f makefile.gnu uninstall

On macOS, you can build a clickable Pd .app bundle using the supplemental build
scripts in the mac directory. See mac/README.txt for more info.

## Reporting Bugs

Let us know if you run into any bugs or issues with building or installing Pd:

* send an email: https://lists.puredata.info/listinfo
* post to the Pd forum: https://forum.pdpatchrepo.info
* create a bugreport: https://bugs.puredata.info
* open an issue: https://github.com/pure-data/pure-data/issues

Please include information involved with your problem such as:

* information about your system: OS version, libraries installed, etc
* configure or make output including error lines
* steps you took: configuration options, etc