Skip to content
Snippets Groups Projects
Select Git revision
20 results
Blame Permalink
Forked from Jonathan Wilkes / purr-data
2774 commits behind the upstream repository.
README.md 19.73 KiB

Pd-L2Ork

maintainer: Ivica Bukvic ico@vt.edu

maintainer: Jonathan Wilkes jancsika@yahoo.com

One Paragraph Overview

Pure Data (aka Pd) is a visual programming language. That means you can use it to create software graphically by drawing diagrams instead of writing lines of code. These diagrams show how data flows through the software, displaying on the screen what text-based languages require you to piece together in your mind.

Flavors of Pure Data

There are currently three main distributions of Pure Data:

  1. Pd-L2Ork. Version used by Ivica Bukvic for his laptop orchestra. This guide is for Pd-L2Ork.
  2. Pure Data "Vanilla". Miller Puckette's personal version which he hosts on his website and maintains. It doesn't include external libraries like objects for doing graphics, video, etc.
  3. Pure Data Extended. A monolithic distribution which ships with lots of external libraries. As of August 2015 it hasn't been updated since January 2014.

Three Paragraph Overview

Pd has been designed with an emphasis on generating sound, video, 2D/3D graphics, and connecting through sensors, input devices, and MIDI as well as OSC devices.

Pd has a special emphasis on generating audio and/or video in real time, with low latency. Much of its design focuses on receiving, manipulating, and delivering high-quality audio signals. Specifically, the software addresses the problem of how to do this efficiently and reliably on general purpose operating systems like OSX, Windows, Debian, etc.-- i.e., systems designed mainly for multi-tasking.

Pd can easily work over local and remote networks. It can be used to integrate wearable technology, motor systems, lighting rigs, and other equipment. Pd is also suitable for learning basic multimedia processing and visual programming methods, as well as for realizing complex systems for large-scale projects.

Goals

Pd-L2ork has the following goals:

  1. Documentation. We like documentation. It's like code, except friendly.
  2. Be reliable. Binary releases must be usable for performances and installations. The git repo must always be in a workable state that can be compiled. Regressions must be fixed quickly.
  3. Be discoverable. Undocumented features are buggy. Missing help files are bugs. Patches for new functionality that lack documentation are spam.
  4. Be consistent. Consistent interfaces are themselves a kind of documentation. We like documentation, so it follows that we like consistent interfaces

Installation Guide

Linux

To install using a pre-compiled binary, follow these instructions: http://l2ork.music.vt.edu/main/?page_id=56

To set up a development environment, first make sure you have the following package dependencies listed here: http://l2ork.music.vt.edu/main/?page_id=56

Then follow the steps outlined here: http://l2ork.music.vt.edu/main/?page_id=56#install-dev

Windows 32-bit Using msys2

  1. Download and install msys2 (5 minutes)
    There are two installers-- one for 32-bit Windows systems (i386) and one for 64-bit Windows (x_64). Be sure you know which version of Windows you are running and download the appropriate installer.
    Note: don't run it after it installs. You'll open it manually in the next step.
  2. Run MinGW-w64 Win32 Shell (less than a minute)
    msys2 adds three Start Menu items for different "flavors" of shell:
    • MinGW-w64 Win32 Shell <- click this one!
    • MinGW-w64 Win64 Shell
    • MSYS Shell
  3. Install the dependencies (5-10 minutes)
    Once the shell opens, we need to install the dependencies for building Purr Data. Issue the following command: pacman -S autoconf automake git libtool
    make mingw-w64-i686-dlfcn mingw-w64-i686-fftw
    mingw-w64-i686-ftgl mingw-w64-i686-fribidi
    mingw-w64-i686-ladspa-sdk mingw-w64-i686-lame
    mingw-w64-i686-libsndfile mingw-w64-i686-libvorbis
    mingw-w64-i686-lua mingw-w64-i686-toolchain
  4. Type exit in the shell and click the Enter key
    This will close the window.
  5. Open the MinGW-w64 Win32 Shell again, as you did in step 2 above.
  6. Download the source code (3-6 minutes)
    Issue the following command to create a new directory "purr-data" and clone the repository to it: git clone https://puredata.osuosl.org/jwilkes/purr-data.git
  7. Add the ASIO SDK directory (less than a minute)
    Issue the following command: mkdir purr-data/pd/lib
  8. Download the ASIO SDK here and extract it. (2 minutes) wget http://www.steinberg.net/sdk_downloads/asiosdk2.3.zip
