//midi for embedded chips,
//Copyright 2010 Alex Norman
//
//This file is part of avr-midi.
//
//avr-midi 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 3 of the License, or
//(at your option) any later version.
//
//avr-midi 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.
//
//You should have received a copy of the GNU General Public License
//along with avr-midi.  If not, see <http://www.gnu.org/licenses/>.

#ifndef MIDI_DEVICE_H
#define MIDI_DEVICE_H

#include "midi_function_types.h"
#include "bytequeue.h"

#define MIDI_INPUT_QUEUE_LENGTH 16

typedef enum {
   IDLE, 
   TWO_BYTE_MESSAGE = 2, 
   THREE_BYTE_MESSAGE = 3,
   SYSEX_MESSAGE} input_state_t;

typedef void (* midi_no_byte_func_t)(MidiDevice * device);

//this structure represents the input and output functions and processing data
//for a midi device.
//A device can represent an actual physical device [serial port, usb port] or
//something virtual.
//You should not need to modify this structure directly.
struct _midi_device {
   //output send function
   midi_var_byte_func_t send_func;

   //********input callbacks
   //three byte funcs
   midi_three_byte_func_t input_cc_callback;
   midi_three_byte_func_t input_noteon_callback;
   midi_three_byte_func_t input_noteoff_callback;
   midi_three_byte_func_t input_aftertouch_callback;
   midi_three_byte_func_t input_pitchbend_callback;
   midi_three_byte_func_t input_songposition_callback;
   //two byte funcs
   midi_two_byte_func_t input_progchange_callback;
   midi_two_byte_func_t input_chanpressure_callback;
   midi_two_byte_func_t input_songselect_callback;
   midi_two_byte_func_t input_tc_quaterframe_callback;
   //one byte funcs
   midi_one_byte_func_t input_realtime_callback;
   midi_one_byte_func_t input_tunerequest_callback;

   //only called if more specific callback is not matched
   midi_var_byte_func_t input_fallthrough_callback;
   //called if registered, independent of other callbacks
   midi_var_byte_func_t input_catchall_callback;

   //pre input processing function
   midi_no_byte_func_t pre_input_process_callback;

   //for internal input processing
   uint8_t input_buffer[3];
   input_state_t input_state;
   uint8_t input_count;

   //for queueing data between the input and the processing functions
   uint8_t input_queue_data[MIDI_INPUT_QUEUE_LENGTH];
   byteQueue_t input_queue;
};

//input processing, only used if you're creating a custom device
void midi_device_input(MidiDevice * device, uint8_t cnt, uint8_t byte0, uint8_t byte1, uint8_t byte2);
//set send function, only used if you're creating a custom device
//you'll most likely want the function that this calls to disable interrupts so
//that you can call the various midi send functions without worrying about
//locking.
void midi_device_set_send_func(MidiDevice * device, midi_var_byte_func_t send_func);

//if you need to run a function to grab input before you pass it to midi_device_input, set it here.
void midi_device_set_pre_input_process_func(MidiDevice * device, midi_no_byte_func_t pre_process_func);

#endif