README
¶
maxgo
Toolkit for building Max externals with Go.
Installation
First you need to ensure you have recent version of Go installed. On macOS simply install it using brew:
brew install go
Then you can install the package and CLI using Go's module management:
go get -u github.com/256dpi/maxgo
go get -u github.com/256dpi/maxgo/cmd/maxgo
This will install the maxgo command line utility. You may need to add Go's bin directory tou your PATH variable to access the CLI in the terminal:
echo 'export PATH=~/go/bin:$PATH' >> ~/.zprofile # for zsh
Cross compilation on macOS for Windows additionally requires the mingw-w64 toolchain:
brew install mingw-w64
Usage
Add the following file to an empty directory:
package main
import "github.com/256dpi/maxgo"
type instance struct {
in1 *maxgo.Inlet
in2 *maxgo.Inlet
out1 *maxgo.Outlet
out2 *maxgo.Outlet
}
func (i *instance) Init(obj *maxgo.Object, args []maxgo.Atom) {
// print to Max console
maxgo.Pretty("init", args)
// declare inlets
i.in1 = obj.Inlet(maxgo.Any, "example inlet 1", true)
i.in2 = obj.Inlet(maxgo.Float, "example inlet 2", false)
// declare outlets
i.out1 = obj.Outlet(maxgo.Any, "example outlet 1")
i.out2 = obj.Outlet(maxgo.Bang, "example outlet 2")
}
func (i *instance) Handle(msg string, inlet int, data []maxgo.Atom) {
// print to Max console
maxgo.Pretty("handle", msg, inlet, data)
// send to first outlet
i.out1.Any(msg, data)
}
func (i *instance) Free() {
// print to Max console
maxgo.Pretty("free")
}
func init() {
// initialize Max class
maxgo.Register("example", &instance{})
}
func main() {
// not called
}
Compile the external to the dist directory:
maxgo -name example -out dist
You can also cross compile (macOS only) and install the external:
maxgo -name example -out dist -cross -install example
Documentation
¶
Index ¶
- func Alert(format string, args ...interface{})
- func Defer(fn func())
- func Error(format string, args ...interface{})
- func Init(name string, init func(*Object, []Atom) bool, ...)
- func IsMainThread() bool
- func Log(format string, args ...interface{})
- func Pretty(a ...interface{})
- func Register(name string, prototype Instance)
- type Atom
- type Inlet
- type Instance
- type Object
- type Outlet
- type Type
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Error ¶
func Error(format string, args ...interface{})
Error will print an error to the max console.
func Init ¶
func Init(name string, init func(*Object, []Atom) bool, handler func(*Object, string, int, []Atom), free func(*Object))
Init will initialize the Max class with the specified name using the provided callbacks to initialize and free objects. This function must be called from the main packages init() function as the main() function is never called by a Max external.
The provided callbacks are called to initialize and object, handle messages and free the object when it is not used anymore. The callbacks are usually called on the Max main thread. However, the handler may be called from and unknown thread in parallel to the other callbacks.
func IsMainThread ¶
func IsMainThread() bool
IsMainThread will return if the Max main thead is executing.
func Log ¶
func Log(format string, args ...interface{})
Log will print a message to the max console.
Types ¶
type Inlet ¶
type Inlet struct {
// contains filtered or unexported fields
}
Inlet is a single Max inlet.
type Instance ¶
type Instance interface {
Init(obj *Object, args []Atom) bool
Handle(msg string, inlet int, data []Atom)
Free()
}
Instance is a generic object instance.
type Object ¶
Object is single Max object.
Source Files
Directories