[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / ImageEx.c

/** @file\r
Implementation for EFI_HII_IMAGE_EX_PROTOCOL.\r
\r
\r
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\r
#include "HiiDatabase.h"\r
\r
/**\r
  The prototype of this extension function is the same with EFI_HII_IMAGE_PROTOCOL.NewImage().\r
  This protocol invokes EFI_HII_IMAGE_PROTOCOL.NewImage() implicitly.\r
\r
  @param  This                   A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
  @param  PackageList            Handle of the package list where this image will\r
                                 be added.\r
  @param  ImageId                On return, contains the new image id, which is\r
                                 unique within PackageList.\r
  @param  Image                  Points to the image.\r
\r
  @retval EFI_SUCCESS            The new image was added successfully.\r
  @retval EFI_NOT_FOUND          The PackageList could not be found.\r
  @retval EFI_OUT_OF_RESOURCES   Could not add the image due to lack of resources.\r
  @retval EFI_INVALID_PARAMETER  Image is NULL or ImageId is NULL.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiNewImageEx (\r
  IN  CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
  IN  EFI_HII_HANDLE                  PackageList,\r
  OUT EFI_IMAGE_ID                    *ImageId,\r
  IN  CONST EFI_IMAGE_INPUT           *Image\r
  )\r
{\r
  HII_DATABASE_PRIVATE_DATA           *Private;\r
\r
  Private = HII_IMAGE_EX_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
  return HiiNewImage (&Private->HiiImage, PackageList, ImageId, Image);\r
}\r
\r
/**\r
  Return the information about the image, associated with the package list.\r
  The prototype of this extension function is the same with EFI_HII_IMAGE_PROTOCOL.GetImage().\r
\r
  This function is similar to EFI_HII_IMAGE_PROTOCOL.GetImage().The difference is that\r
  this function will locate all EFI_HII_IMAGE_DECODER_PROTOCOL instances installed in the\r
  system if the decoder of the certain image type is not supported by the\r
  EFI_HII_IMAGE_EX_PROTOCOL. The function will attempt to decode the image to the\r
  EFI_IMAGE_INPUT using the first EFI_HII_IMAGE_DECODER_PROTOCOL instance that\r
  supports the requested image type.\r
\r
  @param  This                   A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
  @param  PackageList            The package list in the HII database to search for the\r
                                 specified image.\r
  @param  ImageId                The image's id, which is unique within PackageList.\r
  @param  Image                  Points to the image.\r
\r
  @retval EFI_SUCCESS            The new image was returned successfully.\r
  @retval EFI_NOT_FOUND          The image specified by ImageId is not available. The specified\r
                                 PackageList is not in the Database.\r
  @retval EFI_INVALID_PARAMETER  Image was NULL or ImageId was 0.\r
  @retval EFI_OUT_OF_RESOURCES   The bitmap could not be retrieved because there\r
                                 was not enough memory.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetImageEx (\r
  IN  CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
  IN  EFI_HII_HANDLE                  PackageList,\r
  IN  EFI_IMAGE_ID                    ImageId,\r
  OUT EFI_IMAGE_INPUT                 *Image\r
  )\r
{\r
  HII_DATABASE_PRIVATE_DATA           *Private;\r
\r
  Private = HII_IMAGE_EX_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
  return IGetImage (&Private->DatabaseList, PackageList, ImageId, Image, FALSE);\r
}\r
\r
\r
/**\r
  Change the information about the image.\r
\r
  Same with EFI_HII_IMAGE_PROTOCOL.SetImage(),this protocol invokes\r
  EFI_HII_IMAGE_PROTOCOL.SetImage()implicitly.\r
\r
  @param  This                   A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
  @param  PackageList            The package list containing the images.\r
  @param  ImageId                The image's id, which is unique within PackageList.\r
  @param  Image                  Points to the image.\r
\r
  @retval EFI_SUCCESS            The new image was successfully updated.\r
  @retval EFI_NOT_FOUND          The image specified by ImageId is not in the\r
                                 database. The specified PackageList is not in\r
                                 the database.\r
  @retval EFI_INVALID_PARAMETER  The Image was NULL, the ImageId was 0 or\r
                                 the Image->Bitmap was NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiSetImageEx (\r
  IN CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
  IN EFI_HII_HANDLE                  PackageList,\r
  IN EFI_IMAGE_ID                    ImageId,\r
  IN CONST EFI_IMAGE_INPUT           *Image\r
  )\r
{\r
  HII_DATABASE_PRIVATE_DATA           *Private;\r
  Private = HII_IMAGE_EX_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
  return HiiSetImage (&Private->HiiImage, PackageList, ImageId, Image);\r
}\r
\r
\r
/**\r
  Renders an image to a bitmap or to the display.\r
\r
  The prototype of this extension function is the same with\r
  EFI_HII_IMAGE_PROTOCOL.DrawImage(). This protocol invokes\r
  EFI_HII_IMAGE_PROTOCOL.DrawImage() implicitly.\r
\r
  @param  This                   A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
  @param  Flags                  Describes how the image is to be drawn.\r
  @param  Image                  Points to the image to be displayed.\r
  @param  Blt                    If this points to a non-NULL on entry, this points\r
                                 to the image, which is Width pixels wide and\r
                                 Height pixels high.  The image will be drawn onto\r
                                 this image and  EFI_HII_DRAW_FLAG_CLIP is implied.\r
                                 If this points to a NULL on entry, then a buffer\r
                                 will be allocated to hold the generated image and\r
                                 the pointer updated on exit. It is the caller's\r
                                 responsibility to free this buffer.\r
  @param  BltX                   Specifies the offset from the left and top edge of\r
                                 the output image of the first pixel in the image.\r
  @param  BltY                   Specifies the offset from the left and top edge of\r
                                 the output image of the first pixel in the image.\r
\r
  @retval EFI_SUCCESS            The image was successfully drawn.\r
  @retval EFI_OUT_OF_RESOURCES   Unable to allocate an output buffer for Blt.\r
  @retval EFI_INVALID_PARAMETER  The Image or Blt was NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiDrawImageEx (\r
  IN CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
  IN EFI_HII_DRAW_FLAGS              Flags,\r
  IN CONST EFI_IMAGE_INPUT           *Image,\r
  IN OUT EFI_IMAGE_OUTPUT            **Blt,\r
  IN UINTN                           BltX,\r
  IN UINTN                           BltY\r
  )\r
{\r
  HII_DATABASE_PRIVATE_DATA           *Private;\r
  Private = HII_IMAGE_EX_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
  return HiiDrawImage (&Private->HiiImage, Flags, Image, Blt, BltX, BltY);\r
}\r
\r
\r
/**\r
  Renders an image to a bitmap or the screen containing the contents of the specified\r
  image.\r
\r
  This function is similar to EFI_HII_IMAGE_PROTOCOL.DrawImageId(). The difference is that\r
  this function will locate all EFI_HII_IMAGE_DECODER_PROTOCOL instances installed in the\r
  system if the decoder of the certain image type is not supported by the\r
  EFI_HII_IMAGE_EX_PROTOCOL. The function will attempt to decode the image to the\r
  EFI_IMAGE_INPUT using the first EFI_HII_IMAGE_DECODER_PROTOCOL instance that\r
  supports the requested image type.\r
\r
  @param  This                   A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
  @param  Flags                  Describes how the image is to be drawn.\r
  @param  PackageList            The package list in the HII database to search for\r
                                 the  specified image.\r
  @param  ImageId                The image's id, which is unique within PackageList.\r
  @param  Blt                    If this points to a non-NULL on entry, this points\r
                                 to the image, which is Width pixels wide and\r
                                 Height pixels high. The image will be drawn onto\r
                                 this image and EFI_HII_DRAW_FLAG_CLIP is implied.\r
                                 If this points to a NULL on entry, then a buffer\r
                                 will be allocated to hold  the generated image\r
                                 and the pointer updated on exit. It is the caller's\r
                                 responsibility to free this buffer.\r
  @param  BltX                   Specifies the offset from the left and top edge of\r
                                 the output image of the first pixel in the image.\r
  @param  BltY                   Specifies the offset from the left and top edge of\r
                                 the output image of the first pixel in the image.\r
\r
  @retval EFI_SUCCESS            The image was successfully drawn.\r
  @retval EFI_OUT_OF_RESOURCES   Unable to allocate an output buffer for Blt.\r
  @retval EFI_INVALID_PARAMETER  The Blt was NULL or ImageId was 0.\r
  @retval EFI_NOT_FOUND          The image specified by ImageId is not in the database.\r
                                 The specified PackageList is not in the database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiDrawImageIdEx (\r
  IN CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
  IN EFI_HII_DRAW_FLAGS              Flags,\r
  IN EFI_HII_HANDLE                  PackageList,\r
  IN EFI_IMAGE_ID                    ImageId,\r
  IN OUT EFI_IMAGE_OUTPUT            **Blt,\r
  IN UINTN                           BltX,\r
  IN UINTN                           BltY\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  EFI_IMAGE_INPUT                     Image;\r
\r
  //\r
  // Check input parameter.\r
  //\r
  if (This == NULL || Blt == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Get the specified Image.\r
  //\r
  Status = HiiGetImageEx (This, PackageList, ImageId, &Image);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Draw this image.\r
  //\r
  Status = HiiDrawImageEx (This, Flags, &Image, Blt, BltX, BltY);\r
  if (Image.Bitmap != NULL) {\r
    FreePool (Image.Bitmap);\r
  }\r
  return Status;\r
}\r
\r
/**\r
  Return the first HII image decoder instance which supports the DecoderName.\r
\r
  @param BlockType  The image block type.\r
\r
  @retval Pointer to the HII image decoder instance.\r
**/\r
EFI_HII_IMAGE_DECODER_PROTOCOL *\r
LocateHiiImageDecoder (\r
  UINT8                          BlockType\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  EFI_HII_IMAGE_DECODER_PROTOCOL *Decoder;\r
  EFI_HANDLE                     *Handles;\r
  UINTN                          HandleNum;\r
  UINTN                          Index;\r
  EFI_GUID                       *DecoderNames;\r
  UINT16                         NumberOfDecoderName;\r
  UINT16                         DecoderNameIndex;\r
  EFI_GUID                       *DecoderName;\r
\r
  switch (BlockType) {\r
  case EFI_HII_IIBT_IMAGE_JPEG:\r
    DecoderName = &gEfiHiiImageDecoderNameJpegGuid;\r
    break;\r
\r
  case EFI_HII_IIBT_IMAGE_PNG:\r
    DecoderName = &gEfiHiiImageDecoderNamePngGuid;\r
    break;\r
\r
  default:\r
    ASSERT (FALSE);\r
    return NULL;\r
  }\r
\r
  Status = gBS->LocateHandleBuffer (ByProtocol, &gEfiHiiImageDecoderProtocolGuid, NULL, &HandleNum, &Handles);\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
  for (Index = 0; Index < HandleNum; Index++) {\r
    Status = gBS->HandleProtocol (Handles[Index], &gEfiHiiImageDecoderProtocolGuid, (VOID **) &Decoder);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    Status = Decoder->GetImageDecoderName (Decoder, &DecoderNames, &NumberOfDecoderName);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
    for (DecoderNameIndex = 0; DecoderNameIndex < NumberOfDecoderName; DecoderNameIndex++) {\r
      if (CompareGuid (DecoderName, &DecoderNames[DecoderNameIndex])) {\r
        return Decoder;\r
      }\r
    }\r
  }\r
\r
  return NULL;\r
}\r
\r
/**\r
  This function returns the image information to EFI_IMAGE_OUTPUT. Only the width\r
  and height are returned to the EFI_IMAGE_OUTPUT instead of decoding the image\r
  to the buffer. This function is used to get the geometry of the image. This function\r
  will try to locate all of the EFI_HII_IMAGE_DECODER_PROTOCOL installed on the\r
  system if the decoder of image type is not supported by the EFI_HII_IMAGE_EX_PROTOCOL.\r
\r
  @param  This                   A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
  @param  PackageList            Handle of the package list where this image will\r
                                 be searched.\r
  @param  ImageId                The image's id, which is unique within PackageList.\r
  @param  Image                  Points to the image.\r
\r
  @retval EFI_SUCCESS            The new image was returned successfully.\r
  @retval EFI_NOT_FOUND          The image specified by ImageId is not in the\r
                                 database. The specified PackageList is not in the database.\r
  @retval EFI_BUFFER_TOO_SMALL   The buffer specified by ImageSize is too small to\r
                                 hold the image.\r
  @retval EFI_INVALID_PARAMETER  The Image was NULL or the ImageId was 0.\r
  @retval EFI_OUT_OF_RESOURCES   The bitmap could not be retrieved because there\r
                                 was not enough memory.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetImageInfo (\r
  IN CONST  EFI_HII_IMAGE_EX_PROTOCOL       *This,\r
  IN        EFI_HII_HANDLE                  PackageList,\r
  IN        EFI_IMAGE_ID                    ImageId,\r
  OUT       EFI_IMAGE_OUTPUT                *Image\r
  )\r
{\r
  EFI_STATUS                              Status;\r
  HII_DATABASE_PRIVATE_DATA               *Private;\r
  HII_DATABASE_PACKAGE_LIST_INSTANCE      *PackageListNode;\r
  HII_IMAGE_PACKAGE_INSTANCE              *ImagePackage;\r
  EFI_HII_IMAGE_BLOCK                     *CurrentImageBlock;\r
  EFI_HII_IMAGE_DECODER_PROTOCOL          *Decoder;\r
  EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER *ImageInfo;\r
\r
  if (Image == NULL || ImageId == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = HII_IMAGE_EX_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
  PackageListNode = LocatePackageList (&Private->DatabaseList, PackageList);\r
  if (PackageListNode == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
  ImagePackage = PackageListNode->ImagePkg;\r
  if (ImagePackage == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Find the image block specified by ImageId\r
  //\r
  CurrentImageBlock = GetImageIdOrAddress (ImagePackage->ImageBlock, &ImageId);\r
  if (CurrentImageBlock == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  switch (CurrentImageBlock->BlockType) {\r
  case EFI_HII_IIBT_IMAGE_JPEG:\r
  case EFI_HII_IIBT_IMAGE_PNG:\r
    Decoder = LocateHiiImageDecoder (CurrentImageBlock->BlockType);\r
    if (Decoder == NULL) {\r
      return EFI_UNSUPPORTED;\r
    }\r
    //\r
    // Use the common block code since the definition of two structures is the same.\r
    //\r
    ASSERT (OFFSET_OF (EFI_HII_IIBT_JPEG_BLOCK, Data) == OFFSET_OF (EFI_HII_IIBT_PNG_BLOCK, Data));\r
    ASSERT (sizeof (((EFI_HII_IIBT_JPEG_BLOCK *) CurrentImageBlock)->Data) ==\r
            sizeof (((EFI_HII_IIBT_PNG_BLOCK *) CurrentImageBlock)->Data));\r
    ASSERT (OFFSET_OF (EFI_HII_IIBT_JPEG_BLOCK, Size) == OFFSET_OF (EFI_HII_IIBT_PNG_BLOCK, Size));\r
    ASSERT (sizeof (((EFI_HII_IIBT_JPEG_BLOCK *) CurrentImageBlock)->Size) ==\r
            sizeof (((EFI_HII_IIBT_PNG_BLOCK *) CurrentImageBlock)->Size));\r
    Status = Decoder->GetImageInfo (\r
      Decoder,\r
      ((EFI_HII_IIBT_JPEG_BLOCK *) CurrentImageBlock)->Data,\r
      ((EFI_HII_IIBT_JPEG_BLOCK *) CurrentImageBlock)->Size,\r
      &ImageInfo\r
    );\r
\r
    //\r
    // Spec requires to use the first capable image decoder instance.\r
    // The first image decoder instance may fail to decode the image.\r
    //\r
    if (!EFI_ERROR (Status)) {\r
      Image->Height = ImageInfo->ImageHeight;\r
      Image->Width = ImageInfo->ImageWidth;\r
      Image->Image.Bitmap = NULL;\r
      FreePool (ImageInfo);\r
    }\r
    return Status;\r
\r
  case EFI_HII_IIBT_IMAGE_1BIT_TRANS:\r
  case EFI_HII_IIBT_IMAGE_4BIT_TRANS:\r
  case EFI_HII_IIBT_IMAGE_8BIT_TRANS:\r
  case EFI_HII_IIBT_IMAGE_1BIT:\r
  case EFI_HII_IIBT_IMAGE_4BIT:\r
  case EFI_HII_IIBT_IMAGE_8BIT:\r
    //\r
    // Use the common block code since the definition of these structures is the same.\r
    //\r
    Image->Width = ReadUnaligned16 (&((EFI_HII_IIBT_IMAGE_1BIT_BLOCK *) CurrentImageBlock)->Bitmap.Width);\r
    Image->Height = ReadUnaligned16 (&((EFI_HII_IIBT_IMAGE_1BIT_BLOCK *) CurrentImageBlock)->Bitmap.Height);\r
    Image->Image.Bitmap = NULL;\r
    return EFI_SUCCESS;\r
\r
  case EFI_HII_IIBT_IMAGE_24BIT_TRANS:\r
  case EFI_HII_IIBT_IMAGE_24BIT:\r
    Image->Width = ReadUnaligned16 ((VOID *) &((EFI_HII_IIBT_IMAGE_24BIT_BLOCK *) CurrentImageBlock)->Bitmap.Width);\r
    Image->Height = ReadUnaligned16 ((VOID *) &((EFI_HII_IIBT_IMAGE_24BIT_BLOCK *) CurrentImageBlock)->Bitmap.Height);\r
    Image->Image.Bitmap = NULL;\r
    return EFI_SUCCESS;\r
\r
  default:\r
    return EFI_NOT_FOUND;\r
  }\r
}\r
Commit	Line	Data
101a1122 RN	1	/** @file\r
	2	Implementation for EFI_HII_IMAGE_EX_PROTOCOL.\r
	3	\r
	4	\r
	5	Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	\r
	17	#include "HiiDatabase.h"\r
	18	\r
	19	/**\r
	20	The prototype of this extension function is the same with EFI_HII_IMAGE_PROTOCOL.NewImage().\r
	21	This protocol invokes EFI_HII_IMAGE_PROTOCOL.NewImage() implicitly.\r
	22	\r
	23	@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
	24	@param PackageList Handle of the package list where this image will\r
	25	be added.\r
	26	@param ImageId On return, contains the new image id, which is\r
	27	unique within PackageList.\r
	28	@param Image Points to the image.\r
	29	\r
	30	@retval EFI_SUCCESS The new image was added successfully.\r
	31	@retval EFI_NOT_FOUND The PackageList could not be found.\r
	32	@retval EFI_OUT_OF_RESOURCES Could not add the image due to lack of resources.\r
	33	@retval EFI_INVALID_PARAMETER Image is NULL or ImageId is NULL.\r
	34	**/\r
	35	EFI_STATUS\r
	36	EFIAPI\r
	37	HiiNewImageEx (\r
	38	IN CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
	39	IN EFI_HII_HANDLE PackageList,\r
	40	OUT EFI_IMAGE_ID *ImageId,\r
	41	IN CONST EFI_IMAGE_INPUT *Image\r
	42	)\r
	43	{\r
	44	HII_DATABASE_PRIVATE_DATA *Private;\r
	45	\r
	46	Private = HII_IMAGE_EX_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
	47	return HiiNewImage (&Private->HiiImage, PackageList, ImageId, Image);\r
	48	}\r
	49	\r
	50	/**\r
	51	Return the information about the image, associated with the package list.\r
	52	The prototype of this extension function is the same with EFI_HII_IMAGE_PROTOCOL.GetImage().\r
	53	\r
	54	This function is similar to EFI_HII_IMAGE_PROTOCOL.GetImage().The difference is that\r
	55	this function will locate all EFI_HII_IMAGE_DECODER_PROTOCOL instances installed in the\r
	56	system if the decoder of the certain image type is not supported by the\r
	57	EFI_HII_IMAGE_EX_PROTOCOL. The function will attempt to decode the image to the\r
	58	EFI_IMAGE_INPUT using the first EFI_HII_IMAGE_DECODER_PROTOCOL instance that\r
	59	supports the requested image type.\r
	60	\r
	61	@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
	62	@param PackageList The package list in the HII database to search for the\r
	63	specified image.\r
	64	@param ImageId The image's id, which is unique within PackageList.\r
65	@param Image Points to the image.\r
66	\r
67	@retval EFI_SUCCESS The new image was returned successfully.\r
68	@retval EFI_NOT_FOUND The image specified by ImageId is not available. The specified\r
69	PackageList is not in the Database.\r
70	@retval EFI_INVALID_PARAMETER Image was NULL or ImageId was 0.\r
71	@retval EFI_OUT_OF_RESOURCES The bitmap could not be retrieved because there\r
72	was not enough memory.\r
73	\r
74	**/\r
75	EFI_STATUS\r
76	EFIAPI\r
77	HiiGetImageEx (\r
78	IN CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
79	IN EFI_HII_HANDLE PackageList,\r
80	IN EFI_IMAGE_ID ImageId,\r
81	OUT EFI_IMAGE_INPUT *Image\r
82	)\r
83	{\r
84	HII_DATABASE_PRIVATE_DATA *Private;\r
85	\r
86	Private = HII_IMAGE_EX_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
87	return IGetImage (&Private->DatabaseList, PackageList, ImageId, Image, FALSE);\r
88	}\r
89	\r
90	\r
91	/**\r
92	Change the information about the image.\r
93	\r
94	Same with EFI_HII_IMAGE_PROTOCOL.SetImage(),this protocol invokes\r
95	EFI_HII_IMAGE_PROTOCOL.SetImage()implicitly.\r
96	\r
97	@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
98	@param PackageList The package list containing the images.\r
99	@param ImageId The image's id, which is unique within PackageList.\r
100	@param Image Points to the image.\r
101	\r
102	@retval EFI_SUCCESS The new image was successfully updated.\r
103	@retval EFI_NOT_FOUND The image specified by ImageId is not in the\r
104	database. The specified PackageList is not in\r
105	the database.\r
106	@retval EFI_INVALID_PARAMETER The Image was NULL, the ImageId was 0 or\r
107	the Image->Bitmap was NULL.\r
108	\r
109	**/\r
110	EFI_STATUS\r
111	EFIAPI\r
112	HiiSetImageEx (\r
113	IN CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
114	IN EFI_HII_HANDLE PackageList,\r
115	IN EFI_IMAGE_ID ImageId,\r
116	IN CONST EFI_IMAGE_INPUT *Image\r
117	)\r
118	{\r
119	HII_DATABASE_PRIVATE_DATA *Private;\r
120	Private = HII_IMAGE_EX_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
121	return HiiSetImage (&Private->HiiImage, PackageList, ImageId, Image);\r
122	}\r
123	\r
124	\r
125	/**\r
126	Renders an image to a bitmap or to the display.\r
127	\r
128	The prototype of this extension function is the same with\r
129	EFI_HII_IMAGE_PROTOCOL.DrawImage(). This protocol invokes\r
130	EFI_HII_IMAGE_PROTOCOL.DrawImage() implicitly.\r
131	\r
132	@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
133	@param Flags Describes how the image is to be drawn.\r
134	@param Image Points to the image to be displayed.\r
135	@param Blt If this points to a non-NULL on entry, this points\r
136	to the image, which is Width pixels wide and\r
137	Height pixels high. The image will be drawn onto\r
138	this image and EFI_HII_DRAW_FLAG_CLIP is implied.\r
139	If this points to a NULL on entry, then a buffer\r
140	will be allocated to hold the generated image and\r
141	the pointer updated on exit. It is the caller's\r
142	responsibility to free this buffer.\r
143	@param BltX Specifies the offset from the left and top edge of\r
144	the output image of the first pixel in the image.\r
145	@param BltY Specifies the offset from the left and top edge of\r
146	the output image of the first pixel in the image.\r
147	\r
148	@retval EFI_SUCCESS The image was successfully drawn.\r
149	@retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for Blt.\r
150	@retval EFI_INVALID_PARAMETER The Image or Blt was NULL.\r
151	\r
152	**/\r
153	EFI_STATUS\r
154	EFIAPI\r
155	HiiDrawImageEx (\r
156	IN CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
157	IN EFI_HII_DRAW_FLAGS Flags,\r
158	IN CONST EFI_IMAGE_INPUT *Image,\r
159	IN OUT EFI_IMAGE_OUTPUT **Blt,\r
160	IN UINTN BltX,\r
161	IN UINTN BltY\r
162	)\r
163	{\r
164	HII_DATABASE_PRIVATE_DATA *Private;\r
165	Private = HII_IMAGE_EX_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
166	return HiiDrawImage (&Private->HiiImage, Flags, Image, Blt, BltX, BltY);\r
167	}\r
168	\r
169	\r
170	/**\r
171	Renders an image to a bitmap or the screen containing the contents of the specified\r
172	image.\r
173	\r
174	This function is similar to EFI_HII_IMAGE_PROTOCOL.DrawImageId(). The difference is that\r
175	this function will locate all EFI_HII_IMAGE_DECODER_PROTOCOL instances installed in the\r
176	system if the decoder of the certain image type is not supported by the\r
177	EFI_HII_IMAGE_EX_PROTOCOL. The function will attempt to decode the image to the\r
178	EFI_IMAGE_INPUT using the first EFI_HII_IMAGE_DECODER_PROTOCOL instance that\r
179	supports the requested image type.\r
180	\r
181	@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
182	@param Flags Describes how the image is to be drawn.\r
183	@param PackageList The package list in the HII database to search for\r
184	the specified image.\r
185	@param ImageId The image's id, which is unique within PackageList.\r
186	@param Blt If this points to a non-NULL on entry, this points\r
187	to the image, which is Width pixels wide and\r
188	Height pixels high. The image will be drawn onto\r
189	this image and EFI_HII_DRAW_FLAG_CLIP is implied.\r
190	If this points to a NULL on entry, then a buffer\r
191	will be allocated to hold the generated image\r
192	and the pointer updated on exit. It is the caller's\r
193	responsibility to free this buffer.\r
194	@param BltX Specifies the offset from the left and top edge of\r
195	the output image of the first pixel in the image.\r
196	@param BltY Specifies the offset from the left and top edge of\r
197	the output image of the first pixel in the image.\r
198	\r
199	@retval EFI_SUCCESS The image was successfully drawn.\r
200	@retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for Blt.\r
201	@retval EFI_INVALID_PARAMETER The Blt was NULL or ImageId was 0.\r
202	@retval EFI_NOT_FOUND The image specified by ImageId is not in the database.\r
203	The specified PackageList is not in the database.\r
204	\r
205	**/\r
206	EFI_STATUS\r
207	EFIAPI\r
208	HiiDrawImageIdEx (\r
209	IN CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
210	IN EFI_HII_DRAW_FLAGS Flags,\r
211	IN EFI_HII_HANDLE PackageList,\r
212	IN EFI_IMAGE_ID ImageId,\r
213	IN OUT EFI_IMAGE_OUTPUT **Blt,\r
214	IN UINTN BltX,\r
215	IN UINTN BltY\r
216	)\r
217	{\r
218	EFI_STATUS Status;\r
219	EFI_IMAGE_INPUT Image;\r
220	\r
221	//\r
222	// Check input parameter.\r
223	//\r
224	if (This == NULL \|\| Blt == NULL) {\r
225	return EFI_INVALID_PARAMETER;\r
226	}\r
227	\r
228	//\r
229	// Get the specified Image.\r
230	//\r
231	Status = HiiGetImageEx (This, PackageList, ImageId, &Image);\r
232	if (EFI_ERROR (Status)) {\r
233	return Status;\r
234	}\r
235	\r
236	//\r
237	// Draw this image.\r
238	//\r
239	Status = HiiDrawImageEx (This, Flags, &Image, Blt, BltX, BltY);\r
240	if (Image.Bitmap != NULL) {\r
241	FreePool (Image.Bitmap);\r
242	}\r
243	return Status;\r
244	}\r
245	\r
246	/**\r
247	Return the first HII image decoder instance which supports the DecoderName.\r
248	\r
249	@param BlockType The image block type.\r
250	\r
251	@retval Pointer to the HII image decoder instance.\r
252	**/\r
253	EFI_HII_IMAGE_DECODER_PROTOCOL *\r
254	LocateHiiImageDecoder (\r
255	UINT8 BlockType\r
256	)\r
257	{\r
258	EFI_STATUS Status;\r
259	EFI_HII_IMAGE_DECODER_PROTOCOL *Decoder;\r
260	EFI_HANDLE *Handles;\r
261	UINTN HandleNum;\r
262	UINTN Index;\r
263	EFI_GUID *DecoderNames;\r
264	UINT16 NumberOfDecoderName;\r
265	UINT16 DecoderNameIndex;\r
266	EFI_GUID *DecoderName;\r
267	\r
268	switch (BlockType) {\r
269	case EFI_HII_IIBT_IMAGE_JPEG:\r
270	DecoderName = &gEfiHiiImageDecoderNameJpegGuid;\r
271	break;\r
272	\r
273	case EFI_HII_IIBT_IMAGE_PNG:\r
274	DecoderName = &gEfiHiiImageDecoderNamePngGuid;\r
275	break;\r
276	\r
277	default:\r
278	ASSERT (FALSE);\r
279	return NULL;\r
280	}\r
281	\r
282	Status = gBS->LocateHandleBuffer (ByProtocol, &gEfiHiiImageDecoderProtocolGuid, NULL, &HandleNum, &Handles);\r
283	if (EFI_ERROR (Status)) {\r
284	return NULL;\r
285	}\r
286	for (Index = 0; Index < HandleNum; Index++) {\r
287	Status = gBS->HandleProtocol (Handles[Index], &gEfiHiiImageDecoderProtocolGuid, (VOID **) &Decoder);\r
288	if (EFI_ERROR (Status)) {\r
289	continue;\r
290	}\r
291	\r
292	Status = Decoder->GetImageDecoderName (Decoder, &DecoderNames, &NumberOfDecoderName);\r
293	if (EFI_ERROR (Status)) {\r
294	continue;\r
295	}\r
296	for (DecoderNameIndex = 0; DecoderNameIndex < NumberOfDecoderName; DecoderNameIndex++) {\r
297	if (CompareGuid (DecoderName, &DecoderNames[DecoderNameIndex])) {\r
298	return Decoder;\r
299	}\r
300	}\r
301	}\r
302	\r
303	return NULL;\r
304	}\r
305	\r
306	/**\r
307	This function returns the image information to EFI_IMAGE_OUTPUT. Only the width\r
308	and height are returned to the EFI_IMAGE_OUTPUT instead of decoding the image\r
309	to the buffer. This function is used to get the geometry of the image. This function\r
310	will try to locate all of the EFI_HII_IMAGE_DECODER_PROTOCOL installed on the\r
311	system if the decoder of image type is not supported by the EFI_HII_IMAGE_EX_PROTOCOL.\r
312	\r
313	@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.\r
314	@param PackageList Handle of the package list where this image will\r
315	be searched.\r
316	@param ImageId The image's id, which is unique within PackageList.\r
317	@param Image Points to the image.\r
318	\r
319	@retval EFI_SUCCESS The new image was returned successfully.\r
320	@retval EFI_NOT_FOUND The image specified by ImageId is not in the\r
321	database. The specified PackageList is not in the database.\r
322	@retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small to\r
323	hold the image.\r
324	@retval EFI_INVALID_PARAMETER The Image was NULL or the ImageId was 0.\r
325	@retval EFI_OUT_OF_RESOURCES The bitmap could not be retrieved because there\r
326	was not enough memory.\r
327	\r
328	**/\r
329	EFI_STATUS\r
330	EFIAPI\r
331	HiiGetImageInfo (\r
332	IN CONST EFI_HII_IMAGE_EX_PROTOCOL *This,\r
333	IN EFI_HII_HANDLE PackageList,\r
334	IN EFI_IMAGE_ID ImageId,\r
335	OUT EFI_IMAGE_OUTPUT *Image\r
336	)\r
337	{\r
338	EFI_STATUS Status;\r
339	HII_DATABASE_PRIVATE_DATA *Private;\r
340	HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageListNode;\r
341	HII_IMAGE_PACKAGE_INSTANCE *ImagePackage;\r
342	EFI_HII_IMAGE_BLOCK *CurrentImageBlock;\r
343	EFI_HII_IMAGE_DECODER_PROTOCOL *Decoder;\r
344	EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER *ImageInfo;\r
345	\r
346	if (Image == NULL \|\| ImageId == 0) {\r
347	return EFI_INVALID_PARAMETER;\r
348	}\r
349	\r
350	Private = HII_IMAGE_EX_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
351	PackageListNode = LocatePackageList (&Private->DatabaseList, PackageList);\r
352	if (PackageListNode == NULL) {\r
353	return EFI_NOT_FOUND;\r
354	}\r
355	ImagePackage = PackageListNode->ImagePkg;\r
356	if (ImagePackage == NULL) {\r
357	return EFI_NOT_FOUND;\r
358	}\r
359	\r
360	//\r
361	// Find the image block specified by ImageId\r
362	//\r
363	CurrentImageBlock = GetImageIdOrAddress (ImagePackage->ImageBlock, &ImageId);\r
4558491f RN	364	if (CurrentImageBlock == NULL) {\r
	365	return EFI_NOT_FOUND;\r
	366	}\r
	367	\r
101a1122 RN	368	switch (CurrentImageBlock->BlockType) {\r
	369	case EFI_HII_IIBT_IMAGE_JPEG:\r
	370	case EFI_HII_IIBT_IMAGE_PNG:\r
	371	Decoder = LocateHiiImageDecoder (CurrentImageBlock->BlockType);\r
	372	if (Decoder == NULL) {\r
	373	return EFI_UNSUPPORTED;\r
	374	}\r
	375	//\r
	376	// Use the common block code since the definition of two structures is the same.\r
	377	//\r
	378	ASSERT (OFFSET_OF (EFI_HII_IIBT_JPEG_BLOCK, Data) == OFFSET_OF (EFI_HII_IIBT_PNG_BLOCK, Data));\r
	379	ASSERT (sizeof (((EFI_HII_IIBT_JPEG_BLOCK *) CurrentImageBlock)->Data) ==\r
	380	sizeof (((EFI_HII_IIBT_PNG_BLOCK *) CurrentImageBlock)->Data));\r
	381	ASSERT (OFFSET_OF (EFI_HII_IIBT_JPEG_BLOCK, Size) == OFFSET_OF (EFI_HII_IIBT_PNG_BLOCK, Size));\r
	382	ASSERT (sizeof (((EFI_HII_IIBT_JPEG_BLOCK *) CurrentImageBlock)->Size) ==\r
	383	sizeof (((EFI_HII_IIBT_PNG_BLOCK *) CurrentImageBlock)->Size));\r
	384	Status = Decoder->GetImageInfo (\r
	385	Decoder,\r
	386	((EFI_HII_IIBT_JPEG_BLOCK *) CurrentImageBlock)->Data,\r
	387	((EFI_HII_IIBT_JPEG_BLOCK *) CurrentImageBlock)->Size,\r
	388	&ImageInfo\r
	389	);\r
	390	\r
	391	//\r
	392	// Spec requires to use the first capable image decoder instance.\r
	393	// The first image decoder instance may fail to decode the image.\r
	394	//\r
	395	if (!EFI_ERROR (Status)) {\r
	396	Image->Height = ImageInfo->ImageHeight;\r
	397	Image->Width = ImageInfo->ImageWidth;\r
	398	Image->Image.Bitmap = NULL;\r
	399	FreePool (ImageInfo);\r
	400	}\r
	401	return Status;\r
	402	\r
	403	case EFI_HII_IIBT_IMAGE_1BIT_TRANS:\r
	404	case EFI_HII_IIBT_IMAGE_4BIT_TRANS:\r
	405	case EFI_HII_IIBT_IMAGE_8BIT_TRANS:\r
	406	case EFI_HII_IIBT_IMAGE_1BIT:\r
	407	case EFI_HII_IIBT_IMAGE_4BIT:\r
	408	case EFI_HII_IIBT_IMAGE_8BIT:\r
	409	//\r
	410	// Use the common block code since the definition of these structures is the same.\r
	411	//\r
	412	Image->Width = ReadUnaligned16 (&((EFI_HII_IIBT_IMAGE_1BIT_BLOCK *) CurrentImageBlock)->Bitmap.Width);\r
	413	Image->Height = ReadUnaligned16 (&((EFI_HII_IIBT_IMAGE_1BIT_BLOCK *) CurrentImageBlock)->Bitmap.Height);\r
	414	Image->Image.Bitmap = NULL;\r
	415	return EFI_SUCCESS;\r
	416	\r
	417	case EFI_HII_IIBT_IMAGE_24BIT_TRANS:\r
	418	case EFI_HII_IIBT_IMAGE_24BIT:\r
	419	Image->Width = ReadUnaligned16 ((VOID ) &((EFI_HII_IIBT_IMAGE_24BIT_BLOCK ) CurrentImageBlock)->Bitmap.Width);\r
	420	Image->Height = ReadUnaligned16 ((VOID ) &((EFI_HII_IIBT_IMAGE_24BIT_BLOCK ) CurrentImageBlock)->Bitmap.Height);\r
	421	Image->Image.Bitmap = NULL;\r
	422	return EFI_SUCCESS;\r
	423	\r
	424	default:\r
	425	return EFI_NOT_FOUND;\r
	426	}\r
	427	}\r