Grok 15.1.0
grk::CompressCodeblock Struct Reference

#include <Codeblock.h>

Inheritance diagram for grk::CompressCodeblock:
grk::Codeblock grk::grk_buf2d< int32_t, AllocatorAligned > grk::ICacheable grk::grk_buf< int32_t, AllocatorAligned > grk::grk_rect< uint32_t > grk::AllocatorAligned< int32_t >

Public Member Functions

 CompressCodeblock (uint16_t numLayers)
virtual ~CompressCodeblock ()
void init ()
bool allocData (size_t nominalBlockSize)
 Allocates data memory for an compressing code block.
Public Member Functions inherited from grk::Codeblock
 Codeblock (uint16_t numLayers)
virtual ~Codeblock ()
void init (void)
void setRect (grk_rect32 r)
uint8_t getNumPassesInPacket (uint16_t layno)
void setNumPassesInPacket (uint16_t layno, uint8_t passes)
void incNumPassesInPacket (uint16_t layno, uint8_t delta)
Public Member Functions inherited from grk::grk_buf2d< int32_t, AllocatorAligned >
 grk_buf2d (int32_t *buffer, bool ownsData, uint32_t w, uint32_t strd, uint32_t h)
grk_buf2d_simple< int32_t > simple (void) const
grk_buf2d_simple< float > simpleF (void) const
grk_buf2doperator= (const grk_buf2d &rhs)
virtual ~grk_buf2d ()=default
bool alloc2d (bool clear)
void attach (int32_t *buffer, uint32_t strd)
void acquire (int32_t *buffer, uint32_t strd)
void transfer (int32_t **buffer, uint32_t *strd)
bool isWindowValid (grk_rect32 win)
 Returns whether window bounds are valid (non empty and within buffer bounds)
void copyFrom (const grk_buf2d &src, F filter)
int32_t * getBuffer (void) const
int32_t * address (uint32_t x, uint32_t y)
Public Member Functions inherited from grk::grk_rect< uint32_t >
 grk_rect (uint32_t origin_x0, uint32_t origin_y0, uint32_t x0, uint32_t y0, uint32_t x1, uint32_t y1)
 grk_rect (uint32_t x0, uint32_t y0, uint32_t x1, uint32_t y1)
 grk_rect (const grk_rect &rhs)
 grk_rect (const grk_rect *rhs)
 grk_rect (void)
virtual ~grk_rect ()=default
grk_rect< uint32_t > & setOrigin (uint32_t origx, uint32_t origy, bool absolute)
grk_rect< uint32_t > & setOrigin (grk_rect< uint32_t > &rhs, bool absolute)
grk_rect< uint32_t > & setOrigin (grk_rect< uint32_t > *rhs, bool absolute)
grk_rect< uint32_t > & toRelative (void)
grk_rect< uint32_t > & toAbsolute (void)
virtual void print (void) const
std::string boundsString () const
bool valid (void) const
bool empty (void) const
bool contains (grk_pt< uint32_t > pt)
bool contains (uint32_t x, uint32_t y)
grk_rect< uint32_t > & operator= (const grk_rect< uint32_t > &rhs)
grk_rect< uint32_t > & operator= (const grk_rect< uint32_t > *rhs)
bool operator== (const grk_rect< uint32_t > &rhs) const
void setRect (grk_rect< uint32_t > *rhs)
void setRect (grk_rect< uint32_t > rhs)
grk_rect< uint32_t > scaleDownCeil (uint32_t den) const
grk_rect< uint32_t > scale (uint32_t scalex, uint32_t scaley) const
grk_rect< uint32_t > scaleDown (uint64_t denx, uint64_t deny) const
grk_rect< uint32_t > scaleDownPow2 (uint32_t powx, uint32_t powy) const
grk_rect< uint32_t > scaleDownPow2 (grk_pt< uint32_t > pow) const
grk_rect< uint32_t > scaleDownCeil (uint64_t denx, uint64_t deny) const
grk_rect< uint32_t > scaleDownCeilPow2 (uint32_t power) const
grk_rect< uint32_t > scaleDownCeilPow2 (uint32_t powx, uint32_t powy) const
grk_rect< uint32_t > intersection (const grk_rect< uint32_t > rhs) const
bool isContainedIn (const grk_rect< uint32_t > rhs) const
grk_rect< uint32_t > clip (const grk_rect< uint32_t > *rhs) const
grk_rect< uint32_t > clip (const grk_rect< uint32_t > &rhs) const
grk_rect< uint32_t > & clip_IN_PLACE (const grk_rect< uint32_t > &rhs)
grk_rect< uint32_t > intersection (const grk_rect< uint32_t > *rhs) const
bool nonEmptyIntersection (const grk_rect< uint32_t > *rhs) const
grk_rect< uint32_t > rectUnion (const grk_rect< uint32_t > *rhs) const
grk_rect< uint32_t > rectUnion (const grk_rect< uint32_t > &rhs) const
uint64_t area (void) const
uint32_t width () const
uint32_t height () const
grk_line< uint32_t > dimX () const
grk_line< uint32_t > dimY () const
grk_rect< uint32_t > pan (int64_t x, int64_t y) const
grk_rect< uint32_t > & pan_IN_PLACE (int64_t x, int64_t y)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundary)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundaryx, uint32_t boundaryy)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundary, uint32_t maxX, uint32_t maxY)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundaryx, uint32_t boundaryy, uint32_t maxX, uint32_t maxY)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundary, grk_rect< uint32_t > bounds)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundaryx, uint32_t boundaryy, grk_rect< uint32_t > bounds)
uint32_t parityX (void) const
uint32_t parityY (void) const
Public Member Functions inherited from grk::ICacheable
 ICacheable ()
