ST / X_NUCLEO_CCA02M1

Library to handle the X-NUCLEO-CCA02M1 MEMS Microphones Expansion Board.

Dependencies:   ST_I2S ST_FREQUENCY_DIVIDER USBDEVICE

Dependents:   HelloWorld_CCA02M1 HelloWorld_CCA02M1_mbedOS HelloWorld_CCA02M1 Karaoke_CCA01M1_CCA02M1_mbedOS

Fork of X_NUCLEO_CCA02M1 by ST Expansion SW Team

MEMS Microphones Library

Library to handle the X-NUCLEO-CCA02M1 MEMS Microphones Expansion Board. A single board allows to record a standard 2-channel stereo signal as an array of PCM samples (16 bit/sample); in principle, it could make use of six additional MEMS microphones to realize a 8-channel audio system.


Microphones configuration

Currently the configurations supported are the following:

  • Stereo@48KHz
  • Stereo@44.1KHz (CD audio quality)
  • Stereo@32KHz
  • Stereo@16KHz
  • Stereo@8KHz
  • Mono@48KHz
  • Mono@44.1KHz
  • Mono@32KHz
  • Mono@16KHz
  • Mono@8KHz

Mono configurations need a Jumper connecting PB_5 and PB_13 on the Morpho connector to properly work.


Platform compatibility

  • This board can be currently used with the Nucleo F4 Family only, please see the ST_I2S library compatibility for further information.
  • The library is compatible both with mbed OS 5.x and mbed classic 2.x (to work with mbed classic, the main application has to import the "events" library, which is not included into the "mbed" library).


I2S Peripheral Usage

By default this board makes use of the I2S peripheral available on Nucleo boards.


Acquiring through the USB

In order to acquire the recorded PCM audio channel with an audio SW on a PC, please connect the expansion board to a USB port of the PC, and the Nucleo board to a USB power supply.

BSP/PDM2PCMAudio_class.h@0:d5552d432108, 2017-02-28 (annotated)

