djcparam.h

/*
 *
 *  Copyright (C) 1997-2010, OFFIS e.V.
 *  All rights reserved.  See COPYRIGHT file for details.
 *
 *  This software and supporting documentation were developed by
 *
 *    OFFIS e.V.
 *    R&D Division Health
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *
 *  Module:  dcmjpls
 *
 *  Author:  Martin Willkomm, Uli Schlachter
 *
 *  Purpose: codec parameter class JPEG-LS codecs
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:17:19 $
 *  CVS/RCS Revision: $Revision: 1.7 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef DCMJPLS_DJCPARAM_H
#define DCMJPLS_DJCPARAM_H

#include "dcmtk/config/osconfig.h"
#include "dcmtk/dcmdata/dccodec.h" /* for DcmCodecParameter */
#include "dcmtk/dcmjpls/djlsutil.h" /* for enums */

class DJLSCodecParameter: public DcmCodecParameter
{
public:

  enum interleaveMode
  {
    interleaveDefault,
    interleaveSample,
    interleaveLine,
    interleaveNone
  };

   DJLSCodecParameter(
     OFBool jpls_optionsEnabled,
     Uint16 jpls_t1 = 3, // these are the defaults for 8bpp in lossless mode
     Uint16 jpls_t2 = 7,
     Uint16 jpls_t3 = 21,
     Uint16 jpls_reset = 64,
     Uint16 jpls_limit = 0,
     OFBool preferCookedEncoding = OFTrue,
     Uint32 fragmentSize = 0,
     OFBool createOffsetTable = OFTrue,
     JLS_UIDCreation uidCreation = EJLSUC_default,
     OFBool convertToSC = OFFalse,
     JLS_PlanarConfiguration planarConfiguration = EJLSPC_restore,
     OFBool ignoreOffsetTable = OFFalse,
     interleaveMode jplsInterleaveMode = interleaveLine);

  DJLSCodecParameter(
    JLS_UIDCreation uidCreation = EJLSUC_default,
    JLS_PlanarConfiguration planarConfiguration = EJLSPC_restore,
    OFBool ignoreOffsetTable = OFFalse);

  DJLSCodecParameter(const DJLSCodecParameter& arg);

  virtual ~DJLSCodecParameter();

  virtual DcmCodecParameter *clone() const;

  virtual const char *className() const;

  OFBool getConvertToSC() const
  {
    return convertToSC_;
  }

  OFBool getCreateOffsetTable() const
  {
   return createOffsetTable_;
  }

  JLS_UIDCreation getUIDCreation() const
  {
    return uidCreation_;
  }

  JLS_PlanarConfiguration getPlanarConfiguration() const
  {
    return planarConfiguration_;
  }

  OFBool cookedEncodingPreferred() const
  {
    return preferCookedEncoding_;
  }

  Uint32 getFragmentSize() const
  {
    return fragmentSize_;
  }

  Uint16 getT1() const
  {
    return jpls_t1_;
  }

  Uint16 getT2() const
  {
    return jpls_t2_;
  }

  Uint16 getT3() const
  {
    return jpls_t3_;
  }

  Uint16 getReset() const
  {
    return jpls_reset_;
  }

  Uint16 getLimit() const
  {
    return jpls_t1_;
  }
  
  OFBool getUseCustomOptions() const
  {
    return jpls_optionsEnabled_;
  }

  OFBool ignoreOffsetTable() const
  {
    return ignoreOffsetTable_;
  }

  interleaveMode getJplsInterleaveMode() const
  {
    return jplsInterleaveMode_;
  }

private:

  DJLSCodecParameter& operator=(const DJLSCodecParameter&);

  // ****************************************************
  // **** Parameters describing the encoding process ****

  OFBool jpls_optionsEnabled_;

  Uint16 jpls_t1_;

  Uint16 jpls_t2_;

  Uint16 jpls_t3_;

  Uint16 jpls_reset_;

  Uint16 jpls_limit_;

  Uint32 fragmentSize_;

  OFBool createOffsetTable_;

  OFBool preferCookedEncoding_;

  JLS_UIDCreation uidCreation_;

  OFBool convertToSC_;

  interleaveMode jplsInterleaveMode_;

  // ****************************************************
  // **** Parameters describing the decoding process ****

  JLS_PlanarConfiguration planarConfiguration_;

  OFBool ignoreOffsetTable_;

};


#endif

/*
 * CVS/RCS Log:
 * $Log: djcparam.h,v $
 * Revision 1.7  2010-10-14 13:17:19  joergr
 * Updated copyright header. Added reference to COPYRIGHT file.
 *
 * Revision 1.6  2010-03-01 10:35:28  uli
 * Renamed include guards to avoid name clash with e.g. dcmjpeg.
 *
 * Revision 1.5  2010-02-25 10:17:14  uli
 * Fix doxygen comments in a couple of places.
 *
 * Revision 1.4  2009-10-07 13:16:47  uli
 * Switched to logging mechanism provided by the "new" oflog module.
 *
 * Revision 1.3  2009-07-31 10:18:37  meichel
 * Line interleaved JPEG-LS mode now default. This mode works correctly
 *   when decompressing images with the LOCO-I reference implementation.
 *
 * Revision 1.2  2009-07-31 09:14:53  meichel
 * Added codec parameter and command line options that allow to control
 *   the interleave mode used in the JPEG-LS bitstream when compressing
 *   color images.
 *
 * Revision 1.1  2009-07-29 14:46:46  meichel
 * Initial release of module dcmjpls, a JPEG-LS codec for DCMTK based on CharLS
 *
 * Revision 1.1  2007-06-15 14:35:45  meichel
 * Renamed CMake project and include directory from dcmjpgls to dcmjpls
 *
 * Revision 1.4  2007/06/15 10:39:15  meichel
 * Completed implementation of decoder, which now correctly processes all
 *   of the NEMA JPEG-LS sample images, including fragmented frames.
 *
 * Revision 1.3  2007/06/14 12:36:14  meichel
 * Further code clean-up. Updated doxygen comments.
 *
 * Revision 1.2  2007/06/13 16:41:07  meichel
 * Code clean-up and removal of dead code
 *
 *
 */