text: /* LZMA Decompress Header
  
    Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.
    This program and the accompanying materials
    are licensed and made available under the terms and conditions of the BSD License
    which 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,
    WITHWARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  
    */
  
  #ifndef LZMADECOMPRESS_H
  #define LZMADECOMPRESS_H
  
  #include "../basetypes.h"
  #include "SDK/C/LzmaDec.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  #define LZMA_HEADER_SIZE (LZMA_PROPS_SIZE + 8)
  
      /*
        Given a Lzma compressed source buffer, this function retrieves the size of
        the uncompressed buffer and the size of the scratch buffer required
        to decompress the compressed source buffer.
  
        Retrieves the size of the uncompressed buffer and the temporary scratch buffer
        required to decompress the buffer specified by Source and SourceSize.
        The size of the uncompressed buffer is returned DestinationSize,
        the size of the scratch buffer is returned ScratchSize, and RETURN_SUCCESS is returned.
        This function does not have scratch buffer available to perform a thorough
        checking of the validity of the source data. It just retrieves the "Original Size"
        field from the LZMA_HEADER_SIZE beginning bytes of the source data and output it as DestinationSize.
        And ScratchSize is specific to the decompression implementation.
  
        If SourceSize is less than LZMA_HEADER_SIZE, then ASSERT().
  
        @param  Source          The source buffer containing the compressed data.
        @param  SourceSize      The size, bytes, of the source buffer.
        @param  DestinationSize A pointer to the size, bytes, of the uncompressed buffer
        that will be generated when the compressed buffer specified
        by Source and SourceSize is decompressed.
  
        @retval  EFI_SUCCESS The size of the uncompressed data was returned
        DestinationSize and the size of the scratch
        buffer was returned ScratchSize.
  
        */
      EFI_STATUS
          EFIAPI
          LzmaGetInfo (
              CONST VOID  *Source,
              UINT32       SourceSize,
              UINT32       *DestinationSize
          );
  
      /*
        Decompresses a Lzma compressed source buffer.
  
        Extracts decompressed data to its original form.
        If the compressed source data specified by Source is successfully decompressed
        into Destination, then RETURN_SUCCESS is returned.  If the compressed source data
        specified by Source is not a valid compressed data format,
        then RETURN_INVALID_PARAMETER is returned.
  
        @param  Source      The source buffer containing the compressed data.
        @param  SourceSize  The size of source buffer.
        @param  Destination The destination buffer to store the decompressed data
  
        @retval  EFI_SUCCESS Decompression completed successfully, and
        the uncompressed buffer is returned Destination.
        @retval  EFI_INVALID_PARAMETER
        The source buffer specified by Source is corrupted
        (not a valid compressed format).
        */
      EFI_STATUS
          EFIAPI
          LzmaDecompress (
              CONST VOID  *Source,
              UINT32        SourceSize,
              VOID         *Destination
          );
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif // LZMADECOMPRESS_H
  