virtual ~ICacheable ()=default
bool isOpen (void)
bool isClosed (void)
bool isError (void)
void setCacheState (GrkCacheState state)

Public Attributes

uint8_t * paddedCompressedStream
Layerlayers
CodePasspasses
uint32_t numPassesInPreviousPackets
uint32_t numPassesTotal
Public Attributes inherited from grk::Codeblock
grk_buf8 compressedStream
uint8_t numbps
uint8_t numlenbits
Public Attributes inherited from grk::grk_buf2d< int32_t, AllocatorAligned >
uint32_t stride
Public Attributes inherited from grk::grk_rect< uint32_t >
bool absoluteCoordinates
uint32_t origin_x0
uint32_t origin_y0
uint32_t x0
uint32_t y0
uint32_t x1
uint32_t y1

Additional Inherited Members

Protected Member Functions inherited from grk::grk_buf< int32_t, AllocatorAligned >
 grk_buf (int32_t *buffer, size_t off, size_t length, bool ownsData)
virtual ~grk_buf ()
grk_bufoperator= (const grk_buf &rhs)
bool canRead (void)
int32_t read (void)
bool write (int32_t val)
virtual bool alloc (size_t length)
virtual void dealloc ()
void attach (int32_t *buffer)
void acquire (int32_t *buffer)
void transfer (int32_t **buffer)
size_t remainingLength (void)
void incrementOffset (ptrdiff_t off)
int32_t * currPtr (void) const
Protected Member Functions inherited from grk::AllocatorAligned< int32_t >
int32_t * alloc (size_t length)
void dealloc (int32_t *buf)
Protected Member Functions inherited from grk::grk_rect< uint32_t >
 grk_rect (uint32_t origin_x0, uint32_t origin_y0, uint32_t x0, uint32_t y0, uint32_t x1, uint32_t y1)
 grk_rect (uint32_t x0, uint32_t y0, uint32_t x1, uint32_t y1)
 grk_rect (const grk_rect &rhs)
 grk_rect (const grk_rect *rhs)
 grk_rect (void)
