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

3
maintainers:
pokergaming's avatar
pokergaming committed
4

5
6
7
* Ivica Ico Bukvic <ico@vt.edu>
* Albert Graef <aggraef@gmail.com>
* Jonathan Wilkes <jancsika@yahoo.com>
Jonathan Wilkes's avatar
Jonathan Wilkes committed
8

9
[Downloads](https://github.com/jonwwilkes/purr-data/releases)
pokergaming's avatar
pokergaming committed
10

11
[Mailing List](http://disis.music.vt.edu/cgi-bin/mailman/listinfo/l2ork-dev)
12

13
14
15
* [One Paragraph Overview](#one-paragraph-overview)
* [Three Paragraph Overview](#three-paragraph-overview)
* [Goals](#goals)
Rishabh Gupta's avatar
Rishabh Gupta committed
16
* [Relationship of Purr Data to Pure Data](#relationship-of-purr-data-to-pure-data)
17
18
* [Downloads](#downloads)
* [Build Guide](#build-guide)
19
20
21
  * [Gnu/Linux](#linux)
  * [OSX](#osx-64-bit-using-homebrew)
  * [Windows](#windows-32-bit-using-msys2)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
22
* [Code of Conduct](#code-of-conduct)
23
* [Contributor Guide](#contributor-guide)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
24
* [Human Interface Guidelines](#human-interface-guidelines)
25
* [Core Pd Notes](#core-pd-notes)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
26
* [GUI Message Spec](#gui-messaging-specification)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
27

pokergaming's avatar
pokergaming committed
28
### One Paragraph Overview
pokergaming's avatar
pokergaming committed
29

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

pokergaming's avatar
pokergaming committed
35
36
37


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

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
55
### Goals
pokergaming's avatar
pokergaming committed
56

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

pokergaming's avatar
pokergaming committed
59
60
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
61
62
   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
63
3. Be discoverable.  Undocumented features are buggy.  Missing help files are
pokergaming's avatar
pokergaming committed
64
   bugs.  Patches for new functionality that lack documentation are spam.
pokergaming's avatar
pokergaming committed
65
4. Be consistent.  Consistent interfaces are themselves a kind of
pokergaming's avatar
pokergaming committed
66
   documentation.  We like documentation, so it follows that we like consistent
67
   interfaces.
pokergaming's avatar
pokergaming committed
68

Rishabh Gupta's avatar
Rishabh Gupta committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
### Relationship of Purr Data to Pure Data

There are three maintained distributions of Pure Data:

1. Purr Data. This is the 2.0 version of Pd-l2ork. It ships with lots of
   external libraries and uses a modern GUI written using HTML5.
2. Pd-L2Ork 1.0, the version used by Ivica Bukvic for his laptop orchestra.
   Pd-l2ork 1.0 uses tcl/tk (and tkpath) for the GUI. You can find it
   [here](http://l2ork.music.vt.edu/main/make-your-own-l2ork/software/)
3. Pure Data "Vanilla".  Miller Puckette's personal version which he hosts on
   his website and maintains.  It doesn't come with external libraries
   pre-installed, but it does include an interface you can use to search
   and install external libraries maintained and packaged by other developers.

83
84
85
86
87
### Downloads

You can download a precompiled installer for Gnu/Linux, Windows, or OSX
from the following site:

88
[https://github.com/jonwwilkes/purr-data/releases](https://github.com/jonwwilkes/purr-data/releases)
89
90

### Build Guide
91

92
93
94
95
96
97
98
99
100
**NOTE:** The instructions below talk about running the `tar_em_up.sh` build
script, which is still the recommended way to build Purr Data right now.
However, Purr Data also has a new (and experimental) toplevel Makefile so that
just typing `make` will build the package. You may find this easier. The
Makefile also offers the customary targets to clean (`make clean`, or
`make realclean` to put the sources in pristine state again) and to roll a
self-contained distribution tarball (`make dist`). Please check the comments
at the beginning of the Makefile for more information.

101
#### Linux
102
103

Time to build: *40 minutes to 1.5 hours*  
104
Hard drive space required: *roughly 2.5 GB*
105

106
107
1. Install the dependencies

108
        sudo apt-get install bison flex automake libasound2-dev \
109
110
111
112
113
             libjack-jackd2-dev libtool libbluetooth-dev libgl1-mesa-dev \
             libglu1-mesa-dev libglew-dev libmagick++-dev libftgl-dev \
             libgmerlin-dev libgmerlin-avdec-dev libavifile-0.7-dev \
             libmpeg3-dev libquicktime-dev libv4l-dev libraw1394-dev \
             libdc1394-22-dev libfftw3-dev libvorbis-dev ladspa-sdk \
114
115
             dssi-dev tap-plugins invada-studio-plugins-ladspa blepvco \
             swh-plugins mcp-plugins cmt blop slv2-jack omins rev-plugins \
116
117
             libslv2-dev dssi-utils vco-plugins wah-plugins fil-plugins \
             mda-lv2 libmp3lame-dev libspeex-dev libgsl0-dev \
118
             portaudio19-dev liblua5.3-dev python-dev libsmpeg0 libjpeg62-turbo \
Jonathan Wilkes's avatar
Jonathan Wilkes committed
119
             flite1-dev libgsm1-dev libgtk2.0-dev git libstk0-dev \
120
             libsndobj-dev libfluidsynth-dev fluid-soundfont-gm byacc
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

2. Clone the Purr-Data repository *(10 minutes)*

        git clone https://git.purrdata.net/jwilkes/purr-data.git

4. Change to the directory

        cd purr-data/l2ork_addons

5. Run the installer *(15 minutes)*  
   Choose one of the following options:
   * to build a deb installer, type `./tar_em_up.sh -B`
   * to build an rpi deb installer, type `./tar_em_up.sh -R`
   * for a generic tar installer type `./tar_em_up.sh -F`

6. When the installer finishes, type

        cd ..

7. There should now be a .deb file in your current directory


pokergaming's avatar
pokergaming committed
143
144
145
146
147
148
149
150
151
152
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

153
#### OSX 64-bit using Homebrew
154
155

Time to build: *50 minutes to 1.5 hours*  
156
Hard drive space required: *roughly 2 GB*
157

158
1. Install [Homebrew](https://brew.sh) *(15 minutes)*
159
   (asks for password twice-- once for command line tools, once for homebrew)
160
161
162
163
164
165
166
167
168

2. Install the dependencies *(10 minutes)*:

        brew install wget
        brew install autoconf
        brew install automake
        brew install libtool
        brew install fftw
        brew install python
169
        brew install lua
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
        brew install fluidsynth
        brew install lame
        brew install libvorbis
        brew install speex
        brew install gsl
        brew install libquicktime
        brew install pkg-config

3. Clone the Purr-Data repository *(10 minutes)*

        git clone https://git.purrdata.net/jwilkes/purr-data.git

4. Change to the directory

        cd purr-data/l2ork_addons

5. Run the installer *(15 minutes)*

        ./tar_em_up.sh -X

6. When the installer finishes, type

        cd ..

194
7. There should now be a .dmg file in your current directory
195

196
#### Windows 32-bit Using msys2
197
198

Time to build: *roughly 1.5 hours-- 30 minutes of this is for Gem alone*  
199
Hard drive space required to build: *rougly 2.5 GB*
Jonathan Wilkes's avatar
Jonathan Wilkes committed
200

201
202
203
204
Important note: check the name of your Windows user account. If it has a space
in it-- like "My Home Computer" or "2nd Laptop", then **stop**. You may not
use this guide.  (Actually you can probably just install everything in ~/.. in
that case, but I haven't tested doing it like that. Sorry. Get a better OS...)
205

Jonathan Wilkes's avatar
Jonathan Wilkes committed
206
1. Download and install [msys2](https://msys2.github.io/) *(5 minutes)*  
207
208
209
210
211
212
213
   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](http://windows.microsoft.com/en-us/windows/32-bit-and-64-bit-windows#1TC=windows-7)
   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.

214
2. Download and install [inno setup](http://www.jrsoftware.org/isdl.php) *(5 minutes)*
215

216
3. Run MinGW-w64 Win32 Shell *(less than a minute)*  
217
218
219
220
221
   msys2 adds three Start Menu items for different "flavors" of shell:
    + MinGW-w64 __Win32__ Shell <- click this one!
    + MinGW-w64 Win64 Shell
    + MSYS Shell

222
4. Install the dependencies *(5-10 minutes)*  
Jonathan Wilkes's avatar
Jonathan Wilkes committed
223
   Once the shell opens, we need to install the dependencies for building
224
225
226
   Purr Data. Issue the following command:

        pacman -S autoconf automake git libtool \
227
          make mingw-w64-i686-dlfcn mingw-w64-i686-fftw \
228
          mingw-w64-i686-fluidsynth \
229
          mingw-w64-i686-ftgl mingw-w64-i686-fribidi \
230
231
          mingw-w64-i686-ladspa-sdk mingw-w64-i686-lame \
          mingw-w64-i686-libsndfile mingw-w64-i686-libvorbis \
232
          mingw-w64-i686-lua mingw-w64-i686-toolchain \
233
          mingw-w64-i686-libjpeg-turbo \
234
235
236
          rsync unzip wget

5. Download the source code *(3-6 minutes)*  
Jonathan Wilkes's avatar
Jonathan Wilkes committed
237
   Issue the following command to create a new directory "purr-data" and clone
238
239
240
241
242
243
244
245
246
247
248
249
   the repository to it:

        git clone https://git.purrdata.net/jwilkes/purr-data.git

6. Enter the purr-data/l2ork_addons directory *(less than a minute)*

        cd purr-data/l2ork_addons

7. Finally, build Purr-Data *(45-80 minutes)*

        ./tar_em_up.sh -Z

250
8. Look in purr-data/packages/win32_inno/Output and click the setup file to
251
   start installing Purr Data to your machine.
252

253
254
### Code of Conduct

255
1. No sarcasm, please
256
2. Don't appear to lack empathy
Jonathan Wilkes's avatar
Jonathan Wilkes committed
257
258
259
260
261
262
263
264
3. You can't live here. If you're spending hours a day writing Purr Data
   code or-- worse-- spending hours a day *writing emails about* code that 
   has yet to be written, you're doing it wrong
4. If working on something for the first time, ask to be mentored
5. If no one asked you to mentor them, don't teach
6. It is better to let small things go then to risk taking time away from
   solving bigger problems

Jonathan Wilkes's avatar
Jonathan Wilkes committed
265
266
It is a bad idea to break this Code of Conduct *even if* no one complains
about your behavior.
267

Jonathan Wilkes's avatar
Jonathan Wilkes committed
268
### Contributor Guide
pokergaming's avatar
pokergaming committed
269

pokergaming's avatar
pokergaming committed
270
Contributing is easy:
pokergaming's avatar
pokergaming committed
271

pokergaming's avatar
pokergaming committed
272
273
1. Join the development list:
   http://disis.music.vt.edu/cgi-bin/mailman/listinfo/l2ork-dev
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
2. Fork Purr Data using the gitlab UI and then try to build it from source
   for your own platform using the [Build Guide](#build-guide) above. 
   If you run into problems ask on the development list for help.
3. Once you have successfully built Purr Data, install it and make sure it
   runs correctly.
4. Start making changes to the code with brief, clear commit messages. If you
   want some practice you can try fixing one of the bugs on the issue tracker
   labeled
   ["good-first-bug"](https://git.purrdata.net/jwilkes/purr-data/issues?label_name%5B%5D=good-first-bug)
5. One you are done fixing the bug or adding your feature, make a merge request
   in the Gitlab UI so we can merge the fix for the next release.

A few guidelines:
* _No prototypes, please_. Purr Data's biggest strength is that users can
  turn an idea into working code very quickly. But a prototyping language that 
  is itself a prototype isn't very useful. That means Purr Data's core code
  and libraries must be stable, consistent, well-documented, and easy to use.
* Develop incrementally. Small, solid improvements to the software are
  preferable to large, disruptive ones.
293
294
* Try not to duplicate existing functionality.
  For backwards compatibility Purr Data ships many legacy
295
296
297
  libraries which unfortunately duplicate the same functionality. This makes
  it harder to learn how to use Pd, and makes it burdensome to read patches
  and keep track of all the disparate implementations.
298
299
300
301
302
* Keep dependencies to a minimum. Cross-platform dependency handling is
  unfortunately still an open research problem. In the even that you need
  an external library dependency, please mirror it at git.purrdata.net
  so that the build system doesn't depend on the availability of external
  infrastructure.
pokergaming's avatar
pokergaming committed
303

pokergaming's avatar
pokergaming committed
304
305
306
Here are some of the current tasks:

* writing small audio/visual Pd games or demos to include in the next release
pokergaming's avatar
pokergaming committed
307
  * skills needed: ability to write Pd programs
pokergaming's avatar
pokergaming committed
308
  * status: I wrote a little sprite-based game that will ship with the next
309
    version of Pd-L2Ork.  In it, the character walks around in an actual
pokergaming's avatar
pokergaming committed
310
311
312
313
314
    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.
pokergaming's avatar
pokergaming committed
315
* designing/implementing regression test template
pokergaming's avatar
pokergaming committed
316
  * skills needed: knowledge about... regression tests. :)  But also some
pokergaming's avatar
pokergaming committed
317
318
319
320
321
322
323
    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.
324
325
    We currently have a crude test system that at least ensures that each
    external library instantiates without crashing.
pokergaming's avatar
pokergaming committed
326
327
328
329
330
331
    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
332

333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
### 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
377
### Core Pd Notes
pokergaming's avatar
pokergaming committed
378

pokergaming's avatar
pokergaming committed
379
380
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
381
382

Sections 2-3 below are quite old.  Someone needs to check whether they even
383
hold true for Pd Vanilla anymore.
pokergaming's avatar
pokergaming committed
384

pokergaming's avatar
pokergaming committed
385
386
387
#### Structure definition roadmap.

First, the containment tree of things
pokergaming's avatar
pokergaming committed
388
389
390
391
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
392

393
394
395
396
397
398
    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"
pokergaming's avatar
pokergaming committed
399
400

AFTER 0.35:
pokergaming's avatar
pokergaming committed
401

402
403
404
405
    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
pokergaming's avatar
pokergaming committed
406
407

Other structures:
pokergaming's avatar
pokergaming committed
408
409
410
411
412
413
414

    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
415

pokergaming's avatar
pokergaming committed
416
#### 1. Coding Style
pokergaming's avatar
pokergaming committed
417

pokergaming's avatar
pokergaming committed
418
1.0  C coding style.  The source should pass most "warnings" of C compilers
419
(-Wall on Linux, for instance-- see the makefile.)  Some informalities
pokergaming's avatar
pokergaming committed
420
421
422
423
424
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
425
have a K&R-style prefix, as in `((t_atom)x)->a_type`, where the `a_` prefix
pokergaming's avatar
pokergaming committed
426
indicates "atom."  This is intended to enhance readability (although the
427
428
429
430
431
432
433
434
435
436
437
438
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)
  * `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_`.
pokergaming's avatar
pokergaming committed
439
440

1.2.   Function arguments.  Many functions take as their first
441
442
443
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)`.
pokergaming's avatar
pokergaming committed
444
445
446
447
448
449
450
451
452
453
454
455
456

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
457
458
459
460
461
462
```c
if (x)
{
    x = 0;
}
```
pokergaming's avatar
pokergaming committed
463
464
465

Lines should fit within 80 spaces.

pokergaming's avatar
pokergaming committed
466
467
468
#### 2. Compatibility with Max

2.0.  Max patch-level compatibility.  "Import" and "Export" functions are
pokergaming's avatar
pokergaming committed
469
470
471
472
473
474
475
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
476
477
478
#### 3. Source-level Compatibility with Max

3.0.  Compatibility with Max 0.26 "externs"-- source-level compatibility. Pd
pokergaming's avatar
pokergaming committed
479
480
481
482
483
484
485
486
487
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:
488

pokergaming's avatar
pokergaming committed
489
490
491
492
493
494
495
496
497
498
    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
499
500
501
#### 4. Function name prefixes

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

pokergaming's avatar
pokergaming committed
505
506
507
508
509
    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:
510

pokergaming's avatar
pokergaming committed
511
    (pd-gui:)   pdgui -- everything
512
    (pd:)       pd -- functions common to all "pd" objects
pokergaming's avatar
pokergaming committed
513
514
515
516
517
                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
518

pokergaming's avatar
pokergaming committed
519
520
521
#### 5. Source file prefixes

5.0. Source file prefixes. 
522

pokergaming's avatar
pokergaming committed
523
PD:
524

Jonathan Wilkes's avatar
Jonathan Wilkes committed
525
526
527
528
529
530
    s    system interface
    m    message system
    g    graphics stuff
    d    DSP objects
    x    control objects
    z    other
pokergaming's avatar
pokergaming committed
531
532

PD-GUI:
533

Jonathan Wilkes's avatar
Jonathan Wilkes committed
534
    gui    GUI front end
535
536
537
538
539
540

#### 6. Javascript style
1. Brackets on the same line as declaration or expression: `if (a) {`
2. Single line comments only: `//`
3. Use double-quotes for strings
4. Use underscores to separate words of function names and variables
Jonathan Wilkes's avatar
Jonathan Wilkes committed
541
542

### GUI Messaging Specification
Jonathan Wilkes's avatar
Jonathan Wilkes committed
543
#### Public GUI interface
Jonathan Wilkes's avatar
Jonathan Wilkes committed
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558

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, ...);
```

559
where `const char *format` consists of zero or more of the following:
Jonathan Wilkes's avatar
Jonathan Wilkes committed
560

561
562
563
* f - floating point value (`t_float`)
* i - integer (`int`)
* s - c string (`char*	)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
564
* x - hexadecimal integer value, with a precision of at least six digits.
565
      (hex value is preceded by an 'x', like `x123456`)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
566
567
568
569
570

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
571
572
```c
gui_start_vmess(const char *msg, const char *format, ...);
Jonathan Wilkes's avatar
Jonathan Wilkes committed
573
574
575
576
577
578
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
579
580
581
582
583
584
585
586
587
588
589
590
```

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
591
#### Private Wrapper for Nw.js Port
Jonathan Wilkes's avatar
Jonathan Wilkes committed
592
593
594
595
596
597
598
599
600
601
602
603
604
605

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
Rishabh Gupta's avatar
Rishabh Gupta committed
606
else) without affecting _any_ of the rest of the C code.