mirror of https://github.com/acidanthera/audk.git
201 lines
8.6 KiB
C
201 lines
8.6 KiB
C
/** @file
|
|
This protocol provides generic image decoder interfaces to various image formats.
|
|
|
|
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
|
|
|
|
This program and the accompanying materials are licensed and made available under
|
|
the terms and conditions of the BSD License that accompanies this distribution.
|
|
The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php.
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
#ifndef __EFI_IMAGE_DECODER_PROTOCOL_H__
|
|
#define __EFI_IMAGE_DECODER_PROTOCOL_H__
|
|
|
|
#include <Protocol/HiiImage.h>
|
|
|
|
|
|
//
|
|
// In UEFI 2.6 spec,this guid value is duplicate with
|
|
// EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID. Now update this guid value to
|
|
// avoid the duplicate guid issue. So its value is not consistent with
|
|
// UEFI spec definition now. We have proposed to update UEFI spec to
|
|
// use this new guid. After new spec released, we will remove this
|
|
// comments.
|
|
//
|
|
#define EFI_HII_IMAGE_DECODER_PROTOCOL_GUID \
|
|
{0x9e66f251, 0x727c, 0x418c, { 0xbf, 0xd6, 0xc2, 0xb4, 0x25, 0x28, 0x18, 0xea }}
|
|
|
|
|
|
#define EFI_HII_IMAGE_DECODER_NAME_JPEG_GUID \
|
|
{0xefefd093, 0xd9b, 0x46eb, { 0xa8, 0x56, 0x48, 0x35, 0x7, 0x0, 0xc9, 0x8 }}
|
|
|
|
#define EFI_HII_IMAGE_DECODER_NAME_PNG_GUID \
|
|
{0xaf060190, 0x5e3a, 0x4025, { 0xaf, 0xbd, 0xe1, 0xf9, 0x5, 0xbf, 0xaa, 0x4c }}
|
|
|
|
typedef struct _EFI_HII_IMAGE_DECODER_PROTOCOL EFI_HII_IMAGE_DECODER_PROTOCOL;
|
|
|
|
typedef enum {
|
|
EFI_HII_IMAGE_DECODER_COLOR_TYPE_RGB = 0x0,
|
|
EFI_HII_IMAGE_DECODER_COLOR_TYPE_RGBA = 0x1,
|
|
EFI_HII_IMAGE_DECODER_COLOR_TYPE_CMYK = 0x2,
|
|
EFI_HII_IMAGE_DECODER_COLOR_TYPE_UNKNOWN = 0xFF
|
|
} EFI_HII_IMAGE_DECODER_COLOR_TYPE;
|
|
|
|
//
|
|
// EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER
|
|
//
|
|
// DecoderName Name of the decoder
|
|
// ImageInfoSize The size of entire image information structure in bytes
|
|
// ImageWidth The image width
|
|
// ImageHeight The image height
|
|
// ColorType The color type, see EFI_HII_IMAGE_DECODER_COLOR_TYPE.
|
|
// ColorDepthInBits The color depth in bits
|
|
//
|
|
typedef struct _EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER {
|
|
EFI_GUID DecoderName;
|
|
UINT16 ImageInfoSize;
|
|
UINT16 ImageWidth;
|
|
UINT16 ImageHeight;
|
|
EFI_HII_IMAGE_DECODER_COLOR_TYPE ColorType;
|
|
UINT8 ColorDepthInBits;
|
|
} EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER;
|
|
|
|
//
|
|
// EFI_HII_IMAGE_DECODER_JPEG_INFO
|
|
// Header The common header
|
|
// ScanType The scan type of JPEG image
|
|
// Reserved Reserved
|
|
//
|
|
typedef struct _EFI_HII_IMAGE_DECODER_JPEG_INFO {
|
|
EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER Header;
|
|
|
|
#define EFI_IMAGE_JPEG_SCANTYPE_PROGREESSIVE 0x01
|
|
#define EFI_IMAGE_JPEG_SCANTYPE_INTERLACED 0x02
|
|
UINT16 ScanType;
|
|
UINT64 Reserved;
|
|
} EFI_HII_IMAGE_DECODER_JPEG_INFO;
|
|
|
|
//
|
|
// EFI_HII_IMAGE_DECODER_PNG_INFO
|
|
// Header The common header
|
|
// Channels Number of channels in the PNG image
|
|
// Reserved Reserved
|
|
//
|
|
typedef struct _EFI_HII_IMAGE_DECODER_PNG_INFO {
|
|
EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER Header;
|
|
UINT16 Channels;
|
|
UINT64 Reserved;
|
|
} EFI_HII_IMAGE_DECODER_PNG_INFO;
|
|
|
|
/**
|
|
There could be more than one EFI_HII_IMAGE_DECODER_PROTOCOL instances installed
|
|
in the system for different image formats. This function returns the decoder
|
|
name which callers can use to find the proper image decoder for the image. It
|
|
is possible to support multiple image formats in one EFI_HII_IMAGE_DECODER_PROTOCOL.
|
|
The capability of the supported image formats is returned in DecoderName and
|
|
NumberOfDecoderName.
|
|
|
|
@param This EFI_HII_IMAGE_DECODER_PROTOCOL instance.
|
|
@param DecoderName Pointer to a dimension to retrieve the decoder
|
|
names in EFI_GUID format. The number of the
|
|
decoder names is returned in NumberOfDecoderName.
|
|
@param NumberofDecoderName Pointer to retrieve the number of decoders which
|
|
supported by this decoder driver.
|
|
|
|
@retval EFI_SUCCESS Get decoder name success.
|
|
@retval EFI_UNSUPPORTED Get decoder name fail.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_HII_IMAGE_DECODER_GET_DECODER_NAME)(
|
|
IN EFI_HII_IMAGE_DECODER_PROTOCOL *This,
|
|
IN OUT EFI_GUID **DecoderName,
|
|
IN OUT UINT16 *NumberofDecoderName
|
|
);
|
|
|
|
/**
|
|
This function returns the image information of the given image raw data. This
|
|
function first checks whether the image raw data is supported by this decoder
|
|
or not. This function may go through the first few bytes in the image raw data
|
|
for the specific data structure or the image signature. If the image is not supported
|
|
by this image decoder, this function returns EFI_UNSUPPORTED to the caller.
|
|
Otherwise, this function returns the proper image information to the caller.
|
|
It is the caller?s responsibility to free the ImageInfo.
|
|
|
|
@param This EFI_HII_IMAGE_DECODER_PROTOCOL instance.
|
|
@param Image Pointer to the image raw data.
|
|
@param SizeOfImage Size of the entire image raw data.
|
|
@param ImageInfo Pointer to recieve EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER.
|
|
|
|
@retval EFI_SUCCESS Get image info success.
|
|
@retval EFI_UNSUPPORTED Unsupported format of image.
|
|
@retval EFI_INVALID_PARAMETER Incorrect parameter.
|
|
@retval EFI_BAD_BUFFER_SIZE Not enough memory.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_HII_IMAGE_DECODER_GET_IMAGE_INFO)(
|
|
IN EFI_HII_IMAGE_DECODER_PROTOCOL *This,
|
|
IN VOID *Image,
|
|
IN UINTN SizeOfImage,
|
|
IN OUT EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER **ImageInfo
|
|
);
|
|
|
|
/**
|
|
This function decodes the image which the image type of this image is supported
|
|
by this EFI_HII_IMAGE_DECODER_PROTOCOL. If **Bitmap is not NULL, the caller intends
|
|
to put the image in the given image buffer. That allows the caller to put an
|
|
image overlap on the original image. The transparency is handled by the image
|
|
decoder because the transparency capability depends on the image format. Callers
|
|
can set Transparent to FALSE to force disabling the transparency process on the
|
|
image. Forcing Transparent to FALSE may also improve the performance of the image
|
|
decoding because the image decoder can skip the transparency processing. If **Bitmap
|
|
is NULL, the image decoder allocates the memory buffer for the EFI_IMAGE_OUTPUT
|
|
and decodes the image to the image buffer. It is the caller?s responsibility to
|
|
free the memory for EFI_IMAGE_OUTPUT. Image decoder doesn?t have to handle the
|
|
transparency in this case because there is no background image given by the caller.
|
|
The background color in this case is all black (#00000000).
|
|
|
|
@param This EFI_HII_IMAGE_DECODER_PROTOCOL instance.
|
|
@param Image Pointer to the image raw data.
|
|
@param ImageRawDataSize Size of the entire image raw data.
|
|
@param Blt EFI_IMAGE_OUTPUT to receive the image or overlap
|
|
the image on the original buffer.
|
|
@param Transparent BOOLEAN value indicates whether the image decoder
|
|
has to handle the transparent image or not.
|
|
|
|
|
|
@retval EFI_SUCCESS Image decode success.
|
|
@retval EFI_UNSUPPORTED Unsupported format of image.
|
|
@retval EFI_INVALID_PARAMETER Incorrect parameter.
|
|
@retval EFI_BAD_BUFFER_SIZE Not enough memory.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_HII_IMAGE_DECODER_DECODE)(
|
|
IN EFI_HII_IMAGE_DECODER_PROTOCOL *This,
|
|
IN VOID *Image,
|
|
IN UINTN ImageRawDataSize,
|
|
IN OUT EFI_IMAGE_OUTPUT **BitMap OPTIONAL,
|
|
IN BOOLEAN Transparent
|
|
);
|
|
|
|
struct _EFI_HII_IMAGE_DECODER_PROTOCOL {
|
|
EFI_HII_IMAGE_DECODER_GET_DECODER_NAME GetImageDecoderName;
|
|
EFI_HII_IMAGE_DECODER_GET_IMAGE_INFO GetImageInfo;
|
|
EFI_HII_IMAGE_DECODER_DECODE DecodeImage;
|
|
};
|
|
|
|
extern EFI_GUID gEfiHiiImageDecoderProtocolGuid;
|
|
extern EFI_GUID gEfiHiiImageDecoderNameJpegGuid;
|
|
extern EFI_GUID gEfiHiiImageDecoderNamePngGuid;
|
|
|
|
#endif
|