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 Analog Microphone library
40  * @defgroup mic libupm-mic
41  * @ingroup seeed pwm sound gsk
42  */
43 /**
44  * @library mic
45  * @sensor mic
46  * @comname Analog Microphone
47  * @altname Grove Sound Sensor
48  * @type sound
49  * @man seeed
50  * @web http://www.seeedstudio.com/wiki/Grove_-_Sound_Sensors
51  * @con pwm
52  * @kit gsk
53  *
54  * @brief API for the Analog Microphone
55  *
56  * This module defines the Analog Microphone sensor
57  *
58  * @image html mic.jpg
59  * @snippet mic.cxx Interesting
60  */
61 class Microphone {
62     public:
63         /**
64          * Instantiates a Microphone object
65          *
66          * @param micPin Pin where the microphone is connected
67          */
68         Microphone(int micPin);
69 
70         /**
71          * Microphone object destructor
72          */
73         ~Microphone();
74 
75         /**
76          * Gets samples from the microphone according to the provided window and
77          * number of samples
78          *
79          * @param freqMS Time between each sample (in microseconds)
80          * @param numberOfSamples Number of sample to sample for this window
81          * @param buffer Buffer with sampled data
82          */
83         int getSampledWindow (unsigned int freqMS, int numberOfSamples, uint16_t * buffer);
84 
85         /**
86          * Given the sampled buffer, this method returns TRUE/FALSE if threshold
87          * is reached
88          *
89          * @param ctx Threshold context
90          * @param threshold Sample threshold
91          * @param buffer Buffer with samples
92          * @param len Buffer length
93          */
94         int findThreshold (thresholdContext* ctx, unsigned int threshold, uint16_t * buffer, int len);
95 
96         /**
97          *
98          * Prints a running average of the threshold context
99          *
100          * @param ctx Threshold context
101          */
102         void printGraph (thresholdContext* ctx);
103 
104     private:
105         mraa_aio_context    m_micCtx;
106 };
107 
108 }
109