osg::MNGImageFileType Class Reference
[Image]

MNG File Handler. See Image for a detailed description. More...

#include <OSGMNGImageFileType.h>

Inheritance diagram for osg::MNGImageFileType:

List of all members.

Safe Store/Restore
UInt64	store (const ImagePtr &image, UChar8 *buffer, Int32 memSize=-1)
virtual UInt64	maxBufferSize (const ImagePtr &image)
*static UInt64	restore (ImagePtr &image, const UChar8 *buffer, Int32 memSize=-1)
static UInt64	store (const ImagePtr &image, const char *mimeType, UChar8 *buffer, Int32 memSize=-1)
Public Types
Flags
enum	{ OSG_READ_SUPPORTED = 1, OSG_WRITE_SUPPORTED = 2 }
Flags
enum	{ OSG_READ_SUPPORTED = 1, OSG_WRITE_SUPPORTED = 2 }
Public Member Functions
Get Methods
*const Char8 *	getMimeType (void) const
const std::list< IDString > &	getSuffixList (void) const
virtual UInt32	getFlags (void) const
Raw Store/Restore
*virtual UInt64	restoreData (ImagePtr &image, const UChar8 *buffer, Int32 memSize=-1)
virtual UInt64	storeData (const ImagePtr &image, UChar8 *buffer, Int32 memSize=-1)
dump
*void	dump (void)
Destructor
*virtual	~MNGImageFileType (void)
Read/Write
*virtual bool	read (ImagePtr &image, const Char8 *fileName)
virtual bool	write (const ImagePtr &image, const Char8 *fileName)
Get Methods
*const Char8 *	getMimeType (void) const
const std::list< IDString > &	getSuffixList (void) const
virtual UInt32	getFlags (void) const
Read/Write
virtual bool	validateHeader (const Char8 *fileName, bool &implemented)
Raw Store/Restore
*virtual UInt64	restoreData (ImagePtr &image, const UChar8 *buffer, Int32 memSize=-1)
virtual UInt64	storeData (const ImagePtr &image, UChar8 *buffer, Int32 memSize=-1)
dump
*void	dump (void)
Static Public Member Functions
Get Method
*static MNGImageFileType &	the (void)
Protected Member Functions
Default Constructor
*	MNGImageFileType (const Char8 *mimeType, const Char8 *suffixArray[], UInt16 suffixByteCount)
Copy Constructor
*	MNGImageFileType (const MNGImageFileType &obj)
Private Types
typedef ImageFileType	Inherited
Static Private Attributes
static MNGImageFileType	_the

---

Detailed Description

Image File Type to read/write and store/restore Image objects as MNG data.

To be able to load MNG images you need the MNG library, (check the Prerequisites page on www.opensg.org). The lib comes with all Linux distributions.

You have to --enable-mng in the configure line to enable the singleton object.

Definition at line 54 of file OSGMNGImageFileType.h.

---

Member Typedef Documentation

typedef ImageFileType osg::MNGImageFileType::Inherited [private]

Definition at line 107 of file OSGMNGImageFileType.h.

---

Member Enumeration Documentation

anonymous enum [inherited]

Enumerator: OSG_READ_SUPPORTED  OSG_WRITE_SUPPORTED  Definition at line 65 of file OSGImageFileType.h. { OSG_READ_SUPPORTED = 1, OSG_WRITE_SUPPORTED = 2 };

---

Constructor & Destructor Documentation

MNGImageFileType::~MNGImageFileType (  void   )  [virtual]

Destructor Definition at line 286 of file OSGMNGImageFileType.cpp. { return; }

MNGImageFileType::MNGImageFileType (  const Char8 *  mimeType, const Char8 *  suffixArray[], UInt16  suffixByteCount )  [protected]

Constructor used for the singleton object Definition at line 263 of file OSGMNGImageFileType.cpp. : ImageFileType ( mimeType, suffixArray, suffixByteCount ) { return; }

MNGImageFileType::MNGImageFileType (  const MNGImageFileType &  obj  )  [protected]

Dummy Copy Constructor Definition at line 275 of file OSGMNGImageFileType.cpp. : ImageFileType(obj) { return; }

