README.md 16.2 KB
Newer Older
1
## Pd-L2Ork
pokergaming's avatar
pokergaming committed
2
3

maintainer: Ivica Bukvic <ico@vt.edu>
pokergaming's avatar
pokergaming committed
4

pokergaming's avatar
pokergaming committed
5
6
maintainer: Jonathan Wilkes <jancsika@yahoo.com>

7
8
9
10
11
12
* [One Paragraph Overview](#one-paragraph-overview)
* [Flavors of Pure Data](#flavors-of-pure-data)
* [Three Paragraph Overview](#three-paragraph-overview)
* [Goals](#goals)
* [Installation Guide](#installation-guide)
* [Contributor Guide](#contributor-guide)
13
* [Human Interface Guidelines](#hig)
14
* [Core Pd Notes](#core-pd-notes)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
15
* [GUI Message Spec](#gui-messaging-specification)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
16

pokergaming's avatar
pokergaming committed
17
### One Paragraph Overview
pokergaming's avatar
pokergaming committed
18

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

Jonathan Wilkes's avatar
Jonathan Wilkes committed
24
### Flavors of Pure Data
pokergaming's avatar
pokergaming committed
25
26

There are currently three main distributions of Pure Data:
pokergaming's avatar
pokergaming committed
27

28
29
1. Pd-L2Ork.  Version used by Ivica Bukvic for his laptop orchestra.  This
   guide is for Pd-L2Ork.
pokergaming's avatar
pokergaming committed
30
31
32
33
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.
2. Pure Data Extended.  A monolithic distribution which ships with lots of
Jonathan Wilkes's avatar
Jonathan Wilkes committed
34
   external libraries.  As of August 2015 it hasn't been updated since January 2014.
pokergaming's avatar
pokergaming committed
35
36

### Three Paragraph Overview
pokergaming's avatar
pokergaming committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

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.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
54
### Goals
pokergaming's avatar
pokergaming committed
55

56
Pd-L2ork has the following goals:
pokergaming's avatar
pokergaming committed
57

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

Jonathan Wilkes's avatar
Jonathan Wilkes committed
68
### Installation Guide
pokergaming's avatar
pokergaming committed
69
70
71
72
73
74
75
76
77
78
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

Jonathan Wilkes's avatar
Jonathan Wilkes committed
79
### Contributor Guide
pokergaming's avatar
pokergaming committed
80

pokergaming's avatar
pokergaming committed
81
Contributing is easy:
pokergaming's avatar
pokergaming committed
82

pokergaming's avatar
pokergaming committed
83
84
85
86
87
88
89
90
91
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
92
   it, then follow the Pd-L2Ork goals above.
pokergaming's avatar
pokergaming committed
93

pokergaming's avatar
pokergaming committed
94
95
Here are some of the current tasks:

96
* coming up with a better name than Pd-L2Ork. :)
pokergaming's avatar
pokergaming committed
97
98
  * skills needed: creativity, basic knowledge about programming in Pd
  * status: no work done on this yet
pokergaming's avatar
pokergaming committed
99
* writing small audio/visual Pd games or demos to include in the next release
pokergaming's avatar
pokergaming committed
100
  * skills needed: ability to write Pd programs
pokergaming's avatar
pokergaming committed
101
  * status: I wrote a little sprite-based game that will ship with the next
102
    version of Pd-L2Ork.  In it, the character walks around in an actual
pokergaming's avatar
pokergaming committed
103
104
105
106
107
    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.
108
* porting Pd-L2Ork's graphical user interface from Tcl/Tk to Qt.
pokergaming's avatar
pokergaming committed
109
  * skills needed: knowledge about Qt5/QML, threading, and Pd's core design
pokergaming's avatar
pokergaming committed
110
111
    and deterministic message-dispatching and scheduling
  * status: under active development
pokergaming's avatar
pokergaming committed
112
* designing/implementing regression test template
pokergaming's avatar
pokergaming committed
113
  * skills needed: knowledge about... regression tests. :)  But also some
pokergaming's avatar
pokergaming committed
114
115
116
117
118
119
120
121
122
123
124
125
126
    expertise in using Pd so that the tests themselves can
    be written in Pure Data.  At the same time, they should
    be able to be run as part of the automated packaging
    process (i.e., in -nogui mode).
  * status: some externals have their own testing environments, but they are
    limited as they require manual intervention to run and read the
    results inside a graphical window.
    Here's an email thread with Katja Vetter's design, which looks to
    be automatable:
    http://markmail.org/message/t7yitfc55anus76i#query:+page:1+mid:chb56ve7kea2qumn+state:results
    And Mathieu Bouchard's "pure unity" (not sure if this is the most
    recent link...):
    http://sourceforge.net/p/pure-data/svn/HEAD/tree/tags/externals/pureunity/pureunity-0.0/
pokergaming's avatar
pokergaming committed
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
### Human Interface Guidelines

#### General Look and Feel

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

1. A main window, called the "Pd Window" or "Console Window". This window
   displays informational and error messages for Pd programs.
2. One or more "canvas" windows-- aka "patch" windows, used to display the
   diagrams that make up a Pd program.
3. One or more dialog windows used to configure the various parts of Pd.

All should look simple and uncluttered. Although "canvas" windows cannot
(yet) be traversed and edited using only the keyboard, all three parts of Pd
should be designed so that they can be manipulated using only the keyboard.

### Hooks for new users
It should also be possible to produce sound and interact when a new user runs
program for the very first time. In every release, there should be a link at
the bottom of the Console Window to a short game written in Pd that demonstrates
one or more of the capabilities of the Pd environment. The game should be
designed to be fun outside of its efficacy as a demonstration of Pd.

#### Fonts
Pd ships with "DejaVu Sans Mono", which is used for the text in canvas windows.
Fonts are sized to fit the hard-coded constraints in Pd Vanilla. This way box
sizes will match as closely as possible across distributions and OSes.

These hard-coded sizes are maximum character widths and heights. No font
fits these maximums exactly, so it's currently impossible to tell when looking
at a Pd canvas whether the objects will collide on a system using a different
font (or even a different font-rendering engine).

Dialogs and console button labels may use variable-width fonts. There is not
yet a suggested default to use for these.

The console printout area currently uses "DejaVu Sans Mono". Errors are printed
as a link so that the user can click them to highlight the corresponded canvas
or object that triggered the error.

#### Colors

Nothing set in stone yet.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
172
### Core Pd Notes
pokergaming's avatar
pokergaming committed
173

pokergaming's avatar
pokergaming committed
174
175
The following is adapted from Pd Vanilla's original source notes.  (Found
in pd/src/CHANGELOG.txt for some reason...)
pokergaming's avatar
pokergaming committed
176
177
178
179

Sections 2-3 below are quite old.  Someone needs to check whether they even
hold true for Pd Vanilla any more.

pokergaming's avatar
pokergaming committed
180
181
182
#### Structure definition roadmap.

First, the containment tree of things
pokergaming's avatar
pokergaming committed
183
184
185
186
that can be sent messages ("pure data").  (note that t_object and t_text,
and t_graph and t_canvas, should be unified...)

BEFORE 0.35:
pokergaming's avatar
pokergaming committed
187

pokergaming's avatar
pokergaming committed
188
189
190
191
192
193
194
195
    m_pd.h	    t_pd    	    	    anything with a class
                    t_gobj	    	    "graphic object"
                        t_text  	    text object
    g_canvas.h  
                        t_glist 	    list of graphic objects
    g_canvas.c  	    	t_canvas    Pd "document"

AFTER 0.35:
pokergaming's avatar
pokergaming committed
196

pokergaming's avatar
pokergaming committed
197
198
199
200
201
202
    m_pd.h	    t_pd    	    	    anything with a class
                    t_gobj	    	    "graphic object"
                        t_text  	    patchable object, AKA t_object
    g_canvas.h     	    	t_glist     list of graphic objects, AKA t_canvas

Other structures:
pokergaming's avatar
pokergaming committed
203
204
205
206
207
208
209

    g_canvas.h  t_selection -- linked list of gobjs
                t_editor -- editor state, allocated for visible glists
    m_imp.h     t_methodentry -- method handler
                t_widgetbehavior -- class-dependent editing behavior for gobjs
                t_parentwidgetbehavior -- objects' behavior on parent window
                t_class -- method definitions, instance size, flags, etc.
pokergaming's avatar
pokergaming committed
210

pokergaming's avatar
pokergaming committed
211
#### 1. Coding Style
pokergaming's avatar
pokergaming committed
212

pokergaming's avatar
pokergaming committed
213
1.0  C coding style.  The source should pass most "warnings" of C compilers
pokergaming's avatar
pokergaming committed
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
(-Wall on linux, for instance; see the makefile.)  Some informalities
are intentional, for instance the loose use of function prototypes (see
below) and uncast conversions from longer to shorter numerical formats.
The code doesn't respect "const" yet.

1.1.  Prefixes in structure elements.  The names of structure elements always
have a K&R-style prefix, as in ((t_atom)x)->a_type, where the "a_" prefix
indicates "atom."  This is intended to enhance readability (although the
convention arose from a limitation of early C compilers.)  Common prefixes are
"w_" (word), "a_" (atom), "s_" (symbol), "ob_" (object), "te_" (text object),
"g_" (graphical object), and "gl_" (glist, a list of graphical objects).  Also,
global symbols sometimes get prefixes, as in "s_float" (the symbol whose string
is "float).  Typedefs are prefixed by "t_".  Most _private_ structures, i.e.,
structures whose definitions appear in a ".c" file, are prefixed by "x_".

1.2.   Function arguments.  Many functions take as their first
argument a pointer named "x", which is a pointer to a structure suggested
by the function prefix; e.g., canvas_dirty(x, n) where "x" points to a canvas
(t_canvas *x).

1.3.  Function Prototypes.  Functions which are used in at least two different
files (besides where they originate) are prototyped in the appropriate include
file. Functions which are provided in one file and used in one other are
prototyped right where they are used.  This is just to keep the size of the
".h" files down for readability's sake.

1.4.  Whacko private terminology.  Some terms are lifted from other historically
relevant programs, notably "ugen" (which is just a tilde object; see d_ugen.c.)

1.5.  Spacing.  Tabs are 8 spaces; indentation is 4 spaces.  Indenting
curly brackets are by themselves on their own lines, as in:

Jonathan Wilkes's avatar
Jonathan Wilkes committed
246
247
248
249
250
251
```c
if (x)
{
    x = 0;
}
```
pokergaming's avatar
pokergaming committed
252
253
254

Lines should fit within 80 spaces.

pokergaming's avatar
pokergaming committed
255
256
257
#### 2. Compatibility with Max

2.0.  Max patch-level compatibility.  "Import" and "Export" functions are
pokergaming's avatar
pokergaming committed
258
259
260
261
262
263
264
provided which aspire to strict compatibility with 0.26 patches (ISPW version),
but which don't get anywhere close to that yet.  Where possible, features
appearing on the Mac will someday also be provided; for instance, the connect
message on the Mac offers segmented patch cords; these will devolve into
straight lines in Pd.  Many, many UI objects in Opcode Max will not appear in
Pd, at least at first.

pokergaming's avatar
pokergaming committed
265
266
267
#### 3. Source-level Compatibility with Max

3.0.  Compatibility with Max 0.26 "externs"-- source-level compatibility. Pd
pokergaming's avatar
pokergaming committed
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
objects follow the style of 0.26 objects as closely as possible, making
exceptions in cases where the 0.26 model is clearly deficient.  These are:

3.1.  Anything involving the MacIntosh "Handle" data type is changed to use
char * or void * instead.

3.2.  Pd passes true single-precision floating-point arguments to methods;
Max uses double.
Typedefs are provided:
    t_floatarg, t_intarg for arguments passed by the message system
    t_float, t_int for the "word" union (in atoms, for example.)

3.3.  Badly-named entities got name changes:

    w_long --> w_int (in the "union word" structure)

3.4.  Many library functions are renamed and have different arguments;
I hope to provide an include file to alias them when compiling Max externs.

pokergaming's avatar
pokergaming committed
287
288
289
#### 4. Function name prefixes

4.0.  Function name prefixes.
pokergaming's avatar
pokergaming committed
290
291
Many function names have prefixes which indicate what "package" they belong
to.  The exceptions are:
pokergaming's avatar
pokergaming committed
292

pokergaming's avatar
pokergaming committed
293
294
295
296
297
    typedmess, vmess, getfn, gensym (m_class.c)
    getbytes, freebytes, resizebytes (m_memory.c)
    post, error, bug (s_print.c)
which are all frequently called and which don't fit into simple categories.
Important packages are:
pokergaming's avatar
pokergaming committed
298
299
300
301
302
303
304
    (pd-gui:)   pdgui -- everything
    (pd:)	    pd -- functions common to all "pd" objects
                obj -- fuctions common to all "patchable" objects ala Max
                sys -- "system" level functions
                binbuf -- functions manipulating binbufs
                class -- functions manipulating classes
                (other) -- functions common to the named Pd class
pokergaming's avatar
pokergaming committed
305

pokergaming's avatar
pokergaming committed
306
307
308
#### 5. Source file prefixes

5.0. Source file prefixes. 
pokergaming's avatar
pokergaming committed
309
310
311
312
313
314
315
316
317
318
PD:
s    system interface
m    message system
g    graphics stuff
d    DSP objects
x    control objects
z    other

PD-GUI:
t    TK front end
Jonathan Wilkes's avatar
Jonathan Wilkes committed
319
320

### GUI Messaging Specification
Jonathan Wilkes's avatar
Jonathan Wilkes committed
321
#### Public GUI interface
Jonathan Wilkes's avatar
Jonathan Wilkes committed
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342

Purpose: a set of functions to communicate with the gui without putting
language-specific strings (like tcl) into the C code.  The new interface is a
step toward separating some (but not all) of the GUI logic out from the C code.
Of course the GUI can still be designed to parse and evaluate incoming messages
as commands.  But the idiosyncracies of the GUI toolkit can be limited to
either the GUI code itself or to a small set of modular wrappers around
sys_vgui.

The public interface consists of the following:

```c
gui_vmess(const char *msg, const char *format, ...);
```

where const char *format consists of zero or more of the following:

* f - floating point value (t_float)
* i - integer (int)
* s - c string (char*)
* x - hexadecimal integer value, with a precision of at least six digits.
Jonathan Wilkes's avatar
Jonathan Wilkes committed
343
      (hex value is preceded by an 'x', like "x123456")
Jonathan Wilkes's avatar
Jonathan Wilkes committed
344
345
346
347
348

For some of Pd's internals like array visualization, the message length may
vary. For these _special_ cases, the following functions allow the developer
to iteratively build up a message to send to the GUI.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
349
350
```c
gui_start_vmess(const char *msg, const char *format, ...);
Jonathan Wilkes's avatar
Jonathan Wilkes committed
351
352
353
354
355
356
gui_start_array();      // start an array
gui_f(t_float float);   // floating point array element (t_float)
gui_i(int int);         // integer array element (int)
gui_s(const char *str); // c string array element
gui_end_array();        // end an array
gui_end_vmess();        // terminate the message
Jonathan Wilkes's avatar
Jonathan Wilkes committed
357
358
359
360
361
362
363
364
365
366
367
368
```

The above will send a well-formed message to the GUI, where the number of array
elements are limited by the amount of memory available to the GUI. Because of
the complexity of this approach, it may _only_ be used when it is necessary to
send a variable length message to the GUI. (Some of the current code may
violate this rule, but that can be viewed as a bug which needs to get fixed.)

The array element functions gui_f, gui_i, and gui_s may only be used inside an
array.  Arrays may be nested, but this adds complexity and should be avoided if
possible.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
369
#### Private Wrapper for Nw.js Port
Jonathan Wilkes's avatar
Jonathan Wilkes committed
370
371
372
373
374
375
376
377
378
379
380
381
382
383

The public functions above should fit any sensible message format.
Unfortunately, Pd's message format (FUDI) is too simplistic to handle arbitrary
c-strings and arrays, so it cannot be used here. (But if it happens to improve
in the future it should be trivial to make a wrapper for the public interface
above.)

The current wrapper was made with the assumption that there is a Javascript
Engine at the other end of the message. Messages consist of a selector,
followed by whitespace, followed by a comman-delimited list of valid Javascript
primitives (numbers, strings, and arrays). For the arrays, Javascript's array
notation is used. This is a highly idiosyncratic, quick-and-dirty approach.
But the point is that the idiosyncracy exists in a single file of the source
code, and can be easily made more modular (or replaced entirely by something
384
else) without affecting _any_ of the rest of the C code.