virtual ~grk_rect ()=default
grk_rect< uint32_t > & setOrigin (uint32_t origx, uint32_t origy, bool absolute)
grk_rect< uint32_t > & setOrigin (grk_rect< uint32_t > &rhs, bool absolute)
grk_rect< uint32_t > & setOrigin (grk_rect< uint32_t > *rhs, bool absolute)
grk_rect< uint32_t > & toRelative (void)
grk_rect< uint32_t > & toAbsolute (void)
virtual void print (void) const
std::string boundsString () const
bool valid (void) const
bool empty (void) const
bool contains (grk_pt< uint32_t > pt)
bool contains (uint32_t x, uint32_t y)
grk_rect< uint32_t > & operator= (const grk_rect< uint32_t > &rhs)
grk_rect< uint32_t > & operator= (const grk_rect< uint32_t > *rhs)
bool operator== (const grk_rect< uint32_t > &rhs) const
void setRect (grk_rect< uint32_t > *rhs)
void setRect (grk_rect< uint32_t > rhs)
grk_rect< uint32_t > scaleDownCeil (uint32_t den) const
grk_rect< uint32_t > scale (uint32_t scalex, uint32_t scaley) const
grk_rect< uint32_t > scaleDown (uint64_t denx, uint64_t deny) const
grk_rect< uint32_t > scaleDownPow2 (uint32_t powx, uint32_t powy) const
grk_rect< uint32_t > scaleDownPow2 (grk_pt< uint32_t > pow) const
grk_rect< uint32_t > scaleDownCeil (uint64_t denx, uint64_t deny) const
grk_rect< uint32_t > scaleDownCeilPow2 (uint32_t power) const
grk_rect< uint32_t > scaleDownCeilPow2 (uint32_t powx, uint32_t powy) const
grk_rect< uint32_t > intersection (const grk_rect< uint32_t > rhs) const
bool isContainedIn (const grk_rect< uint32_t > rhs) const
grk_rect< uint32_t > clip (const grk_rect< uint32_t > *rhs) const
grk_rect< uint32_t > clip (const grk_rect< uint32_t > &rhs) const
grk_rect< uint32_t > & clip_IN_PLACE (const grk_rect< uint32_t > &rhs)
grk_rect< uint32_t > intersection (const grk_rect< uint32_t > *rhs) const
bool nonEmptyIntersection (const grk_rect< uint32_t > *rhs) const
grk_rect< uint32_t > rectUnion (const grk_rect< uint32_t > *rhs) const
grk_rect< uint32_t > rectUnion (const grk_rect< uint32_t > &rhs) const
uint64_t area (void) const
uint32_t width () const
uint32_t height () const
grk_line< uint32_t > dimX () const
grk_line< uint32_t > dimY () const
grk_rect< uint32_t > pan (int64_t x, int64_t y) const
grk_rect< uint32_t > & pan_IN_PLACE (int64_t x, int64_t y)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundary)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundaryx, uint32_t boundaryy)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundary, uint32_t maxX, uint32_t maxY)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundaryx, uint32_t boundaryy, uint32_t maxX, uint32_t maxY)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundary, grk_rect< uint32_t > bounds)
grk_rect< uint32_t > & grow_IN_PLACE (uint32_t boundaryx, uint32_t boundaryy, grk_rect< uint32_t > bounds)
uint32_t parityX (void) const
uint32_t parityY (void) const
Protected Attributes inherited from grk::Codeblock
uint8_t * numPassesInPacket
uint16_t numlayers_
Protected Attributes inherited from grk::grk_buf< int32_t, AllocatorAligned >
int32_t * buf
size_t offset
size_t len
bool owns_data
Protected Attributes inherited from grk::grk_rect< uint32_t >
bool absoluteCoordinates
uint32_t origin_x0
uint32_t origin_y0
uint32_t x0
uint32_t y0
uint32_t x1
uint32_t y1

Constructor & Destructor Documentation

◆ CompressCodeblock()

grk::CompressCodeblock::CompressCodeblock ( uint16_t numLayers)
inline

◆ ~CompressCodeblock()

virtual grk::CompressCodeblock::~CompressCodeblock ( )
inlinevirtual

References layers, and passes.

Member Function Documentation

◆ allocData()

bool grk::CompressCodeblock::allocData ( size_t nominalBlockSize)
inline

Allocates data memory for an compressing code block.

We actually allocate 2 more bytes than specified, and then offset data by +2. This is done so that we can safely initialize the MQ coder pointer to data-1, without risk of accessing uninitialized memory.

References grk::grk_buf< int32_t, AllocatorAligned >::buf, grk::Codeblock::compressedStream, grk_cblk_enc_compressed_data_pad_left, and paddedCompressedStream.

◆ init()

void grk::CompressCodeblock::init ( void )
inline

Member Data Documentation

◆ layers

Layer* grk::CompressCodeblock::layers

◆ numPassesInPreviousPackets

uint32_t grk::CompressCodeblock::numPassesInPreviousPackets

◆ numPassesTotal

uint32_t grk::CompressCodeblock::numPassesTotal

◆ paddedCompressedStream

uint8_t* grk::CompressCodeblock::paddedCompressedStream

◆ passes


The documentation for this struct was generated from the following file: