blob.h File Reference

#include "MagickCore/image.h"
#include "MagickCore/stream.h"

Include dependency graph for blob.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	MagickMaxBufferExtent   (32*8192)
Typedefs
typedef int *(*	BlobFifo )(const Image *, const void *, const size_t)
Enumerations
enum	BlobMode {   UndefinedBlobMode, ReadBlobMode, ReadBinaryBlobMode, WriteBlobMode,   WriteBinaryBlobMode, AppendBlobMode, AppendBinaryBlobMode }
enum	MapMode { ReadMode, WriteMode, IOMode }
Functions
MagickExport BlobInfo *	CloneBlobInfo (const BlobInfo *)
MagickExport BlobInfo *	ReferenceBlob (BlobInfo *)
MagickExport char *	ReadBlobString (Image *, char *)
MagickExport double	ReadBlobDouble (Image *)
MagickExport FILE *	GetBlobFileHandle (const Image *)
MagickExport float	ReadBlobFloat (Image *)
MagickExport Image *	BlobToImage (const ImageInfo *, const void *, const size_t, ExceptionInfo *)
MagickExport Image *	PingBlob (const ImageInfo *, const void *, const size_t, ExceptionInfo *)
MagickExport int	EOFBlob (const Image *)
MagickExport int	ReadBlobByte (Image *)
MagickExport MagickBooleanType	BlobToFile (char *, const void *, const size_t, ExceptionInfo *)
MagickExport MagickBooleanType	CloseBlob (Image *)
MagickExport MagickBooleanType	DiscardBlobBytes (Image *, const MagickSizeType)
MagickExport MagickBooleanType	FileToImage (Image *, const char *, ExceptionInfo *)
MagickExport MagickBooleanType	ImageToFile (Image *, char *, ExceptionInfo *)
MagickExport MagickBooleanType	InjectImageBlob (const ImageInfo *, Image *, Image *, const char *, ExceptionInfo *)
MagickExport MagickBooleanType	OpenBlob (const ImageInfo *, Image *, const BlobMode, ExceptionInfo *)
MagickExport MagickBooleanType	UnmapBlob (void *, const size_t)
MagickExport MagickOffsetType	SeekBlob (Image *, const MagickOffsetType, const int)
MagickExport MagickOffsetType	TellBlob (const Image *)
MagickExport MagickSizeType	GetBlobSize (const Image *)
MagickExport MagickSizeType	ReadBlobLongLong (Image *)
MagickExport MagickSizeType	ReadBlobMSBLongLong (Image *)
MagickExport ssize_t	ReadBlob (Image *, const size_t, unsigned char *)
MagickExport ssize_t	WriteBlob (Image *, const size_t, const unsigned char *)
MagickExport ssize_t	WriteBlobByte (Image *, const unsigned char)
MagickExport ssize_t	WriteBlobFloat (Image *, const float)
MagickExport ssize_t	WriteBlobLong (Image *, const unsigned int)
MagickExport ssize_t	WriteBlobShort (Image *, const unsigned short)
MagickExport ssize_t	WriteBlobLSBLong (Image *, const unsigned int)
MagickExport ssize_t	WriteBlobLSBShort (Image *, const unsigned short)
MagickExport ssize_t	WriteBlobMSBLong (Image *, const unsigned int)
MagickExport ssize_t	WriteBlobMSBLongLong (Image *, const MagickSizeType)
MagickExport ssize_t	WriteBlobMSBShort (Image *, const unsigned short)
MagickExport ssize_t	WriteBlobString (Image *, const char *)
MagickExport unsigned char *	DetachBlob (BlobInfo *)
MagickExport unsigned char *	FileToBlob (const char *, const size_t, size_t *, ExceptionInfo *)
MagickExport unsigned char *	GetBlobStreamData (const Image *)
MagickExport unsigned char *	ImageToBlob (const ImageInfo *, Image *, size_t *, ExceptionInfo *)
MagickExport unsigned char *	ImagesToBlob (const ImageInfo *, Image *, size_t *, ExceptionInfo *)
MagickExport unsigned char *	MapBlob (int, const MapMode, const MagickOffsetType, const size_t)
MagickExport unsigned int	ReadBlobLong (Image *)
MagickExport unsigned int	ReadBlobLSBLong (Image *)
MagickExport unsigned int	ReadBlobMSBLong (Image *)
MagickExport unsigned short	ReadBlobShort (Image *)
MagickExport unsigned short	ReadBlobLSBShort (Image *)
MagickExport unsigned short	ReadBlobMSBShort (Image *)
MagickExport void	AttachBlob (BlobInfo *, const void *, const size_t)
MagickExport void	DestroyBlob (Image *)
MagickExport void	DuplicateBlob (Image *, const Image *)
MagickExport void	MSBOrderLong (unsigned char *, const size_t)
MagickExport void	MSBOrderShort (unsigned char *, const size_t)

---

Define Documentation

#define MagickMaxBufferExtent   (32*8192)

Definition at line 28 of file blob.h.

Referenced by FileToBlob(), FileToImage(), ImageToFile(), InjectImageBlob(), OpenBlob(), DiskToDiskPixelCacheClone(), ReadPixelCacheMetacontent(), ReadPixelCachePixels(), WritePixelCacheMetacontent(), WritePixelCachePixels(), CopyDelegateFile(), and AcquireUniqueSymbolicLink().

---

Typedef Documentation

typedef int*(* BlobFifo)(const Image *, const void *, const size_t)

Definition at line 49 of file blob.h.

---

Enumeration Type Documentation

enum BlobMode

Enumerator:

UndefinedBlobMode
ReadBlobMode
ReadBinaryBlobMode
WriteBlobMode
WriteBinaryBlobMode
AppendBlobMode
AppendBinaryBlobMode

Definition at line 30 of file blob.h.

enum MapMode

Enumerator:

ReadMode
WriteMode
IOMode

Definition at line 41 of file blob.h.

---

Function Documentation

MagickExport void AttachBlob	(	BlobInfo *	,
		const void *	,
		const size_t
	)

MagickExport MagickBooleanType BlobToFile	(	char *	,
		const void *	,
		const size_t	,
		ExceptionInfo *
	)

MagickExport Image* BlobToImage	(	const ImageInfo *	,
		const void *	,
		const size_t	,
		ExceptionInfo *
	)

MagickExport BlobInfo* CloneBlobInfo

(

const BlobInfo *

)

MagickExport MagickBooleanType CloseBlob

(

Image *

)

MagickExport void DestroyBlob

(

Image *

)

MagickExport unsigned char* DetachBlob

(

BlobInfo *

)

MagickExport MagickBooleanType DiscardBlobBytes	(	Image *	,
		const MagickSizeType
	)

MagickExport void DuplicateBlob	(	Image *	,
		const Image *
	)

MagickExport int EOFBlob

(

const Image *

)

MagickExport unsigned char * FileToBlob	(	const char *	,
		const size_t	,
		size_t *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType FileToImage	(	Image *	,
		const char *	,
		ExceptionInfo *
	)

MagickExport FILE* GetBlobFileHandle

(

const Image *

)

Definition at line 1220 of file blob.c.

References _Image::signature, MagickSignature, _Image::blob, and _BlobInfo::file.

MagickExport MagickSizeType GetBlobSize

(

const Image *

)

MagickExport unsigned char * GetBlobStreamData

(

const Image *

)

MagickExport unsigned char * ImagesToBlob	(	const ImageInfo *	,
		Image *	,
		size_t *	,
		ExceptionInfo *
	)

MagickExport unsigned char * ImageToBlob	(	const ImageInfo *	,
		Image *	,
		size_t *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType ImageToFile	(	Image *	,
		char *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType InjectImageBlob	(	const ImageInfo *	,
		Image *	,
		Image *	,
		const char *	,
		ExceptionInfo *
	)

MagickExport unsigned char * MapBlob	(	int	,
		const MapMode	,
		const MagickOffsetType	,
		const size_t
	)

Definition at line 2113 of file blob.c.

References ReadMode, WriteMode, IOMode, and MAP_FAILED.

Referenced by FileToBlob(), OpenBlob(), SetBlobExtent(), AllocatePixelCachePixels(), OpenPixelCache(), AcquireCacheNexusPixels(), AcquireRadonInfo(), AcquireStreamPixels(), and ConfigureFileToStringInfo().

MagickExport void MSBOrderLong	(	unsigned char *	,
		const size_t
	)

MagickExport void MSBOrderShort	(	unsigned char *	,
		const size_t
	)

Definition at line 2253 of file blob.c.

MagickExport MagickBooleanType OpenBlob	(	const ImageInfo *	,
		Image *	,
		const BlobMode	,
		ExceptionInfo *
	)

MagickExport Image * PingBlob	(	const ImageInfo *	,
		const void *	,
		const size_t	,
		ExceptionInfo *
	)

Definition at line 2658 of file blob.c.

References _ImageInfo::signature, MagickSignature, _ImageInfo::debug, MagickFalse, LogMagickEvent(), TraceEvent, GetMagickModule, _ImageInfo::filename, ThrowMagickException(), BlobError, _ImageInfo::magick, CloneImageInfo(), _ImageInfo::blob, AcquireQuantumMemory(), ResourceLimitFatalError, _ImageInfo::length, _ImageInfo::ping, MagickTrue, ReadStream(), PingStream(), RelinquishMagickMemory(), and DestroyImageInfo().

MagickExport ssize_t ReadBlob	(	Image *	,
		const size_t	,
		unsigned char *
	)

MagickExport int ReadBlobByte

(

Image *

)

Definition at line 2867 of file blob.c.

References _Image::signature, MagickSignature, and ReadBlobStream().

MagickExport double ReadBlobDouble

(

Image *

)

Definition at line 2909 of file blob.c.

References ReadBlobLongLong().

MagickExport float ReadBlobFloat

(

Image *

)

Definition at line 2948 of file blob.c.

References ReadBlobLong().

MagickExport unsigned int ReadBlobLong

(

Image *

)

MagickExport MagickSizeType ReadBlobLongLong

(

Image *

)

MagickExport unsigned int ReadBlobLSBLong

(

Image *

)

MagickExport unsigned short ReadBlobLSBShort

(

Image *

)

MagickExport unsigned int ReadBlobMSBLong

(

Image *

)

Definition at line 3263 of file blob.c.

References _Image::signature, MagickSignature, and ReadBlobStream().

MagickExport MagickSizeType ReadBlobMSBLongLong

(

Image *

)

Definition at line 3313 of file blob.c.

References _Image::signature, MagickSignature, ReadBlobStream(), and MagickULLConstant.

MagickExport unsigned short ReadBlobMSBShort

(

Image *

)

Definition at line 3367 of file blob.c.

References _Image::signature, MagickSignature, and ReadBlobStream().

MagickExport unsigned short ReadBlobShort

(

Image *

)

MagickExport char* ReadBlobString	(	Image *	,
		char *
	)

Definition at line 3417 of file blob.c.

References _Image::signature, MagickSignature, MaxTextExtent, and ReadBlobStream().

MagickExport BlobInfo * ReferenceBlob

(

BlobInfo *

)

Definition at line 3475 of file blob.c.

References _BlobInfo::signature, MagickSignature, _BlobInfo::debug, MagickFalse, LogMagickEvent(), TraceEvent, GetMagickModule, LockSemaphoreInfo(), _BlobInfo::semaphore, _BlobInfo::reference_count, and UnlockSemaphoreInfo().

Referenced by DuplicateBlob(), AcquireNextImage(), CloneImage(), and SyncNextImageInList().

MagickExport MagickOffsetType SeekBlob	(	Image *	,
		const MagickOffsetType	,
		const int
	)

MagickExport MagickOffsetType TellBlob

(

const Image *

)

Definition at line 3856 of file blob.c.

References _Image::signature, MagickSignature, _Image::debug, MagickFalse, LogMagickEvent(), TraceEvent, GetMagickModule, _Image::filename, _Image::blob, _BlobInfo::type, UndefinedStream, FileStream, _BlobInfo::file, StandardStream, PipeStream, ZipStream, BZipStream, FifoStream, BlobStream, and _BlobInfo::offset.

Referenced by SeekBlob(), and SetBlobExtent().

MagickExport MagickBooleanType UnmapBlob	(	void *	,
		const size_t
	)

Definition at line 3925 of file blob.c.

References MagickFalse, and MagickTrue.

Referenced by DestroyBlob(), DetachBlob(), FileToBlob(), SetBlobExtent(), RelinquishPixelCachePixels(), RelinquishCacheNexusPixels(), DestroyMagickMemory(), DestroyRadonInfo(), RelinquishStreamPixels(), and ConfigureFileToStringInfo().

MagickExport ssize_t WriteBlob	(	Image *	,
		const size_t	,
		const unsigned char *
	)

MagickExport ssize_t WriteBlobByte	(	Image *	,
		const unsigned char
	)

MagickExport ssize_t WriteBlobFloat	(	Image *	,
		const float
	)

MagickExport ssize_t WriteBlobLong	(	Image *	,
		const unsigned int
	)

MagickExport ssize_t WriteBlobLSBLong	(	Image *	,
		const unsigned int
	)

MagickExport ssize_t WriteBlobLSBShort	(	Image *	,
		const unsigned short
	)

MagickExport ssize_t WriteBlobMSBLong	(	Image *	,
		const unsigned int
	)

MagickExport ssize_t WriteBlobMSBLongLong	(	Image *	,
		const MagickSizeType
	)

MagickExport ssize_t WriteBlobMSBShort	(	Image *	,
		const unsigned short
	)

MagickExport ssize_t WriteBlobShort	(	Image *	,
		const unsigned short
	)

MagickExport ssize_t WriteBlobString	(	Image *	,
		const char *
	)

Definition at line 4485 of file blob.c.

References _Image::signature, MagickSignature, and WriteBlobStream().