pd-fileutils
v0.4.0
Published
A set of utilities for Pure Data files : parser, image generator.
Downloads
22
Readme
Pure Data file utilities
This library is a set of tools for handling pure data files.
pd-fileutils
allows you to parse Pd files to a JavaScript object which is easy to modify. Of course, you can also create a patch from scratch. A patch can then be rendered to pd
format, or to SVG
if you want an image of it.
Demos
- Random drone generator : generate random droning patches (you know ... robot sounds), listen to them online, and download the pd file if you like it.
Usage in the browser
First download the latest (or latest stable) browser build from dist/
and include it in your page :
<script src="js/pd-fileutils.js"></script>
Then you can use pd-fileutils
:
<div id="svg"></div>
<script>
var patch = pdfu.parse('#N canvas 778 17 450 300 10;\n#X obj 14 13 loadbang;\n#X obj 14 34 print bla;\n#X connect 0 0 1 0;')
var rendered = pdfu.renderSvg(patch, {svgFile: false})
$('#svg').html(rendered)
</script>
Usage on node.js
Installation
Obviously, you will need node.js.
Installation is easier with the node package manager npm :
npm install pd-fileutils
To install the command-line tool globally, you might want to run npm
with the -g
option. Note that in this case you might need admin rights :
npm install -g pd-fileutils
Command-line tool
At the moment, the only thing you can do is render .pd
files to .svg
, for example :
pd-fileutils myPatch.pd > myPatch.svg
API documentation
Patch objects
pd-fileutils
deals with JavaScript objects representing patches.
Specification
Patch object :
{
nodes: [<node1>, ..., <nodeN>],
connections: [<connection1>, ..., <connectionN>],
args: [<arg1>, ..., <argN>],
layout: {<key>: <value>},
}
Where <nodeK>
is with format :
{
id: <id>,
proto: <object type>,
args: [<arg1>, ..., <argN>],
layout: {<key>: <value>},
data: [<number1>, ..., <numberN>],
subpatch: <a patch object>
}
layout
: a map containing all the layout properties of the object/patch.args
: an array of the creation arguments of the object/patch. Those can be only strings or numbers.data
: [only for tables] a list of numbers.subpatch
: [only for subpatches] contains the whole subpatch's graph.
And <connectionK>
:
{
source: {
id: <source object id>,
port: <outlet>
},
sink: {
id: <sink object id>,
port: <inlet>
}
}
parse(pdFile)
Parses the string pdFile
to a patch object. Example usage on Node.js
:
var pdfu = require('pd-fileutils')
, fs = require('fs')
, patchStr, patch
// Read the file
patchStr = fs.readFileSync('./simple.pd').toString()
// Parse the read file
patch = pdfu.parse(patchStr)
renderPd(patch)
Renders the patch
object to a string in the Pd file format.
renderSvg(patch)
Renders the patch
object to a string in SVG format
Contributions
Are most welcome. There is still a lot of work to do there. Fork the project, make your changes and send me a pull request.
Running the tests
Running tests require mocha
. Run with :
npm test
Building from source to dist/
npm run build
History
0.4
- update all dependencies + move to webpack
0.3.4
- parsing handles infos after the comma on a object definition line
0.3
- parsing separates layout from model data
- SVG rendering of all controls
- basic pd rendering
0.2
- SVG rendering + command-line tool
- parsing supports most of the format
0.1
- basic parsing