lz4s.h
Go to the documentation of this file.
00001 /*********************************************************************
00002 * Software License Agreement (BSD License)
00003 *
00004 *  Copyright (c) 2014, Ben Charrow
00005 *  All rights reserved.
00006 *
00007 *  Redistribution and use in source and binary forms, with or without
00008 *  modification, are permitted provided that the following conditions
00009 *  are met:
00010 *
00011 *   * Redistributions of source code must retain the above copyright
00012 *     notice, this list of conditions and the following disclaimer.
00013 *   * Redistributions in binary form must reproduce the above
00014 *     copyright notice, this list of conditions and the following
00015 *     disclaimer in the documentation and/or other materials provided
00016 *     with the distribution.
00017 *   * Neither the name of Willow Garage, Inc. nor the names of its
00018 *     contributors may be used to endorse or promote products derived
00019 *     from this software without specific prior written permission.
00020 *
00021 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032 *  POSSIBILITY OF SUCH DAMAGE.
00033 ********************************************************************/
00034 
00035 #ifndef ROSLZ4_LZ4S_H
00036 #define ROSLZ4_LZ4S_H
00037 
00038 #include <lz4.h>
00039 
00040 #ifdef __cplusplus
00041 extern "C" {
00042 #endif
00043 
00044 // Return codes
00045 const int ROSLZ4_MEMORY_ERROR = -5;
00046 const int ROSLZ4_PARAM_ERROR = -4;
00047 const int ROSLZ4_DATA_ERROR = -3;
00048 const int ROSLZ4_OUTPUT_SMALL = -2;
00049 const int ROSLZ4_ERROR = -1;
00050 const int ROSLZ4_OK = 0;
00051 const int ROSLZ4_STREAM_END = 2;
00052 
00053 // Actions
00054 const int ROSLZ4_RUN = 0;
00055 const int ROSLZ4_FINISH = 1;
00056 
00057 typedef struct {
00058   char *input_next;
00059   int input_left;
00060 
00061   char *output_next;
00062   int output_left;
00063 
00064   int total_in;
00065   int total_out;
00066 
00067   int block_size_id;
00068 
00069   // Internal use
00070   void *state;
00071 } roslz4_stream;
00072 
00073 // Low level functions
00074 int roslz4_blockSizeFromIndex(int block_id);
00075 
00076 int roslz4_compressStart(roslz4_stream *stream, int block_size_id);
00077 int roslz4_compress(roslz4_stream *stream, int action);
00078 void roslz4_compressEnd(roslz4_stream *stream);
00079 
00080 int roslz4_decompressStart(roslz4_stream *stream);
00081 int roslz4_decompress(roslz4_stream *stream);
00082 void roslz4_decompressEnd(roslz4_stream *str);
00083 
00084 // Oneshot compression / decompression
00085 int roslz4_buffToBuffCompress(char *input, unsigned int input_size,
00086                               char *output, unsigned int *output_size,
00087                               int block_size_id);
00088 int roslz4_buffToBuffDecompress(char *input, unsigned int input_size,
00089                                 char *output, unsigned int *output_size);
00090 
00091 #ifdef __cplusplus
00092 }
00093 #endif
00094 
00095 #endif // ROSLZ4_LZ4S_H


roslz4
Author(s): Ben Charrow
autogenerated on Thu Jun 6 2019 21:09:51