midicatdrv

README

midicatdrv

This driver is based on the slim midicat tool (see tools/midicat for more information).

Installation

This is driver uses the midicat binary.

Download the binaries (for Windows) here.

Or install them via

go install gitlab.com/gomidi/midi/tools/midicat@latest

(When using windows, run the commands inside cmd.exe.)

The midicat binary is based on the rtmidi project and connects MIDI ports to Stdin and Stdout. The idea is, to have just one binary that requires CGO (midicat) and for all the Go projects that need to connect to MIDI ports just pipe the MIDI data from and to this binary.

This driver connects to the midicat binary via Stdin and Stdout while providing the same unified https://gitlab.com/gomidi/v2/drivers.Driver interface as rtmididrv and portmididrv. But projects importing this midicatdrv will not required CGO (like that would be the case otherwise).

Download or compile the midicat binary and place it in your PATH before using this driver. midicat version >= 0.6.8 is required.

Documentation

Overview

Package midicatdrv provides a Driver to connect via the program midicat (from the tools).

Index

• type CloseErrors
  • func (c CloseErrors) Error() string
• type Driver
  • func New() (*Driver, error)
  • func (d *Driver) Close() (err error)
  • func (d *Driver) Ins() (ins []drivers.In, err error)
  • func (d *Driver) Outs() (outs []drivers.Out, err error)
  • func (d *Driver) String() string

Types

type CloseErrors

type CloseErrors []error

CloseErrors collects error from closing multiple MIDI ports

func (CloseErrors) Error

func (c CloseErrors) Error() string

type Driver

type Driver struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func New

func New() (*Driver, error)

New returns a driver based on the default rtmidi in and out

func (*Driver) Close

func (d *Driver) Close() (err error)

Close closes all open ports. It must be called at the end of a session.

func (*Driver) Ins

func (d *Driver) Ins() (ins []drivers.In, err error)

Ins returns the available MIDI input ports

func (*Driver) Outs

func (d *Driver) Outs() (outs []drivers.Out, err error)

Outs returns the available MIDI output ports

func (*Driver) String

func (d *Driver) String() string