MozziGuts.h

/*
 * MozziGuts.h
 *
 * This file is part of Mozzi.
 *
 * Copyright 2012-2024 Tim Barrass and the Mozzi Team
 *
 * Mozzi is licensed under the GNU Lesser General Public Licence (LGPL) Version 2.1 or later.
 *
 */
 
#ifndef MOZZIGUTS_H_
#define MOZZIGUTS_H_
 
#include "Arduino.h"
 
#include "MozziConfigValues.h"
 
#if !(defined(MOZZI_H_) || defined(MOZZI_HEADERS_ONLY_H_))
#warning Direct inclusion of MozziGuts.h is deprecated. Use Mozzi.h, instead, and read about porting to Mozzi 2.0
#define MOZZI_COMPATIBILITY_LEVEL MOZZI_COMPATIBILITY_1_1
#endif
 
#include "hardware_defines.h"
 
#if IS_TEENSY3() || IS_TEENSY4()
// required from http://github.com/pedvide/ADC for Teensy 3.*
#include <ADC.h>
#endif
 
#include "internal/config_checks_generic.h"
 
#include "mozzi_analog.h"
#include "AudioOutput.h"
 
// TODO Mozzi 2.0: These typedef probably obsolete?
// common numeric types
typedef unsigned char uchar;
typedef unsigned int uint;
typedef unsigned long ulong;
 
#if defined(__AVR__)
typedef unsigned char byte; // for arduino ide
typedef unsigned char uint8_t;
typedef signed char int8_t;
typedef unsigned int uint16_t;
typedef signed int int16_t;
typedef unsigned long uint32_t;
typedef signed long int32_t;
#else
// Other supported arches add typedefs, here, unless already defined for that platform needed
#endif
 
void startMozzi(int control_rate_hz = MOZZI_CONTROL_RATE);
 
 
 
void stopMozzi();
 
 
#if (MOZZI_COMPATIBILITY_LEVEL <= MOZZI_COMPATIBILITY_1_1) && MOZZI_IS(MOZZI_AUDIO_CHANNELS, MOZZI_MONO)
AudioOutput_t updateAudio();
#else
AudioOutput updateAudio();
#endif
 
void updateControl();
 
 
void audioHook();
 
template<byte RES> uint16_t getAudioInput();
 
template<byte RES> inline uint16_t getAudioInput16() { return getAudioInput<16>(); }
 
#if defined(FOR_DOXYGEN_ONLY) || (!MOZZI_IS(MOZZI_AUDIO_INPUT, MOZZI_AUDIO_INPUT_NONE))
#if defined(FOR_DOXYGEN_ONLY) || defined(MOZZI_ANALOG_READ_RESOLUTION)
inline uint16_t getAudioInput() { return getAudioInput<MOZZI_ANALOG_READ_RESOLUTION>(); };
#else
MOZZI_DEPRECATED("2.0", "This use of getAudioInput() is not portable. Refer to the API documentation for suggested alternatives") inline uint16_t getAudioInput() { return getAudioInput<MOZZI__INTERNAL_ANALOG_READ_RESOLUTION>(); };
#endif
#endif
 
 
unsigned long audioTicks();
 
 
 
unsigned long mozziMicros();
 
#ifndef _MOZZI_HEADER_ONLY
#include "internal/MozziGuts.hpp"
#endif
 
#endif /* MOZZIGUTS_H_ */