/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Board of Trustees of the University of Illinois.         *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of HDF.  The full HDF copyright notice, including       *
 * terms governing use, modification, and redistribution, is contained in    *
 * the COPYING file, which can be found at the root of the source code       *
 * distribution tree, or in https://support.hdfgroup.org/ftp/HDF/releases/.  *
 * If you do not have access to either file, you may request a copy from     *
 * help@hdfgroup.org.                                                        *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/* $Id$ */

/*-----------------------------------------------------------------------------
 * File:     dfgr.c
 * Purpose:  read and write general raster images
 * Invokes:  df.c, dfkit.c, dfcomp.c, dfgroup.c, dfgr.h
 * Contents:
 *  DFGRgetlutdims  : get dimensions of lookup table
 *  DFGRreqlutil    : use this interlace when returning lookup table
 *  DFGRgetlut      : read in lookup table
 *  DFGRgetimdims   : get dimensions of image
 *  DFGRreqimil     : use this interlace when returning image
 *  DFGRgetimage    : read in image
 *  DFGRsetcompress : specify compression scheme to be used
 *  DFGRsetlutdims  : set dimensions of lookup table
 *  DFGRsetlut      : set lookup table to write out with subsequent images
 *  DFGRaddlut      : write out lookup table
 *  DFGRsetimdims   : set dimensions of image
 *  DFGRaddimage    : write out image
 *
 *  DFGRgetrig  : read in raster image group
 *  DFGRaddrig  : write out raster image group
 *
 *  DFGRIopen      : open/reopen file
 *  DFGRIriginfo   : obtain info about next RIG
 *  DFGRIgetdims   : get dimensions of lut/iamge
 *  DFGRIreqil     : get lut/image with this interlace
 *  DFGRIgetimlut  : get image/lut
 *  DFGRIsetdims   : set image/lut dimensions
 *  DFGRIaddimlut  : write out image/lut
 * Remarks: A RIG specifies attributes associated with an image - lookup table,
 *          dimension, compression, color compensation etc.
 *---------------------------------------------------------------------------*/

#include "hdf.h"
#include "dfgr.h"

PRIVATE char *Grlastfile = NULL;
PRIVATE uint8 *Grlutdata = NULL;    /* points to lut, if in memory */
PRIVATE intn Grnewdata = 0;     /* does Grread contain fresh data? */
PRIVATE intn Grcompr = 0;       /* compression scheme to use */
PRIVATE comp_info Grcinfo;      /* Compression information for each
                                   scheme */
PRIVATE uint16 Grrefset = 0;    /* Ref of image to get next */
PRIVATE uint16 Grlastref = 0;   /* Last ref read/written */
PRIVATE intn Grreqil[2] =
{0, 0};                         /* requested lut/image il */
PRIVATE struct
  {                             /* track refs of set vals written before */
      intn        lut;          /* -1: no vals set */
      int16       dims[2];      /* 0: vals set, not written */
      intn        nt;           /* non-zero: ref of val in file */
  }
Ref =
{
    -1,
    {
        -1, -1
    }
    ,-1
};
PRIVATE DFGRrig Grread =
{                               /* information about RIG being read */
    NULL, 0, 0, (float32) 0.0, (float32) 0.0,
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {
        {0, 0},
        {0, 0},
        {0, 0},},
    {
        {0, 0, 0, 0,
         {0, 0},
         {0, 0}},
        {0, 0, 0, 0,
         {0, 0},
         {0, 0}},
        {0, 0, 0, 0,
         {0, 0},
         {0, 0}},},
};
PRIVATE DFGRrig Grwrite =
{                               /* information about RIG being written */
    NULL, 0, 0, (float32) 0.0, (float32) 0.0,
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {
        {0, 0},
        {0, 0},
        {0, 0},},
    {
        {0, 0, 0, 0,
         {0, 0},
         {0, 0}},
        {0, 0, 0, 0,
         {0, 0},
         {0, 0}},
        {0, 0, 0, 0,
         {0, 0},
         {0, 0}},},
};
PRIVATE DFGRrig Grzrig =
{                               /* empty RIG for initialization */
    NULL, 0, 0, (float32) 0.0, (float32) 0.0,
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {(float32) 0.0, (float32) 0.0, (float32) 0.0},
    {
        {0, 0},
        {0, 0},
        {0, 0},},
    {
        {0, 0, 0, 0,
         {0, 0},
         {0, 0}},
        {0, 0, 0, 0,
         {0, 0},
         {0, 0}},
        {0, 0, 0, 0,
         {0, 0},
         {0, 0}},},
};

/* Whether we've installed the library termination function yet for this interface */
PRIVATE intn library_terminate = FALSE;

#define LUT     0
#define IMAGE   1

/* private functions */
PRIVATE int DFGRIriginfo
            (int32 file_id);
PRIVATE int DFGRgetrig
            (int32 file_id, uint16 ref, DFGRrig * rig);
PRIVATE int DFGRaddrig
            (int32 file_id, uint16 ref, DFGRrig * rig);
PRIVATE intn DFGRIstart(void);

/*-----------------------------------------------------------------------------
 * Name:    DFGRgetlutdims
 * Purpose: get dimensions of lut from next RIG
 * Inputs:  filename: name of HDF file
 *          pxdim, pydim: pointer to locations for returning x,y dimensions
 *          pncomps: location for returning no of components
 *          pil: location for returning interlace of lut in file
 * Returns: 0 on success, -1 on failure with DFerror set
 *          *pxdim, *pydim, *pncomps, *pil set on success
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIgetdims
 * Remarks: none
 *---------------------------------------------------------------------------*/

int
DFGRgetlutdims(const char *filename, int32 *pxdim, int32 *pydim, int *pncomps,
               int *pil)
{
    return (DFGRIgetdims(filename, pxdim, pydim, pncomps, pil, LUT));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRreqlutil
 * Purpose: get next lut with specified interlace
 * Inputs:  il: interlace to get next lut with
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIreqil
 * Remarks: none
 *---------------------------------------------------------------------------*/

int
DFGRreqlutil(int il)
{
    return (DFGRIreqil(il, LUT));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRgetlut
 * Purpose: get lut from next RIG
 * Inputs:  filename: name of HDF file
 *          lut: pointer to space to return lookup table
 *          xdim, ydim: dimensions of space to return lut
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIgetimlut
 * Remarks: space is assumed to be xdim * ydim * ncomps bytes
 *---------------------------------------------------------------------------*/

int
DFGRgetlut(const char *filename, void * lut, int32 xdim, int32 ydim)
{
    int compressed, has_pal;
    uint16 compr_type;
    /* 0 == C */
    return (DFGRIgetimlut(filename, lut, xdim, ydim, LUT, 0,
			  &compressed, &compr_type, &has_pal));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRgetimdims
 * Purpose: get dimensions of next image RIG
 * Inputs:  filename: name of HDF file
 *          pxdim, pydim: pointer to locations for returning x,y dimensions
 *          pncomps: location for returning no of components
 *          pil: location for returning interlace of image in file
 * Returns: 0 on success, -1 on failure with DFerror set
 *          *pxdim, *pydim, *pncomps, *pil set on success
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIgetdims
 * Remarks: none
 *---------------------------------------------------------------------------*/

int
DFGRgetimdims(const char *filename, int32 *pxdim, int32 *pydim, int *pncomps,
              int *pil)
{
    return (DFGRIgetdims(filename, pxdim, pydim, pncomps, pil, IMAGE));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRreqimil
 * Purpose: get next image with specified interlace
 * Inputs:  il: interlace to get next image with
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIreqil
 * Remarks: none
 *---------------------------------------------------------------------------*/

int
DFGRreqimil(int il)
{
    return (DFGRIreqil(il, IMAGE));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRgetimage
 * Purpose: get image from next RIG
 * Inputs:  filename: name of HDF file
 *          image: pointer to space to return image
 *          xdim, ydim: dimensions of space to return lut
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIgetimlut
 * Remarks: space is assumed to be xdim * ydim * ncomps bytes
 *---------------------------------------------------------------------------*/

int
DFGRgetimage(const char *filename, void * image, int32 xdim, int32 ydim)
{
    int compressed, has_pal;
    uint16 compr_type;
    /* 0 == C */
    return (DFGRIgetimlut(filename, image, xdim, ydim, IMAGE, 0,
			  &compressed, &compr_type, &has_pal));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRsetcompress
 * Purpose: set compression scheme to use
 * Inputs:
 *      scheme - compression scheme
 *      cinfo - compression information structure
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: none
 * Remarks: none
 *---------------------------------------------------------------------------*/
int
DFGRsetcompress(int32 scheme, comp_info * cinfo)
{
    CONSTR(FUNC, "DFGRsetcompress");
    intn   ret_value = SUCCEED;

    HEclear();

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    if (scheme == COMP_NONE)
      {     /* quick check for no compression */
          Grcompr = 0;  /* Set the compression scheme */
          HGOTO_DONE(SUCCEED);
      }     /* end if */

    if (scheme < 0 || scheme > COMP_MAX_COMP || compress_map[scheme] == 0)
        HGOTO_ERROR(DFE_BADSCHEME, FAIL);

    /* map JPEG compression into correct type of JPEG compression */
    if (scheme == COMP_JPEG)
        Grcompr = DFTAG_JPEG5;   /* Set the compression scheme */
    else    /* otherwise, just use mapped tag */
        Grcompr = (intn)compress_map[scheme];
    Grcinfo = (*cinfo);     /* Set the compression parameters */

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */

    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}   /* end DFGRsetcompress() */

/*-----------------------------------------------------------------------------
 * Name:    DFGRsetlutdims
 * Purpose: set dimensions of lut to write next
 * Inputs:  xdim, ydim: dimensions of lut
 *          ncomps: no of components
 *          il: interlace of lut
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIsetdims
 * Remarks: none
 *---------------------------------------------------------------------------*/

int
DFGRsetlutdims(int32 xdim, int32 ydim, int ncomps, int il)
{
    if (DFGRIsetil(il, LUT) < 0)
        return FAIL;
    return (DFGRIsetdims(xdim, ydim, ncomps, LUT));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRsetlut
 * Purpose: set lut for subsequent RIGs
 * Inputs:  lut: lookup table to write
 *          xdim, ydim: dimensions of array lut
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIaddimlut
 * Remarks: array lut is assumed to be xdim * ydim * ncomps bytes
 *---------------------------------------------------------------------------*/

int
DFGRsetlut(void * lut, int32 xdim, int32 ydim)
{
    /* 0 == C, 0 == no newfile */
    return (DFGRIaddimlut((const char *) NULL, lut, xdim, ydim, LUT, 0, 0));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRaddlut
 * Purpose: write lut to file, associate it with subsequent RIGs
 * Inputs:  filename: name of HDF file
 *          lut: lookup table to write
 *          xdim, ydim: dimensions of array lut
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIaddimlut
 * Remarks: array lut is assumed to be xdim * ydim * ncomps bytes
 *---------------------------------------------------------------------------*/

int
DFGRaddlut(const char *filename, void * lut, int32 xdim, int32 ydim)
{
    /* 0 == C, 0 == no new file */
    return (DFGRIaddimlut(filename, lut, xdim, ydim, LUT, 0, 0));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRsetimdims
 * Purpose: set dimensions of image to write next
 * Inputs:  xdim, ydim: dimensions of image
 *          ncomps: no of components
 *          il: interlace of image
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIsetdims
 * Remarks: none
 *---------------------------------------------------------------------------*/

int
DFGRsetimdims(int32 xdim, int32 ydim, int ncomps, int il)
{
    if (DFGRIsetil(il, IMAGE) < 0)
        return FAIL;
    return (DFGRIsetdims(xdim, ydim, ncomps, IMAGE));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRaddimage
 * Purpose: Write out image
 * Inputs:  filename: name of HDF file
 *          image: image to write
 *          xdim, ydim: dimensions of array image
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIaddimlut
 * Remarks: array image is assumed to be xdim * ydim * ncomps bytes
 *---------------------------------------------------------------------------*/

int
DFGRaddimage(const char *filename, void * image, int32 xdim, int32 ydim)
{
    /* 0 == C, 0 == not new file */
    return (DFGRIaddimlut(filename, image, xdim, ydim, IMAGE, 0, 0));
}

int
DFGRputimage(const char *filename, void * image, int32 xdim, int32 ydim)
{
    /* 0 == C, 1 == new file */
    return (DFGRIaddimlut(filename, image, xdim, ydim, IMAGE, 0, 1));
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRreadref
 * Purpose: Set ref of rig to get next
 * Inputs:  filename: file to which this applies
 *          ref: reference number of next get
 * Returns: 0 on success, -1 on failure
 * Users:   HDF programmers, other routines and utilities
 * Invokes: DFGRIopen, DFIfind, DFclose
 * Remarks: checks if rig with this ref exists
 *---------------------------------------------------------------------------*/

int
DFGRreadref(const char *filename, uint16 ref)
{
    CONSTR(FUNC, "DFGRreadref");
    intn    ret_value = SUCCEED;
    int32   file_id=(-1);
#ifdef OLD_WAY
    int32   aid;
#endif /* OLD_WAY */

    HEclear();

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    if ((file_id = DFGRIopen(filename, DFACC_READ))== FAIL)
        HGOTO_ERROR(DFE_BADOPEN, FAIL);

#ifdef OLD_WAY
    if ((aid = Hstartread(file_id, DFTAG_RIG, ref)) == FAIL)
        HGOTO_ERROR(DFE_BADAID, FAIL);

    if (Hendaccess(aid)==FAIL)
        HGOTO_ERROR(DFE_CANTENDACCESS, FAIL);
#else /* OLD_WAY */
    if (Hexist(file_id, DFTAG_RIG, ref) == FAIL)
        HGOTO_ERROR(DFE_BADAID, FAIL);

#endif /* OLD_WAY */

    Grrefset = ref;
    ret_value= Hclose(file_id);

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */
      if(file_id!=(-1))
          Hclose(file_id);

    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}

/*****************************************************************************/
/* This is the next lower layer - procedures to read in and write out a RIG. */
/*****************************************************************************/

/*-----------------------------------------------------------------------------
 * Name:    DFGRgetrig
 * Purpose: Read a RIG into memory
 * Inputs:  file_id: pointer to HDF file containing RIG
 *          ref: reference number of RIG to get
 *          rig: struct in which to place info obtained
 * Returns: 0 on success, -1 on failure with DFerror set
 *          contents of RIG in the struct rig
 * Users:   HDF programmers, utilities, DFGRIgetdims,DFGRIgetimlut,
 *          other routines
 * Invokes: DFdiget, DFdinext, DFIcheck, DFgetelement
 * Remarks: incomplete - does not support DFTAG_MA etc.
 *---------------------------------------------------------------------------*/

PRIVATE int
DFGRgetrig(int32 file_id, uint16 ref, DFGRrig * rig)
{
    CONSTR(FUNC, "DFGRgetrig");
    uint16      elt_tag, elt_ref;
    uint8       ntstring[4];
    int         type;
    int32       GroupID;
    uint8       GRtbuf[64];     /* local buffer for reading RIG info */
    intn        ret_value = SUCCEED;

    HEclear();

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    if (!HDvalidfid(file_id) || !ref)
        HGOTO_ERROR(DFE_ARGS, FAIL);

    /* read RIG into memory */
    if ((GroupID = DFdiread(file_id, DFTAG_RIG, ref)) == FAIL)
        HGOTO_ERROR(DFE_READERROR, FAIL);

    *rig = Grzrig;  /* fill rig with zeroes */
    while (!DFdiget(GroupID, &elt_tag, &elt_ref))
      {     /* get next tag/ref */
          switch (elt_tag)
            {   /* process tag/ref */
                case DFTAG_CI:
                case DFTAG_RI:
                case DFTAG_LUT:
                    type = (elt_tag == DFTAG_LUT) ? LUT : IMAGE;
                    rig->data[type].tag = elt_tag;
                    rig->data[type].ref = elt_ref;
                    break;

                case DFTAG_ID:      /* read description info */
                case DFTAG_LD:
                    type = (elt_tag == DFTAG_LD) ? LUT : IMAGE;
                    if (Hgetelement(file_id, elt_tag, elt_ref, GRtbuf) != FAIL)
                      {
                          int16       int16var;
                          uint8      *p;

                          p = GRtbuf;
                          INT32DECODE(p, rig->datadesc[type].xdim);
                          INT32DECODE(p, rig->datadesc[type].ydim);
                          UINT16DECODE(p, rig->datadesc[type].nt.tag);
                          UINT16DECODE(p, rig->datadesc[type].nt.ref);
                          INT16DECODE(p, int16var);
                          rig->datadesc[type].ncomponents=(intn)int16var;
                          INT16DECODE(p, int16var);
                          rig->datadesc[type].interlace=(intn)int16var;
                          UINT16DECODE(p, rig->datadesc[type].compr.tag);
                          UINT16DECODE(p, rig->datadesc[type].compr.ref);
                      }
                    else
                      {
                    	DFdifree(GroupID);
                        HGOTO_ERROR(DFE_READERROR, FAIL);
                    }

                    if (rig->datadesc[type].nt.tag == 0)
                        break;  /* old RIGs */

                    /* read NT */
                    if (Hgetelement(file_id, rig->datadesc[type].nt.tag,
                              rig->datadesc[type].nt.ref, ntstring) == FAIL)
                      {
                    	DFdifree(GroupID);
                        HGOTO_ERROR(DFE_READERROR, FAIL);
                      }
                    if ((ntstring[2] != 8) || (ntstring[1] != DFNT_UCHAR))
                      {
                     	DFdifree(GroupID);
                        HGOTO_ERROR(DFE_BADCALL, FAIL);
                      }
                    break;
                default:    /* ignore unknown tags */
                    break;
            }
      }
      
done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */

    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRaddrig
 * Purpose: Write RIG struct out to HDF file
 * Inputs:  file_id: HDF file pointer
 *          ref: ref to write RIG with
 *          rig: struct containing RIG info to write
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF programmers, utilities, DFGRIaddimlut, other routines
 * Invokes: DFIcheck, DFdistart, DFdiadd, DFdiend, DFputelement
 * Remarks: none
 *---------------------------------------------------------------------------*/

PRIVATE int
DFGRaddrig(int32 file_id, uint16 ref, DFGRrig * rig)
{
    CONSTR(FUNC, "DFGRaddrig");
    uint8       ntstring[4];
    int32       lutsize;
    int32       GroupID;
    uint8       GRtbuf[64];     /* local buffer for reading RIG info */
    intn        ret_value = SUCCEED;

    HEclear();

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    if (!HDvalidfid(file_id) || !ref)
        HGOTO_ERROR(DFE_ARGS, FAIL);

    if (Ref.nt <= 0)
      {     /* if nt not previously written to file */
          /* construct and write out NT */
          ntstring[0] = DFNT_VERSION;   /* version */
          ntstring[1] = DFNT_UCHAR;     /* type */
          ntstring[2] = 8;  /* width: RIG data is 8-bit chars */
          ntstring[3] = DFNTC_BYTE;     /* class: data are numeric values */
          if (Hputelement(file_id, DFTAG_NT, ref,
                          (uint8 *) ntstring, (int32) 4) == FAIL)
              HGOTO_ERROR(DFE_PUTELEM, FAIL);
          rig->datadesc[IMAGE].nt.tag = DFTAG_NT;
          rig->datadesc[IMAGE].nt.ref = ref;
          Ref.nt = (intn)ref;
      }

    if (Ref.dims[IMAGE] == 0)
      {
          uint8      *p;

          p = GRtbuf;
          INT32ENCODE(p, rig->datadesc[IMAGE].xdim);
          INT32ENCODE(p, rig->datadesc[IMAGE].ydim);
          UINT16ENCODE(p, rig->datadesc[IMAGE].nt.tag);
          UINT16ENCODE(p, rig->datadesc[IMAGE].nt.ref);
          INT16ENCODE(p, rig->datadesc[IMAGE].ncomponents);
          INT16ENCODE(p, rig->datadesc[IMAGE].interlace);
          UINT16ENCODE(p, rig->datadesc[IMAGE].compr.tag);
          UINT16ENCODE(p, rig->datadesc[IMAGE].compr.ref);

          if (Hputelement(file_id, DFTAG_ID, ref,
                          GRtbuf, (int32) (p - GRtbuf)) == FAIL)
              HGOTO_ERROR(DFE_PUTELEM, FAIL);

          Ref.dims[IMAGE] = (int16)ref;
      }
    if (!Ref.lut)
      {     /* associated lut not written to this file */
          if (Grlutdata == NULL)    /* no lut associated */
              HGOTO_ERROR(DFE_ARGS, FAIL);
          lutsize = Grwrite.datadesc[LUT].xdim * Grwrite.datadesc[LUT].ydim *
              Grwrite.datadesc[LUT].ncomponents;
          if (Hputelement(file_id, DFTAG_LUT, ref,
                          Grlutdata, (int32) lutsize) == FAIL)
              HGOTO_ERROR(DFE_PUTELEM, FAIL);
          rig->data[LUT].tag = DFTAG_LUT;
          rig->data[LUT].ref = ref;
          Ref.lut = (intn)ref;
      }

    if (Ref.dims[LUT] == 0)
      {
          uint8      *p;
          p = GRtbuf;
          INT32ENCODE(p, rig->datadesc[LUT].xdim);
          INT32ENCODE(p, rig->datadesc[LUT].ydim);
          UINT16ENCODE(p, rig->datadesc[LUT].nt.tag);
          UINT16ENCODE(p, rig->datadesc[LUT].nt.ref);
          INT16ENCODE(p, rig->datadesc[LUT].ncomponents);
          INT16ENCODE(p, rig->datadesc[LUT].interlace);
          UINT16ENCODE(p, rig->datadesc[LUT].compr.tag);
          UINT16ENCODE(p, rig->datadesc[LUT].compr.ref);
          if (Hputelement(file_id, DFTAG_LD, ref,
                          GRtbuf, (int32) (p - GRtbuf)) == FAIL)
              HGOTO_ERROR(DFE_PUTELEM, FAIL);
          Ref.dims[LUT] = (int16)ref;
      }

    /* prepare to start writing rig */
    /* ### NOTE: the parameter to this call may go away */
    if ((GroupID = DFdisetup(10)) == FAIL)
        HGOTO_ERROR(DFE_GROUPSETUP, FAIL);    /* max 10 tag/refs in set */
    /* add tag/ref to RIG - image description, image and lookup table */
    if (DFdiput(GroupID, DFTAG_ID, (uint16) Ref.dims[IMAGE]) == FAIL)
        HGOTO_ERROR(DFE_PUTGROUP, FAIL);

    if (DFdiput(GroupID, rig->data[IMAGE].tag, rig->data[IMAGE].ref) == FAIL)
        HGOTO_ERROR(DFE_PUTGROUP, FAIL);

    if ((Ref.dims[LUT] > 0)
        && (DFdiput(GroupID, DFTAG_LD, (uint16) Ref.dims[LUT]) == FAIL))
        HGOTO_ERROR(DFE_PUTGROUP, FAIL);

    if ((Ref.lut > 0)
      && (DFdiput(GroupID, rig->data[LUT].tag, rig->data[LUT].ref) == FAIL))
        HGOTO_ERROR(DFE_PUTGROUP, FAIL);

    /* write out RIG */
    if(DFdiwrite(file_id, GroupID, DFTAG_RIG, ref)==FAIL)
        HGOTO_ERROR(DFE_INTERNAL, FAIL);

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */

    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}

/*****************************************************************************/
/*----------------------- Internal routines ---------------------------------*/
/*****************************************************************************/

/*-----------------------------------------------------------------------------
 * Name:    DFGRIopen
 * Purpose: open or reopen a file
 * Inputs:  filename: name of file to open
 *          acc_mode : access mode
 * Returns: file pointer on success, NULL on failure with DFerror set
 * Users:   HDF systems programmers, all the RIG routines
 * Invokes: DFopen
 * Remarks: This is a hook for someday providing more efficient ways to
 *          reopen a file, to avoid re-reading all the headers
 *---------------------------------------------------------------------------*/

int32
DFGRIopen(const char *filename, int acc_mode)
{
    CONSTR(FUNC, "DFGRIopen");
    int32       file_id=(-1);
    int32       ret_value = SUCCEED;

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    if (( file_id = Hopen(filename, acc_mode, 0))== FAIL)
        HGOTO_ERROR(DFE_BADOPEN, FAIL);

    /* Check if filename buffer has been allocated */
    if (Grlastfile == NULL)
      {
          if (( Grlastfile = (char *) HDmalloc(DF_MAXFNLEN + 1))== NULL)
              HGOTO_ERROR(DFE_NOSPACE, FAIL);
          *Grlastfile = '\0';   /* initialize to a 0-length string */
      }

    /* use reopen if same file as last time - more efficient */
    if (HDstrncmp(Grlastfile, filename, DF_MAXFNLEN) || (acc_mode == DFACC_CREATE))
      {
          /* treat create as different file */
          Grrefset = 0;     /* no ref to get set for this file */
          Grnewdata = 0;
          if (Ref.lut > 0)
              Ref.lut = 0;
          if (Grlutdata == NULL)
              Ref.lut = (-1);   /* no LUT if not a "set" call */
          if (Ref.dims[IMAGE] > 0)
              Ref.dims[IMAGE] = 0;
          if (Ref.dims[LUT] > 0)
              Ref.dims[LUT] = 0;
          if (Ref.nt > 0)
              Ref.nt = 0;
          Grread = Grzrig;  /* no rigs read yet */
      }

    /* remember filename, so reopen may be used next time if same file */
    HDstrncpy(Grlastfile, filename, DF_MAXFNLEN);

    ret_value= file_id;

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */
      if(file_id!=(-1))
          Hclose(file_id);

    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRIriginfo
 * Purpose: Get information about next RIG in file
 * Inputs:  file_id: pointer to DF file
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF systems programmers
 * Invokes: DFIfind, DFgetelement, DFGRgetrig
 * Remarks: if Grrefset set, gets image with that ref, if any
 *---------------------------------------------------------------------------*/

PRIVATE int
DFGRIriginfo(int32 file_id)
{
    CONSTR(FUNC, "DFGRIriginfo");
    int         i, isfirst;
    uint16      newref = 0, newtag = 0, gettag, getref, ref=0, dummy=0;
    struct
      {
          uint16      xdim;
          uint16      ydim;
      }
    r8dims;
    char       *p;
    int32       aid;
  intn        ret_value = SUCCEED;

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    isfirst = (Grrefset != 0) || (Grread.data[IMAGE].ref == 0);
    getref = Grrefset;  /* ref if specified, else 0 */
    Grrefset = 0;   /* no longer need to remember specified ref */
    gettag = DFTAG_RIG;
    for (i = 0; i < 4; i++)
      {     /* repeat for RIG, RI8, CI8, II8 */
          if (isfirst)
            {
                aid = Hstartread(file_id, gettag, getref);
            }
          else
            {
                aid = Hstartread(file_id, gettag, Grread.data[IMAGE].ref);
                if ((aid != FAIL) &&
                    Hnextread(aid, gettag, getref, DF_CURRENT) == FAIL)
                  {
                      Hendaccess(aid);
                      aid = FAIL;
                  }
            }
          if (aid == FAIL)
            {   /* not found */
                if (gettag == DFTAG_RIG)
                  {     /* were looking for RIGs */
                      if ((Grread.data[IMAGE].tag == DFTAG_RI)  /* file has RIGs */
                          || (Grread.data[IMAGE].tag == DFTAG_CI))
                          HGOTO_DONE(FAIL);  /* no more to return */
                      gettag = DFTAG_RI8;   /* if no RIGs in file, look for RI8s */
                  }
                else if ((gettag == DFTAG_II8) && (!newref))    /* no RI8/CI8/II8 */
                    HGOTO_DONE(FAIL);
                continue;   /* continue checking */
            }
          /* found */
          HQuerytagref(aid, &dummy, &ref);
          Hendaccess(aid);
          if (!newref || (ref < newref))
            {   /* is it next one? */
                newref = ref;   /* remember tag, ref */
                newtag = gettag;
            }
          if (gettag == DFTAG_RI8)
              gettag = DFTAG_CI8;   /* check next */
          else if (gettag == DFTAG_CI8)
              gettag = DFTAG_II8;
          else
              break;    /* all checked, quit */
      }

    if (newtag == DFTAG_RIG)
      {
          if (DFGRgetrig(file_id, newref, &Grread) == FAIL)
              HGOTO_ERROR(DFE_INTERNAL, FAIL);
      }
    else
      {
          uint16    uint16var;

          Grread.data[IMAGE].ref = newref;
          Grread.data[IMAGE].tag = newtag;
          if (newtag == DFTAG_CI8)
              Grread.datadesc[IMAGE].compr.tag = DFTAG_RLE;
          else if (newtag == DFTAG_II8)
              Grread.datadesc[IMAGE].compr.tag = DFTAG_IMC;

          if (Hgetelement(file_id, DFTAG_ID8, newref, (uint8 *) &r8dims) == FAIL)
              HGOTO_ERROR(DFE_GETELEM, FAIL);
          p = (char *) &r8dims;
          UINT16DECODE(p, uint16var);
          Grread.datadesc[IMAGE].xdim=(int32)uint16var;
          UINT16DECODE(p, uint16var);
          Grread.datadesc[IMAGE].ydim=(int32)uint16var;

          aid = Hstartread(file_id, DFTAG_IP8, newref);
          if (aid != FAIL)
            {
                Grread.data[LUT].tag = DFTAG_IP8;
                Grread.data[LUT].ref = newref;
                Hendaccess(aid);
            }
          HEclear();    /* reset it, just in case! */
      }

    /* if LUT dimensions not set, set default dimensions */
    if (Grread.data[LUT].tag && Grread.datadesc[LUT].xdim == 0)
      {
          Grread.datadesc[LUT].xdim = 256;
          Grread.datadesc[LUT].ydim = 1;
          Grread.datadesc[LUT].ncomponents = 3;
      }

#ifdef OLD_WAY
    Grlastref = Grread.data[IMAGE].ref;     /* remember ref read */
#else /* OLD_WAY */
    Grlastref = newref;     /* remember ref read */
#endif /* OLD_WAY */

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */

    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRIgetdims
 * Purpose: get dimensions of next image/lut from RIG
 * Inputs:  filename: name of HDF file
 *          pxdim, pxdim: pointer to locations for returning x,y dimensions
 *          pncomps: location for returning no of components
 *          pil: location for returning interlace of image/lut in file
 *          type: LUT to get lut dims, IMAGE to get image dims
 * Returns: 0 on success, -1 on failure with DFerror set
 *          *pxdim, *pydim are set to dimensions of the next image on success
 *          *pncomps, *pil set on success
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: DFGRIopen, DFclose, DFGRIriginfo, DFIerr
 * Remarks: none
 *---------------------------------------------------------------------------*/

int
DFGRIgetdims(const char *filename, int32 *pxdim, int32 *pydim,
             int *pncomps, int *pil, int type)
{
    CONSTR(FUNC, "DFGRIgetdims");
    intn        ret_value = SUCCEED;
    int32       file_id=(-1);

    HEclear();

    if (( file_id = DFGRIopen(filename, DFACC_READ))== FAIL)
        HGOTO_ERROR(DFE_BADOPEN, FAIL);

    if (type == IMAGE)
      {     /* getimdims sequences, getlutdims does not */
          /* reads next RIG or RI8 from file */
          if (DFGRIriginfo(file_id) == FAIL)
              HGOTO_ERROR(DFE_INTERNAL,FAIL);
          Grnewdata = 1;
      }

    if (type == LUT && Grread.data[LUT].ref == 0)
        HGOTO_ERROR(DFE_NOMATCH, FAIL);

    if (pxdim)
        *pxdim = Grread.datadesc[type].xdim;
    if (pydim)
        *pydim = Grread.datadesc[type].ydim;
    if (pncomps)
        *pncomps = Grread.datadesc[type].ncomponents;
    if (pil)
        *pil = Grread.datadesc[type].interlace;

  Hclose(file_id);

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */
      if(file_id!=(-1))
        Hclose(file_id);
    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRIreqil
 * Purpose: set interlace with which to get subsequent images/luts
 * Inputs:  il: interlace to get image/lut with
 *          type: LUT for luts, IMAGE for images
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF users, utilities, other routines
 * Invokes: none
 * Remarks: none
 *---------------------------------------------------------------------------*/

int
DFGRIreqil(intn il, intn type)
{
    CONSTR(FUNC, "DFGRIreqil");
    intn    ret_value = SUCCEED;

    HEclear();

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    Grreqil[type] = il;

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */

    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRIgetimlut
 * Purpose: get next image/lut from a RIG
 * Inputs:  filename: name of HDF file
 *          imlut: space to read image/lut into
 *          xdim, ydim: dimensions of space allocated by user for image/lut
 *          type: LUT for luts, IMAGE for images
 *          isfortran: 0 if called from C, 1 if called from Fortran
 * Returns: 0 on success, -1 on failure with DFerror set
 *          image/lut in imlut
 * Users:   HDF HLL users, utilities, other routines
 * Invokes: DFGRIopen, DFGRIriginfo, DFIerr, DFclose, DFgetelement, DFgetcomp
 * Remarks: Will also get RI8s and CI8s if no RIGs in file
 *          Normally, DFGRgetimdims is called first and it moves to next image
 *          But if that is not called, DFGRgetimlut will itself move to next
 *          image (but not next lut!).
 *          Automatically decompresses images/luts
 *---------------------------------------------------------------------------*/

/* shut lint up */
/* ARGSUSED */
int
DFGRIgetimlut(const char *filename, void * imlut, int32 xdim, int32 ydim,
              int type, int isfortran, int *compressed, uint16 *compr_type, 
	      int *has_pal)
{
    CONSTR(FUNC, "DFGRIgetimlut");
    int32       file_id=(-1);
    int32       currpos[3], currmax[3], destsize[3], bufsize, i, j;
    uint8      *buf, *destp;
    int32       aid;
    intn        ret_value = SUCCEED;

    /* shut compiler up */
    isfortran = isfortran;

    HEclear();

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    if (( file_id = DFGRIopen(filename, DFACC_READ))== FAIL)
        HGOTO_ERROR(DFE_BADOPEN, FAIL);

    if ((type == IMAGE) && (Grnewdata != 1))
      {     /* if Grread not fresh */
          if (DFGRIriginfo(file_id) == FAIL)    /* reads next RIG or RI8 from file */
              HGOTO_ERROR(DFE_INTERNAL, FAIL);
      }
    if (Grnewdata == 0)
        HGOTO_ERROR(DFE_BADCALL, FAIL);
    Grnewdata = 0;  /* read new RIG next time */

    if ((xdim != Grread.datadesc[type].xdim)
        || (ydim != Grread.datadesc[type].ydim))
        HGOTO_ERROR(DFE_ARGS, FAIL);

    /* read image/lut */
    if (Grread.datadesc[type].compr.tag)
      {     /* compressed image/lut */
          *compressed = 1;
	  *compr_type = Grread.datadesc[type].compr.tag;
	  if ((Grreqil[type] >= 0)
              && (Grreqil[type] != Grread.datadesc[type].interlace))
              HGOTO_ERROR(DFE_UNSUPPORTED, FAIL);
          if (DFgetcomp(file_id, Grread.data[type].tag, Grread.data[type].ref,
                        (uint8 *) imlut, Grread.datadesc[type].xdim,
                        Grread.datadesc[type].ydim,
                        Grread.datadesc[type].compr.tag) == FAIL)
              HGOTO_ERROR(DFE_INTERNAL, FAIL);
      }
    else
      {     /* non-compressed raster image/lut */
	  *compressed = 0;
          if (Grreqil[type] >= 0)
            {
                if (Grreqil[type] >= Grread.datadesc[type].ncomponents)
                  {
                      HGOTO_ERROR(DFE_ARGS, FAIL);
                  }
                else if (Grreqil[type] != Grread.datadesc[type].interlace)
                  {
                      aid = Hstartread(file_id, Grread.data[type].tag,
                                       Grread.data[type].ref);
                      if (aid == FAIL)
                          HGOTO_ERROR(DFE_BADAID, FAIL);
                      /* current position in data */
                      currpos[0] = currpos[1] = currpos[2] = 0;
                      currmax[0] = Grread.datadesc[type].ncomponents;
                      currmax[1] = Grread.datadesc[type].xdim;
                      currmax[2] = Grread.datadesc[type].ydim;

                      /* compute size of each dim of dest array */
                      destsize[0] = destsize[1] = 1;
                      destsize[2] = currmax[1];     /* xdim is more sig than ydim */
                      if (Grreqil[type] == 0)
                        {
                            destsize[1] *= currmax[0];
                            destsize[2] *= currmax[0];
                        }
                      else if (Grreqil[type] == 1)
                        {
                            destsize[0] *= currmax[1];
                            destsize[2] *= currmax[0];
                        }
                      else if (Grreqil[type] == 2)
                        {
                            destsize[0] *= currmax[1] * currmax[2];
                        }

                      bufsize = Grread.datadesc[type].ydim *
                          Grread.datadesc[type].ncomponents;
                      buf = (uint8 *) HDmalloc((uint32) bufsize);
                      if (buf == NULL)
                        {
                            Hendaccess(aid);
                            HGOTO_ERROR(DFE_NOSPACE, FAIL);
                        }

                      /* read byte by byte and copy */
                      for (i = 0; i < Grread.datadesc[type].xdim; i++)
                        {
                            if (Hread(aid, bufsize, buf) == FAIL)
                              {
                                  Hendaccess(aid);
                                  HGOTO_ERROR(DFE_READERROR, FAIL);
                              }
                            for (j = 0; j < bufsize; j++)
                              {
                                  destp = (uint8 *) imlut + destsize[0] * currpos[0] +
                                      destsize[1] * currpos[1] +
                                      destsize[2] * currpos[2];
                                  *destp = buf[j];
                                  if (Grread.datadesc[type].interlace == 0)
                                    {
                                        if (++currpos[0] == currmax[0])
                                          {
                                              currpos[0] = 0;
                                              if (++currpos[1] == currmax[1])
                                                {
                                                    currpos[1] = 0;
                                                    if (++currpos[2] == currmax[2])
                                                        break;
                                                }
                                          }
                                    }
                                  else if (++currpos[1] == currmax[1])
                                    {
                                        currpos[1] = 0;
                                        if (Grread.datadesc[type].interlace == 1)
                                          {
                                              if (++currpos[0] == currmax[0])
                                                {
                                                    currpos[0] = 0;
                                                    if (++currpos[2] == currmax[2])
                                                        break;
                                                }
                                          }
                                        else
                                          {
                                              if (++currpos[2] == currmax[2])
                                                {
                                                    currpos[2] = 0;
                                                    if (++currpos[0] == currmax[0])
                                                        break;
                                                }
                                          }
                                    }
                              }
                        }
                      Hendaccess(aid);
                      HDfree(buf);
                      HGOTO_DONE(Hclose(file_id));
                  }
            }
          if (Hgetelement(file_id, Grread.data[type].tag, Grread.data[type].ref,
                          (uint8 *) imlut) == FAIL) {
              *has_pal = 0;
              HGOTO_ERROR(DFE_GETELEM,FAIL);
          }
	  else
	      *has_pal = 1;
      }

    Hclose(file_id);

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */
      if(file_id!=(-1))
        Hclose(file_id);
    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRIsetdims
 * Purpose: set dimensions of image/lut
 * Inputs:  xdim, ydim: dimensions of lut
 *          ncomps: no of components
 *          il: interlace of lut
 *          type: LUT if lut, IMAGE if image
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: none
 * Remarks: none
 *---------------------------------------------------------------------------*/

int
DFGRIsetdims(int32 xdim, int32 ydim, intn ncomps, int type)
{
    CONSTR(FUNC, "DFGRIsetdims");
    intn    ret_value = SUCCEED;

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    if (ncomps == FAIL || (xdim <= 0) || (ydim <= 0))
        HGOTO_ERROR(DFE_ARGS, FAIL);

    Grwrite.datadesc[type].xdim = xdim;
    Grwrite.datadesc[type].ydim = ydim;
    Grwrite.datadesc[type].ncomponents = ncomps;

    Ref.dims[type] = 0;

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */

    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRIsetil
 * Purpose: set interlace of image/lut
 * Inputs:  il: interlace of lut
 *          type: LUT if lut, IMAGE if image
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: none
 * Remarks: none
 *---------------------------------------------------------------------------*/

int
DFGRIsetil(int il, int type)
{
    CONSTR(FUNC, "DFGRIsetil");
    intn    ret_value = SUCCEED;

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    if (il == FAIL)
        HRETURN_ERROR(DFE_ARGS, FAIL);

    Grwrite.datadesc[type].interlace = il;

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */

    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}
/*-----------------------------------------------------------------------------
 * Name:    DFGRIrestart
 * Purpose: restart file
 * Inputs:
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF HLL (high-level library) users, utilities, other routines
 * Invokes: none
 * Remarks: none
 *---------------------------------------------------------------------------*/
int
DFGRIrestart(void)
{
    CONSTR(FUNC, "DFGRIrestart");
    intn    ret_value = SUCCEED;

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    if (Grlastfile != NULL)
        *Grlastfile = '\0';     /* zero out string instead of NULL'ing pointer */
    Grrefset = 0;

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */

    } /* end if */

  /* Normal function cleanup */

  return ret_value;
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRIaddimlut
 * Purpose: Internal routine to write RIG to file
 * Inputs:  filename: name of HDF file
 *          imlut: image/lut to be written to file
 *          xdim, ydim: dimensions of image/lut
 *          type: LUT if lut, IMAGE if image
 *          isfortran: 0 if called from C, 1 if called from Fortran
 * Returns: 0 on success, -1 on failure with DFerror set
 * Users:   HDF systems programmers, DFGRaddimage, DFGRaddlut, DFGRsetlut
 * Invokes: DFGRIopen, DFclose, DFputelement, DFdup, DFGRaddrig, DFputcomp,
 *          DFIerr
 * Remarks: Creates both RIG and RI8/CI8 tags, to accomodate older programs
 *          LUT will be associated with image if set previously
 *---------------------------------------------------------------------------*/

/* shut lint up */
/* ARGSUSED */
int
DFGRIaddimlut(const char *filename, const void * imlut, int32 xdim, int32 ydim,
              int type, int isfortran, int newfile)
{
    CONSTR(FUNC, "DFGRIaddimlut");
    int32       file_id=(-1);
    uint16      wtag, wref;     /* tag of image/lut being written */
    uint16      rigref;         /* ref # for the RIG */
    uint8      *newlut = NULL;
    int32       lutsize = 0;
    int         is8bit;
    struct
      {
          uint16      xdim;
          uint16      ydim;
      }
    r8dims;
    uint8      *p;
    intn        ret_value = SUCCEED;

    /* shut compiler up */
    isfortran = isfortran;

    HEclear();

    /* Perform global, one-time initialization */
    if (library_terminate == FALSE)
        if(DFGRIstart()==FAIL)
            HGOTO_ERROR(DFE_CANTINIT, FAIL);

    /* Check if filename buffer has been allocated */
    if (Grlastfile == NULL)
      {
          Grlastfile = (char *) HDmalloc((DF_MAXFNLEN + 1) * sizeof(char));
          if (Grlastfile == NULL)
              HGOTO_ERROR(DFE_NOSPACE, FAIL);
          *Grlastfile = '\0';   /* initialize to a 0-length string */
      }

    if (0 != HDstrcmp(Grlastfile, filename))
      {     /* if new file, reset dims */
          Grwrite.datadesc[type].xdim = xdim;
          Grwrite.datadesc[type].ydim = ydim;
          Ref.dims[type] = 0;   /* indicate set & not written */
      }

    if ((Ref.dims[type] == 0 && (xdim != Grwrite.datadesc[type].xdim
                         || ydim != Grwrite.datadesc[type].ydim)) || !imlut)
        HGOTO_ERROR(DFE_ARGS, FAIL);

    /* if dims not set, set dimensions */
    if (Ref.dims[type] == FAIL)
        if (DFGRIsetdims(xdim, ydim, 1, type) == FAIL)
            HGOTO_ERROR(DFE_INTERNAL, FAIL);

    /* default: ncomps=1, il=0 */

    if ((type == LUT) && (filename == NULL))
      {     /* set call */
          if (Grlutdata)
            {
                HDfree(Grlutdata);
                Grlutdata = NULL;
            }
          Ref.lut = -1;
          if (imlut == NULL)
              HGOTO_DONE(SUCCEED);
          lutsize = Grwrite.datadesc[LUT].xdim * Grwrite.datadesc[LUT].ydim
              * Grwrite.datadesc[LUT].ncomponents;
          if (( Grlutdata = (uint8 *) HDmalloc((uint32) lutsize))== NULL)
              HGOTO_ERROR(DFE_NOSPACE, FAIL);
          HDmemcpy(Grlutdata, imlut, (uint32) lutsize);
          Ref.lut = 0;
          HGOTO_DONE(SUCCEED);
      }

    if (( file_id = DFGRIopen(filename, newfile ? DFACC_CREATE : DFACC_RDWR))== (int32) NULL)
        HGOTO_ERROR(DFE_BADOPEN, FAIL);

    /* make 8-bit compatibility only for older 8-bit stuff, not JPEG */
    is8bit = ((Grwrite.datadesc[IMAGE].ncomponents == 1) &&
              (Grcompr != DFTAG_GREYJPEG5 && Grcompr != DFTAG_JPEG5));

    wtag = (uint16) ((type == LUT) ? DFTAG_LUT : (Grcompr ? DFTAG_CI : DFTAG_RI));
    Grwrite.data[type].tag = wtag;

    if (( wref = Htagnewref(file_id,wtag))==0)
        HGOTO_ERROR(DFE_INTERNAL,FAIL);

    /* write out image/lut */
    if ((type == IMAGE) && Grcompr)
      {
          lutsize = Grwrite.datadesc[LUT].xdim * Grwrite.datadesc[LUT].ydim *
              Grwrite.datadesc[LUT].ncomponents;
          if (Grcompr == DFTAG_IMC)
            {
                if (Grlutdata == NULL)
                    HGOTO_ERROR(DFE_BADCALL, FAIL);
                if (( newlut = (uint8 *) HDmalloc((uint32) lutsize))==NULL)
                    HGOTO_ERROR(DFE_NOSPACE, FAIL);
            }
          if (DFputcomp(file_id, wtag, wref, imlut, xdim, ydim,
           (uint8 *) Grlutdata, (uint8 *) newlut, (int16) Grcompr, &Grcinfo)
              == FAIL)
              HGOTO_ERROR(DFE_NOSPACE, FAIL);
      }
    else
      {     /* image need not be compressed */
          if (Hputelement(file_id, (uint16) wtag, (uint16) wref, imlut,
                  xdim * ydim * Grwrite.datadesc[type].ncomponents) == FAIL)
              HGOTO_ERROR(DFE_PUTELEM, FAIL);
      }
    Grwrite.data[type].ref = wref;
    Grwrite.aspectratio = (float32) 1.0;

    /* Write out Raster-8 tags for those who want it */
    if (is8bit)
      {
          wtag = (uint16) ((type == LUT) ? DFTAG_IP8 : Grcompr ?
                           ((Grcompr == DFTAG_RLE) ? DFTAG_CI8 :
                            DFTAG_II8) : DFTAG_RI8);

          if (Hdupdd(file_id, wtag, wref, Grwrite.data[type].tag, wref) == FAIL)
              HGOTO_ERROR(DFE_DUPDD, FAIL);
      }     /* end if */

    if (type == IMAGE)
        Grwrite.datadesc[IMAGE].compr.tag = (uint16) Grcompr;

    if (Grcompr == DFTAG_IMC)
      {
          if (Hputelement(file_id, DFTAG_LUT, wref, newlut, lutsize) == FAIL)
              HGOTO_ERROR(DFE_PUTELEM, FAIL);
          Ref.lut = (intn)wref;
      }

    if (( rigref = Htagnewref(file_id,DFTAG_RIG))==0)
        HGOTO_ERROR(DFE_INTERNAL,FAIL);
    if (DFGRaddrig(file_id, rigref, &Grwrite) == FAIL)    /* writes ID, NT */
        HGOTO_ERROR(DFE_INTERNAL, FAIL);

    if (is8bit)
      {
          /* put in Raster-8 stuff also, for those who want it */
          if ((Ref.lut >= 0)
              && Hdupdd(file_id, DFTAG_IP8, wref, DFTAG_LUT, wref) == FAIL)
              HGOTO_ERROR(DFE_DUPDD, FAIL);
          p = (uint8 *) &r8dims.xdim;
          UINT16ENCODE(p, Grwrite.datadesc[IMAGE].xdim);
          UINT16ENCODE(p, Grwrite.datadesc[IMAGE].ydim);
          if (Hputelement(file_id, DFTAG_ID8, wref, (uint8 *) &r8dims, (int32) 4) == FAIL)
              HGOTO_ERROR(DFE_PUTELEM, FAIL);
      }

    if (Grcompr == DFTAG_IMC)
      {
          Ref.lut = 0;
          HDfree(newlut);
          newlut = NULL;
      }

#ifdef OLD_WAY
    Grlastref = wref;   /* remember the last ref */
#else /* OLD_WAY */
    Grlastref = rigref;   /* remember the last ref */
#endif /* OLD_WAY */

    wref = 0;   /* don't know ref to write next */

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */
        
    } /* end if */

  /* Normal function cleanup */
  if(file_id!=(-1))
    Hclose(file_id);

  return ret_value;
}

/*-----------------------------------------------------------------------------
 * Name:    DFGRlastref
 * Purpose: Return last ref written or read
 * Inputs:  none
 * Globals: Grlastref
 * Returns: ref on success
 * Users:   HDF users, utilities, other routines
 * Invokes: none
 * Method:  return Grlastref
 * Remarks: none
 *---------------------------------------------------------------------------*/

uint16
DFGRIlastref(void)
{
    return ((uint16) Grlastref);
}

/*--------------------------------------------------------------------------
 NAME
    DFGRIstart
 PURPOSE
    DFGR-level initialization routine
 USAGE
    intn DFGRIstart()
 RETURNS
    Returns SUCCEED/FAIL
 DESCRIPTION
    Register the shut-down routine (DFGRPshutdown) for call with atexit
 GLOBAL VARIABLES
 COMMENTS, BUGS, ASSUMPTIONS
 EXAMPLES
 REVISION LOG
--------------------------------------------------------------------------*/
PRIVATE intn DFGRIstart(void)
{
    CONSTR(FUNC, "DFGRIstart");    /* for HERROR */
    intn        ret_value = SUCCEED;

    /* Don't call this routine again... */
    library_terminate = TRUE;

    /* Install atexit() library cleanup routine */
    if (HPregister_term_func(&DFGRPshutdown) != 0)
      HGOTO_ERROR(DFE_CANTINIT, FAIL);

done:
  if(ret_value == FAIL)   
    { /* Error condition cleanup */

    } /* end if */

  /* Normal function cleanup */

    return(ret_value);
} /* end DFGRIstart() */

/*--------------------------------------------------------------------------
 NAME
    DFGRPshutdown
 PURPOSE
    Terminate various static buffers.
 USAGE
    intn DFGRshutdown()
 RETURNS
    Returns SUCCEED/FAIL
 DESCRIPTION
    Free various buffers allocated in the DFGR routines.
 GLOBAL VARIABLES
 COMMENTS, BUGS, ASSUMPTIONS
    Should only ever be called by the "atexit" function HDFend
 EXAMPLES
 REVISION LOG
--------------------------------------------------------------------------*/
intn DFGRPshutdown(void)
{
    if(Grlastfile!=NULL)
      {
          HDfree(Grlastfile);
          Grlastfile=NULL;
      } /* end if */
    return(SUCCEED);
} /* end DFGRPshutdown() */

