OcAudio.h

Go to the documentation of this file.

 
#ifndef OC_AUDIO_PROTOCOL_H
#define OC_AUDIO_PROTOCOL_H
 
#include <Protocol/AudioIo.h>
#include <Protocol/AppleVoiceOver.h>
#include <Protocol/DevicePath.h>
 
#define OC_AUDIO_PROTOCOL_REVISION  0x070000
 
//
// OC_AUDIO_PROTOCOL_GUID
// 4B228577-6274-4A48-82AE-0713A1171987
//
#define OC_AUDIO_PROTOCOL_GUID  \
  { 0x4B228577, 0x6274, 0x4A48, \
    { 0x82, 0xAE, 0x07, 0x13, 0xA1, 0x17, 0x19, 0x87 } }
 
typedef struct OC_AUDIO_PROTOCOL_ OC_AUDIO_PROTOCOL;
 
#define OC_VOICE_OVER_AUDIO_BASE_TYPE_APPLE      "AXEFIAudio"
#define OC_VOICE_OVER_AUDIO_BASE_TYPE_OPEN_CORE  "OCEFIAudio"
 
#define  OC_VOICE_OVER_AUDIO_FILE_ABORT_TIMEOUT         "AbortTimeout"
#define  OC_VOICE_OVER_AUDIO_FILE_CHOOSE_OS             "ChooseOS"
#define  OC_VOICE_OVER_AUDIO_FILE_DEFAULT               "Default"
#define  OC_VOICE_OVER_AUDIO_FILE_DISK_IMAGE            "DiskImage"
#define  OC_VOICE_OVER_AUDIO_FILE_ENTER_PASSWORD        "EnterPassword"
#define  OC_VOICE_OVER_AUDIO_FILE_EXECUTION_FAILURE     "ExecutionFailure"
#define  OC_VOICE_OVER_AUDIO_FILE_EXECUTION_SUCCESSFUL  "ExecutionSuccessful"
#define  OC_VOICE_OVER_AUDIO_FILE_EXTERNAL              "External"
#define  OC_VOICE_OVER_AUDIO_FILE_EXTERNAL_OS           "ExternalOS"
#define  OC_VOICE_OVER_AUDIO_FILE_EXTERNAL_TOOL         "ExternalTool"
#define  OC_VOICE_OVER_AUDIO_FILE_FIRMWARE_SETTINGS     "FirmwareSettings"
#define  OC_VOICE_OVER_AUDIO_FILE_LOADING               "Loading"
#define  OC_VOICE_OVER_AUDIO_FILE_MAC_OS                "macOS"
#define  OC_VOICE_OVER_AUDIO_FILE_MAC_OS_RECOVERY       "macOS_Recovery"
#define  OC_VOICE_OVER_AUDIO_FILE_MAC_OS_TIME_MACHINE   "macOS_TimeMachine"
#define  OC_VOICE_OVER_AUDIO_FILE_MAC_OS_UPDATE_FW      "macOS_UpdateFw"
#define  OC_VOICE_OVER_AUDIO_FILE_NETWORK_BOOT          "NetworkBoot"
#define  OC_VOICE_OVER_AUDIO_FILE_OTHER_OS              "OtherOS"
#define  OC_VOICE_OVER_AUDIO_FILE_PASSWORD_ACCEPTED     "PasswordAccepted"
#define  OC_VOICE_OVER_AUDIO_FILE_PASSWORD_INCORRECT    "PasswordIncorrect"
#define  OC_VOICE_OVER_AUDIO_FILE_PASSWORD_RETRY_LIMIT  "PasswordRetryLimit"
#define  OC_VOICE_OVER_AUDIO_FILE_RELOADING             "Reloading"
#define  OC_VOICE_OVER_AUDIO_FILE_RESET_NVRAM           "ResetNVRAM"
#define  OC_VOICE_OVER_AUDIO_FILE_RESTART               "Restart"
#define  OC_VOICE_OVER_AUDIO_FILE_SELECTED              "Selected"
#define  OC_VOICE_OVER_AUDIO_FILE_SHOW_AUXILIARY        "ShowAuxiliary"
#define  OC_VOICE_OVER_AUDIO_FILE_SHUT_DOWN             "ShutDown"
#define  OC_VOICE_OVER_AUDIO_FILE_SIP_IS_DISABLED       "SIPIsDisabled"
#define  OC_VOICE_OVER_AUDIO_FILE_SIP_IS_ENABLED        "SIPIsEnabled"
#define  OC_VOICE_OVER_AUDIO_FILE_TIMEOUT               "Timeout"
#define  OC_VOICE_OVER_AUDIO_FILE_UEFI_SHELL            "UEFI_Shell"
#define  OC_VOICE_OVER_AUDIO_FILE_VOICE_OVER_BOOT       "VoiceOver_Boot"
#define  OC_VOICE_OVER_AUDIO_FILE_WELCOME               "Welcome"
#define  OC_VOICE_OVER_AUDIO_FILE_WINDOWS               "Windows"
 
