ui.h

// Copyright 2013 Emilie Gillet.
//
// Author: Emilie Gillet (emilie.o.gillet@gmail.com)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
// 
// See http://creativecommons.org/licenses/MIT/ for more information.
//
// -----------------------------------------------------------------------------
//
// Settings

#ifndef PEAKS_UI_H_
#define PEAKS_UI_H_

#include "stmlib/stmlib.h"

#include "stmlib/ui/event_queue.h"

#include "peaks/drivers/adc.h"
#include "peaks/drivers/gate_input.h"
#include "peaks/drivers/leds.h"
#include "peaks/drivers/switches.h"

#include "peaks/processors.h"

namespace peaks {

enum SwitchIndex {
  SWITCH_TWIN_MODE,
  SWITCH_FUNCTION,
  SWITCH_GATE_TRIG_1,
  SWITCH_GATE_TRIG_2
};

enum EditMode {
  EDIT_MODE_TWIN,
  EDIT_MODE_SPLIT,
  EDIT_MODE_FIRST,
  EDIT_MODE_SECOND,
  EDIT_MODE_LAST
};

enum Function {
  FUNCTION_ENVELOPE,
  FUNCTION_LFO,
  FUNCTION_TAP_LFO,
  FUNCTION_DRUM_GENERATOR,
  FUNCTION_MINI_SEQUENCER,
  FUNCTION_PULSE_SHAPER,
  FUNCTION_PULSE_RANDOMIZER,
  FUNCTION_FM_DRUM_GENERATOR,
  FUNCTION_LAST,
  FUNCTION_FIRST_ALTERNATE_FUNCTION = FUNCTION_MINI_SEQUENCER
};

struct Settings {
  uint8_t edit_mode;
  uint8_t function[2];
  uint8_t pot_value[8];
  bool snap_mode;
};

class CalibrationData;

class Ui {
 public:
  Ui() { }
  ~Ui() { }
  
  void Init(CalibrationData* calibration_data);
  void Poll();
  void PollPots();
  void DoEvents();
  void FlushEvents();
  
  void set_led_brightness(int channel, int16_t value) {
    brightness_[channel] = value;
  }
  
  inline uint32_t ReadPanelGateState() {
    uint32_t state = 0;
    state |= panel_gate_control_[0] ? 1 : 0;
    state |= panel_gate_control_[1] ? 2 : 0;
    return state;
  }
  
  inline bool calibrating() const { return calibrating_; }
  
 private:
  inline Function function() const {
    return edit_mode_ == EDIT_MODE_SECOND ? function_[1] : function_[0];
  }
  void LockPots();
  void OnSwitchPressed(const stmlib::Event& e);
  void OnSwitchReleased(const stmlib::Event& e);
  void OnPotChanged(const stmlib::Event& e);
  void RefreshLeds();
  
  void ChangeControlMode();
  void SetFunction(uint8_t index, Function f);
  void SaveState();

  int32_t adc_lp_[kNumAdcChannels];
  int32_t adc_value_[kNumAdcChannels];
  int32_t adc_threshold_[kNumAdcChannels];
  uint32_t press_time_[kNumSwitches];
  bool panel_gate_control_[2];
  static const ProcessorFunction function_table_[FUNCTION_LAST][2];
  
  stmlib::EventQueue<32> queue_;
  
  Leds leds_;
  Switches switches_;
  Adc adc_;
  
  EditMode edit_mode_;
  Function function_[2];
  Settings settings_;
  uint16_t version_token_;
  
  int16_t brightness_[2];
  
  uint8_t panel_gate_state_;
  
  uint8_t double_press_counter_;
  uint8_t pot_value_[8];
  
  bool snap_mode_;
  bool snapped_[kNumAdcChannels];
  
  CalibrationData* calibration_data_;
  bool calibrating_;
  
  DISALLOW_COPY_AND_ASSIGN(Ui);
};

}  // namespace peaks

#endif  // PEAKS_UI_H_