src/base/compression/base.hh

   1 /*
   2  * Copyright (c) 2003-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Erik Hallnor
  29  *          Nathan Binkert
  30  */
  31
  32 #ifndef __BASE_COMPRESSION_BASE_HH__
  33 #define __BASE_COMPRESSION_BASE_HH__
  34
  35 /**
  36  * @file
  37  * This file defines a base (abstract virtual) compression algorithm object.
  38  */
  39
  40 #include "base/types.hh"
  41
  42 /**
  43  * Abstract virtual compression algorithm object.
  44  */
  45 class CompressionAlgorithm
  46 {
  47   public:
  48     virtual ~CompressionAlgorithm() {}
  49
  50     /**
  51      * Uncompress the data, causes a fatal since no data should be compressed.
  52      * @param dest The output buffer.
  53      * @param src  The compressed data.
  54      * @param size The number of bytes in src.
  55      *
  56      * @retval The size of the uncompressed data.
  57      */
  58     virtual int uncompress(uint8_t * dest, uint8_t *src, int size) = 0;
  59
  60     /**
  61      * Compress the data, just returns the source data.
  62      * @param dest The output buffer.
  63      * @param src  The data to be compressed.
  64      * @param size The number of bytes in src.
  65      *
  66      * @retval The size of the compressed data.
  67      */
  68     virtual int compress(uint8_t *dest, uint8_t *src, int size) = 0;
  69 };
  70
  71 #endif //__BASE_COMPRESSION_BASE_HH__