openshot-audio  0.1.6
Classes | Public Types | Public Member Functions | Friends | List of all members
GZIPCompressorOutputStream Class Reference

#include <juce_GZIPCompressorOutputStream.h>

Inheritance diagram for GZIPCompressorOutputStream:
OutputStream

Classes

class  GZIPCompressorHelper
 

Public Types

enum  WindowBitsValues { windowBitsRaw = -15, windowBitsGZIP = 15 + 16 }
 

Public Member Functions

 GZIPCompressorOutputStream (OutputStream *destStream, int compressionLevel=0, bool deleteDestStreamWhenDestroyed=false, int windowBits=0)
 
 ~GZIPCompressorOutputStream ()
 
void flush () override
 
int64 getPosition () override
 
bool setPosition (int64) override
 
bool write (const void *, size_t) override
 
- Public Member Functions inherited from OutputStream
virtual ~OutputStream ()
 
virtual bool writeByte (char byte)
 
virtual bool writeBool (bool boolValue)
 
virtual bool writeShort (short value)
 
virtual bool writeShortBigEndian (short value)
 
virtual bool writeInt (int value)
 
virtual bool writeIntBigEndian (int value)
 
virtual bool writeInt64 (int64 value)
 
virtual bool writeInt64BigEndian (int64 value)
 
virtual bool writeFloat (float value)
 
virtual bool writeFloatBigEndian (float value)
 
virtual bool writeDouble (double value)
 
virtual bool writeDoubleBigEndian (double value)
 
virtual bool writeRepeatedByte (uint8 byte, size_t numTimesToRepeat)
 
virtual bool writeCompressedInt (int value)
 
virtual bool writeString (const String &text)
 
virtual bool writeText (const String &text, bool asUTF16, bool writeUTF16ByteOrderMark)
 
virtual int64 writeFromInputStream (InputStream &source, int64 maxNumBytesToWrite)
 
void setNewLineString (const String &newLineString)
 
const StringgetNewLineString () const noexcept
 

Friends

struct ContainerDeletePolicy< GZIPCompressorHelper >
 

Additional Inherited Members

- Protected Member Functions inherited from OutputStream
 OutputStream ()
 

Detailed Description

A stream which uses zlib to compress the data written into it.

Important note: When you call flush() on a GZIPCompressorOutputStream, the gzip data is closed - this means that no more data can be written to it, and any subsequent attempts to call write() will cause an assertion.

See also
GZIPDecompressorInputStream

Member Enumeration Documentation

These are preset values that can be used for the constructor's windowBits parameter. For more info about this, see the zlib documentation for its windowBits parameter.

Enumerator
windowBitsRaw 
windowBitsGZIP 

Constructor & Destructor Documentation

GZIPCompressorOutputStream::GZIPCompressorOutputStream ( OutputStream destStream,
int  compressionLevel = 0,
bool  deleteDestStreamWhenDestroyed = false,
int  windowBits = 0 
)

Creates a compression stream.

Parameters
destStreamthe stream into which the compressed data should be written
compressionLevelhow much to compress the data, between 1 and 9, where 1 is the fastest/lowest compression, and 9 is the slowest/highest compression. Any value outside this range indicates that a default compression level should be used.
deleteDestStreamWhenDestroyedwhether or not to delete the destStream object when this stream is destroyed
windowBitsthis is used internally to change the window size used by zlib - leave it as 0 unless you specifically need to set its value for some reason
GZIPCompressorOutputStream::~GZIPCompressorOutputStream ( )

Destructor.

Member Function Documentation

void GZIPCompressorOutputStream::flush ( )
overridevirtual

Flushes and closes the stream. Note that unlike most streams, when you call flush() on a GZIPCompressorOutputStream, the stream is closed - this means that no more data can be written to it, and any subsequent attempts to call write() will cause an assertion.

Implements OutputStream.

int64 GZIPCompressorOutputStream::getPosition ( )
overridevirtual

Returns the stream's current position.

See also
setPosition

Implements OutputStream.

bool GZIPCompressorOutputStream::setPosition ( int64  newPosition)
overridevirtual

Tries to move the stream's output position.

Not all streams will be able to seek to a new position - this will return false if it fails to work.

See also
getPosition

Implements OutputStream.

bool GZIPCompressorOutputStream::write ( const void *  dataToWrite,
size_t  numberOfBytes 
)
overridevirtual

Writes a block of data to the stream.

When creating a subclass of OutputStream, this is the only write method that needs to be overloaded - the base class has methods for writing other types of data which use this to do the work.

Parameters
dataToWritethe target buffer to receive the data. This must not be null.
numberOfBytesthe number of bytes to write.
Returns
false if the write operation fails for some reason

Implements OutputStream.

Friends And Related Function Documentation


The documentation for this class was generated from the following files: