src/mic/mic.h

   1 /*
   2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
   3  * Copyright (c) 2014 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24 #pragma once
  25
  26 #include <string>
  27 #include <mraa/gpio.h>
  28 #include <mraa/aio.h>
  29
  30 struct thresholdContext {
  31     long averageReading;
  32     long runningAverage;
  33     int averagedOver;
  34 };
  35
  36 namespace upm {
  37
  38 /**
  39  * @brief C++ API for Microphone
  40  *
  41  * This file defines the Microphone Analog sensor
  42  *
  43  * @snippet mic-example.cxx Interesting
  44  *
  45  */
  46 class Microphone {
  47     public:
  48         /**
  49          * Instanciates a Microphone object
  50          *
  51          * @param micPin pin where microphone is connected
  52          */
  53         Microphone(int micPin);
  54
  55         /**
  56          * MAX31723 object destructor
  57          */
  58         ~Microphone();
  59
  60         /**
  61          * Get samples from microphone according to provided window and
  62          * number of samples
  63          *
  64          * @param freqMS time between each sample (in microseconds)
  65          * @param numberOfSamples number of sample to sample for this window
  66          * @param buffer bufer with sampled data
  67          */
  68         int getSampledWindow (unsigned int freqMS, unsigned int numberOfSamples, uint16_t * buffer);
  69
  70         /**
  71          * Given sampled buffer this method will return TRUE/FALSE if threshold
  72          * was reached
  73          *
  74          * @param ctx threshold context
  75          * @param threshold sample threshold
  76          * @param buffer buffer with samples
  77          * @param len bufer len
  78          */
  79         int findThreshold (thresholdContext* ctx, unsigned int threshold, uint16_t * buffer, unsigned int len);
  80
  81         /**
  82          *
  83          * Print running average of threshold context
  84          *
  85          * @param ctx threshold context
  86          */
  87         void printGraph (thresholdContext* ctx);
  88
  89     private:
  90         mraa_aio_context    m_micCtx;
  91 };
  92
  93 }