---

Member Function Documentation

bool MNGImageFileType::read (  ImagePtr &  image, const Char8 *  fileName )  [virtual]

Tries to fill the image object with the data read from the given fileName. Returns true on success. Implements osg::ImageFileType. Definition at line 127 of file OSGMNGImageFileType.cpp. References osg::ImageFileType::getMimeType(), and SWARNING. { #ifdef MNG_LIB /* png_structp png_ptr; png_infop info_ptr; png_uint_32 width, wc, height, h, i; png_byte bit_depth, channels, color_type; png_bytep *row_pointers, base; FILE *fd; bool retCode; if ((fd = fopen(fileName, "rb")) == 0) { cerr << "Could not open file " << fileName << std::endl; return false; } png_ptr = png_create_read_struct(MNG_LIBMNG_VER_STRING, 0, 0, 0); if (!png_ptr) { fclose(fd); return false; } info_ptr = png_create_info_struct(png_ptr); if (!info_ptr) { fclose(fd); png_destroy_read_struct(&png_ptr, 0, 0); return false; } if (setjmp(png_ptr->jmpbuf)) { png_destroy_read_struct(&png_ptr, &info_ptr, 0); fclose(fd); return false; } png_init_io(png_ptr, fd); png_read_info(png_ptr, info_ptr); width = png_get_image_width(png_ptr, info_ptr); height = png_get_image_height(png_ptr, info_ptr); bit_depth = png_get_bit_depth(png_ptr, info_ptr); channels = png_get_channels(png_ptr, info_ptr); color_type = png_get_color_type(png_ptr, info_ptr); if (image.set(width, height, channels)) { // Convert paletted images to RGB if (color_type == MNG_COLOR_TYPE_PALETTE && bit_depth <= 8) png_set_expand(png_ptr); // Convert < 8 bit to 8 bit if (color_type == MNG_COLOR_TYPE_GRAY && bit_depth < 8) png_set_expand(png_ptr); // Add a full alpha channel if there is transparency // information in a tRNS chunk if (png_get_valid(png_ptr, info_ptr, MNG_INFO_tRNS)) png_set_expand(png_ptr); // Convert 16 bit to 8 bit if (bit_depth == 16) png_set_strip_16(png_ptr); // Calculate the row pointers row_pointers = new png_bytep[height]; wc = width * channels; h = height - 1; base = image.data(); for (i = 0; i < height; ++i) row_pointers[i] = base + (h - i) * wc; // Read the image data png_read_image(png_ptr, row_pointers); delete [] row_pointers; retCode = true; } else retCode = false; png_destroy_read_struct(&png_ptr, &info_ptr, 0); fclose(fd); return retCode; */ #else SWARNING << getMimeType() << " read is not compiled into the current binary " << std::endl; return false; #endif }

bool MNGImageFileType::write (  const ImagePtr &  image, const Char8 *  fileName )  [virtual]

Tries to write the image object to the given fileName. Returns true on success. Implements osg::ImageFileType. Definition at line 237 of file OSGMNGImageFileType.cpp. References osg::endLog(), osg::ImageFileType::getMimeType(), and SWARNING. { #ifdef MNG_LIB SWARNING << getMimeType() << " write is not implemented " << endLog; #else SWARNING << getMimeType() << " write is not compiled into the current binary " << endLog; return false; #endif }

MNGImageFileType & MNGImageFileType::the (  void   )  [static]

Class method to get the singleton Object Definition at line 113 of file OSGMNGImageFileType.cpp. References _the. { return _the; }

const Char8 * ImageFileType::getMimeType (  void   )  const [inherited]

Get method for the mime type Definition at line 106 of file OSGImageFileType.cpp. References osg::ImageFileType::_mimeType, and osg::IDString::str(). Referenced by osg::ImageFileType::dump(), osg::TIFImageFileType::read(), osg::PNGImageFileType::read(), read(), osg::JPGImageFileType::read(), osg::ImageFileHandler::read(), osg::PNGImageFileType::restoreData(), osg::JPGImageFileType::restoreData(), osg::ImageFileType::restoreData(), osg::ImageFileType::store(), osg::ImageFileHandler::store(), osg::PNGImageFileType::storeData(), osg::JPGImageFileType::storeData(), osg::ImageFileType::storeData(), osg::TIFImageFileType::write(), osg::TGAImageFileType::write(), osg::PNGImageFileType::write(), write(), osg::JPGImageFileType::write(), osg::ImageFileHandler::write(), osg::GIFImageFileType::write(), and osg::DDSImageFileType::write(). { return _mimeType.str(); }

const std::list< IDString > & ImageFileType::getSuffixList (  void   )  const [inherited]

Get method for the suffix list container Definition at line 125 of file OSGImageFileType.cpp. References osg::ImageFileType::_suffixList. Referenced by osg::ImageFileHandler::addImageFileType(). { return _suffixList; }

UInt32 ImageFileType::getFlags (  void   )  const [virtual, inherited]

Get method for the flags indicating read/write support. Most image types only support reading. Definition at line 116 of file OSGImageFileType.cpp. References osg::ImageFileType::_flags. Referenced by osg::ImageFileHandler::getSuffixList(). { return _flags; }

bool ImageFileType::validateHeader (  const Char8 *  fileName, bool &  implemented )  [virtual, inherited]

Reimplemented in osg::GIFImageFileType, osg::JPGImageFileType, osg::PNGImageFileType, osg::SGIImageFileType, and osg::TIFImageFileType. Definition at line 132 of file OSGImageFileType.cpp. Referenced by osg::ImageFileHandler::getFileType(). { implemented = false; return true; }

UInt64 ImageFileType::restore (  ImagePtr &  image, const UChar8 *  buffer, Int32  memSize = -1 )  [static, inherited]

Tries to restore the Imagedata from the given memblock. The buffer must include a ImageFileType::Head data block. Definition at line 223 of file OSGImageFileType.cpp. References FDEBUG, FWARNING, osg::ImageFileHandler::getFileType(), osg::NullFC, osg::Image::OSG_UINT8_IMAGEDATA, osg::ImageFileType::restoreData(), and osg::ImageFileHandler::the(). Referenced by osg::ClusterViewBuffer::recv(), osg::ImageFileHandler::restore(), and osg::SimpleSceneManager::useOpenSGLogo(). { unsigned long imageSize, headSize = sizeof(Head); unsigned long size = 0, attachmentSize; Head head; const UChar8 *data = buffer ? (buffer + headSize) : 0; ImageFileType *type; const char *mimeType; Image::Type dataType; if ((image != osg::NullFC) && buffer && (memSize >= headSize)) { // Copy header. Otherwise netToHost would change the original // data structur. memcpy(&head,buffer,sizeof(Head)); head.netToHost(); mimeType = head.mimeType; if((type = ImageFileHandler::the().getFileType(mimeType, 0))) { if (head.dataType) dataType = Image::Type(head.dataType); else dataType = Image::OSG_UINT8_IMAGEDATA; image->set(Image::PixelFormat(head.pixelFormat), head.width, head.height, head.depth, head.mipmapCount, head.frameCount, float(head.frameDelay) / 1000.0, 0, dataType,true,head.sideCount ); imageSize = static_cast<unsigned long>( type->restoreData(image, data, memSize - headSize)); attachmentSize = 0; // head->attachmentSize; /* if ((attachmentSize = head->attachmentSize)) { attData = (char*)(buffer + headSize + imageSize); attKey = attData; attValue = 0; for (i = 0; i < (attachmentSize-1); i++) { if (attData[i] == 0) if (attKey) { attValue = &(attData[i+1]); image->setAttachmentField (attKey,attValue); attKey = attValue = 0; } else attKey = &(attData[i+1]); } if (attKey || attValue) { FFATAL (("Attachment restore error\n")); } } */ size = headSize + imageSize + attachmentSize; FDEBUG (( "Restore image data: %lu (%lu/%lu/%lu)\n", size, headSize, imageSize, attachmentSize )); } else { imageSize = 0; FWARNING(("Can not restore image data, invalid mimeType: %s\n", mimeType ? mimeType : "Unknown")); } } return size; }

UInt64 ImageFileType::store (  const ImagePtr &  image, const char *  mimeType, UChar8 *  buffer, Int32  memSize = -1 )  [static, inherited]

Tries to store the raster data to the given mem block. Will include a ImageFileType::Head description and the data encoded as 'mimeType' Definition at line 304 of file OSGImageFileType.cpp. References osg::ImageFileHandler::getFileType(), osg::ImageFileType::store(), and osg::ImageFileHandler::the(). Referenced by osg::ClusterViewBuffer::send(), osg::ImageFileType::store(), and osg::ImageFileHandler::store(). { ImageFileType *type = ImageFileHandler::the().getFileType(mimeType); return type ? type->store(image, buffer, memSize) : 0; }

UInt64 ImageFileType::store (  const ImagePtr &  image, UChar8 *  buffer, Int32  memSize = -1 )  [inherited]

Tries to store the raster data to the given mem block. Will include a ImageFileType::Head description for the derived concreate mimeType. Definition at line 318 of file OSGImageFileType.cpp. References osg::ImageFileType::Head::attachmentSize, osg::ImageFileType::Head::dataType, osg::ImageFileType::Head::depth, FDEBUG, FFATAL, osg::ImageFileType::Head::frameCount, osg::ImageFileType::Head::frameDelay, osg::ImageFileType::getMimeType(), osg::ImageFileType::Head::height, osg::ImageFileType::Head::hostToNet(), osg::ImageFileType::Head::mimeType, osg::ImageFileType::Head::mipmapCount, osg::ImageFileType::Head::pixelFormat, osg::ImageFileType::Head::sideCount, osg::ImageFileType::storeData(), and osg::ImageFileType::Head::width. { Head *head; unsigned long dataSize = 0, headSize = sizeof(Head); unsigned long attachmentSize; UChar8 *dest; const UChar8 *src = image->getData(); std::map<std::string, std::string>::const_iterator aI; std::string value; attachmentSize = 0; // get attachment size /* ImageGenericAttPtr att=ImageGenericAttPtr::dcast( const_cast<Image*>(image.getCPtr())->findAttachment( ImageGenericAtt::getClassType().getGroupId())); if(att != NullFC) { for(i = 0; i < (att->getType().getNumFieldDescs()-1); ++i) { FieldDescription *fieldDesc=att->getType().getFieldDescription(i); Field *field=att->getField(i); if (fieldDesc && field) { field->getValueByStr(value); attachmentSize += strlen( fieldDesc->getName().str() ) + 1; attachmentSize += value.length() + 1; std::cout << fieldDesc->getName().str() << std::endl; std::cout << value << std::endl; } else { FFATAL (("Invalid Attachment in ImageFileType::store()\n")); } } } */ if (buffer) { head = (Head *)buffer; head->pixelFormat = image->getPixelFormat(); head->width = image->getWidth(); head->height = image->getHeight(); head->depth = image->getDepth(); head->mipmapCount = image->getMipMapCount(); head->frameCount = image->getFrameCount(); head->frameDelay = short(image->getFrameDelay() * 1000.0); head->sideCount = image->getSideCount(); head->dataType = image->getDataType(); head->attachmentSize = static_cast<unsigned short>(attachmentSize); head->hostToNet(); strcpy(head->mimeType, getMimeType()); dest = (UChar8 *) (buffer + headSize); if (src) dataSize = static_cast<unsigned long>( storeData(image, dest, memSize - headSize)); dest = (UChar8 *) (buffer + headSize + dataSize); /* if(att != NullFC) { for(i = 0; i < (att->getType().getNumFieldDescs()-1); ++i) { FieldDescription *fieldDesc=att->getType().getFieldDescription(i); Field *field=att->getField(i); if (field && fieldDesc) { field->getValueByStr(value); l = strlen( fieldDesc->getName().str() ); for (i = 0; i < l; i++) *dest++ = fieldDesc->getName().str()[i]; *dest++ = 0; l = value.length(); for (i = 0; i < l; i++) *dest++ = value[i]; *dest++ = 0; } else { FFATAL (("Invalid Attachment in ImageFileType::store()\n")); } } } */ FDEBUG (( "Store image data: %lu (%lu/%lu/%lu)\n", headSize + dataSize + attachmentSize, headSize, dataSize, attachmentSize )); } else { FFATAL (("Invalid buffer in ImageFileType::store()\n")); } return (headSize + dataSize + attachmentSize); }

UInt64 ImageFileType::maxBufferSize (  const ImagePtr &  image  )  [virtual, inherited]

Returns the max buffer size needed to store the Image (Head + mimeType specific data block) Definition at line 430 of file OSGImageFileType.cpp. References FINFO. Referenced by osg::ClusterViewBuffer::send(), and osg::ImageFileHandler::store(). { std::string value; unsigned long size, attachmentSize; unsigned long imageSize = image->getSize(), headSize = sizeof(Head); std::map<std::string, std::string>::const_iterator aI; attachmentSize = 0; // get attachment size /* ImageGenericAttPtr att=ImageGenericAttPtr::dcast( const_cast<Image*>(image.getCPtr())->findAttachment( ImageGenericAtt::getClassType().getGroupId())); if(att != NullFC) { for(i = 0; i < (att->getType().getNumFieldDescs()-1); ++i) { FieldDescription *fieldDesc=att->getType().getFieldDescription(i); Field *field=att->getField(i); if (field && fieldDesc) { field->getValueByStr(value); attachmentSize += strlen( fieldDesc->getName().str() ) + 1; attachmentSize += value.length() + 1; } else { FFATAL (("Invalid Attachment in ImageFileType::maxBufferSize()\n")); } } } */ size = headSize + imageSize + attachmentSize; FINFO (( "ImageFileType::maxBufferSize(): %lu (%lu/%lu/%lu)\n", size, headSize, imageSize, attachmentSize )); return size; }

UInt64 ImageFileType::restoreData (  ImagePtr &  image, const UChar8 *  buffer, Int32  memSize = -1 )  [virtual, inherited]

Abstract restore method. Should be overwriten by a concrete derived class. Tries to restore the image data from the given memblock. Reimplemented in osg::DATImageFileType, osg::JPGImageFileType, osg::MTDImageFileType, and osg::PNGImageFileType. Definition at line 193 of file OSGImageFileType.cpp. References FWARNING, and osg::ImageFileType::getMimeType(). Referenced by osg::ImageFileType::restore(). { FWARNING(("ImageXFileType::restoreData() not impl. for mimeType %s\n", getMimeType())); return 0; }

UInt64 ImageFileType::storeData (  const ImagePtr &  image, UChar8 *  buffer, Int32  memSize = -1 )  [virtual, inherited]

Abstract restore method. Should be overwriten by a concrete derived class. Tries to store the given image data to the given memblock Reimplemented in osg::DATImageFileType, osg::JPGImageFileType, osg::MTDImageFileType, and osg::PNGImageFileType. Definition at line 208 of file OSGImageFileType.cpp. References FWARNING, and osg::ImageFileType::getMimeType(). Referenced by osg::ImageFileType::store(). { FWARNING(("ImageXFileType::storeData() not impl. for mimeType %s\n", getMimeType())); return 0; }

void ImageFileType::dump (  void   )  [inherited]

The dump method just writes some object debugging info to the LOG stream Definition at line 477 of file OSGImageFileType.cpp. References osg::ImageFileType::_suffixList, osg::ImageFileType::getMimeType(), osg::LOG_DEBUG, and SLOG. { std::list<IDString>::iterator sI; SLOG << getMimeType(); if(_suffixList.empty()) { SLOG << ": Suffix: "; for(sI = _suffixList.begin(); sI != _suffixList.end(); sI++) { Log().stream(OSG::LOG_DEBUG) << sI->str() << " "; } } std::cerr << std::endl; }

---

Member Data Documentation

MNGImageFileType MNGImageFileType::_the [static, private]

Referenced by the().

---

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

• OSGMNGImageFileType.h
• OSGMNGImageFileType.cpp

---