Refactored variables to avoid naming conflicts

Author: PantelisGeorgiadis

CMakeLists.txt

@@ -8,7 +8,7 @@ project(
 
 set(DCMTKHTJ2K_VERSION_MAJOR 1)
 set(DCMTKHTJ2K_VERSION_MINOR 0)
-set(DCMTKHTJ2K_VERSION_BUILD 1)
+set(DCMTKHTJ2K_VERSION_BUILD 2)
 set(DCMTKHTJ2K_VERSION
     "${DCMTKHTJ2K_VERSION_MAJOR}.${DCMTKHTJ2K_VERSION_MINOR}.${DCMTKHTJ2K_VERSION_BUILD}"
 )

include/dcmtkhtj2k/djcparam.h

@@ -34,12 +34,12 @@ class DCMTKHTJ2K_EXPORT HtJ2kCodecParameter : public DcmCodecParameter {
   HtJ2kCodecParameter(
       OFBool jp2k_optionsEnabled, Uint16 jp2k_decompositions = 5,
       Uint16 jp2k_cblkwidth = 64, Uint16 jp2k_cblkheight = 64,
-      J2K_ProgressionOrder jp2k_progressionOrder = EJ2KPO_default,
+      HTJ2K_ProgressionOrder jp2k_progressionOrder = EHTJ2KPO_default,
       OFBool preferCookedEncoding = OFTrue, Uint32 fragmentSize = 0,
       OFBool createOffsetTable = OFTrue,
-      J2K_UIDCreation uidCreation = EJ2KUC_default,
+      HTJ2K_UIDCreation uidCreation = EHTJ2KUC_default,
       OFBool convertToSC = OFFalse,
-      J2K_PlanarConfiguration planarConfiguration = EJ2KPC_restore,
+      HTJ2K_PlanarConfiguration planarConfiguration = EHTJ2KPC_restore,
       OFBool ignoreOffsetTable = OFFalse);
 
   /** constructor, for use with decoders. Initializes all encoder options to
@@ -52,8 +52,8 @@ class DCMTKHTJ2K_EXPORT HtJ2kCodecParameter : public DcmCodecParameter {
    * offset table when decompressing multiframe images
    */
   HtJ2kCodecParameter(
-      J2K_UIDCreation uidCreation = EJ2KUC_default,
-      J2K_PlanarConfiguration planarConfiguration = EJ2KPC_restore,
+      HTJ2K_UIDCreation uidCreation = EHTJ2KUC_default,
+      HTJ2K_PlanarConfiguration planarConfiguration = EHTJ2KPC_restore,
       OFBool ignoreOffsetTable = OFFalse);
 
   /// copy constructor
@@ -86,12 +86,12 @@ class DCMTKHTJ2K_EXPORT HtJ2kCodecParameter : public DcmCodecParameter {
   /** returns mode for SOP Instance UID creation
    *  @return mode for SOP Instance UID creation
    */
-  J2K_UIDCreation getUIDCreation() const { return uidCreation_; }
+  HTJ2K_UIDCreation getUIDCreation() const { return uidCreation_; }
 
   /** returns mode for handling planar configuration
    *  @return mode for handling planar configuration
    */
-  J2K_PlanarConfiguration getPlanarConfiguration() const {
+  HTJ2K_PlanarConfiguration getPlanarConfiguration() const {
     return planarConfiguration_;
   }
 
@@ -125,7 +125,7 @@ class DCMTKHTJ2K_EXPORT HtJ2kCodecParameter : public DcmCodecParameter {
   /** returns HT-J2K parameter progression order
    *  @return HT-J2K parameter progression order
    */
-  J2K_ProgressionOrder get_progressionOrder() const {
+  HTJ2K_ProgressionOrder get_progressionOrder() const {
     return jp2k_progressionOrder_;
   }
 
@@ -161,7 +161,7 @@ class DCMTKHTJ2K_EXPORT HtJ2kCodecParameter : public DcmCodecParameter {
   Uint16 jp2k_cblkheight_;
 
   /// HT-J2K progression order parameter
-  J2K_ProgressionOrder jp2k_progressionOrder_;
+  HTJ2K_ProgressionOrder jp2k_progressionOrder_;
 
   /// maximum fragment size (in kbytes) for compression, 0 for unlimited.
   Uint32 fragmentSize_;
@@ -174,7 +174,7 @@ class DCMTKHTJ2K_EXPORT HtJ2kCodecParameter : public DcmCodecParameter {
   OFBool preferCookedEncoding_;
 
   /// mode for SOP Instance UID creation (used both for encoding and decoding)
-  J2K_UIDCreation uidCreation_;
+  HTJ2K_UIDCreation uidCreation_;
 
   /// flag indicating whether image should be converted to Secondary Capture
   /// upon compression
@@ -185,7 +185,7 @@ class DCMTKHTJ2K_EXPORT HtJ2kCodecParameter : public DcmCodecParameter {
 
   /// flag describing how planar configuration of decompressed color images
   /// should be handled
-  J2K_PlanarConfiguration planarConfiguration_;
+  HTJ2K_PlanarConfiguration planarConfiguration_;
 
   /// flag indicating if temporary files should be kept, false if they should be
   /// deleted after use

include/dcmtkhtj2k/djdecode.h

@@ -24,8 +24,8 @@ class DCMTKHTJ2K_EXPORT HtJ2kDecoderRegistration {
    * table when decompressing multiframe images
    */
   static void registerCodecs(
-      J2K_UIDCreation uidcreation = EJ2KUC_default,
-      J2K_PlanarConfiguration planarconfig = EJ2KPC_restore,
+      HTJ2K_UIDCreation uidcreation = EHTJ2KUC_default,
+      HTJ2K_PlanarConfiguration planarconfig = EHTJ2KPC_restore,
       OFBool ignoreOffsetTable = OFFalse);
 
   /** deregisters decoders.

include/dcmtkhtj2k/djencode.h

@@ -43,10 +43,10 @@ class DCMTKHTJ2K_EXPORT HtJ2kEncoderRegistration {
   static void registerCodecs(
       OFBool jp2k_optionsEnabled = OFFalse, Uint16 jp2k_decompositions = 5,
       Uint16 jp2k_cblkwidth = 64, Uint16 jp2k_cblkheight = 64,
-      J2K_ProgressionOrder jp2k_progressionOrder = EJ2KPO_default,
+      HTJ2K_ProgressionOrder jp2k_progressionOrder = EHTJ2KPO_default,
       OFBool preferCookedEncoding = OFTrue, Uint32 fragmentSize = 0,
       OFBool createOffsetTable = OFTrue,
-      J2K_UIDCreation uidCreation = EJ2KUC_default,
+      HTJ2K_UIDCreation uidCreation = EHTJ2KUC_default,
       OFBool convertToSC = OFFalse);
 
   /** deregisters encoders.

include/dcmtkhtj2k/djutils.h

@@ -6,7 +6,7 @@
 #include "dcmtk/ofstd/ofcond.h" /* for class OFCondition */
 #include "dldefine.h"
 
-#define DCMTKHTJ2K_VERSION_STRING "DCMTK HTJ2K"
+#define DCMTKHTJ2K_VERSION_STRING "DCMTK-HTJ2K 1.0.2"
 
 // global definitions for logging mechanism provided by the oflog module
 
@@ -21,147 +21,150 @@ extern DCMTKHTJ2K_EXPORT OFLogger DCM_ht2kLogger;
 
 // include this file in doxygen documentation
 
-/** @file djlsutil.h
+/** @file djutils.h
  *  @brief enumerations, error constants and helper functions for the dcmhtj2k
  * module
  */
 
 /** describes the condition under which a compressed or decompressed image
  *  receives a new SOP instance UID.
  */
-enum J2K_UIDCreation {
+enum HTJ2K_UIDCreation {
   /** Upon compression, assign new SOP instance UID if compression is lossy.
    *  Upon decompression never assign new SOP instance UID.
    */
-  EJ2KUC_default,
+  EHTJ2KUC_default,
 
   /// always assign new SOP instance UID on compression and decompression
-  EJ2KUC_always,
+  EHTJ2KUC_always,
 
   /// never assign new SOP instance UID
-  EJ2KUC_never
+  EHTJ2KUC_never
 };
 
 /** describes how the decoder should handle planar configuration of
  *  decompressed color images.
  */
-enum J2K_PlanarConfiguration {
+enum HTJ2K_PlanarConfiguration {
   /// restore planar configuration as indicated in data set
-  EJ2KPC_restore,
+  EHTJ2KPC_restore,
 
   /** automatically determine whether color-by-plane is required from
    *  the SOP Class UID and decompressed photometric interpretation
    */
-  EJ2KPC_auto,
+  EHTJ2KPC_auto,
 
   /// always create color-by-pixel planar configuration
-  EJ2KPC_colorByPixel,
+  EHTJ2KPC_colorByPixel,
 
   /// always create color-by-plane planar configuration
-  EJ2KPC_colorByPlane
+  EHTJ2KPC_colorByPlane
 };
 
 /** describes how the encoder handles the image bit depth
  *  upon lossy compression.
  */
-enum J2K_CompressionBitDepth {
+enum HTJ2K_CompressionBitDepth {
   /// keep original bit depth
-  EJ2KBD_original,
+  EHTJ2KBD_original,
 
   /** limit bit depth to a certain value, i.e. scale down
    *  if the original image bit depth is larger
    */
-  EJ2KBD_limit,
+  EHTJ2KBD_limit,
 
   /** force bit depth to a certain value, i.e. scale up
    *  or scale down the original image to match the given
    *  bit depth.
    */
-  EJ2KBD_force
+  EHTJ2KBD_force
 };
 
 /** describes the progression order used in the codestream
  */
-enum J2K_ProgressionOrder {
+enum HTJ2K_ProgressionOrder {
   /// use default progression order as defined in HT-J2K standard
-  EJ2KPO_default,
+  EHTJ2KPO_default,
 
   /// layer-resolution-component-position progression order
-  EJ2KPO_LRCP,
+  EHTJ2KPO_LRCP,
 
   /// resolution-layer-component-position progression order
-  EJ2KPO_RLCP,
+  EHTJ2KPO_RLCP,
 
   /// resolution-position-component-layer progression order
-  EJ2KPO_RPCL,
+  EHTJ2KPO_RPCL,
 
   /// position-component-resolution-layer progression order
-  EJ2KPO_PCRL,
+  EHTJ2KPO_PCRL,
 
   /// component-position-resolution-layer progression order
-  EJ2KPO_CPRL
+  EHTJ2KPO_CPRL
 };
 
 // CONDITION CONSTANTS
 
 /// error condition constant: Too small buffer used for image data (internal
 /// error)
 extern DCMTKHTJ2K_EXPORT const OFConditionConst
-    EC_J2KUncompressedBufferTooSmall;
+    EC_HTJ2KUncompressedBufferTooSmall;
 
 /// error condition constant: Too small buffer used for compressed image data
 /// (internal error)
-extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_J2KCompressedBufferTooSmall;
+extern DCMTKHTJ2K_EXPORT const OFConditionConst
+    EC_HTJ2KCompressedBufferTooSmall;
 
 /// error condition constant: The image uses some features which the codec does
 /// not support
-extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_J2KCodecUnsupportedImageType;
+extern DCMTKHTJ2K_EXPORT const OFConditionConst
+    EC_HTJ2KCodecUnsupportedImageType;
 
 /// error condition constant: The codec was fed with invalid parameters (e.g.
 /// height = -1)
-extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_J2KCodecInvalidParameters;
+extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_HTJ2KCodecInvalidParameters;
 
 /// error condition constant: The codec was fed with unsupported parameters
 /// (e.g. 32 bit per sample)
-extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_J2KCodecUnsupportedValue;
+extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_HTJ2KCodecUnsupportedValue;
 
 /// error condition constant: The compressed image is invalid
-extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_J2KInvalidCompressedData;
+extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_HTJ2KInvalidCompressedData;
 
 /// error condition constant: The images' color transformation is not supported
 /// in this bit depth
 extern DCMTKHTJ2K_EXPORT const OFConditionConst
-    EC_J2KUnsupportedBitDepthForTransform;
+    EC_HTJ2KUnsupportedBitDepthForTransform;
 
 /// error condition constant: The images' color transformation is not supported
-extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_J2KUnsupportedColorTransform;
+extern DCMTKHTJ2K_EXPORT const OFConditionConst
+    EC_HTJ2KUnsupportedColorTransform;
 
 /// error condition constant: Unsupported bit depth in HT-J2K transfer syntax
-extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_J2KUnsupportedBitDepth;
+extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_HTJ2KUnsupportedBitDepth;
 
 /// error condition constant: Cannot compute number of fragments for HT-J2K
 /// frame
 extern DCMTKHTJ2K_EXPORT const OFConditionConst
-    EC_J2KCannotComputeNumberOfFragments;
+    EC_HTJ2KCannotComputeNumberOfFragments;
 
 /// error condition constant: Image data mismatch between DICOM header and
 /// HT-J2K bitstream
-extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_J2KImageDataMismatch;
+extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_HTJ2KImageDataMismatch;
 
 /// error condition constant: Unsupported photometric interpretation for
 /// near-lossless HT-J2K compression
 extern DCMTKHTJ2K_EXPORT const OFConditionConst
-    EC_J2KUnsupportedPhotometricInterpretation;
+    EC_HTJ2KUnsupportedPhotometricInterpretation;
 
 /// error condition constant: Unsupported pixel representation for near-lossless
 /// HT-J2K compression
 extern DCMTKHTJ2K_EXPORT const OFConditionConst
-    EC_J2KUnsupportedPixelRepresentation;
+    EC_HTJ2KUnsupportedPixelRepresentation;
 
 /// error condition constant: Unsupported type of image for HT-J2K compression
-extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_J2KUnsupportedImageType;
+extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_HTJ2KUnsupportedImageType;
 
 /// error condition constant: Trailing data after image
-extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_J2KTooMuchCompressedData;
+extern DCMTKHTJ2K_EXPORT const OFConditionConst EC_HTJ2KTooMuchCompressedData;
 
 #endif

libsrc/djcodecd.cc

@@ -101,7 +101,7 @@ OFCondition HtJ2kDecoderBase::decode(
 
   // we only support up to 16 bits per sample
   if ((imageBitsStored < 1) || (imageBitsStored > 16))
-    return EC_J2KUnsupportedBitDepth;
+    return EC_HTJ2KUnsupportedBitDepth;
 
   // determine the number of bytes per sample (bits allocated) for the
   // de-compressed object.
@@ -169,7 +169,7 @@ OFCondition HtJ2kDecoderBase::decode(
     // changes if we're on the main level of the dataset,
     // which should always identify itself as dataset, not as item.
     if ((dataset->ident() == EVR_dataset) &&
-        (djcp->getUIDCreation() == EJ2KUC_always)) {
+        (djcp->getUIDCreation() == EHTJ2KUC_always)) {
       // create new SOP instance UID
       result = DcmCodec::newInstance((DcmItem *)dataset, NULL, NULL, NULL);
     }
@@ -227,7 +227,7 @@ OFCondition HtJ2kDecoderBase::decodeFrame(
 
   // we only support up to 16 bits per sample
   if ((imageBitsStored < 1) || (imageBitsStored > 16))
-    return EC_J2KUnsupportedBitDepth;
+    return EC_HTJ2KUnsupportedBitDepth;
 
   // determine the number of bytes per sample (bits allocated) for the
   // de-compressed object.
@@ -305,7 +305,8 @@ OFCondition HtJ2kDecoderBase::decodeFrame(
   // frame
   fragmentsForThisFrame = computeNumberOfFragments(
       imageFrames, frameNo, currentItem, ignoreOffsetTable, fromPixSeq);
-  if (fragmentsForThisFrame == 0) result = EC_J2KCannotComputeNumberOfFragments;
+  if (fragmentsForThisFrame == 0)
+    result = EC_HTJ2KCannotComputeNumberOfFragments;
 
   // determine planar configuration for uncompressed data
   OFString imageSopClass;
@@ -318,7 +319,7 @@ OFCondition HtJ2kDecoderBase::decodeFrame(
 
   if (imageSamplesPerPixel > 1) {
     switch (cp->getPlanarConfiguration()) {
-      case EJ2KPC_restore:
+      case EHTJ2KPC_restore:
         // get planar configuration from dataset
         imagePlanarConfiguration = 2;  // invalid value
         dataset->findAndGetUint16(DCM_PlanarConfiguration,
@@ -328,14 +329,14 @@ OFCondition HtJ2kDecoderBase::decodeFrame(
           imagePlanarConfiguration = determinePlanarConfiguration(
               imageSopClass, imagePhotometricInterpretation);
         break;
-      case EJ2KPC_auto:
+      case EHTJ2KPC_auto:
         imagePlanarConfiguration = determinePlanarConfiguration(
             imageSopClass, imagePhotometricInterpretation);
         break;
-      case EJ2KPC_colorByPixel:
+      case EHTJ2KPC_colorByPixel:
         imagePlanarConfiguration = 0;
         break;
-      case EJ2KPC_colorByPlane:
+      case EHTJ2KPC_colorByPlane:
         imagePlanarConfiguration = 1;
         break;
     }
@@ -393,11 +394,11 @@ OFCondition HtJ2kDecoderBase::decodeFrame(
       int height = siz.get_recon_height(0);
 
       if (width != imageColumns)
-        result = EC_J2KImageDataMismatch;
+        result = EC_HTJ2KImageDataMismatch;
       else if (height != imageRows)
-        result = EC_J2KImageDataMismatch;
+        result = EC_HTJ2KImageDataMismatch;
       else if (num_comps != imageSamplesPerPixel)
-        result = EC_J2KImageDataMismatch;
+        result = EC_HTJ2KImageDataMismatch;
 
       if (result.good()) {
         codestream.create();