Anh Tran / Mbed OS GR-Boards_WebCamera

test public

Dependencies:   HttpServer_snapshot_mbed-os

mbed-gr-libs/components/AUDIO/AUDIO_RBSP.h@0:e9fd5575b10e, 2019-10-18 (annotated)

Committer:
anhtran
Date:
Fri Oct 18 03:09:43 2019 +0000
Revision:
0:e9fd5575b10e
abc

Who changed what in which revision?

UserRevisionLine numberNew contents of line
anhtran 0:e9fd5575b10e 1 /*******************************************************************************
anhtran 0:e9fd5575b10e 2 * DISCLAIMER
anhtran 0:e9fd5575b10e 3 * This software is supplied by Renesas Electronics Corporation and is only
anhtran 0:e9fd5575b10e 4 * intended for use with Renesas products. No other uses are authorized. This
anhtran 0:e9fd5575b10e 5 * software is owned by Renesas Electronics Corporation and is protected under
anhtran 0:e9fd5575b10e 6 * all applicable laws, including copyright laws.
anhtran 0:e9fd5575b10e 7 * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
anhtran 0:e9fd5575b10e 8 * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
anhtran 0:e9fd5575b10e 9 * LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
anhtran 0:e9fd5575b10e 10 * AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
anhtran 0:e9fd5575b10e 11 * TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
anhtran 0:e9fd5575b10e 12 * ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
anhtran 0:e9fd5575b10e 13 * FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
anhtran 0:e9fd5575b10e 14 * ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
anhtran 0:e9fd5575b10e 15 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
anhtran 0:e9fd5575b10e 16 * Renesas reserves the right, without notice, to make changes to this software
anhtran 0:e9fd5575b10e 17 * and to discontinue the availability of this software. By using this software,
anhtran 0:e9fd5575b10e 18 * you agree to the additional terms and conditions found by accessing the
anhtran 0:e9fd5575b10e 19 * following link:
anhtran 0:e9fd5575b10e 20 * http://www.renesas.com/disclaimer*
anhtran 0:e9fd5575b10e 21 * Copyright (C) 2018 Renesas Electronics Corporation. All rights reserved.
anhtran 0:e9fd5575b10e 22 *******************************************************************************/
anhtran 0:e9fd5575b10e 23
anhtran 0:e9fd5575b10e 24 #ifndef AUDIO_RBSP_H
anhtran 0:e9fd5575b10e 25 #define AUDIO_RBSP_H
anhtran 0:e9fd5575b10e 26
anhtran 0:e9fd5575b10e 27 #include "mbed.h"
anhtran 0:e9fd5575b10e 28 #include "R_BSP_Aio.h"
anhtran 0:e9fd5575b10e 29
anhtran 0:e9fd5575b10e 30 /** AUDIO_RBSP class
anhtran 0:e9fd5575b10e 31 *
anhtran 0:e9fd5575b10e 32 */
anhtran 0:e9fd5575b10e 33 class AUDIO_RBSP {
anhtran 0:e9fd5575b10e 34 public:
anhtran 0:e9fd5575b10e 35 /** Overloaded power()
anhtran 0:e9fd5575b10e 36 *
anhtran 0:e9fd5575b10e 37 * @param type true=power up, false=power down
anhtran 0:e9fd5575b10e 38 */
anhtran 0:e9fd5575b10e 39 virtual void power(bool type = true) = 0;
anhtran 0:e9fd5575b10e 40
anhtran 0:e9fd5575b10e 41 /** Set I2S interface bit length and mode
anhtran 0:e9fd5575b10e 42 *
anhtran 0:e9fd5575b10e 43 * @param length Set bit length to 16 bits
anhtran 0:e9fd5575b10e 44 * @return true = success, false = failure
anhtran 0:e9fd5575b10e 45 */
anhtran 0:e9fd5575b10e 46 virtual bool format(char length) = 0;
anhtran 0:e9fd5575b10e 47
anhtran 0:e9fd5575b10e 48 /** Set sample frequency
anhtran 0:e9fd5575b10e 49 *
anhtran 0:e9fd5575b10e 50 * @param frequency Sample frequency of data in Hz
anhtran 0:e9fd5575b10e 51 * @return true = success, false = failure
anhtran 0:e9fd5575b10e 52 *
anhtran 0:e9fd5575b10e 53 * supports frequencies: 44.1kHz
anhtran 0:e9fd5575b10e 54 * Default is 44.1kHz
anhtran 0:e9fd5575b10e 55 */
anhtran 0:e9fd5575b10e 56 virtual bool frequency(int hz) = 0;
anhtran 0:e9fd5575b10e 57
anhtran 0:e9fd5575b10e 58 /** Enqueue asynchronous write request
anhtran 0:e9fd5575b10e 59 *
anhtran 0:e9fd5575b10e 60 * @param p_data Location of the data
anhtran 0:e9fd5575b10e 61 * @param data_size Number of bytes to write
anhtran 0:e9fd5575b10e 62 * @param p_data_conf Asynchronous control block structure
anhtran 0:e9fd5575b10e 63 * @return Number of bytes written on success. negative number on error.
anhtran 0:e9fd5575b10e 64 */
anhtran 0:e9fd5575b10e 65 virtual int write(void * const p_data, uint32_t data_size, const rbsp_data_conf_t * const p_data_conf = NULL) = 0;
anhtran 0:e9fd5575b10e 66
anhtran 0:e9fd5575b10e 67 /** Enqueue asynchronous read request
anhtran 0:e9fd5575b10e 68 *
anhtran 0:e9fd5575b10e 69 * @param p_data Location of the data
anhtran 0:e9fd5575b10e 70 * @param data_size Number of bytes to read
anhtran 0:e9fd5575b10e 71 * @param p_data_conf Asynchronous control block structure
anhtran 0:e9fd5575b10e 72 * @return Number of bytes read on success. negative number on error.
anhtran 0:e9fd5575b10e 73 */
anhtran 0:e9fd5575b10e 74 virtual int read(void * const p_data, uint32_t data_size, const rbsp_data_conf_t * const p_data_conf = NULL) = 0;
anhtran 0:e9fd5575b10e 75
anhtran 0:e9fd5575b10e 76 /** Headphone out volume control
anhtran 0:e9fd5575b10e 77 *
anhtran 0:e9fd5575b10e 78 * @param leftVolumeOut Left headphone-out volume
anhtran 0:e9fd5575b10e 79 * @param rightVolumeOut Right headphone-out volume
anhtran 0:e9fd5575b10e 80 * @return Returns "true" for success, "false" if parameters are out of range
anhtran 0:e9fd5575b10e 81 */
anhtran 0:e9fd5575b10e 82 virtual bool outputVolume(float leftVolumeOut, float rightVolumeOut) = 0;
anhtran 0:e9fd5575b10e 83
anhtran 0:e9fd5575b10e 84 /** Microphone volume
anhtran 0:e9fd5575b10e 85 *
anhtran 0:e9fd5575b10e 86 * @param VolumeIn Microphone volume
anhtran 0:e9fd5575b10e 87 * @return Returns "true" for success, "false" if parameters are out of range
anhtran 0:e9fd5575b10e 88 */
anhtran 0:e9fd5575b10e 89 virtual bool micVolume(float VolumeIn) = 0;
anhtran 0:e9fd5575b10e 90
anhtran 0:e9fd5575b10e 91 };
anhtran 0:e9fd5575b10e 92
anhtran 0:e9fd5575b10e 93 #endif