CWGenerator.hxx

Go to the documentation of this file.

/*
Copyright (c) 2012,2013,2014, 2025 Matthew H. Reilly (kb1vc)
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
    Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
    Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
 
#include "SoDaBase.hxx"
#include "Command.hxx"
#include "Params.hxx"
#include <map>
#include <memory>
 
namespace SoDa {
  class CWGenerator;
  typedef std::shared_ptr<CWGenerator> CWGeneratorPtr; 
  
  class CWGenerator {
  protected:
    CWGenerator(FDatMBoxPtr cw_env_stream, double _samp_rate, unsigned int _env_buf_len);
 
  public:
    static CWGeneratorPtr make(FDatMBoxPtr cw_env_stream, 
                   double _samp_rate, 
                   unsigned int _env_buf_len) {
      auto ret = std::shared_ptr<CWGenerator>(new CWGenerator(cw_env_stream,
                                 _samp_rate,
                                 _env_buf_len));
      return ret; 
    }
    
    void setCWSpeed(unsigned int wpm);

    unsigned int getCWSpeed() { return words_per_minute; }

    bool readyForMore();

    bool sendChar(char c);
    
  private:

    void appendToOut(std::vector<float> & v);

    void flushBuffer();

    void clearBuffer();

    void initMorseMap();
    
    // configuration params. 
    FDatMBoxPtr env_stream;  
    double sample_rate;  
    unsigned int env_buf_len; 
 
    // timing parameters
    unsigned int words_per_minute; 
    unsigned int edge_sample_count; 
 
    unsigned int bufs_per_sec; 
 
    // envelopes are float buffers.
    std::vector<float> dit; 
    std::vector<float> dah; 
    std::vector<float> inter_char_space; 
    std::vector<float> inter_word_space; 
    
    // edges are float buffers too
    std::vector<float> rising_edge; 
    std::vector<float> falling_edge; 
 
    static std::map<char, std::string> morse_map; 
 
    // current output buffer
    SoDa::FBufPtr cur_buf; 
    unsigned int cur_buf_idx; 
    
    // state of the translator
    bool in_digraph; 
    bool last_was_space; 
  }; 
}