/usr/include/dcmtk/dcmjpls/djcodece.h is in libdcmtk2-dev 3.6.0-15.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 | /*
*
* Copyright (C) 2007-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 classes for JPEG-LS encoders.
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:17:19 $
* CVS/RCS Revision: $Revision: 1.8 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DCMJPLS_DJCODEC_H
#define DCMJPLS_DJCODEC_H
#include "dcmtk/config/osconfig.h"
#include "dcmtk/dcmdata/dccodec.h" /* for class DcmCodec */
#include "dcmtk/dcmdata/dcofsetl.h" /* for struct DcmOffsetList */
#include "dcmtk/ofstd/ofstring.h" /* for class OFString */
class DJLSRepresentationParameter;
class DJLSCodecParameter;
class DicomImage;
/** abstract codec class for JPEG-LS encoders.
* This abstract class contains most of the application logic
* needed for a dcmdata codec object that implements a JPEG-LS encoder
* This class only supports compression, it neither implements
* decoding nor transcoding.
*/
class DJLSEncoderBase : public DcmCodec
{
public:
/// default constructor
DJLSEncoderBase();
/// destructor
virtual ~DJLSEncoderBase();
/** decompresses the given pixel sequence and
* stores the result in the given uncompressedPixelData element.
* @param fromRepParam current representation parameter of compressed data, may be NULL
* @param pixSeq compressed pixel sequence
* @param uncompressedPixelData uncompressed pixel data stored in this element
* @param cp codec parameters for this codec
* @param objStack stack pointing to the location of the pixel data
* element in the current dataset.
* @return EC_Normal if successful, an error code otherwise.
*/
virtual OFCondition decode(
const DcmRepresentationParameter * fromRepParam,
DcmPixelSequence * pixSeq,
DcmPolymorphOBOW& uncompressedPixelData,
const DcmCodecParameter * cp,
const DcmStack& objStack) const;
/** decompresses a single frame from the given pixel sequence and
* stores the result in the given buffer.
* @param fromParam representation parameter of current compressed
* representation, may be NULL.
* @param fromPixSeq compressed pixel sequence
* @param cp codec parameters for this codec
* @param dataset pointer to dataset in which pixel data element is contained
* @param frameNo number of frame, starting with 0 for the first frame
* @param startFragment index of the compressed fragment that contains
* all or the first part of the compressed bitstream for the given frameNo.
* Upon successful return this parameter is updated to contain the index
* of the first compressed fragment of the next frame.
* When unknown, zero should be passed. In this case the decompression
* algorithm will try to determine the index by itself, which will always
* work if frames are decompressed in increasing order from first to last,
* but may fail if frames are decompressed in random order, multiple fragments
* per frame and multiple frames are present in the dataset, and the offset
* table is empty.
* @param buffer pointer to buffer where frame is to be stored
* @param bufSize size of buffer in bytes
* @param decompressedColorModel upon successful return, the color model
* of the decompressed image (which may be different from the one used
* in the compressed images) is returned in this parameter.
* @return EC_Normal if successful, an error code otherwise.
*/
virtual OFCondition decodeFrame(
const DcmRepresentationParameter * fromParam,
DcmPixelSequence * fromPixSeq,
const DcmCodecParameter * cp,
DcmItem *dataset,
Uint32 frameNo,
Uint32& startFragment,
void *buffer,
Uint32 bufSize,
OFString& decompressedColorModel) const;
/** compresses the given uncompressed DICOM image and stores
* the result in the given pixSeq element.
* @param pixelData pointer to the uncompressed image data in OW format
* and local byte order
* @param length of the pixel data field in bytes
* @param toRepParam representation parameter describing the desired
* compressed representation (e.g. JPEG quality)
* @param pixSeq compressed pixel sequence (pointer to new DcmPixelSequence object
* allocated on heap) returned in this parameter upon success.
* @param cp codec parameters for this codec
* @param objStack stack pointing to the location of the pixel data
* element in the current dataset.
* @return EC_Normal if successful, an error code otherwise.
*/
virtual OFCondition encode(
const Uint16 * pixelData,
const Uint32 length,
const DcmRepresentationParameter * toRepParam,
DcmPixelSequence * & pixSeq,
const DcmCodecParameter *cp,
DcmStack & objStack) const;
/** transcodes (re-compresses) the given compressed DICOM image and stores
* the result in the given toPixSeq element.
* @param fromRepType current transfer syntax of the compressed image
* @param fromRepParam current representation parameter of compressed data, may be NULL
* @param fromPixSeq compressed pixel sequence
* @param toRepParam representation parameter describing the desired
* new compressed representation (e.g. JPEG quality)
* @param toPixSeq compressed pixel sequence (pointer to new DcmPixelSequence object
* allocated on heap) returned in this parameter upon success.
* @param cp codec parameters for this codec
* @param objStack stack pointing to the location of the pixel data
* element in the current dataset.
* @return EC_Normal if successful, an error code otherwise.
*/
virtual OFCondition encode(
const E_TransferSyntax fromRepType,
const DcmRepresentationParameter * fromRepParam,
DcmPixelSequence * fromPixSeq,
const DcmRepresentationParameter * toRepParam,
DcmPixelSequence * & toPixSeq,
const DcmCodecParameter * cp,
DcmStack & objStack) const;
/** checks if this codec is able to convert from the
* given current transfer syntax to the given new
* transfer syntax
* @param oldRepType current transfer syntax
* @param newRepType desired new transfer syntax
* @return true if transformation is supported by this codec, false otherwise.
*/
virtual OFBool canChangeCoding(
const E_TransferSyntax oldRepType,
const E_TransferSyntax newRepType) const;
/** determine color model of the decompressed image
* @param fromParam representation parameter of current compressed
* representation, may be NULL
* @param fromPixSeq compressed pixel sequence
* @param cp codec parameters for this codec
* @param dataset pointer to dataset in which pixel data element is contained
* @param dataset pointer to DICOM dataset in which this pixel data object
* is located. Used to access photometric interpretation.
* @param decompressedColorModel upon successful return, the color model
* of the decompressed image (which may be different from the one used
* in the compressed images) is returned in this parameter
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition determineDecompressedColorModel(
const DcmRepresentationParameter *fromParam,
DcmPixelSequence *fromPixSeq,
const DcmCodecParameter *cp,
DcmItem *dataset,
OFString &decompressedColorModel) const;
private:
/** returns the transfer syntax that this particular codec
* is able to encode
* @return supported transfer syntax
*/
virtual E_TransferSyntax supportedTransferSyntax() const = 0;
/** lossless encoder that compresses the complete pixel cell
* (very much like the RLE encoder in module dcmdata).
* @param pixelData pointer to the uncompressed image data in OW format
* and local byte order
* @param length of the pixel data field in bytes
* @param dataset pointer to dataset containing image pixel module
* @param djrp representation parameter
* @param pixSeq pixel sequence to write to
* @param djcp codec parameter
* @param compressionRatio compression ratio returned upon success
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition losslessRawEncode(
const Uint16 *pixelData,
const Uint32 length,
DcmItem *dataset,
const DJLSRepresentationParameter *djrp,
DcmPixelSequence * & pixSeq,
const DJLSCodecParameter *djcp,
double& compressionRatio) const;
/** lossless encoder that moves Overlays to (60xx,3000) and only
* compresses the stored bits of the pixel cell.
* @param pixelData pointer to the uncompressed image data in OW format
* and local byte order
* @param length of the pixel data field in bytes
* @param dataset pointer to dataset containing image pixel module
* @param djrp representation parameter
* @param pixSeq pixel sequence to write to
* @param djcp codec parameter
* @param compressionRatio compression ratio returned upon success
* @param nearLosslessDeviation maximum deviation for near-lossless encoding
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition losslessCookedEncode(
const Uint16 * pixelData,
const Uint32 length,
DcmItem *dataset,
const DJLSRepresentationParameter *djrp,
DcmPixelSequence * & pixSeq,
const DJLSCodecParameter *djcp,
double& compressionRatio,
Uint16 nearLosslessDeviation) const;
/** for all overlay groups create (60xx,3000) Overlay Data.
* @param dataset dataset to be modified
* @param image DicomImage object for this dataset
* @return EC_Normal if successful, an error code otherwise
*/
OFCondition adjustOverlays(
DcmItem *dataset,
DicomImage& image) const;
/** create Lossy Image Compression and Lossy Image Compression Ratio.
* @param dataset dataset to be modified
* @param ratio image compression ratio > 1. This is the real effective ratio
* between compressed and uncompressed image,
* i. e. 30 means a 30:1 lossy compression.
* @return EC_Normal if successful, an error code otherwise
*/
OFCondition updateLossyCompressionRatio(
DcmItem *dataset,
double ratio) const;
/** create Derivation Description.
* @param dataset dataset to be modified
* @param djrp representation parameter passed to encode()
* @param ratio image compression ratio > 1. This is the real effective ratio
* between compressed and uncompressed image,
* i. e. 30 means a 30:1 lossy compression.
* @return EC_Normal if successful, an error code otherwise
*/
OFCondition updateDerivationDescription(
DcmItem *dataset,
const DJLSRepresentationParameter *djrp,
double ratio) const;
/** perform the lossless raw compression of a single frame
* @param framePointer pointer to start of frame
* @param bitsAllocated number of bits allocated per pixel
* @param columns frame width
* @param rows frame height
* @param samplesPerPixel image samples per pixel
* @param planarConfiguration image planar configuration
* @param photometricInterpretation photometric interpretation of the DICOM dataset
* @param pixelSequence object in which the compressed frame is stored
* @param offsetList list of frame offsets updated in this parameter
* @param compressedSize size of compressed frame returned in this parameter
* @param djcp parameters for the codec
* @return EC_Normal if successful, an error code otherwise
*/
OFCondition compressRawFrame(
const Uint8 *framePointer,
Uint16 bitsAllocated,
Uint16 columns,
Uint16 rows,
Uint16 samplesPerPixel,
Uint16 planarConfiguration,
const OFString& photometricInterpretation,
DcmPixelSequence *pixelSequence,
DcmOffsetList &offsetList,
unsigned long &compressedSize,
const DJLSCodecParameter *djcp) const;
/** perform the lossless cooked compression of a single frame
* @param pixelSequence object in which the compressed frame is stored
* @param dimage DicomImage instance used to process frame
* @param photometricInterpretation photometric interpretation of the DICOM dataset
* @param offsetList list of frame offsets updated in this parameter
* @param compressedSize size of compressed frame returned in this parameter
* @param djcp parameters for the codec
* @param frame frame index
* @param nearLosslessDeviation maximum deviation for near-lossless encoding
* @return EC_Normal if successful, an error code otherwise
*/
OFCondition compressCookedFrame(
DcmPixelSequence *pixelSequence,
DicomImage *dimage,
const OFString& photometricInterpretation,
DcmOffsetList &offsetList,
unsigned long &compressedSize,
const DJLSCodecParameter *djcp,
Uint32 frame,
Uint16 nearLosslessDeviation) const;
/** Convert an image from sample interleaved to uninterleaved.
* @param target A buffer where the converted image will be stored
* @param source The image buffer to be converted
* @param components Color components used in the image
* @param width The width of the image
* @param height The height of the image
* @param bitsAllocated The number of bits allocated in the image.
* @return EC_Normal if succesful, an error code otherwise
*/
OFCondition convertToUninterleaved(
Uint8 *target,
const Uint8 *source,
Uint16 components,
Uint32 width,
Uint32 height,
Uint16 bitsAllocated) const;
/** Convert an image from uninterleaved to sample interleaved.
* @param target A buffer where the converted image will be stored
* @param source The image buffer to be converted
* @param components Color components used in the image
* @param width The width of the image.
* @param height The height of the image.
* @param bitsAllocated The number of bits allocated in the image.
* @return EC_Normal if succesful, an error code otherwise
*/
OFCondition convertToSampleInterleaved(
Uint8 *target,
const Uint8 *source,
Uint16 components,
Uint32 width,
Uint32 height,
Uint16 bitsAllocated) const;
};
/** codec class for JPEG-LS lossless only TS encoding
*/
class DJLSLosslessEncoder : public DJLSEncoderBase
{
/** returns the transfer syntax that this particular codec
* is able to encode
* @return supported transfer syntax
*/
virtual E_TransferSyntax supportedTransferSyntax() const;
};
/** codec class for JPEG-LS lossy and lossless TS encoding
*/
class DJLSNearLosslessEncoder : public DJLSEncoderBase
{
/** returns the transfer syntax that this particular codec
* is able to encode
* @return supported transfer syntax
*/
virtual E_TransferSyntax supportedTransferSyntax() const;
};
#endif
/*
* CVS/RCS Log:
* $Log: djcodece.h,v $
* Revision 1.8 2010-10-14 13:17:19 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.7 2010-03-01 10:35:28 uli
* Renamed include guards to avoid name clash with e.g. dcmjpeg.
*
* Revision 1.6 2010-02-26 10:54:41 uli
* Fixed a compiler warning with MSVC about unsafe casts.
*
* Revision 1.5 2010-02-25 10:17:14 uli
* Fix doxygen comments in a couple of places.
*
* Revision 1.4 2009-11-17 16:57:14 joergr
* Added new method that allows for determining the color model of the
* decompressed image.
*
* Revision 1.3 2009-10-07 13:16:47 uli
* Switched to logging mechanism provided by the "new" oflog module.
*
* Revision 1.2 2009-07-31 09:14:52 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.3 2008-05-29 10:54:05 meichel
* Implemented new method DcmPixelData::getUncompressedFrame
* that permits frame-wise access to compressed and uncompressed
* objects without ever loading the complete object into main memory.
* For this new method to work with compressed images, all classes derived from
* DcmCodec need to implement a new method decodeFrame(). For now, only
* dummy implementations returning an error code have been defined.
*
* Revision 1.2 2007/06/20 12:37:37 meichel
* Completed implementation of encoder, which now supports lossless
* "raw" and "cooked" and near-lossless "cooked" modes.
*
* 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:38:43 meichel
* Further code clean-up. Encoder now produces valid offset tables if
* a JPEG-LS frame size an odd number of bytes.
*
* 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
*
*
*/
|