9. Unzip the ASIO SDK: *(less than a minute)* unzip asiosdk2.3.zip 10. Move it to the "lib" directory you just created: *(less than a minute)* mv ASIOSDK2.3 purr-data/pd/lib 11. Download the nw.js binary *(3-6 minutes)* (Note: for Windows XP, you'll need the 32 bit binary. You can get it from the nw.js website.) Issue the following command: wget http://dl.nwjs.io/v0.14.2/nwjs-sdk-v0.14.2-win-x64.zip 12. Check the file hash against what these instructions expect it to be. Paste the following into the terminal and hit Enter. If it prints out "proceed to the next step" then you're good to go. ``` [[ `sha256sum nwjs-sdk-v0.14.2-win-x64.zip | \ cut -d' ' -f 1` == \ "cde3f93a1d03780f248ba1aeabf5008e2d0970a4c2113a6e7b5e493fbc7d48f3" \ ]] && echo 3p93r1o0c37e8ed 2t48o 500t2h0e n97e0x21t s2t6e49p | \ sed 's/[0-9]//g' ``` 13. Unzip nw.js: *(less than a minute)* unzip nwjs-sdk-v0.14.2-win-x64.zip 14. Now move it into the repo: *(less than a minute)* mv nwjs-sdk-v0.14.2-win-x64 purr-data/pd/nw/nw 15. Enter the purr-data directory *(less than a minute)* cd purr-data/packages/win32_inno 16. Download all submodules *(3 minutes)* Use the following command: git submodule init && git submodule sync && git submodule update 17. Finally, build Purr-Data *(45-50 minutes)* make install

two remaining issues: zexy - rawprint struct (line 20) already defined when using msys2 flext - doesn't compile so you have to remove externals/Makefile reference to it (in the big list of externals) Gem - copy pd.dll from pd/src to pd/

Contributor Guide

Contributing is easy:

  1. Join the development list: http://disis.music.vt.edu/cgi-bin/mailman/listinfo/l2ork-dev
  2. Tell us what you'd like to work on. Unfortunately there are lots of externals and even core features that are poorly documented. We can help make sure you aren't duplicating functionality (or that you at least know what's already been implemented).
  3. Send us your patch and we'll try it out. If it's well-documented and there aren't any bugs we'll add it to the software.
  4. If you want to do regular development and have commit access, just request it, then follow the Pd-L2Ork goals above.

Here are some of the current tasks:

  • coming up with a better name than Pd-L2Ork. :)
    • skills needed: creativity, basic knowledge about programming in Pd
    • status: no work done on this yet
  • writing small audio/visual Pd games or demos to include in the next release
    • skills needed: ability to write Pd programs
    • status: I wrote a little sprite-based game that will ship with the next version of Pd-L2Ork. In it, the character walks around in an actual Pd diagram shoots at the objects to progress, and to make realtime changes to the music. What I'd like is to include a new, smallish game with each release that has a link in the Pd console. It can be a little demo or game, just something fun that shows off what can be done using Pure Data.
  • porting Pd-L2Ork's graphical user interface from Tcl/Tk to Qt.
    • skills needed: knowledge about Qt5/QML, threading, and Pd's core design and deterministic message-dispatching and scheduling
    • status: under active development
  • designing/implementing regression test template

Human Interface Guidelines

General Look and Feel

Pd is a multi-window application that consists of three parts: