(PureBasic) Chunked Compression Using CompressBd2 with FirstChunk and LastChunk

See more Compression Examples

This example demonstrates how to compress data in multiple segments using the CompressBd2 method together with the FirstChunk and LastChunk properties. Instead of compressing all data in a single call, the input is divided into smaller chunks and processed sequentially, which is useful when handling streaming data or large inputs.

The example shows how to correctly mark the first, middle, and final chunks so that the compression stream is properly initialized and finalized. The compressed output is accumulated in a separate BinData object without modifying the input chunks. Finally, the example decompresses the combined result to verify that the original data is restored correctly.

This approach is ideal for scenarios where data is received incrementally, such as reading from a network stream, processing large files in parts, or handling real-time data feeds.

Chilkat PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkBinData.pb"
IncludeFile "CkCompression.pb"

Procedure ChilkatExample()

    success.i = 0

    ; This example assumes the Chilkat API has already been unlocked.
    ; See Global Unlock Sample for sample code.

    compress.i = CkCompression::ckCreate()
    If compress.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkCompression::setCkAlgorithm(compress, "zlib")

    ; This will accumulate the compressed output.
    bdOut.i = CkBinData::ckCreate()
    If bdOut.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; ------------------------------------------------------------------
    ; Simulate input arriving in chunks.
    ; ------------------------------------------------------------------

    part1.s = "The quick brown fox "
    part2.s = "jumps over the lazy dog. "
    part3.s = "This text is split into chunks."

    ; ------------------------------------------------------------------
    ; Compress the first chunk
    ; ------------------------------------------------------------------

    CkCompression::setCkFirstChunk(compress, 1)
    CkCompression::setCkLastChunk(compress, 0)

    bdIn.i = CkBinData::ckCreate()
    If bdIn.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkBinData::ckAppendString(bdIn,part1,"utf-8")

    success = CkCompression::ckCompressBd2(compress,bdIn,bdOut)
    If success = 0
        Debug CkCompression::ckLastErrorText(compress)
        CkCompression::ckDispose(compress)
        CkBinData::ckDispose(bdOut)
        CkBinData::ckDispose(bdIn)
        ProcedureReturn
    EndIf

    ; ------------------------------------------------------------------
    ; Compress a middle chunk
    ; ------------------------------------------------------------------

    CkCompression::setCkFirstChunk(compress, 0)
    CkCompression::setCkLastChunk(compress, 0)

    CkBinData::ckClear(bdIn)
    CkBinData::ckAppendString(bdIn,part2,"utf-8")

    success = CkCompression::ckCompressBd2(compress,bdIn,bdOut)
    If success = 0
        Debug CkCompression::ckLastErrorText(compress)
        CkCompression::ckDispose(compress)
        CkBinData::ckDispose(bdOut)
        CkBinData::ckDispose(bdIn)
        ProcedureReturn
    EndIf

    ; ------------------------------------------------------------------
    ; Compress the final chunk
    ; ------------------------------------------------------------------

    CkCompression::setCkFirstChunk(compress, 0)
    CkCompression::setCkLastChunk(compress, 1)

    CkBinData::ckClear(bdIn)
    CkBinData::ckAppendString(bdIn,part3,"utf-8")

    success = CkCompression::ckCompressBd2(compress,bdIn,bdOut)
    If success = 0
        Debug CkCompression::ckLastErrorText(compress)
        CkCompression::ckDispose(compress)
        CkBinData::ckDispose(bdOut)
        CkBinData::ckDispose(bdIn)
        ProcedureReturn
    EndIf

    ; Get the final compressed result as base64 for display
    compressedBase64.s = CkBinData::ckGetEncoded(bdOut,"base64")

    Debug "Compressed data (base64):"
    Debug compressedBase64

    ; ------------------------------------------------------------------
    ; Decompress to verify correctness
    ; ------------------------------------------------------------------

    bdDecompressed.i = CkBinData::ckCreate()
    If bdDecompressed.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkCompression::setCkFirstChunk(compress, 1)
    CkCompression::setCkLastChunk(compress, 1)

    success = CkCompression::ckDecompressBd2(compress,bdOut,bdDecompressed)
    If success = 0
        Debug CkCompression::ckLastErrorText(compress)
        CkCompression::ckDispose(compress)
        CkBinData::ckDispose(bdOut)
        CkBinData::ckDispose(bdIn)
        CkBinData::ckDispose(bdDecompressed)
        ProcedureReturn
    EndIf

    ; Convert decompressed bytes back to a string
    resultText.s = CkBinData::ckGetString(bdDecompressed,"utf-8")

    Debug "Decompressed text:"
    Debug resultText


    CkCompression::ckDispose(compress)
    CkBinData::ckDispose(bdOut)
    CkBinData::ckDispose(bdIn)
    CkBinData::ckDispose(bdDecompressed)


    ProcedureReturn
EndProcedure