ricehdf.h

Go to the documentation of this file.

/*  BEGIN THIRD_PARTY_COPYRIGHT  */
/*==============================================================
The SZIP Science Data Lossless Compression Program is Copyright (C) 2001
Science & Technology Corporation @ UNM.  All rights released.
Copyright (C) 2003 Lowell H. Miles and Jack A. Venbrux.  Licensed to ICs, LLC,
for distribution by the University of Illinois' National Center for
Supercomputing Applications as a part of the HDF data storage and retrieval
file format and software library products package.  All rights reserved.
Do not modify or use for other purposes.
 
SZIP implements an extended Rice adaptive lossless compression algorithm for
sample data.  The primary algorithm was developed by R. F. Rice at Jet
Propulsion Laboratory.
 
SZIP embodies certain inventions patented by the National Aeronautics &
Space Administration.  United States Patent Nos. 5,448,642, 5,687,255,
and 5,822,457 have been licensed to ICs, LLC, for distribution with the
HDF data storage and retrieval file format and software library products.
All rights reserved.
 
Revocable, royalty-free, nonexclusive sublicense to use SZIP decompression
software routines and underlying patents is hereby granted by ICs, LLC, to
all users of and in conjunction with HDF data storage and retrieval file
format and software library products.
 
Revocable, royalty-free, nonexclusive sublicense to use SZIP compression
software routines and underlying patents for non-commercial, scientific use
only is hereby granted by ICs, LLC, to users of and in conjunction with HDF
data storage and retrieval file format and software library products.
 
For commercial use license to SZIP compression software routines and
underlying patents please contact ICs, LLC, at:
        ICs, LLC
        2600-A E. Seltice Way #234,
        Post Falls, ID 83854
 
        Phone: (208) 755-8990
        Fax: (208) 773-5747.
 
*************Begin NPOESS Specific Permission *******************
NPOESS Permissions: Email correspondence, dated February 6, 2007, from
Dr. Joseph J. Feeley, Chief Executive Officer, of ICs, LLC
2040 Warren Wagon Road, PO Box 2236, McCall ID 83638, USA, grants:
1. Raytheon Company is granted Royalty free permission to use this code
file (as modified) for the compression and decompression of all NPOESS data
packets.
2. Same permission is granted to the NPOESS Integrated Program Office,
all NPOESS contractors, and all U.S. Government agencies using NPOESS data.
  **
3. NPOESS data users may use SZIP decompression software routines and
underlying patents only in conjunction with decompressing NPOESS data in
accordance with and as limited by the above Third Party License.
 
4. All other rights reserved.  Do not modify or use for other purposes.
Further information available at http://www.hdfgroup.org/doc.resource/SZIP/
or by contacting ICs, LLC, at support@ICs4chips.com
*************End NPOESS Specific Permission *******************
 
==============================================================================*/
/*  END THIRD_PARTY_COPYRIGHT  */
 
/* BEGIN GOVERNMENT RIGHTS */
/**************************************************************************
* This code was partially developed under NASA, and other
* U.S. Government contracts.
*
* Patent/copyrights are retained as described in THIRD_PARTY_COPYRIGHT above.
*
* Please also see "LIMITATIONS" below.
*
****************************************************************************/
/* END GOVERNMENT RIGHTS */
 
/* BEGIN ITAR */
/* END ITAR CONTROL */
 
/* BEGIN CATEGORY */
/**************************************************************************
* CATEGORY: 1 (see SEN for definitions)
*
* ricehdf.h
*
* Refer to Software Standards and Practices Manual (SSPM) for
* coding standards.
*
* NOTE: This code is exempt from NPOESS SSPM because it is Third Party,
* copyrighted code.  (Please see THIRD_PARTY_COPYRIGHT above)
*
**************************************************************************/
/* END CATEGORY */
 
