Nordic Thingy:52 v2.2.0
drv_mic.h
1 /*
2  Copyright (c) 2010 - 2017, Nordic Semiconductor ASA
3  All rights reserved.
4 
5  Redistribution and use in source and binary forms, with or without modification,
6  are permitted provided that the following conditions are met:
7 
8  1. Redistributions of source code must retain the above copyright notice, this
9  list of conditions and the following disclaimer.
10 
11  2. Redistributions in binary form, except as embedded into a Nordic
12  Semiconductor ASA integrated circuit in a product or a software update for
13  such product, must reproduce the above copyright notice, this list of
14  conditions and the following disclaimer in the documentation and/or other
15  materials provided with the distribution.
16 
17  3. Neither the name of Nordic Semiconductor ASA nor the names of its
18  contributors may be used to endorse or promote products derived from this
19  software without specific prior written permission.
20 
21  4. This software, with or without modification, must only be used with a
22  Nordic Semiconductor ASA integrated circuit.
23 
24  5. Any software provided in binary form under this license must not be reverse
25  engineered, decompiled, modified and/or disassembled.
26 
27  THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
28  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
29  OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
30  DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
31  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
33  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
36  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37  */
38 
48 #ifndef __DRV_MIC_H__
49 #define __DRV_MIC_H__
50 
51 #include <stdint.h>
52 #include "drv_audio_config.h"
53 
56 typedef struct
57 {
58  uint8_t data[CONFIG_AUDIO_FRAME_SIZE_BYTES];
59  uint16_t data_size;
61 
64 typedef uint32_t (*drv_mic_data_handler_t)(m_audio_frame_t * p_frame);
65 
70 uint32_t drv_mic_start(void);
71 
76 uint32_t drv_mic_stop(void);
77 
84 uint32_t drv_mic_init(drv_mic_data_handler_t data_handler);
85 
86 #endif
87 
Compressed audio frame representation.
Definition: drv_mic.h:56
uint32_t drv_mic_start(void)
Function for starting the microphone driver.
uint32_t drv_mic_stop(void)
Function for stopping the microphone driver.
uint32_t(* drv_mic_data_handler_t)(m_audio_frame_t *p_frame)
Microphone driver data handler callback type.
Definition: drv_mic.h:64
uint32_t drv_mic_init(drv_mic_data_handler_t data_handler)
Function for initializing the microphone driver.