Bela.h

Go to the documentation of this file.

#ifndef BELA_H_
#define BELA_H_

#include <stdint.h>
#include <unistd.h>
#include <rtdk.h>
#include "digital_gpio_mapping.h"
#include <GPIOcontrol.h>

// Useful constants

#define CODEC_I2C_ADDRESS  0x18         // Address of TLV320AIC3104 codec

#define MAX_PRU_FILENAME_LENGTH 256
#define MAX_SERVERNAME_LENGTH 256

#define BELA_AUDIO_PRIORITY             95

// Default volume levels

#define DEFAULT_DAC_LEVEL       0.0

#define DEFAULT_ADC_LEVEL       -6.0


#define DEFAULT_PGA_GAIN 16

#define DEFAULT_HP_LEVEL        -6.0

#define BELA_FLAG_INTERLEAVED                           (1 << 0)        // Set if buffers are interleaved

#define BELA_FLAG_ANALOG_OUTPUTS_PERSIST        (1 << 1)        // Set if analog/digital outputs persist for future buffers

typedef struct {
        // These items might be adjusted by the user:

        int periodSize;
        int useAnalog;
        int useDigital;
        int numAudioInChannels;
        int numAudioOutChannels;
        int numAnalogInChannels;
        int numAnalogOutChannels;
        int numDigitalChannels;

        int beginMuted;
        float dacLevel;
        float adcLevel;
        float pgaGain[2];
        float headphoneLevel;
        int numMuxChannels;

        int pruNumber; 
        char pruFilename[MAX_PRU_FILENAME_LENGTH];
        int verbose;

        // These items are application-dependent but should probably be
        // determined by the programmer rather than the user

        int interleave;
        int analogOutputsPersist;

        // These items are hardware-dependent and should only be changed
        // to run on different hardware

        int codecI2CAddress;
        int ampMutePin;
        int receivePort;
        int transmitPort;
        char serverName[MAX_SERVERNAME_LENGTH];
} BelaInitSettings;


typedef struct {
        const float * const audioIn;

        float * const audioOut;

        const float * const analogIn;

        float * const analogOut;

        uint32_t * const digital;

        const uint32_t audioFrames;
        const uint32_t audioInChannels;
        const uint32_t audioOutChannels;
        const float audioSampleRate;

        const uint32_t analogFrames;

        const uint32_t analogInChannels;

        const uint32_t analogOutChannels;

        const float analogSampleRate;

        const uint32_t digitalFrames;
        const uint32_t digitalChannels;
        const float digitalSampleRate;

        const uint64_t audioFramesElapsed;

        const uint32_t flags;
} BelaContext;

typedef void* AuxiliaryTask;    // Opaque data type to keep track of aux tasks

extern int gShouldStop;

// *** User-defined render functions ***

bool setup(BelaContext *context, void *userData);

void render(BelaContext *context, void *userData);

void cleanup(BelaContext *context, void *userData);

// *** Command-line settings ***

void Bela_defaultSettings(BelaInitSettings *settings);

int Bela_getopt_long(int argc, char *argv[], const char *customShortOptions,
                                   const struct option *customLongOptions, BelaInitSettings *settings);

void Bela_usage();

void Bela_setVerboseLevel(int level);


// *** Audio control functions ***

int Bela_initAudio(BelaInitSettings *settings, void *userData);

int Bela_startAudio();

int Bela_startAuxiliaryTask(AuxiliaryTask it);
void Bela_stopAudio();

void Bela_cleanupAudio();

// *** Volume and level controls ***

int Bela_setDACLevel(float decibels);

int Bela_setADCLevel(float decibels);


int Bela_setPgaGain(float decibels, int channel);

int Bela_setHeadphoneLevel(float decibels);

int Bela_muteSpeakers(int mute);

// *** Functions for creating auxiliary tasks ***

AuxiliaryTask Bela_createAuxiliaryTask(void (*functionToCall)(void*), int priority, const char *name, void* args, bool autoSchedule = false);
AuxiliaryTask Bela_createAuxiliaryTask(void (*functionToCall)(void), int priority, const char *name, bool autoSchedule = false);

int Bela_startAuxiliaryTask(AuxiliaryTask task);
void Bela_scheduleAuxiliaryTask(AuxiliaryTask task);
void Bela_autoScheduleAuxiliaryTasks();

#include <Utilities.h>

#endif /* BELA_H_ */