1/*
2Copyright (c) 2012, Broadcom Europe Ltd
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions are met:
7 * Redistributions of source code must retain the above copyright
8 notice, this list of conditions and the following disclaimer.
9 * Redistributions in binary form must reproduce the above copyright
10 notice, this list of conditions and the following disclaimer in the
11 documentation and/or other materials provided with the distribution.
12 * Neither the name of the copyright holder nor the
13 names of its contributors may be used to endorse or promote products
14 derived from this software without specific prior written permission.
15
16THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
20DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*/
27
28#ifndef MMAL_PARAMETERS_AUDIO_H
29#define MMAL_PARAMETERS_AUDIO_H
30
31#include "mmal_parameters_common.h"
32
33/*************************************************
34 * ALWAYS ADD NEW ENUMS AT THE END OF THIS LIST! *
35 ************************************************/
36
37/** Audio-specific MMAL parameter IDs.
38 * @ingroup MMAL_PARAMETER_IDS
39 */
40enum
41{
42 MMAL_PARAMETER_AUDIO_DESTINATION /**< Takes a MMAL_PARAMETER_STRING_T */
43 = MMAL_PARAMETER_GROUP_AUDIO,
44 MMAL_PARAMETER_AUDIO_LATENCY_TARGET, /**< Takes a MMAL_PARAMETER_AUDIO_LATENCY_TARGET_T */
45 MMAL_PARAMETER_AUDIO_SOURCE,
46 MMAL_PARAMETER_AUDIO_PASSTHROUGH, /**< Takes a MMAL_PARAMETER_BOOLEAN_T */
47};
48
49/** Audio latency target to maintain.
50 * These settings are used to adjust the clock speed in order
51 * to match the measured audio latency to a specified value. */
52typedef struct MMAL_PARAMETER_AUDIO_LATENCY_TARGET_T
53{
54 MMAL_PARAMETER_HEADER_T hdr;
55
56 MMAL_BOOL_T enable; /**< whether this mode is enabled */
57 uint32_t filter; /**< number of latency samples to filter on, good value: 1 */
58 uint32_t target; /**< target latency (microseconds) */
59 uint32_t shift; /**< shift for storing latency values, good value: 7 */
60 int32_t speed_factor; /**< multiplier for speed changes, in 24.8 format, good value: 256-512 */
61 int32_t inter_factor; /**< divider for comparing latency versus gradiant, good value: 300 */
62 int32_t adj_cap; /**< limit for speed change before nSpeedFactor is applied, good value: 100 */
63} MMAL_PARAMETER_AUDIO_LATENCY_TARGET_T;
64
65#endif /* MMAL_PARAMETERS_AUDIO_H */
66
67