typedef
EFI_STATUS
(EFIAPI *OC_AUDIO_CONNECT)(
  IN OUT OC_AUDIO_PROTOCOL         *This,
  IN     EFI_DEVICE_PATH_PROTOCOL  *DevicePath      OPTIONAL,
  IN     UINT8                     CodecAddress     OPTIONAL,
  IN     UINT64                    OutputIndexMask
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_AUDIO_SET_DEFAULT_GAIN)(
  IN OUT OC_AUDIO_PROTOCOL         *This,
  IN     INT8                      Gain
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_AUDIO_PROVIDER_ACQUIRE)(
  IN  VOID                            *Context,
  IN  CONST CHAR8                     *BasePath,
  IN  CONST CHAR8                     *BaseType,
  IN  BOOLEAN                         Localised,
  IN  APPLE_VOICE_OVER_LANGUAGE_CODE  LanguageCode,
  OUT UINT8                           **Buffer,
  OUT UINT32                          *BufferSize,
  OUT EFI_AUDIO_IO_PROTOCOL_FREQ      *Frequency,
  OUT EFI_AUDIO_IO_PROTOCOL_BITS      *Bits,
  OUT UINT8                           *Channels
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_AUDIO_PROVIDER_RELEASE)(
  IN  VOID                            *Context,
  IN  UINT8                           *Buffer
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_AUDIO_SET_PROVIDER)(
  IN OUT OC_AUDIO_PROTOCOL          *This,
  IN     OC_AUDIO_PROVIDER_ACQUIRE  Acquire,
  IN     OC_AUDIO_PROVIDER_RELEASE  Release  OPTIONAL,
  IN     VOID                       *Context
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_AUDIO_RAW_GAIN_TO_DECIBELS)(
  IN OUT OC_AUDIO_PROTOCOL          *This,
  IN     UINT8                      GainParam,
  OUT INT8                       *Gain
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_AUDIO_PLAY_FILE)(
  IN OUT OC_AUDIO_PROTOCOL              *This,
  IN     CONST CHAR8                    *BasePath,
  IN     CONST CHAR8                    *BaseType,
  IN     BOOLEAN                        Localised,
  IN     INT8                           Gain  OPTIONAL,
  IN     BOOLEAN                        UseGain,
  IN     BOOLEAN                        Wait
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_AUDIO_STOP_PLAYBACK)(
  IN OUT OC_AUDIO_PROTOCOL          *This,
  IN     BOOLEAN                    Wait
  );
 
typedef
UINTN
(EFIAPI *OC_AUDIO_SET_DELAY)(
  IN OUT OC_AUDIO_PROTOCOL          *This,
  IN     UINTN                      Delay
  );
 
//
// Includes a revision for debugging reasons.
//
struct OC_AUDIO_PROTOCOL_ {
  UINTN                            Revision;
  OC_AUDIO_CONNECT                 Connect;
  OC_AUDIO_RAW_GAIN_TO_DECIBELS    RawGainToDecibels;
  OC_AUDIO_SET_DEFAULT_GAIN        SetDefaultGain;
  OC_AUDIO_SET_PROVIDER            SetProvider;
  OC_AUDIO_PLAY_FILE               PlayFile;
  OC_AUDIO_STOP_PLAYBACK           StopPlayback;
  OC_AUDIO_SET_DELAY               SetDelay;
};
 
extern EFI_GUID  gOcAudioProtocolGuid;
 
#endif // OC_AUDIO_PROTOCOL_H