OcAudioLib.h File Reference

#include <Uefi.h>
#include <Library/OcFileLib.h>
#include <Protocol/OcAudio.h>

Go to the source code of this file.

Data Structures
struct	APPLE_VOICE_OVER_FILE_MAP

Macros
#define	OC_AUDIO_DEFAULT_GAIN   (-30)

Functions
OC_AUDIO_PROTOCOL *	OcAudioInstallProtocols (IN BOOLEAN Reinstall, IN BOOLEAN DisconnectHda)
CONST CHAR8 *	OcLanguageCodeToString (IN APPLE_VOICE_OVER_LANGUAGE_CODE LanguageCode)
VOID	OcGetAmplifierGain (OUT UINT8 *RawGain, OUT INT8 *DecibelGain, OUT BOOLEAN *Muted, OUT BOOLEAN *TryConversion)
EFI_STATUS	OcSetVoiceOverLanguage (CONST CHAR8 *Language OPTIONAL)
EFI_STATUS	OcAudioDump (IN EFI_FILE_PROTOCOL *Root)

Detailed Description

This library implements audio interaction.

Copyright (c) 2020, vit9696. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause

Definition in file OcAudioLib.h.

Macro Definition Documentation

OC_AUDIO_DEFAULT_GAIN

#define OC_AUDIO_DEFAULT_GAIN   (-30)

Definition at line 15 of file OcAudioLib.h.

Function Documentation

OcAudioDump()

EFI_STATUS OcAudioDump

(

IN EFI_FILE_PROTOCOL *

Root

)

Dump audio data to the specified directory.

Parameters

[in]

Root

Directory to write audio data.

Return values

EFI_SUCCESS

on success.

Definition at line 578 of file OcAudioDump.c.

OcAudioInstallProtocols()

OC_AUDIO_PROTOCOL * OcAudioInstallProtocols	(	IN BOOLEAN	Reinstall,
		IN BOOLEAN	DisconnectHda )

Install audio support protocols.

Parameters

[in]	Reinstall	Overwrite installed protocols.
[in]	DisconnectHda	Attempt to disconnect HDA controller first.

Return values

installed	protocol.
NULL	when conflicting audio implementation is present.
NULL	when installation failed.

Definition at line 80 of file OcAudioLib.c.

OcGetAmplifierGain()

VOID OcGetAmplifierGain	(	OUT UINT8 *	RawGain,
		OUT INT8 *	DecibelGain,
		OUT BOOLEAN *	Muted,
		OUT BOOLEAN *	TryConversion )

Get system amplifier gain.

Parameters

[out]	RawGain	Raw codec gain setting.
[out]	DecibelGain	Decibel gain setting.
[out]	Muted	Whether amplifier should be muted.
[out]	TryConversion	TRUE when decibel gain setting is a default value and raw codec gain setting is a real value.

Definition at line 166 of file OcAudioLib.c.

OcLanguageCodeToString()

CONST CHAR8 * OcLanguageCodeToString

(

IN APPLE_VOICE_OVER_LANGUAGE_CODE

LanguageCode

)

Convert language code to ASCII string.

Parameters

[in]

LanguageCode

Code.

Return values

ASCII

string.

Definition at line 130 of file OcAudioVoiceOver.c.

OcSetVoiceOverLanguage()

EFI_STATUS OcSetVoiceOverLanguage

(

CONST CHAR8 *Language

OPTIONAL

)

Set VoiceOver language from string.

Parameters

[in]

Language

Language string, optional for system.

Return values

EFI_SUCCESS

on success.

Definition at line 138 of file OcAudioVoiceOver.c.