FuseImageContent Class Reference
[FireVision FUSE Network Protocol, FireVision Image Processing Framework and Applications]

FUSE image content. More...

#include <fvutils/net/fuse_image_content.h>

Inheritance diagram for FuseImageContent:


Public Member Functions
	FuseImageContent (SharedMemoryImageBuffer *b)
	Constructor.
	FuseImageContent (uint32_t type, void *payload, size_t payload_size)
	Constructor.
	FuseImageContent (FUSE_image_format_t image_format, const char image_id, unsigned char buffer, size_t buffer_size, colorspace_t colorspace, unsigned int width, unsigned int height, long int capture_time_sec=0, long int capture_time_usec=0)
	Constructor.
	~FuseImageContent ()
	Destructor.
unsigned char *	buffer () const
	Image buffer.
size_t	buffer_size () const
	Get size of buffer.
unsigned int	pixel_width () const
	Get image width.
unsigned int	pixel_height () const
	Get image height.
unsigned int	colorspace () const
	Get colorspace.
unsigned int	format () const
	Get image format.
void	decompress (unsigned char *yuv422_planar_buffer, size_t buffer_size)
	Decompress image data.
fawkes::Time *	capture_time () const
	Get capture time.
virtual void	serialize ()
	Serialize message content.

Detailed Description

FUSE image content.

Author:: Tim Niemueller

Definition at line 34 of file fuse_image_content.h.

Constructor & Destructor Documentation

FuseImageContent::FuseImageContent ( SharedMemoryImageBuffer * b )

Constructor.

Copies data from given buffer.

Parameters:

b

shared memory image buffer to copy image from

Definition at line 71 of file fuse_image_content.cpp.

FuseImageContent::FuseImageContent	(	uint32_t	type,
		void *	payload,
		size_t	payload_size
	)

Constructor.

Parameters:

	type	message type
	payload	payload
	payload_size	size of payload

Definition at line 48 of file fuse_image_content.cpp.

References FuseMessageContent::_payload, FuseMessageContent::_payload_size, FUSE_image_message_header_t::buffer_size, FUSE_image_message_header_t::capture_time_sec, and FUSE_image_message_header_t::capture_time_usec.

FuseImageContent::FuseImageContent	(	FUSE_image_format_t	image_format,
		const char *	image_id,
		unsigned char *	buffer,
		size_t	buffer_size,
		colorspace_t	colorspace,
		unsigned int	width,
		unsigned int	height,
		long int	capture_time_sec = `0`,
		long int	capture_time_usec = `0`
	)

Constructor.

Copies data from given buffer.

Parameters:

	image_format	image format
	image_id	image ID
	buffer	image buffer, encoded according to image_format
	buffer_size	size of buffer in bytes
	colorspace	color space
	width	width of image in pixels
	height	height of image in pixels
	capture_time_sec	optional seconds part of the capture time
	capture_time_usec	optional microseconds part of the capture time

Definition at line 117 of file fuse_image_content.cpp.

References FuseMessageContent::_payload, FuseMessageContent::_payload_size, FUSE_image_message_header_t::buffer_size, FUSE_image_message_header_t::capture_time_sec, FUSE_image_message_header_t::capture_time_usec, FUSE_image_message_header_t::colorspace, FUSE_image_message_header_t::format, FUSE_image_message_header_t::height, FUSE_image_message_header_t::image_id, FUSE_image_message_header_t::reserved, and FUSE_image_message_header_t::width.

FuseImageContent::~FuseImageContent ( )

Destructor.

Definition at line 152 of file fuse_image_content.cpp.

Member Function Documentation

unsigned char * FuseImageContent::buffer ( ) const

Image buffer.

Returns:: image buffer

Definition at line 161 of file fuse_image_content.cpp.

Referenced by NetworkCamera::buffer(), NetworkCamera::capture(), and FireVisionNetworkTool::fuse_inbound_received().

size_t FuseImageContent::buffer_size ( ) const

Get size of buffer.

Returns:: size of buffer returned by buffer()

Definition at line 171 of file fuse_image_content.cpp.

Referenced by NetworkCamera::capture(), and FireVisionNetworkTool::fuse_inbound_received().

fawkes::Time * FuseImageContent::capture_time ( ) const

Get capture time.

Returns:: capture time

Definition at line 221 of file fuse_image_content.cpp.

References FUSE_image_message_header_t::capture_time_sec, and FUSE_image_message_header_t::capture_time_usec.

Referenced by NetworkCamera::capture_time().

unsigned int FuseImageContent::colorspace ( ) const

Get colorspace.

Returns:: colorspace

Definition at line 201 of file fuse_image_content.cpp.

References FUSE_image_message_header_t::colorspace.

Referenced by NetworkCamera::buffer_size(), and FireVisionNetworkTool::fuse_inbound_received().

void FuseImageContent::decompress	(	unsigned char *	yuv422_planar_buffer,
		size_t	buffer_size
	)

Decompress image data.

This is a utility method which can be used on clients to decompress compressed image payload. Since every time a new decompressor is created and deleted this method can be slower compared to decompressing the data directly in your application so use with care.

Parameters:

	yuv422_planar_buffer	an already allocated buffer where the decompressed image will be stored.
	buffer_size	size of yuv422_planar_buffer in bytes. Must be big enough to store a YUV422_PLANAR image of the image dimensions of the compressed data.

Definition at line 248 of file fuse_image_content.cpp.

References FUSE_image_message_header_t::colorspace, JpegImageDecompressor::decompress(), FUSE_image_message_header_t::format, FUSE_image_message_header_t::height, ImageDecompressor::set_compressed_buffer(), ImageDecompressor::set_decompressed_buffer(), and FUSE_image_message_header_t::width.

unsigned int FuseImageContent::format ( ) const

Get image format.