MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Library / BmpSupportLib.h

/** @file\r
\r
Provides services to convert a BMP graphics image to a GOP BLT buffer\r
and to convert a GOP BLT buffer to a BMP graphics image.\r
\r
Copyright (c) 2016, Microsoft Corporation\r
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r
\r
All rights reserved.\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __BMP_SUPPORT_LIB_H__\r
#define __BMP_SUPPORT_LIB_H__\r
\r
#include <Protocol/GraphicsOutput.h>\r
\r
/**\r
  Translate a *.BMP graphics image to a GOP blt buffer. If a NULL Blt buffer\r
  is passed in a GopBlt buffer will be allocated by this routine using\r
  EFI_BOOT_SERVICES.AllocatePool(). If a GopBlt buffer is passed in it will be\r
  used if it is big enough.\r
\r
  @param [in]      BmpImage      Pointer to BMP file.\r
  @param [in]      BmpImageSize  Number of bytes in BmpImage.\r
  @param [in, out] GopBlt        Buffer containing GOP version of BmpImage.\r
  @param [in, out] GopBltSize    Size of GopBlt in bytes.\r
  @param [out]     PixelHeight   Height of GopBlt/BmpImage in pixels.\r
  @param [out]     PixelWidth    Width of GopBlt/BmpImage in pixels.\r
\r
  @retval RETURN_SUCCESS            GopBlt and GopBltSize are returned.\r
  @retval RETURN_INVALID_PARAMETER  BmpImage is NULL.\r
  @retval RETURN_INVALID_PARAMETER  GopBlt is NULL.\r
  @retval RETURN_INVALID_PARAMETER  GopBltSize is NULL.\r
  @retval RETURN_INVALID_PARAMETER  PixelHeight is NULL.\r
  @retval RETURN_INVALID_PARAMETER  PixelWidth is NULL.\r
  @retval RETURN_UNSUPPORTED        BmpImage is not a valid *.BMP image.\r
  @retval RETURN_BUFFER_TOO_SMALL   The passed in GopBlt buffer is not big\r
                                    enough.  The required size is returned in\r
                                    GopBltSize.\r
  @retval RETURN_OUT_OF_RESOURCES   The GopBlt buffer could not be allocated.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
TranslateBmpToGopBlt (\r
  IN     VOID                           *BmpImage,\r
  IN     UINTN                          BmpImageSize,\r
  IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL  **GopBlt,\r
  IN OUT UINTN                          *GopBltSize,\r
  OUT    UINTN                          *PixelHeight,\r
  OUT    UINTN                          *PixelWidth\r
  );\r
\r
/**\r
  Translate a GOP blt buffer to an uncompressed 24-bit per pixel BMP graphics\r
  image. If a NULL BmpImage is passed in a BmpImage buffer will be allocated by\r
  this routine using EFI_BOOT_SERVICES.AllocatePool(). If a BmpImage buffer is\r
  passed in it will be used if it is big enough.\r
\r
  @param [in]      GopBlt        Pointer to GOP blt buffer.\r
  @param [in]      PixelHeight   Height of GopBlt/BmpImage in pixels.\r
  @param [in]      PixelWidth    Width of GopBlt/BmpImage in pixels.\r
  @param [in, out] BmpImage      Buffer containing BMP version of GopBlt.\r
  @param [in, out] BmpImageSize  Size of BmpImage in bytes.\r
\r
  @retval RETURN_SUCCESS            BmpImage and BmpImageSize are returned.\r
  @retval RETURN_INVALID_PARAMETER  GopBlt is NULL.\r
  @retval RETURN_INVALID_PARAMETER  BmpImage is NULL.\r
  @retval RETURN_INVALID_PARAMETER  BmpImageSize is NULL.\r
  @retval RETURN_UNSUPPORTED        GopBlt cannot be converted to a *.BMP image.\r
  @retval RETURN_BUFFER_TOO_SMALL   The passed in BmpImage buffer is not big\r
                                    enough.  The required size is returned in\r
                                    BmpImageSize.\r
  @retval RETURN_OUT_OF_RESOURCES   The BmpImage buffer could not be allocated.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
TranslateGopBltToBmp (\r
  IN     EFI_GRAPHICS_OUTPUT_BLT_PIXEL  *GopBlt,\r
  IN     UINT32                         PixelHeight,\r
  IN     UINT32                         PixelWidth,\r
  IN OUT VOID                           **BmpImage,\r
  IN OUT UINT32                         *BmpImageSize\r
  );\r
\r
#endif\r