zynaptik.h

/*
 * ******************************************************************
 * ZYNTHIAN PROJECT: Zynaptik Library
 * 
 * Library for interfacing external sensors and actuators.
 * It implements interfaces with extra MCP23017, ADS1115, etc.
 * 
 * Copyright (C) 2015-2019 Fernando Moyano <jofemodo@zynthian.org>
 *
 * ******************************************************************
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * For a full copy of the GNU General Public License see the LICENSE.txt file.
 * 
 * ******************************************************************
 */

#ifndef ZYNNAPTIK_H
#define ZYNANPTIK_H

#include <stdint.h>
#include <unistd.h>
#include <pthread.h>
#include <stdbool.h>
#include <jack/jack.h>
#include <jack/midiport.h>

#include "zynads1115.h"
#include <MCP4728.h>

//-----------------------------------------------------------------------------
// MCP23017 Stuff
//-----------------------------------------------------------------------------

//Default config for Zynaptik's MCP23017
#if !defined(ZYNAPTIK_MCP23017_I2C_ADDRESS)
	#define ZYNAPTIK_MCP23017_I2C_ADDRESS 0x21
#endif
#if !defined(ZYNAPTIK_MCP23017_BASE_PIN)
	#define ZYNAPTIK_MCP23017_BASE_PIN 200
#endif
#if !defined(ZYNAPTIK_MCP23017_INTA_PIN)
	#define ZYNAPTIK_MCP23017_INTA_PIN 27
#endif
#if !defined(ZYNAPTIK_MCP23017_INTB_PIN)
	#define ZYNAPTIK_MCP23017_INTB_PIN 25
#endif

//-----------------------------------------------------------------------------
// ADS1115 Stuff
//-----------------------------------------------------------------------------

//Default config for Zynaptik's ADS1115
#if !defined(ZYNAPTIK_ADS1115_I2C_ADDRESS)
	#define ZYNAPTIK_ADS1115_I2C_ADDRESS 0x48
#endif
#if !defined(ZYNAPTIK_ADS1115_BASE_PIN)
	#define ZYNAPTIK_ADS1115_BASE_PIN 300
#endif

//-----------------------------------------------------------------------------
// MCP4728 Stuff
//-----------------------------------------------------------------------------

//Default config for Zynaptik's MCP4728
#if !defined(ZYNAPTIK_MCP4728_I2C_ADDRESS)
	#if ZYNAPTIK_VERSION==1
		#define ZYNAPTIK_MCP4728_I2C_ADDRESS 0x60
	#else
		#define ZYNAPTIK_MCP4728_I2C_ADDRESS 0x61
	#endif
#endif

//-----------------------------------------------------------------------------
// CV-IN: Generate MIDI from Analog Inputs: CC, Pitchbend, Channel Pressure
//-----------------------------------------------------------------------------

#define MAX_NUM_ZYNCVINS 4
#define K_CVIN_VOLT_OCTAVE (12.0 * 6.144 / 32767.0)

#if !defined(ZYNAPTIK_CVIN_VOLTS_OCTAVE)
	#define ZYNAPTIK_CVIN_VOLTS_OCTAVE 1.0
#endif
#if !defined(ZYNAPTIK_CVIN_NOTE0)
	#define ZYNAPTIK_CVIN_NOTE0 0
#endif

struct zyncvin_st {
	uint8_t enabled;

	int midi_evt;
	uint8_t midi_chan;
	uint8_t midi_num;
	uint16_t midi_val;
};

void zynaptik_cvin_set_volts_octave(float vo);
float zynaptik_cvin_get_volts_octave();
void zynaptik_cvin_set_note0(int note0);
int zynaptik_cvin_get_note0();

void zynaptik_setup_cvin(uint8_t i, int midi_evt, uint8_t midi_chan, uint8_t midi_num);
void zynaptik_disable_cvin(uint8_t i);

int32_t zynaptik_get_cvin(uint8_t i);
void zynaptik_cvin_to_midi(uint8_t i, uint16_t val);

//CV-IN Polling interval
#define POLL_ZYNAPTIK_CVINS_US 40000
pthread_t init_poll_zynaptik_cvins();

//-----------------------------------------------------------------------------
// CV-OUT: Set Analog Outputs from MIDI: CC, Notes (velocity+pitchbend)
//-----------------------------------------------------------------------------

#define MAX_NUM_ZYNCVOUTS 4
#define K_CVOUT_VOLT_OCTAVE (60.0 / (127.0 * 0.97))

#if !defined(ZYNAPTIK_CVOUT_VOLTS_OCTAVE)
	#define ZYNAPTIK_CVOUT_VOLTS_OCTAVE 1.0
#endif
#if !defined(ZYNAPTIK_CVOUT_NOTE0)
	#define ZYNAPTIK_CVOUT_NOTE0 0
#endif

struct zyncvout_st {
	uint8_t enabled;

	int midi_evt;
	uint8_t midi_chan;
	uint8_t midi_num;
	uint8_t note[128];

	uint16_t midi_event_temp;
	uint16_t midi_event_mask;

	uint16_t val;
};

void zynaptik_cvout_set_volts_octave(float vo);
float zynaptik_cvout_get_volts_octave();
void zynaptik_cvout_set_note0(int note0);
int zynaptik_cvout_get_note0();

void zynaptik_setup_cvout(uint8_t i, int midi_evt, uint8_t midi_chan, uint8_t midi_num);
void zynaptik_disable_cvout(uint8_t i);
void zynaptik_midi_to_cvout(jack_midi_event_t *ev);
void zynaptik_set_cvout(int i, uint16_t val);
void zynaptik_refresh_cvouts();

//CV-OUT Refresh interval
#define REFRESH_ZYNAPTIK_CVOUTS_US 40000

//-----------------------------------------------------------------------------
// GATE-OUT: Set Digital Outputs from MIDI Notes
//-----------------------------------------------------------------------------

#define MAX_NUM_ZYNGATEOUTS 36

struct zyngateout_st {
	uint8_t enabled;

	int midi_evt;
	uint8_t midi_chan;
	uint8_t midi_num;

	uint16_t midi_event_temp;
	uint16_t midi_event_mask;
};

void zynaptik_setup_gateout(uint8_t i, int midi_evt, uint8_t midi_chan, uint8_t midi_num);
void zynaptik_disable_gateout(uint8_t i);
void zynaptik_midi_to_gateout(jack_midi_event_t *ev);

//-----------------------------------------------------------------------------
// Zynaptik Library Initialization
//-----------------------------------------------------------------------------

int init_zynaptik();
int end_zynaptik();

//-----------------------------------------------------------------------------

#endif