Steinberg::FStreamer Class Reference

Byteorder-aware base class for typed stream i/o. More...

#include "fstreamer.h"

Inheritance diagram for Steinberg::FStreamer:

Public Member Functions
	FStreamer (int16 byteOrder=BYTEORDER)
bool	skip (uint32 bytes)
bool	pad (uint32 bytes)
Implementing class must override.
virtual TSize	readRaw (void *, TSize)=0
	Read one buffer of size.
virtual TSize	writeRaw (const void *, TSize)=0
	Write one buffer of size.
virtual int64	seek (int64, FSeekMode)=0
	Set file position for stream.
virtual int64	tell ()=0
	Return current file position.
Streams are byteOrder aware.
void	setByteOrder (int32 e)
int32	getByteOrder () const
read and write int8 and char.
bool	writeChar8 (char8)
bool	readChar8 (char8 &)
bool	writeUChar8 (unsigned char)
bool	readUChar8 (unsigned char &)
bool	writeChar16 (char16 c)
bool	readChar16 (char16 &c)
bool	writeInt8 (int8 c)
bool	readInt8 (int8 &c)
bool	writeInt8u (uint8 c)
bool	readInt8u (uint8 &c)
read and write int16.
bool	writeInt16 (int16)
bool	readInt16 (int16 &)
bool	writeInt16Array (const int16 *array, int32 count)
bool	readInt16Array (int16 *array, int32 count)
bool	writeInt16u (uint16)
bool	readInt16u (uint16 &)
bool	writeInt16uArray (const uint16 *array, int32 count)
bool	readInt16uArray (uint16 *array, int32 count)
read and write int32.
bool	writeInt32 (int32)
bool	readInt32 (int32 &)
bool	writeInt32Array (const int32 *array, int32 count)
bool	readInt32Array (int32 *array, int32 count)
bool	writeInt32u (uint32)
bool	readInt32u (uint32 &)
bool	writeInt32uArray (const uint32 *array, int32 count)
bool	readInt32uArray (uint32 *array, int32 count)
read and write int64.
bool	writeInt64 (int64)
bool	readInt64 (int64 &)
bool	writeInt64Array (const int64 *array, int32 count)
bool	readInt64Array (int64 *array, int32 count)
bool	writeInt64u (uint64)
bool	readInt64u (uint64 &)
bool	writeInt64uArray (const uint64 *array, int32 count)
bool	readInt64uArray (uint64 *array, int32 count)
read and write float and float array.
bool	writeFloat (float)
bool	readFloat (float &)
bool	writeFloatArray (const float *array, int32 count)
bool	readFloatArray (float *array, int32 count)
read and write double and double array.
bool	writeDouble (double)
bool	readDouble (double &)
bool	writeDoubleArray (const double *array, int32 count)
bool	readDoubleArray (double *array, int32 count)
read and write Boolean.
bool	writeBool (bool)
	Write one boolean.
bool	readBool (bool &)
	Read one bool.

Protected Attributes
int16	byteOrder

read and write Strings.
TSize	writeString8 (const char8 *ptr, bool terminate=false)
	a direct output function writing only one string (ascii 8bit)
TSize	readString8 (char8 *ptr, TSize size)
	a direct input function reading only one string (ascii) (ended by a or \0 or eof)
bool	writeStr8 (const char8 *ptr)
	write a string length (strlen) and string itself
char8 *	readStr8 ()
	read a string length and string text (The return string must be deleted when use is finished)
bool	writeStringUtf8 (const tchar *ptr)
	always terminated, converts to utf8 if non ascii characters are in string
int32	readStringUtf8 (tchar *ptr, int32 maxSize)
	read a UTF8 string
static int32	getStr8Size (const char8 *ptr)
	returns the size of a saved string

Detailed Description

Byteorder-aware base class for typed stream i/o.

Definition at line 57 of file fstreamer.h.

Constructor & Destructor Documentation

FStreamer()

Steinberg::FStreamer::FStreamer

(

int16

byteOrder = BYTEORDER

)

Definition at line 140 of file fstreamer.cpp.

~FStreamer()

virtual Steinberg::FStreamer::~FStreamer ( )

virtual

Definition at line 62 of file fstreamer.h.

Member Function Documentation

getByteOrder()

int32 Steinberg::FStreamer::getByteOrder

(

)

const

Definition at line 75 of file fstreamer.h.

getStr8Size()

int32 Steinberg::FStreamer::getStr8Size ( const char8 *  ptr )

static

returns the size of a saved string

Definition at line 708 of file fstreamer.cpp.

pad()

bool Steinberg::FStreamer::pad

(

uint32

bytes

)

Definition at line 743 of file fstreamer.cpp.

readBool()

bool Steinberg::FStreamer::readBool

(

bool &

b

)

Read one bool.

Definition at line 563 of file fstreamer.cpp.

readChar16()

bool Steinberg::FStreamer::readChar16

(

char16 &

c

)

Definition at line 178 of file fstreamer.cpp.

readChar8()

bool Steinberg::FStreamer::readChar8

(

char8 &

c

)

Definition at line 152 of file fstreamer.cpp.

readDouble()

bool Steinberg::FStreamer::readDouble

(

double &

d

)

Definition at line 528 of file fstreamer.cpp.

readDoubleArray()

bool Steinberg::FStreamer::readDoubleArray	(	double *	array,
		int32	count
	)

Definition at line 552 of file fstreamer.cpp.

readFloat()

bool Steinberg::FStreamer::readFloat

(

float &

f

)

Definition at line 485 of file fstreamer.cpp.

readFloatArray()

bool Steinberg::FStreamer::readFloatArray	(	float *	array,
		int32	count
	)

Definition at line 509 of file fstreamer.cpp.

readInt16()

bool Steinberg::FStreamer::readInt16

(

int16 &

i

)

Definition at line 224 of file fstreamer.cpp.

readInt16Array()

bool Steinberg::FStreamer::readInt16Array	(	int16 *	array,
		int32	count
	)

Definition at line 248 of file fstreamer.cpp.

readInt16u()

bool Steinberg::FStreamer::readInt16u

(

uint16 &

i

)

Definition at line 267 of file fstreamer.cpp.

readInt16uArray()

bool Steinberg::FStreamer::readInt16uArray	(	uint16 *	array,
		int32	count
	)

Definition at line 291 of file fstreamer.cpp.

readInt32()

bool Steinberg::FStreamer::readInt32

(

int32 &

i

)

Definition at line 311 of file fstreamer.cpp.

readInt32Array()

bool Steinberg::FStreamer::readInt32Array	(	int32 *	array,
		int32	count
	)

Definition at line 335 of file fstreamer.cpp.

readInt32u()

bool Steinberg::FStreamer::readInt32u

(

uint32 &

i

)

Definition at line 354 of file fstreamer.cpp.

readInt32uArray()

bool Steinberg::FStreamer::readInt32uArray	(	uint32 *	array,
		int32	count
	)

Definition at line 378 of file fstreamer.cpp.

readInt64()

bool Steinberg::FStreamer::readInt64

(

int64 &

i

)

Definition at line 398 of file fstreamer.cpp.

readInt64Array()

bool Steinberg::FStreamer::readInt64Array	(	int64 *	array,
		int32	count
	)

Definition at line 422 of file fstreamer.cpp.

readInt64u()

bool Steinberg::FStreamer::readInt64u

(

uint64 &

i

)

Definition at line 441 of file fstreamer.cpp.

readInt64uArray()

bool Steinberg::FStreamer::readInt64uArray	(	uint64 *	array,
		int32	count
	)

Definition at line 465 of file fstreamer.cpp.

readInt8()

bool Steinberg::FStreamer::readInt8

(

int8 &

c

)

Definition at line 197 of file fstreamer.cpp.

readInt8u()

bool Steinberg::FStreamer::readInt8u

(

uint8 &

c

)

Definition at line 209 of file fstreamer.cpp.

readRaw()

virtual TSize Steinberg::FStreamer::readRaw ( void *  , TSize    )

pure virtual

Read one buffer of size.

Implemented in Steinberg::IBStreamer.

readStr8()

char8 * Steinberg::FStreamer::readStr8

(

)

read a string length and string text (The return string must be deleted when use is finished)

Definition at line 714 of file fstreamer.cpp.

readString8()

TSize Steinberg::FStreamer::readString8	(	char8 *	ptr,
		TSize	size
	)

a direct input function reading only one string (ascii) (ended by a
or \0 or eof)

Definition at line 588 of file fstreamer.cpp.

readStringUtf8()

int32 Steinberg::FStreamer::readStringUtf8	(	tchar *	ptr,
		int32	maxSize
	)

read a UTF8 string

Definition at line 643 of file fstreamer.cpp.

readUChar8()

bool Steinberg::FStreamer::readUChar8

(

unsigned char &

c

)

Definition at line 164 of file fstreamer.cpp.

seek()

virtual int64 Steinberg::FStreamer::seek ( int64  , FSeekMode    )

pure virtual

Set file position for stream.

Implemented in Steinberg::IBStreamer.

setByteOrder()

void Steinberg::FStreamer::setByteOrder

(

int32

e

)

Definition at line 74 of file fstreamer.h.

skip()

bool Steinberg::FStreamer::skip

(

uint32

bytes

)

Definition at line 731 of file fstreamer.cpp.

tell()

virtual int64 Steinberg::FStreamer::tell ( )

pure virtual

Return current file position.

Implemented in Steinberg::IBStreamer.

writeBool()

bool Steinberg::FStreamer::writeBool

(

bool

b

)

Write one boolean.

Definition at line 572 of file fstreamer.cpp.

writeChar16()

bool Steinberg::FStreamer::writeChar16

(

char16

c

)

Definition at line 170 of file fstreamer.cpp.

writeChar8()

bool Steinberg::FStreamer::writeChar8

(

char8

c

)

Definition at line 146 of file fstreamer.cpp.

writeDouble()

bool Steinberg::FStreamer::writeDouble

(

double

d

)

Definition at line 520 of file fstreamer.cpp.

writeDoubleArray()

bool Steinberg::FStreamer::writeDoubleArray	(	const double *	array,
		int32	count
	)

Definition at line 541 of file fstreamer.cpp.

writeFloat()

bool Steinberg::FStreamer::writeFloat

(

float

f

)

Definition at line 477 of file fstreamer.cpp.

writeFloatArray()

bool Steinberg::FStreamer::writeFloatArray	(	const float *	array,
		int32	count
	)

Definition at line 498 of file fstreamer.cpp.

writeInt16()

bool Steinberg::FStreamer::writeInt16

(

int16

i

)

Definition at line 216 of file fstreamer.cpp.

writeInt16Array()

bool Steinberg::FStreamer::writeInt16Array	(	const int16 *	array,
		int32	count
	)

Definition at line 237 of file fstreamer.cpp.

writeInt16u()

bool Steinberg::FStreamer::writeInt16u

(

uint16

i

)

Definition at line 259 of file fstreamer.cpp.

writeInt16uArray()

bool Steinberg::FStreamer::writeInt16uArray	(	const uint16 *	array,
		int32	count
	)

Definition at line 280 of file fstreamer.cpp.

writeInt32()

bool Steinberg::FStreamer::writeInt32

(

int32

i

)

Definition at line 303 of file fstreamer.cpp.

writeInt32Array()

bool Steinberg::FStreamer::writeInt32Array	(	const int32 *	array,
		int32	count
	)

Definition at line 324 of file fstreamer.cpp.

writeInt32u()

bool Steinberg::FStreamer::writeInt32u

(

uint32

i

)

Definition at line 346 of file fstreamer.cpp.

writeInt32uArray()

bool Steinberg::FStreamer::writeInt32uArray	(	const uint32 *	array,
		int32	count
	)

Definition at line 367 of file fstreamer.cpp.

writeInt64()

bool Steinberg::FStreamer::writeInt64

(

int64

i

)

Definition at line 390 of file fstreamer.cpp.

writeInt64Array()

bool Steinberg::FStreamer::writeInt64Array	(	const int64 *	array,
		int32	count
	)

Definition at line 411 of file fstreamer.cpp.

writeInt64u()

bool Steinberg::FStreamer::writeInt64u

(

uint64

i

)

Definition at line 433 of file fstreamer.cpp.

writeInt64uArray()

bool Steinberg::FStreamer::writeInt64uArray	(	const uint64 *	array,
		int32	count
	)

Definition at line 454 of file fstreamer.cpp.

writeInt8()

bool Steinberg::FStreamer::writeInt8

(

int8

c

)

Definition at line 191 of file fstreamer.cpp.

writeInt8u()

bool Steinberg::FStreamer::writeInt8u

(

uint8

c

)

Definition at line 203 of file fstreamer.cpp.

writeRaw()

virtual TSize Steinberg::FStreamer::writeRaw ( const void *  , TSize    )

pure virtual

Write one buffer of size.

Implemented in Steinberg::IBStreamer.

writeStr8()

bool Steinberg::FStreamer::writeStr8

(

const char8 *

ptr

)

write a string length (strlen) and string itself

Definition at line 695 of file fstreamer.cpp.

writeString8()

TSize Steinberg::FStreamer::writeString8	(	const char8 *	ptr,
		bool	terminate = false
	)

a direct output function writing only one string (ascii 8bit)

Definition at line 578 of file fstreamer.cpp.

writeStringUtf8()

bool Steinberg::FStreamer::writeStringUtf8

(

const tchar *

ptr

)

always terminated, converts to utf8 if non ascii characters are in string

Definition at line 616 of file fstreamer.cpp.

writeUChar8()

bool Steinberg::FStreamer::writeUChar8

(

unsigned char

c

)

Definition at line 158 of file fstreamer.cpp.

Member Data Documentation

byteOrder

int16 Steinberg::FStreamer::byteOrder

protected

Definition at line 171 of file fstreamer.h.

---

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

• juce_audio_processors/format_types/VST3_SDK/base/source/fstreamer.h
• juce_audio_processors/format_types/VST3_SDK/base/source/fstreamer.cpp