/**************************************************************************
*
* NAME: ricehdf.h
*
* REVISION/EVENT HISTORY:
* DATE        PR#      AUTHOR            Build    DESCRIPTION
* ---------   ---      ------            -----    -----------
* 29AUG2006            Miles              1.5     received source from L. Miles
*                                                at ICs Corp. Source is same as
*                                                U. of Illinois HDF Library.
* 25SEP2006            Arbeiter           1.5     inserted modifications
*                                               developed by Jennings, SBRS
* 27SEP2006            Arbeiter           1.5     added NPOESS headings
* 16FEB2007            Arbeiter           1.5     added NPOESS specific
*                                               permissions to 3rd Party
*                                               copyright Notices.
* 16APR2007            Arbeiter           1.5     Updated header comments
* 21DEC2007            Arbeiter           1.5     Updated header comments
*                                               and LIMITATIONS notes
* 31JAN2008            Arbeiter          1.5x1    Limitations updated
* 21NOV2008            Arbeiter          1.5x1    comment updates
* ---------   ---      ------            -----    -----------
*
* REFERENCES: None.
*
*
* LIMITATIONS:
* 1. This code is not generalized Rice Compress/Uncompress.  It will only
* work with the VIIRS sensor data.
*
* 2. Use of this software for data from satellites other than NPP or NPOESS
* is prohibited.
*
* 3. This code has only been tested with the numbers of pixels in the VIIRS
* aggregation or compression zones, or the number of calibration pixels:
* 16, 48, 64, 96, 368, 488, 592, 640, 736, 760, 784, 1184, 1280, and 1776.
* Results with other numbers of pixels may be unreliable.
*
* 4. Raytheon has only tested this code with settings for 15 bits per pixel,
* 8 pixels per block, and option mask for NN, MSB, RAW, and CHIP.  Results with
* other settings may be unreliable. (These are the settings used by
* the VIIRS sensor for all compressions.)
*
* NOTES (MISCELLANEOUS) SECTION:
* Raytheon Company, Bellevue, Nebraska
*  2007 Raytheon Company.  All Rights Reserved.
*  2008 Raytheon Company.  All Rights Reserved.
*
* Comment marking "MJJ" is code written by Michael J. Jennings,
* of Raytheon SBRS, Goleta, California, 04/28/2004.
*
* Comment marking "RGA" is code written by Randolph G. Arbeiter,
* of Raytheon IIS, Omaha, Nebraska, September 2006.
*
*******************************************************************************/
 
/* ##begin code inserted for VIIRS - RGA 14SEP2006 */
#ifndef _RICEHDF_H_
#define _RICEHDF_H_
 
#ifdef __cplusplus
extern "C"               /* prevents name dithering by C++ compiler RGA */
{
#endif
/* ##end code inserted for VIIRS - RGA 14SEP2006 */
 
/********************************************************/
/* defines and declarations to interface to the szip    */
/* functions in file rice.c.                            */
/* USE EXTREME CARE WHEN MODIFYING THIS FILE            */
/********************************************************/
extern int szip_allow_encoding;
 
#define SZ_ALLOW_K13_OPTION_MASK         1
#define SZ_CHIP_OPTION_MASK              2 
#define SZ_EC_OPTION_MASK                4
#define SZ_LSB_OPTION_MASK               8
#define SZ_MSB_OPTION_MASK              16
#define SZ_NN_OPTION_MASK               32
#define SZ_RAW_OPTION_MASK             128
 
#define SZ_STREAM_ERROR    (-1)
#define SZ_MEM_ERROR       (-2)
#define SZ_INIT_ERROR      (-3)
#define SZ_PARAM_ERROR     (-4)
#define SZ_NO_ENCODER_ERROR (-5)
 
#define SZ_MAX_BLOCKS_PER_SCANLINE            256
#define SZ_MAX_PIXELS_PER_BLOCK                32
#define SZ_MAX_PIXELS_PER_SCANLINE     (SZ_MAX_BLOCKS_PER_SCANLINE)*(SZ_MAX_PIXELS_PER_BLOCK)
 
long szip_compress_memory(
   int options_mask,
   int bits_per_pixel,
   int pixels_per_block,
   int pixels_per_scanline,
   const void *in,
   long pixels,
   char *out);
 
long szip_uncompress_memory(
   int new_options_mask,
   int new_bits_per_pixel,
   int new_pixels_per_block,
   int new_pixels_per_scanline, 
   const char *in,
   long in_bytes,
   void *out,
   long out_pixels);
 
int szip_check_params(
   int bits_per_pixel,
   int pixels_per_block,
   int pixels_per_scanline,
   long image_pixels,
   char **msg);
 
/* ##begin code inserted for VIIRS - RGA 14SEP2006 */
#ifdef __cplusplus
}
#endif
 
#endif
/* ##end code inserted for VIIRS - RGA 14SEP2006 */