| Nordic Thingy:52 v2.0.0

drv_speaker.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_SPEAKER_H__
49 #define __DRV_SPEAKER_H__
50
51 #include <stdint.h>
52
55 typedef enum
56 {
57 DRV_SPEAKER_EVT_FINISHED,
58 DRV_SPEAKER_EVT_BUFFER_WARNING,
59 DRV_SPEAKER_EVT_BUFFER_READY
60 }drv_speaker_evt_t;
61
64 typedef void (*drv_speaker_evt_handler_t)(drv_speaker_evt_t evt);
65
68 typedef struct
69 {
70 drv_speaker_evt_handler_t evt_handler;
71 }drv_speaker_init_t;
72
81 uint32_t drv_speaker_init(drv_speaker_init_t * p_params);
82
93 uint32_t drv_speaker_tone_start(uint16_t freq_hz, uint32_t duration_ms, uint8_t volume);
94
103 uint32_t drv_speaker_flash_pcm_play(uint8_t const * const p_sound, uint32_t size);
104
113 uint32_t drv_speaker_ble_pcm_play(uint8_t * p_sound, uint32_t length);
114
122 uint32_t drv_speaker_sample_play(uint8_t sample_id);
123
124 #endif
125
drv_speaker_init
uint32_t drv_speaker_init(drv_speaker_init_t *p_params)
Function for initializing the speaker driver.
drv_speaker_init_t
Speaker driver initialization type.
Definition: drv_speaker.h:68
drv_speaker_sample_play
uint32_t drv_speaker_sample_play(uint8_t sample_id)
Function for playing one of the prestored samples. See sounds.h.
drv_speaker_evt_t
drv_speaker_evt_t
Speaker driver event types.
Definition: drv_speaker.h:55
drv_speaker_ble_pcm_play
uint32_t drv_speaker_ble_pcm_play(uint8_t *p_sound, uint32_t length)
Function for playing an 8-bit 8 kHz PCM encoded audio split into packages.
drv_speaker_tone_start
uint32_t drv_speaker_tone_start(uint16_t freq_hz, uint32_t duration_ms, uint8_t volume)
Function for playing a single tone through the speaker.
drv_speaker_evt_handler_t
void(* drv_speaker_evt_handler_t)(drv_speaker_evt_t evt)
Speaker driver event handler callback type.
Definition: drv_speaker.h:64
drv_speaker_flash_pcm_play
uint32_t drv_speaker_flash_pcm_play(uint8_t const *const p_sound, uint32_t size)
Function for playing an 8-bit 8 kHz PCM encoded audio sample.