README.md 29.3 KB
Newer Older
Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
1
[Automated Testing Framework](#automated-testing-framework)
2

3
[Inject Purr Data Directly into the Web](#inject-purr-data-directly-into-the-web)
4

Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
5
[API for HTML5 Web Apps](#api-for-html5-web-apps)
6

Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
7
[K12 Mode](#k12-mode)
8

Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
9
[Profile and Optimize Purr Data for Realtime Safety](#profile-and-optimize-purr-data-for-realtime-safety)
10

Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
11
[ASCII art to Purr Data diagram conversion](#ascii-art-to-purr-data-diagram-conversion)
12

Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
13
[Navigation of "Wireless" Objects](#navigation-of-wireless-objects)
14

Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
15
[Terminal REPL](#terminal-repl)
16

Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
17
[Core Accessibility](#core-accessibility)
18

Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
19
[Purr Data Message and DSP Profiler](#purr-data-message-and-dsp-profiler)
20

Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
21
22
[Streamlining Purr Data GUI-Pd communication](#streamlining-purr-data-gui-pd-communication)

Jonathan Wilkes's avatar
Jonathan Wilkes committed
23
24
[Vintage Platform Audio Emulation Library](#vintage-platform-audio-emulation-library)

25
[Library for Data-Over-Audio Communication](#data-over-audio-messaging)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
26

Jonathan Wilkes's avatar
Jonathan Wilkes committed
27
[Interaction with Audio Plugins](#interaction-with-audio-plugins)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
28

Jonathan Wilkes's avatar
Jonathan Wilkes committed
29
[JIT-compiled signal graph for the audio engine](#jit-compiled-signal-graph-for-the-audio-engine)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
30

Jonathan Wilkes's avatar
Jonathan Wilkes committed
31
32
33
Automated Testing Framework
---------------------------

Jonathan Wilkes's avatar
Jonathan Wilkes committed
34
### Goal
Jonathan Wilkes's avatar
Jonathan Wilkes committed
35
36
Build a testing framework that covers most methods of internal
and external classes. This should include the "dsp"
Jonathan Wilkes's avatar
Jonathan Wilkes committed
37
38
39
method of all signal-based externals, so that we can compare the block output
of each across commits to serve as both a regression and code coverage test.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
40
41
### Benefits
This will help developers catch bugs earlier in the development process,
Jonathan Wilkes's avatar
Jonathan Wilkes committed
42
43
44
leading to overall cleaner code in merge requests and less disruption to
users from regressions.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
45
46
47
### Difficulty level
Moderate. One challenge is that not all classes
have sane defaults for their methods. For example, the internal
48
49
50
51
class [until] will iterate in an infinite loop when the "bang" method is
invoked. Even with external libraries, such poor defaults are entrenched. A
robust testing system must therefore work around these challenges.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
52
53
Another challenge is that many external libraries have
never been tested at all. Many are not 64-bit clean.
54
55
56
57
A maintainable and sensible testing system will therefore take an incremental
approach, starting with the most well-tested and popular libraries and
branching out from there to the more obscure ones.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
58
59
### Languages
Testing framework can be fully implemented in Purr Data itself. However, some
60
61
62
familiarity with shell scripting tools and the platforms supported by
Purr Data will be useful (i.e., Windows, OSX, and GNU/Linux).

63
64
Inject Purr Data Directly into the Web
--------------------------------------
Jonathan Wilkes's avatar
Jonathan Wilkes committed
65

Jonathan Wilkes's avatar
Jonathan Wilkes committed
66
### Goal
67
68
Add a WebAssembly target and pure HTML5 GUI framework for running Purr
Data from a browser window
Jonathan Wilkes's avatar
Jonathan Wilkes committed
69

Jonathan Wilkes's avatar
Jonathan Wilkes committed
70
### Benefits
71
72
73
Installing Purr Data is often the biggest hurdle for newcomers. Running
it in a web browser simplifies this process and allows Purr Data to be run
on any device, with any architecture, as long as it has a web browser installed.
Jonathan Wilkes's avatar
Jonathan Wilkes committed
74

Jonathan Wilkes's avatar
Jonathan Wilkes committed
75
### Details
76
77
78
79
80
81
82
83
84
85
86
87
88
For the core, we want to produce a WebAssembly binary that can load a patch
and produce audio using the Web Audio API. If possible, we want to also
leverage Chromium's newer callback-based interface to compute realtime audio
as efficiently as possible.

For the GUI, we need a framework that can display and edit a Pd patch
within a container in a web page. It should be possible to run the core
WebAssembly binary with or without the GUI displayed.

The challenge with the GUI is that Purr Data currently uses multiple
toplevel windows to display a patch and its visible subcanvases, and
properties windows for certain widgets. The framework needs to allow
viewing all of these in a container within a *single* browser window.
89

Jonathan Wilkes's avatar
Jonathan Wilkes committed
90
### Difficulty
91
92
93
Hard. There has been some prior art for building a WebAssembly binary
for the core audio engine. However, the difficulty will lie in building
the GUI framework that has a workable UX within a single browser window.
94

Jonathan Wilkes's avatar
Jonathan Wilkes committed
95
### Languages
96
C, HTML5, and Emscripten
97

98
99
100
API for HTML5 Web Apps
----------------------

Jonathan Wilkes's avatar
Jonathan Wilkes committed
101
102
103
### Goal
Create an API and simple user interface for loading a web app
that can communicate with a Pd patch.
104

Jonathan Wilkes's avatar
Jonathan Wilkes committed
105
106
107
108
109
### Details
Currently Pd patches are essentially just an HTML5 page with
a window/application menu. It should be possible
for the user to instead open an arbitrary HTML document that can communicate
through a javascript interface with a Pd patch.
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

Implementation suggestion: since the current pdgui.js module already has
an interface for sending messages to the Pd backend, we should probably
leverage that to communicate from the web app to Pd. Then it's only
necessary to add a feature that allows a Pd Patch to send messages back
to the web app.

The user should then be able to load an HTML file using the existing
File->Open dialog. Then the web app will need something like the following
interface:

* ability to send messages to Pd (already exists)
* ability to tell Pd to load a particular patch in the same directory as
the web app (or perhaps using Pd's search path).
* ability to close a Pd patch
* ability to specify whether the patch we're loading should default to
  being visible or hidden
* ability to set callbacks for the web app to receive the following events:
  * the Pd patch we wanted to open has loaded
  * the Pd patch we loaded has closed
130

Jonathan Wilkes's avatar
Jonathan Wilkes committed
131
132
### Languages
Javascript. Some basic knowledge of C will be helpful if we need
133
134
135
136
to add a method in the Purr Data engine. However, such methods will probably
be quite simple and won't require implementing any complex algorithms in the
C language.

137
138
139
### Potential Mentor
Jonathan Wilkes

140
141
142
K12 Mode
--------

Jonathan Wilkes's avatar
Jonathan Wilkes committed
143
144
### Goal
Port the K12 Mode that Pd-l2ork introduced.
145

Jonathan Wilkes's avatar
Jonathan Wilkes committed
146
147
### Details
Currently we ship a lot of the K12 abstractions with Purr Data.
148
149
150
151
152
153
154
155
156
157
158
159
160
However, I never ported the special mode that starts the program up in a
"K12" mode that replaces the window/application menubar with a more
user-friendly, clickable object menu.

That mode makes it easier for beginners to get started. In porting it, we
can take advantage of the new HTML5 GUI:
* The menu itself can leverage HTML/CSS to be more responsive, autohide, etc.
* The entire K12 Mode could itself just be a web-app separate from normal
  Pd app operation.

To figure out which is best, it's probably helpful to know more about the
history of K12 mode, and whether the ability to also open and interact with
normal Pd objects turned out to be an important feature.
Jonathan Wilkes's avatar
Jonathan Wilkes committed
161
162
163
Ivica Bukvic has a lot of experience using this mode when teaching
kids, so we can look to him for some more insight into the right path to
take.
164
165
166
167

Either way, this feature vastly improves the usability of Purr Data for new
users, giving them a way to quickly generate sounds and experiment with the
interface.
168

Jonathan Wilkes's avatar
Jonathan Wilkes committed
169
170
### Difficulty
Hard. A lot of the initial implementation of K12 mode was made
171
172
173
174
175
176
in the core engine in C. This will require at least reading a lot of the
source code and making sense of the changes made for K12 mode, plus possibly
refactoring some of that code so that it can be handled in the GUI instead.
On the other hand, there is a working version of the old K12 mode which can
be consulted as a reference implementation.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
177
178
### Languages
Javascript, C, CSS, HTML.
179

180
181
182
### Potential Mentor
Ivica Bukvic, Jonathan Wilkes

183
184
185
Profile and Optimize Purr Data for Realtime Safety
--------------------------------------------------

Jonathan Wilkes's avatar
Jonathan Wilkes committed
186
187
### Goal
Find the "pain points" in Purr Data's core message dispatcher and
188
189
190
audio engine, and optimize the code where possible to improve the realtime
scheduling of DSP.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
191
192
### Details
The core DSP algorithms of Purr Data tend to avoid system calls,
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
unnecessary branching, and other calls which would make the performance of
the audio process unreliable. However, there are many areas of Purr Data
which are not optimized for realtime scheduling.

The first order of business would be to profile Purr Data in several areas
to see where problems may be. Some likely culprits are the following:

* parse time for incoming messages from GUI to the audio/messaging engine
* overhead of sending messages to the GUI, especially for visual arrays and
  drawing instructions for data structures
* overhead of sending streams of "motion" messages from GUI to Pd to track
  mouse position
* overhead of walking the linked list of objects in order to find the object
  under the mouse/mouseclick
* overhead of tracking mouse position over a visual array
* overhead of calculating bboxes in the audio process as opposed to GUI
* overhead of calculating text positioning in audio process as opposed to GUI
* overhead of counting UTF-8 code points in audio process to calculate
  line breaks
* overhead of handling incoming/outgoing socket traffic in the same thread
  as the audio scheduler
* probably other areas

Once we get a sense of the pain points, we can tackle the problem of how
to optimize in a maintainable manner. Some references for this:

* [Guilio Moro's work](https://github.com/giuliomoro/purrdata/commit/9dc3223ece79be5f60a6a629450b52a79b9e050c) on using a separate thread for the socket connections from GUI to the core audio engine (plus all the other socket connections
like netsend, netreceive, etc.)
* Guilio Moro's work on a threaded microsleep for the event loop.
* [Guilio Moro's work](https://github.com/giuliomoro/purrdata/commits/simpler-motion) to simplify GUI communication by handling more of the mouse motion/click
  logic in the GUI. This results in fewer messages from GUI to audio engine,
  but still requires a linked-list walk in the audio engine to find the
  relevant object.
* Matt Barber's link to a new cosine wave generator algorithm that may be
  more performant than the current implementation. (Not so important for
  current performance, but this may become more relevant once we switch to
  double-precision for block samples.)
230
231
232
* Possibility to vectorize DSP algos using SIMD. Also more crude experiments
  by just hand-unrolling one or two classes when N=64 (i.e., the most common
  block size) and measuring the performance impact (if any).
233

234
235
236
237
Note: There may be some overlap with the other profiling idea listed below.
Developers for both ideas may therefore benefit by periodically sharing their
work with each other.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
238
239
### Difficulty
Moderate to hard. The initial profiling will take some time but
240
241
242
243
244
245
isn't particularly challenging. Making changes to the core audio engine,
however, will require some knowledge of Linux system interfaces and some of
Purr Data's internals. Properly assessing and testing any threading techniques
in C is also frought with peril and will require extreme care in order to
keep the code maintainable and avoid insidious bugs.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
246
247
### Languages
Basic to advanced shell scripting, C, plus familiarity with
248
249
profiling tools like gprof and others.

250
251
252
ASCII art to Purr Data diagram conversion
-----------------------------------------

Jonathan Wilkes's avatar
Jonathan Wilkes committed
253
254
### Goal
Make a GUI interface where the user can either type or paste in
255
256
257
ASCII art for a Purr Data diagram and have it converted to a floating selection
in the current Purr Data diagram.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
258
259
### Details
Often Purr Data users rely on ASCII art in forums, mailing lists
260
261
262
263
264
265
266
267
268
and other documentation to give examples of Purr Data programs. This is
convenient because it's quicker than taking a screenshot of the Purr Data
GUI and takes up less space, too.

The ability for the user to type ASCII art into an object box and get a new
selection of a Purr Data object chain would be useful. This would let users
paste ASCII art from the mailing list directly into the interface. It would
also make it easier to create Purr Data diagrams using only the keyboard.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
269
270
### Bonus Goal
Make it possible to convert a subset of Purr Data diagrams into
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
ASCII art.

Bonus Goal Details: Unfortunately Purr Data allows arbitrary positioning
of objects on an integer-based x/y axis. Thus, not all Purr Data diagrams
can be represented as ASCII art.

The bonus goal would add a feature to check if the currently selected Purr
Data diagram is able to be represented using only ASCII art. This could be
either a) a button that does an analysis, or b) realtime feedback to let the
user know when they have positioned an object or connection in such a way
that makes ASCII art impossible.

This is a non-trivial problem. For example, one could add a button to Purr
Data that would constrain object positioning to a predefined grid. Then one
could disallow objects to overlap with each other. Still, the connections
among the various objects (i.e., the arcs which connect the nodes) could
overlap in such a way that makes unambiguous ASCII art impossible.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
289
290
### Difficulty
Easy to hard. This idea runs the gamut-- a simple GUI-side
291
292
293
294
295
296
297
298
299
300
301
parser for simple ASCII art is a quick exercise. Handling some of the more
complicated art with multiple and/or crossed connections is moderate. Scanning
the mailing lists for examples and covering the majority of them is hard.

Additionally, converting an existing Purr Data graphical diagram back to
ASCII art is a difficult problem. This will require reading up on the current
state of the art and comparing various approaches from other fields like
OCR and some of the current work converting Photoshop mockups to HTML pages.
However, Purr Data diagrams tend to be much simpler than arbitrary Photoshop
art, so the problem may be more tractable here than in other fields.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
302
303
### Languages
Javascript if converting ASCII art to Purr Data diagram, C if
304
305
attempting to convert from graphical diagram *back* to ASCII art.

Jonathan Wilkes's avatar
add TOC    
Jonathan Wilkes committed
306
Navigation of Wireless Objects
307
308
--------------------------------

Jonathan Wilkes's avatar
Jonathan Wilkes committed
309
310
### Goal
Make it possible for the user to navigate among all extant wireless
311
312
objects that are bound to a particular symbol.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
313
314
### Details
Purr Data diagrams typically consist of objects-- English words in
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
boxes-- connected by Bezier curves. In a complex diagram, however, the
Bezier curves can end up obscuring the flow of the data in the diagram. For
these instances, "wireless" objects like `[send]` and `[receive]` may be
used to send data from one object to another without making an explicit
connection.

However, such "nonlocal" connections can quickly make diagrams difficult to
maintain. It would be helpful if the user could query a particular "wireless"
object to find out how many other objects it communicates with.

Internally, all related "wireless" objects are bound to the same immutable
symbol. This makes it easy to find all related objects for a given symbol.

Probably the easiest UI for this would be a button to query all related
connections. Once Purr Data's engine finishes the search, it can send back
the ids of all the objects it found. Finally, the gui can just print a list
of hyperlinks to the console. When the user clicks any hyperlink, the
corresponding object can be highlighted (or the relevant diagram brought up
with the object in it highlighted).

Jonathan Wilkes's avatar
Jonathan Wilkes committed
335
### Difficulty
336
Moderate. Purr Data's bindelem and pd_bind API are a little
337
338
339
340
341
342
343
344
tricky if one hasn't used them before. However, once that interface is
understood it is all that is needed to return a complete list of all
nonlocal objects bound to a particular symbol.

The remainder of the problem is easy and can be done in Javascript. However,
this problem "upgrades" gracefully. Once the initial UI is done, it can be
tested on users and iteratively improved from there.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
345
346
### Languages
Javascript, C.
347

348
349
350
Terminal REPL
-------------

Jonathan Wilkes's avatar
Jonathan Wilkes committed
351
352
### Goal
Make a little REPL interface with which the user can interact with
353
354
Purr Data programs and program state.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
355
356
### Details
Purr Data is being used in situations where the hardware is an embedded
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
device. While the current GUI runs on most common hardware including the RPI,
there are situations where it would be more convenient to simply interact using
a text interface (locally or over ssh).

The user can already communicate with Purr Data's audio engine over a socket
connection. So the "read" and "evaluate" part already exists. However, Purr
Data does not print a response nor loop in this situation.

Additionally, the UX of sending raw messages to Purr Data's interpreter is
quite lacking. The syntax for creating new environments and objects was not
meant to be used directly. Objects are referenced by index number, and the
diagrams themselves must be referenced using hex identifiers.

It would be very beneficial to create a REPL UI that is more user-friendly
and well-documented/specified. This way Purr Data users can always interact
with and create programs easily on any embedded device, even if there is
no direct display. (This would also be very handy for debugging purposes.)
374

Jonathan Wilkes's avatar
Jonathan Wilkes committed
375
376
### Difficulty
Moderate. An initial REPL can be created with the current Purr
377
378
379
Data API, but it won't be particularly user-friendly. To achieve that requires
more work and an understanding of Purr Data's message dispatching system.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
380
381
### Languages
C, some shell scripting.
382
383
384
385

Core Accessibility
------------------

Jonathan Wilkes's avatar
Jonathan Wilkes committed
386
387
### Goal
Ensure that Purr Data is accessible by coupling accessibility
388
389
with the core UX

Jonathan Wilkes's avatar
Jonathan Wilkes committed
390
391
### Details
Especially because Purr Data is a graphical environment, it's
392
393
394
395
396
397
398
399
400
401
402
403
404
important to make sure the core functionality is accessible. Rather than
tack on accessibility as an afterthought, Purr Data should have a UX that
makes accessibility features a generally useful part of the programming
environment.

For example: how does one navigate the nodes of a Purr Data diagram? There
should be a way to navigate among the nodes and their connections
without using the mouse. If we make sure that each element in the diagram
is annotated we can tackle accessibility and keyboard navigation at the
same time. Thus, a robust keyboard navigation implementation will help
make it possible for screen readers to give meaningful information about
each node in the graph.

405
406
407
408
Note: there may be some overlap with the REPL idea above, as the REPL could
provide a sensible way for a user to traverse the diagram as an alternative
to using the GUI.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
409
410
### Difficulty
Moderate. For example, it will be necessary to study the current
411
412
413
414
415
GUI implementation to figure out how to extend it to add keyboard navigation.
It will also be necessary to study pre-existing approaches to making SVG
diagrams accessible and study the current state of HTML5 tools that facilitate
this.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
416
417
### Languages
Javascript, HTML, CSS. Some basic C knowledge may be required to
418
419
420
421
422
423
424
send a richer set of data about each object from the core to the GUI. However,
there is already an interface that can do this-- it just needs to be hooked
into the GUI.

Purr Data Message and DSP Profiler
----------------------------------

Jonathan Wilkes's avatar
Jonathan Wilkes committed
425
426
### Goal
Measure the time it takes for each object in a Purr Data diagram to
427
428
process its data and display the results in the diagram.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
429
430
### Details
Purr Data users would benefit greatly from the ability to profile
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
their programs while they are running. This is easy to do for the program
as a whole, but challenging to do per-object.

A successful implementation of this feature will give an accurate measure
of the time it takes each object to process its incoming data. This needs to
support all of Purr Data's platforms: Windows, OSX, and GNU/Linux.

A successful implementation will also be performant enough that the
measurements themselves don't impact the realtime operation of Purr Data
itself.

A now defunct fork of Pure Data called ["DesireData"](http://artengine.ca/desiredata/)
did an initial
implementation of this idea using the x86 RDTSC instruction. (Though its
unlikely this feature was actually stable at the time DesireData was
in active development.) Though this instruction is no longer considered
reliable on modern machines, the overall approach taken by DesireData of
adding a field to the t_gobj struct for storing this timing data is
probably a sound starting point.

451
452
453
454
Note: There may be overlap with the other profiling idea listed above, as
developers on both ideas will probably be using the same tools and can
therefore benefit by periodically sharing their work with each other.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
455
456
### Bonus goal
Figure out a way to meaningfully profile DSP objects. DSP objects
457
458
459
typically process data at a high sample rate (44,100 is common) so displaying
the data in a user-friendly and meaningful way is tricky.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
460
461
### Difficulty
Moderate to Hard. This feature touches the main artery of the
462
463
464
465
message dispatching system, and the bonus goal would touch the main DSP
routine. In both cases realtime scheduling deadlines must be taken into
account by careful profiling.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
466
467
### Languages
C for the profiling business logic, HTML5 for displaying the
468
results in the GUI.
469
470
471
472

Streamlining Purr Data GUI-Pd communication
------------------------------------------

Jonathan Wilkes's avatar
Jonathan Wilkes committed
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
### Goal
Move some of the GUI callbacks out of Purr Data's audio engine so that GUI
interaction is less likely to cause dropouts.

### Details
The Pd GUI is heavily entangled with the Pd audio backend. In fact, most of the
"gestures" performed on the GUI are passed straight to the Pd engine for
processing. The GUI gestures are then "analyzed" by the audio thread, which may
respond with triggering a GUI action, changing the state of an object, or
nothing.

For instance, each mouse move triggers a `motion` message to the Pd backend,
handled by `canvas_motion()` in `g_editor.h`. This calls
`canvas_doclick(... doit = false)`, which in turn iterates through all the
objects on the patch and asks each of them "does the cursor happen to be on top
of you?" (`canvas_findhitbox()`/`canvas_hitbox()`), calling a callback function
(`w_getrectfn()`) for each of those objects.

Now, most of the time the cursor is not on an object (or patch cable) and the
calls to `w_getrecfn()` have no effect, except for wasting CPU power. There are
two notable exceptions: 
a) when the mouse pointer is on top of an object, or one of its inlets or
outlets, or on top of a patch cord, or on top of a GUI object, the mouse
pointer may change, plus, e.g.: flickering inlets/outlets.
b) some objects use the calls to `w_getrecfn()` to track mouse position
(e.g.: [mousestate] from cyclone).

The above results in a plethora of CPU cycles being wasted, which may cause
dropouts when using small blocksizes and/or embedded platforms. Besides - and
perhaps most importantly - it seems the wrong approach that some GUI-specific
actions (like the ones at a) above) have to be processed and validated by the
audio engine, within the audio thread.

We could therefore think of an improvement to the Purr-data architecture, where
the GUI stuff (e.g.: point a) above) is delegated uniquely to the GUI, which
makes for lower CPU usage and potentially a more responsive GUI. For instance,
the GUI could be designed to only send `motion` messages when the mouse is on
top of an object and it could send alongside with it the Pd "tag" of the object,
so that `w_getrectfn()`  can be called only for the relevant object).

The optimal approach would involve handling all the graphics effects (in/outlet
animation, mouse pointers) directly within the GUI, and only sending `motion`
messages when something relevant to the Pd engine is _actually_ happening
(e.g.: when connecting objects).

Additionally, and looking forward, in order to address point b), objects that
need to track mouse position should declare this at initialization and should
be kept in a dedicated list, so that the `motion` messages from the GUI can be
delivered only to them with minimal CPU waste.

An alternative - and probably worse - approach to the problem, which could
reduce peak CPU usage, would be for the Pd audio engine to maintain a
"rasterized" cached map of the patch (e.g.: by calling `w_getrecfn()` for each
object at each pixel). This way, it could simply look up the cached map in
response to each `motion` message. The cache could be recomputed in a separate
thread every time after a new object or patch cord is created. Threading issues
may arise here, in case one of the objects is deleted while the cached map is
being built.

### Difficulty: Moderate. This project comes with a number of
challenges, including: potential threading issues between the engine and the
GUI, the necessity to re-write the C code of some objects, providing complete
documentation for creators of externals, maintaining - where possible (e.g.:
excluding objects that track mouse position) - backwards compatibility with Pd.

More details on a previous attempt at addressing the problem can be found
[here]( http://disis.music.vt.edu/pipermail/l2ork-dev/2017-June/001383.html).

### Languages
Javascript and C.
543

544
545
546
### Potential Mentor
Giulio Moro

547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
Vintage Platform Audio Emulation Library
----------------------------------------

### Goal
Create a library with objects that emulate the hardware from
old hardware like the atari 2600, NES, and others.

### Details
There are a lot of resources online for emulating old
hardware. Purr Data would benefit by having a library
that provides a consistent interface for objects that
take input into an emulation of a piece of hardware and
output one or more audio signals.

If possible, it would be beneficial if most of the interface
could be built as a set of abstractions. That way more
developers would be able to understand and improve the library.

There is a TIA chip emulator written in C in externals/mmonoplayer
that can be used as a starting point.

### Difficulty: Moderate.

### Languages
Pd (Purr Data is a fork of the software Pure Data-- the visual language itself
is usually referred to as Pd.) Also, C.

574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
Data Over Audio Messaging
-------------------------

### Goal
Create a library that allows two instances of Purr Data to pass data messages
to each other using sound as the transmission medium.

### Details
Pd messages consist mainly of space-separated numbers and symbols.
Semicolons mark the end of a message.

Sometimes it would be helpful to be able to pass messages from
one instance of Purr Data to another-- especially if each instance is
on a different machine in the same room. This is currently done either
by setting up socket listener/receiver between the two instances or by
leveraging a separate message-passing system outside of Purr Data.

Since Purr Data is concerned mainly with analyzing and sythesizing sound,
machines running Purr Data typically have a mic and speakers connected to
a running instance. If it were possible for the user to simply create
objects which send/receive messages by sending audio signals to/from each
other it would greatly simplify sending at least small amounts of data
between machines.

### Difficulty: Moderate.

### Languages
Pd (Purr Data is a fork of the software Pure Data-- the visual language itself
is usually referred to as Pd.) However, the library may also be written in
C.
Jonathan Wilkes's avatar
Jonathan Wilkes committed
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682

Interaction with Audio Plugins
------------------------------

### Goal
Make sure that Purr Data has a well-documented way to accept input from 
standard audio plugin APIs like VST, LADSP, and LV2. Also
make sure Purr Data can be used as a plugin in other environments.


### Details
There are multiple audio plugin APIs that aim at seamlessly mixing and
matching audio filters, synthesizers, and analysis tools in different
languages and applications.

Purr Data has some libraries to interface with at least two of these
standards (VST and LADSPA). There is also a library for LV2 that
Purr Data can leverage. However, not all of these libraries run on
all the supported platforms (OSX, Windows, Linux).

Purr Data also has all the APIs necessary to act as a plugin itself
in other applications. But work must be done to ensure this works
properly and that it is properly documented how to do it.

### Difficulty: Moderate. There is a lot of pre-existing technology 
here, but it needs to be tested rigorously on all platforms.

### Languages
C. Also, familiarity with shell scripting as well as Gnu make.

Interaction with Audio Plugins
------------------------------

### Goal
Make sure that Purr Data has a well-documented way to accept input from 
standard audio plugin APIs like VST, LADSP, and LV2. Also
make sure Purr Data can be used as a plugin in other environments.

### Details
There are multiple audio plugin APIs that aim at seamlessly mixing and
matching audio filters, synthesizers, and analysis tools in different
languages and applications.

Purr Data has some libraries to interface with at least two of these
standards (VST and LADSPA). There is also a library for LV2 that
Purr Data can leverage. However, not all of these libraries run on
all the supported platforms (OSX, Windows, Linux).

Purr Data also has all the APIs necessary to act as a plugin itself
in other applications. But work must be done to ensure this works
properly and that it is properly documented how to do it.

### Difficulty: Moderate. There is a lot of pre-existing technology 
here, but it needs to be tested rigorously on all platforms.

### Languages
C. Also, familiarity with shell scripting as well as Gnu make.


JIT-compiled Signal Graph for the Audio Engine
----------------------------------------------

### Goal
Leverage LLVM to make a jit-compiler for Purr Data's DSP graph.

### Details
Alex Norman has shown that it is possible to build a jit compiler
for one of Pd's "workhorse" libraries-- the "expr" library. This
library essentially lets users specify a mathematical expression
that can operate on both vectors and on the sample level. The
current library parses the tokens of the expression and requires
a separate function call for each unit. This is similar to the
way Pd's DSP graph itself gets executed.

The jit compiler produces assembly which has superior performance
to the current "expr" library. Extending that process to the entire
signal graph (or at least core classes within it) would benefit
performance on a greater level.

683
### Difficulty: Difficult
684
685

Since there is pre-existing
Jonathan Wilkes's avatar
Jonathan Wilkes committed
686
687
688
689
690
691
work done with the jit "expr" library, a good start would be to help
test that library and improve it. Once the student gains a mental
model of the process the student can begin to extend it to Purr Data's
DSP graph itself.

### Languages
692
C++. Knowledge of LLVM will also come in handy here.
693
694
695
696

### Potential Mentor
Alex Norman