The heavy hvcc compiler for Pure Data patches.
hvccis a python-based dataflow audio programming language compiler that generates C/C++ code and a variety of specific framework wrappers.
This repo is currently unsupported and looking for a maintainer. The original authors will not respond to messages or issues. Bugs will not be fixed. Features will not be added. You are on your own. Good luck.
The original need for
hvccarose from running against performance limitations while creating interactive music and sound products for the iPhone. Pure Data (libpd) was the only real choice for a design tool as it was embeddable and provided a high enough abstraction level that musicians or sound designers could be creative.
The goal was to leverage Pure Data as a design interface and statically interpret the resultant patches to generate a low-level, portable and optimised C/C++ program that would be structured to take advantage of modern hardware whilst still generating the same behaviour and audio output as Pure Data.
It has since then been expanded to provide further support for many different platforms and frameworks, especially targeting game audio production tools.
enum(for error reporting)
jinja2(for generator templating)
nose2(for tests, optional)
$ git clone https://github.com/enzienaudio/hvcc.git
$ cd hvcc/
$ pip2.7 install -r requirements.txt
hvccrequires at least one argument that determines the top-level patch file to be loaded.
Generate a C/C++ program from
input.pdand place the files in
$ python2.7 hvcc.py ~/myProject/_main.pd
This command will generate the following directories:
~/myProject/hvheavylang representation of the input pd patch(es)
~/myProject/irheavyir representation of the heavylang patch
~/myProject/cfinal generated C/C++ source files (this is what you would use in your project)
-oSelect output directory
As seen in the above command, typical output of
hvccis split into several directories that contain the intermediate files used by the compiler itself, the final generated source files, and any additional framework specific files and projects.
--out_dirparameter will specify where the output files are placed after a successful compile.
$ python2.7 hvcc.py ~/myProject/_main.pd -o ~/Desktop/somewhere/else/
Will place all the generated files in
-nSpecify Patch Name
--nameparameter can be used to easily namespace the generated code so that there are no conflicts when integrating multiple patches into the same project.
$ python2.7 hvcc.py ~/myProject/_main.pd -o ~/Desktop/somewhere/else/ -n mySynth
hvcchas generated internal information about the patch the
--genparameter can be used to specify the output files it should generate. By default it will always include
cfor the C/C++ source files and additional generators can specified for certain framework targets.
$ python2.7 hvcc.py ~/myProject/_main.pd -o ~/Desktop/somewhere/else/ -n mySynth -g unity
Will also generate a
unitysection in the output directory contain all the build projects and source files to compile a Unity plugin.
It is also possible to pass a list of generators:
$ python2.7 hvcc.py ~/myProject/_main.pd -o ~/Desktop/somewhere/else/ -n mySynth -g unity wwise js
Available generator options:
hvccwill iterate through various directories when resolving patch objects and abstractions. The
--search_pathsargument can be used to add additional folders for
hvccto look in.
This can be handy when using a third-party patch library for example https://github.com/enzienaudio/heavylib.
$ python2.7 hvcc.py ~/myProject/_main.pd -o ~/Desktop/somewhere/else/ -n mySynth -p "[~/Workspace/Projects/Enzien/heavylib/, ~/Desktop/myLib/]"
By default all the generated source files via
hvccwill have the following copyright text applied to the top of the file:
Copyright (c) 2018 Enzien Audio, Ltd.
This can be changed with
$ python2.7 hvcc.py ~/myProject/_main.pd -o ~/Desktop/somewhere/else/ -n mySynth --copyright "Copyright (c) Los Pollos Hermanos 2019"
Displays all the available parameters and options for hvcc.