sequencer.h

Go to the documentation of this file.

/*
 * Copyright 2015 Sebastian Neuser
 *
 * This file is part of the uMIDI firmware.
 *
 * The MIDI volume controller firmware 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.
 *
 * The uMIDI firmware 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 the uMIDI firmware.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _SEQUENCER_H
#define _SEQUENCER_H


//---------------- includes ----------------//
#include <stdbool.h>
#include <stdint.h>

#include "gpio.h"
#include "math.h"
#include "midi.h"
#include "wave.h"


//---------------- constants ----------------//

#define SEQUENCER_STEPS_PER_PATTERN     16


//---------------- data types ----------------//

enum sequencer_pattern_number
{
    SEQUENCER_PATTERN_01,   
    SEQUENCER_PATTERN_02,   
    SEQUENCER_PATTERN_03,   
    SEQUENCER_PATTERN_04,   
    SEQUENCER_PATTERN_05,   
    SEQUENCER_PATTERN_06,   
    SEQUENCER_PATTERN_07,   
    SEQUENCER_PATTERN_08,   
    SEQUENCER_PATTERN_09,   
    SEQUENCER_PATTERN_10,   
    SEQUENCER_PATTERN_11,   
    SEQUENCER_PATTERN_12,   
    SEQUENCER_PATTERN_13,   
    SEQUENCER_PATTERN_14,   
    SEQUENCER_PATTERN_15,   
    SEQUENCER_PATTERN_16,   
    SEQUENCER_PATTERN_17,   
    SEQUENCER_PATTERN_18,   
    SEQUENCER_PATTERN_19,   
    SEQUENCER_PATTERN_20,   
    SEQUENCER_PATTERNS      
};

enum sequencer_channel_number
{
    SEQUENCER_CHANNEL_1,    
    SEQUENCER_CHANNEL_2,    
    SEQUENCER_CHANNEL_3,    
    SEQUENCER_CHANNEL_4,    
    SEQUENCER_CHANNELS      
};

enum sequencer_channel_mode
{
    SEQUENCER_CHANNEL_MODE_ONE_SHOT,    
    SEQUENCER_CHANNEL_MODE_CONTINUOUS   
};

struct sequencer_step
{
    enum midi_channel       channel;    
    enum midi_message_type  type;       
    midi_value_t            data0;      
    midi_value_t            data1;      
};

struct sequencer_pattern
{
    uint8_t                 length;                             
    struct sequencer_step   steps[SEQUENCER_STEPS_PER_PATTERN]; 
};

struct sequencer_channel
{
    enum sequencer_pattern_number   pattern;        
    uint8_t                         speed;          
    enum sequencer_channel_mode     mode;           
    bool                            running;        
    uint8_t                         step_index;     
    struct wave                     wave;           
    bool                            clock_state;    
    void (*tick_callback)(void);                   
};


//---------------- functions and procedures ----------------//
enum sequencer_pattern_number adjust_sequencer_pattern(struct sequencer_channel* channel, int8_t difference);

midi_value_t adjust_sequencer_speed(struct sequencer_channel* channel, int8_t difference);

void configure_sequencer_channel(enum sequencer_channel_number number, struct sequencer_channel* channel);

void copy_pattern(enum sequencer_pattern_number source, enum sequencer_pattern_number destination);

char* export_pattern(enum sequencer_pattern_number number);

uint8_t get_pattern_length(enum sequencer_pattern_number pattern);

struct sequencer_step get_pattern_step(enum sequencer_pattern_number pattern, uint8_t index);

void import_pattern(enum sequencer_pattern_number number, const char* data);

void init_sequencer_patterns(const struct sequencer_pattern* factory_patterns, uint8_t number_of_patterns);

void overwrite_pattern(enum sequencer_pattern_number number, const struct sequencer_pattern* pattern);

void set_pattern_length(enum sequencer_pattern_number pattern, uint8_t length);

void set_pattern_step(enum sequencer_pattern_number pattern, uint8_t index, const struct sequencer_step* step);

void set_sequencer_pattern(struct sequencer_channel* channel, enum sequencer_pattern_number pattern);

void set_sequencer_speed(struct sequencer_channel* channel, midi_value_t speed);

void start_sequencer(struct sequencer_channel* channel);

void stop_sequencer(struct sequencer_channel* channel);

bool toggle_sequencer(struct sequencer_channel* channel);

void update_sequencer(void);

void wipe_pattern(enum sequencer_pattern_number number);

//---------------- EOF ----------------//
#endif // _SEQUENCER_H