Committer:
davide.aliprandi@st.com
Date:
Tue Feb 28 11:20:53 2017 +0100
Revision:
0:d5552d432108
Library to handle the X-NUCLEO-CCA02M1 MEMS Microphones Expansion Board.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
davide.aliprandi@st.com 0:d5552d432108 1 /**
davide.aliprandi@st.com 0:d5552d432108 2 ******************************************************************************
davide.aliprandi@st.com 0:d5552d432108 3 * @file PDM2PCMAudio_class.h
davide.aliprandi@st.com 0:d5552d432108 4 * @author AST / Software Platforms and Cloud
davide.aliprandi@st.com 0:d5552d432108 5 * @version V1.0
davide.aliprandi@st.com 0:d5552d432108 6 * @date November 10th, 2016
davide.aliprandi@st.com 0:d5552d432108 7 * @brief Class header file for the PDM2PCMAudio conversion library.
davide.aliprandi@st.com 0:d5552d432108 8 ******************************************************************************
davide.aliprandi@st.com 0:d5552d432108 9 * @attention
davide.aliprandi@st.com 0:d5552d432108 10 *
davide.aliprandi@st.com 0:d5552d432108 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
davide.aliprandi@st.com 0:d5552d432108 12 *
davide.aliprandi@st.com 0:d5552d432108 13 * Redistribution and use in source and binary forms, with or without modification,
davide.aliprandi@st.com 0:d5552d432108 14 * are permitted provided that the following conditions are met:
davide.aliprandi@st.com 0:d5552d432108 15 * 1. Redistributions of source code must retain the above copyright notice,
davide.aliprandi@st.com 0:d5552d432108 16 * this list of conditions and the following disclaimer.
davide.aliprandi@st.com 0:d5552d432108 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
davide.aliprandi@st.com 0:d5552d432108 18 * this list of conditions and the following disclaimer in the documentation
davide.aliprandi@st.com 0:d5552d432108 19 * and/or other materials provided with the distribution.
davide.aliprandi@st.com 0:d5552d432108 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
davide.aliprandi@st.com 0:d5552d432108 21 * may be used to endorse or promote products derived from this software
davide.aliprandi@st.com 0:d5552d432108 22 * without specific prior written permission.
davide.aliprandi@st.com 0:d5552d432108 23 *
davide.aliprandi@st.com 0:d5552d432108 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
davide.aliprandi@st.com 0:d5552d432108 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
davide.aliprandi@st.com 0:d5552d432108 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
davide.aliprandi@st.com 0:d5552d432108 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
davide.aliprandi@st.com 0:d5552d432108 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
davide.aliprandi@st.com 0:d5552d432108 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
davide.aliprandi@st.com 0:d5552d432108 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
davide.aliprandi@st.com 0:d5552d432108 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
davide.aliprandi@st.com 0:d5552d432108 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
davide.aliprandi@st.com 0:d5552d432108 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
davide.aliprandi@st.com 0:d5552d432108 34 *
davide.aliprandi@st.com 0:d5552d432108 35 ******************************************************************************
davide.aliprandi@st.com 0:d5552d432108 36 */
davide.aliprandi@st.com 0:d5552d432108 37
davide.aliprandi@st.com 0:d5552d432108 38
davide.aliprandi@st.com 0:d5552d432108 39 /* Define to prevent recursive inclusion -------------------------------------*/
davide.aliprandi@st.com 0:d5552d432108 40
davide.aliprandi@st.com 0:d5552d432108 41 #ifndef __PDM2PCM_AUDIO_CLASS_H
davide.aliprandi@st.com 0:d5552d432108 42 #define __PDM2PCM_AUDIO_CLASS_H
davide.aliprandi@st.com 0:d5552d432108 43
davide.aliprandi@st.com 0:d5552d432108 44
davide.aliprandi@st.com 0:d5552d432108 45 /* Includes ------------------------------------------------------------------*/
davide.aliprandi@st.com 0:d5552d432108 46
davide.aliprandi@st.com 0:d5552d432108 47 #include "mbed.h"
davide.aliprandi@st.com 0:d5552d432108 48 #include "component.h"
davide.aliprandi@st.com 0:d5552d432108 49 #include "pdm_filter.h"
davide.aliprandi@st.com 0:d5552d432108 50
davide.aliprandi@st.com 0:d5552d432108 51
davide.aliprandi@st.com 0:d5552d432108 52 /* Definitions ---------------------------------------------------------------*/
davide.aliprandi@st.com 0:d5552d432108 53
davide.aliprandi@st.com 0:d5552d432108 54 #define DEMUX_FILTER_SIZE 128
davide.aliprandi@st.com 0:d5552d432108 55 #define DEMUX_FILTER_MASK 0x55
davide.aliprandi@st.com 0:d5552d432108 56 #define PDM2PCM_FILTER_SIZE 4
davide.aliprandi@st.com 0:d5552d432108 57 #define PDM2PCM_NOGAIN_VOLUME 4
davide.aliprandi@st.com 0:d5552d432108 58 #define PDM2PCM_MAX_VOLUME 64
davide.aliprandi@st.com 0:d5552d432108 59 #define PDM2PCM_DECIMATION_FACTOR 64
davide.aliprandi@st.com 0:d5552d432108 60
davide.aliprandi@st.com 0:d5552d432108 61
davide.aliprandi@st.com 0:d5552d432108 62 /* Classes -------------------------------------------------------------------*/
davide.aliprandi@st.com 0:d5552d432108 63
davide.aliprandi@st.com 0:d5552d432108 64 /** PDM2PCMAudio Conversion Library Class.
davide.aliprandi@st.com 0:d5552d432108 65 */
davide.aliprandi@st.com 0:d5552d432108 66 class PDM2PCMAudio
davide.aliprandi@st.com 0:d5552d432108 67 {
davide.aliprandi@st.com 0:d5552d432108 68 public:
davide.aliprandi@st.com 0:d5552d432108 69
davide.aliprandi@st.com 0:d5552d432108 70
davide.aliprandi@st.com 0:d5552d432108 71 /**
davide.aliprandi@st.com 0:d5552d432108 72 * @brief Constructor.
davide.aliprandi@st.com 0:d5552d432108 73 * @param frequency Audio sampling frequency.
davide.aliprandi@st.com 0:d5552d432108 74 * @param _channels Number of audio _channels to be recorded.
davide.aliprandi@st.com 0:d5552d432108 75 */
davide.aliprandi@st.com 0:d5552d432108 76 PDM2PCMAudio(uint32_t frequency, uint32_t _channels) :
davide.aliprandi@st.com 0:d5552d432108 77 _frequency(frequency),
davide.aliprandi@st.com 0:d5552d432108 78 _channels(_channels)
davide.aliprandi@st.com 0:d5552d432108 79 {
davide.aliprandi@st.com 0:d5552d432108 80 /* Enable CRC peripheral to unlock the PDM2PCMAudio library. */
davide.aliprandi@st.com 0:d5552d432108 81 __CRC_CLK_ENABLE();
davide.aliprandi@st.com 0:d5552d432108 82
davide.aliprandi@st.com 0:d5552d432108 83 /* Initializing PDM2PCMAudio Filter. */
davide.aliprandi@st.com 0:d5552d432108 84 for (uint32_t i = 0; i < _channels; i++)
davide.aliprandi@st.com 0:d5552d432108 85 {
davide.aliprandi@st.com 0:d5552d432108 86 /* Filter LP and HP Init */
davide.aliprandi@st.com 0:d5552d432108 87 _PDM2PCM_filter[i].LP_HZ = _frequency / 2;
davide.aliprandi@st.com 0:d5552d432108 88 _PDM2PCM_filter[i].HP_HZ = 10;
davide.aliprandi@st.com 0:d5552d432108 89 _PDM2PCM_filter[i].Fs = _frequency;
davide.aliprandi@st.com 0:d5552d432108 90 _PDM2PCM_filter[i].Out_MicChannels = _channels;
davide.aliprandi@st.com 0:d5552d432108 91 _PDM2PCM_filter[i].In_MicChannels = _channels;
davide.aliprandi@st.com 0:d5552d432108 92 PDM_Filter_Init((PDMFilter_InitStruct *) &_PDM2PCM_filter[i]);
davide.aliprandi@st.com 0:d5552d432108 93 }
davide.aliprandi@st.com 0:d5552d432108 94 };
davide.aliprandi@st.com 0:d5552d432108 95
davide.aliprandi@st.com 0:d5552d432108 96 /**
davide.aliprandi@st.com 0:d5552d432108 97 * @brief Converting audio data from PDM to PCM.
davide.aliprandi@st.com 0:d5552d432108 98 * @param output_buffer Pointer to output PCM buffer data.
davide.aliprandi@st.com 0:d5552d432108 99 * @param input_buffer Pointer to input PDM buffer data.
davide.aliprandi@st.com 0:d5552d432108 100 * @param volume Volume level (it must be in the range [0..64]).
davide.aliprandi@st.com 0:d5552d432108 101 * @param decimation_factor Decimation factor (it must be either 64 or 128).
davide.aliprandi@st.com 0:d5552d432108 102 * @retval COMPONENT_OK in case of success, COMPONENT_ERROR otherwise.
davide.aliprandi@st.com 0:d5552d432108 103 */
davide.aliprandi@st.com 0:d5552d432108 104 Status_t Convert(int16_t *output_buffer, uint16_t *input_buffer, uint32_t volume, uint32_t decimation_factor);
davide.aliprandi@st.com 0:d5552d432108 105
davide.aliprandi@st.com 0:d5552d432108 106 /**
davide.aliprandi@st.com 0:d5552d432108 107 * @brief Scrambling audio data.
davide.aliprandi@st.com 0:d5552d432108 108 * @param output_buffer Pointer to output PDM buffer data.
davide.aliprandi@st.com 0:d5552d432108 109 * @param input_buffer Pointer to input PDM buffer data.
davide.aliprandi@st.com 0:d5552d432108 110 * @param size Size of the buffers (thay has to be equally sized).
davide.aliprandi@st.com 0:d5552d432108 111 * @retval COMPONENT_OK in case of success, COMPONENT_ERROR otherwise.
davide.aliprandi@st.com 0:d5552d432108 112 */
davide.aliprandi@st.com 0:d5552d432108 113 Status_t Scramble(uint16_t *output_buffer, uint16_t *input_buffer, uint32_t size);
davide.aliprandi@st.com 0:d5552d432108 114
davide.aliprandi@st.com 0:d5552d432108 115 /**
davide.aliprandi@st.com 0:d5552d432108 116 * @brief Demuxing audio data.
davide.aliprandi@st.com 0:d5552d432108 117 * @param output_buffer Pointer to output PDM buffer data.
davide.aliprandi@st.com 0:d5552d432108 118 * @param input_buffer Pointer to input PDM buffer data.
davide.aliprandi@st.com 0:d5552d432108 119 * @param size Size of the buffers (thay has to be equally sized).
davide.aliprandi@st.com 0:d5552d432108 120 * @retval COMPONENT_OK in case of success, COMPONENT_ERROR otherwise.
davide.aliprandi@st.com 0:d5552d432108 121 */
davide.aliprandi@st.com 0:d5552d432108 122 Status_t Demux(uint16_t *output_buffer, uint16_t *input_buffer, uint32_t size);
davide.aliprandi@st.com 0:d5552d432108 123
davide.aliprandi@st.com 0:d5552d432108 124
davide.aliprandi@st.com 0:d5552d432108 125 protected:
davide.aliprandi@st.com 0:d5552d432108 126
davide.aliprandi@st.com 0:d5552d432108 127 uint32_t _frequency;
davide.aliprandi@st.com 0:d5552d432108 128 uint32_t _channels;
davide.aliprandi@st.com 0:d5552d432108 129 PDMFilter_InitStruct _PDM2PCM_filter[PDM2PCM_FILTER_SIZE];
davide.aliprandi@st.com 0:d5552d432108 130 static const uint8_t _demux_filter[DEMUX_FILTER_SIZE];
davide.aliprandi@st.com 0:d5552d432108 131 };
davide.aliprandi@st.com 0:d5552d432108 132
davide.aliprandi@st.com 0:d5552d432108 133 #endif /* __PDM2PCM_AUDIO_CLASS_H */
davide.aliprandi@st.com 0:d5552d432108 134
davide.aliprandi@st.com 0:d5552d432108 135 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/