text: // Copyright 2014 Olivier Gillet.
  //
  // Author: Olivier Gillet (ol.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.
  //
  // -----------------------------------------------------------------------------
  //
  // User interface
  
  #ifndef WARPS_UI_H_
  #define WARPS_UI_H_
  
  #include "stmlib/stmlib.h"
  
  #include "stmlib/ui/event_queue.h"
  
  #include "warps/drivers/leds.h"
  #include "warps/drivers/switches.h"
  
  #include "warps/dsp/modulator.h"
  
  namespace warps {
  
  class CvScaler;
  class Settings;
  
  enum UiMode {
    UI_MODE_NORMAL,
    UI_MODE_FEATURE_SWITCH,
    UI_MODE_CALIBRATION_C1,
    UI_MODE_CALIBRATION_C3,
    UI_MODE_CALIBRATION_LOW,
    UI_MODE_CALIBRATION_HIGH,
    UI_MODE_CALIBRATION_ERROR,
    UI_MODE_PANIC,
  };
  
  enum FactoryTestingCommand {
    FACTORY_TESTING_READ_POT,
    FACTORY_TESTING_READ_CV,
    FACTORY_TESTING_READ_GATE,
    FACTORY_TESTING_SET_BYPASS,
    FACTORY_TESTING_CALIBRATE,
    FACTORY_TESTING_READ_NORMALIZATION
  };
  
  class Ui {
   public:
    Ui() { }
    ~Ui() { }
    
    void Init(Settings* settings, CvScaler* cv_scaler, Modulator* modulator);
    void Poll();
    void DoEvents();
    void Panic() {
      mode_ = UI_MODE_PANIC;
    }
    
    uint8_t HandleFactoryTestingRequest(uint8_t command);
    
   private:
    void OnSwitchPressed(const stmlib::Event& e);
    void OnSwitchReleased(const stmlib::Event& e);
    void StartCalibration();
    void CalibrateC1();
    void CalibrateC3();
    void StartNormalizationCalibration();
    void CalibrateLow();
    void CalibrateHigh();
  
    void UpdateSettings();
  
    stmlib::EventQueue<16> queue_;
    
    Leds leds_;
    Switches switches_;
  
    Settings* settings_;
    CvScaler* cv_scaler_;
    Modulator* modulator_;
    
    UiMode mode_;
    uint32_t press_time_;
    uint8_t carrier_shape_;
    uint8_t secret_handshake_[6];
  
    float last_algo_pot_;
    bool feature_mode_changed_;
    uint8_t feature_mode_;
    
    static const uint8_t palette_[10][3];
    static const uint8_t freq_shifter_palette_[10][3];
    static const uint8_t feature_mode_palette_[10][3];
  
    DISALLOW_COPY_AND_ASSIGN(Ui);
  };
  
  }  // namespace warps
  
  #endif  // WARPS_UI_H_
  