osg::JPGImageFileType Class Reference
[Image]

JPEG File Handler. Used to read/write JPEG files. See Image for a detailed description. More...

#include <OSGJPGImageFileType.h>

Inheritance diagram for osg::JPGImageFileType:

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 Member Functions
Destructor
*virtual	~JPGImageFileType (void)
Get Method
*void	setQuality (UInt32 cl)
UInt32	getQuality (void)
Read/Write
*virtual bool	read (ImagePtr &image, const Char8 *fileName)
virtual bool	write (const ImagePtr &image, const Char8 *fileName)
virtual bool	validateHeader (const Char8 *fileName, bool &implemented)
Buffer
*virtual UInt64	restoreData (ImagePtr &image, const UChar8 *buffer, Int32 memSize=-1)
virtual UInt64	storeData (const ImagePtr &image, UChar8 *buffer, Int32 memSize=-1)
Static Public Member Functions
Get Method
*static JPGImageFileType &	the (void)
Protected Member Functions
Default Constructor
*	JPGImageFileType (const Char8 *mimeType, const Char8 *suffixArray[], UInt16 suffixByteCount, UInt32 flags)
Copy Constructor
*	JPGImageFileType (const JPGImageFileType &obj)
Private Types
typedef ImageFileType	Inherited
Private Attributes
UInt32	_quality
Static Private Attributes
static JPGImageFileType	_the

---

Detailed Description

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

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

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

Definition at line 55 of file OSGJPGImageFileType.h.

---

Member Typedef Documentation

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

Definition at line 128 of file OSGJPGImageFileType.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

JPGImageFileType::~JPGImageFileType (  void   )  [virtual]

Destructor Definition at line 625 of file OSGJPGImageFileType.cpp. { return; }

JPGImageFileType::JPGImageFileType (  const Char8 *  mimeType, const Char8 *  suffixArray[], UInt16  suffixByteCount, UInt32  flags )  [protected]

Constructor used for the singleton object Definition at line 600 of file OSGJPGImageFileType.cpp. : ImageFileType(mimeType, suffixArray, suffixByteCount, flags), _quality(90) { return; }

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

Dummy Copy Constructor Definition at line 614 of file OSGJPGImageFileType.cpp. : ImageFileType(obj), _quality(obj._quality) { return; }

---

Member Function Documentation

void JPGImageFileType::setQuality (  UInt32  cl  )

Definition at line 216 of file OSGJPGImageFileType.cpp. References _quality. { if(cl > 100) cl = 100; _quality = cl; }

UInt32 JPGImageFileType::getQuality (  void   )

Definition at line 224 of file OSGJPGImageFileType.cpp. References _quality. { return _quality; }

bool JPGImageFileType::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 234 of file OSGJPGImageFileType.cpp. References osg::ImageFileType::getMimeType(), osg::Image::OSG_INVALID_PF, osg::Image::OSG_L_PF, osg::Image::OSG_LA_PF, osg::Image::OSG_RGB_PF, osg::Image::OSG_RGBA_PF, and SWARNING. { #ifdef OSG_WITH_JPG bool retCode = false; struct local_error_mgr { struct jpeg_error_mgr pub; jmp_buf setjmp_buffer; }; unsigned char *destData; Image::PixelFormat pixelFormat = osg::Image::OSG_INVALID_PF; unsigned long imageSize; typedef struct local_error_mgr *local_error_ptr; struct local_error_mgr jerr; struct jpeg_decompress_struct cinfo; FILE *infile; JSAMPARRAY buffer; int row_stride; if((infile = fopen(fileName, "rb"))) { cinfo.err = jpeg_std_error(&jerr.pub); if(setjmp(jerr.setjmp_buffer)) { jpeg_destroy_decompress(&cinfo); fclose(infile); return retCode; } jpeg_create_decompress(&cinfo); jpeg_stdio_src(&cinfo, infile); jpeg_read_header(&cinfo, TRUE); jpeg_start_decompress(&cinfo); switch(cinfo.output_components) { case 1: pixelFormat = Image::OSG_L_PF; break; case 2: pixelFormat = Image::OSG_LA_PF; break; case 3: pixelFormat = Image::OSG_RGB_PF; break; case 4: pixelFormat = Image::OSG_RGBA_PF; break; }; if(image->set(pixelFormat, cinfo.output_width, cinfo.output_height)) { imageSize = image->getSize(); destData = image->getData() + imageSize; row_stride = cinfo.output_width * cinfo.output_components; buffer = (*cinfo.mem->alloc_sarray) ((j_common_ptr) & cinfo, JPOOL_IMAGE, row_stride, 1); while(cinfo.output_scanline < cinfo.output_height) { destData -= row_stride; jpeg_read_scanlines(&cinfo, buffer, 1); memcpy(destData, *buffer, row_stride); } retCode = true; } else retCode = false; jpeg_finish_decompress(&cinfo); jpeg_destroy_decompress(&cinfo); fclose(infile); } return retCode; #else SWARNING << getMimeType() << " read is not compiled into the current binary " << std::endl; return false; #endif }

bool JPGImageFileType::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 327 of file OSGJPGImageFileType.cpp. References _quality, osg::ImageFileType::getMimeType(), and SWARNING. { #ifdef OSG_WITH_JPG if((image->getBpp() != 1 && image->getBpp() != 3) || image->getDepth() != 1) { SWARNING << getMimeType() << " JPEG write only works for 2D 1 or 3 bpp images " << std::endl; return false; } bool retCode = false; struct local_error_mgr { struct jpeg_error_mgr pub; jmp_buf setjmp_buffer; }; typedef struct local_error_mgr *local_error_ptr; struct local_error_mgr jerr; struct jpeg_compress_struct cinfo; FILE *outfile; JSAMPARRAY buffer; UChar8 *data; if((outfile = fopen(fileName, "wb")) == NULL) { fprintf(stderr, "can't open %s\n", fileName); return retCode; } cinfo.err = jpeg_std_error(&jerr.pub); if(setjmp(jerr.setjmp_buffer)) { jpeg_destroy_compress(&cinfo); fclose(outfile); return 0; } jpeg_create_compress(&cinfo); jpeg_stdio_dest(&cinfo, outfile); cinfo.image_width = image->getWidth(); cinfo.image_height = image->getHeight(); cinfo.input_components = image->getBpp(); cinfo.in_color_space = (image->getBpp() == 1) ? JCS_GRAYSCALE : JCS_RGB; jpeg_set_defaults(&cinfo); jpeg_set_quality(&cinfo, _quality, TRUE); jpeg_start_compress(&cinfo, TRUE); buffer = &data; while(cinfo.next_scanline < cinfo.image_height) { data = image->getData() + (image->getHeight() - 1 - cinfo.next_scanline) * image->getWidth() * image->getBpp(); jpeg_write_scanlines(&cinfo, buffer, 1); } jpeg_finish_compress(&cinfo); jpeg_destroy_compress(&cinfo); fclose(outfile); return true; #else SWARNING << getMimeType() << " write is not compiled into the current binary " << std::endl; return false; #endif }

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

Tries to fill the image object with the data read from the given fileName. Returns true on success. Reimplemented from osg::ImageFileType. Definition at line 408 of file OSGJPGImageFileType.cpp. { implemented = true; if(fileName == NULL) return false; FILE *file = fopen(fileName, "rb"); if(file == NULL) return false; UInt16 magic = 0; fread((void *) &magic, sizeof(magic), 1, file); fclose(file); #if BYTE_ORDER == LITTLE_ENDIAN if(magic == 0xd8ff) // the magic header is big endian need to swap it. #else if(magic == 0xffd8) #endif { return true; } return false; }

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

Abstract restore method. Should be overwriten by a concrete derived class. Tries to restore the image data from the given memblock. Reimplemented from osg::ImageFileType. Definition at line 437 of file OSGJPGImageFileType.cpp. References osg::ImageFileType::getMimeType(), osg::Image::OSG_INVALID_PF, osg::Image::OSG_L_PF, osg::Image::OSG_LA_PF, osg::Image::OSG_RGB_PF, osg::Image::OSG_RGBA_PF, and SWARNING. { #ifdef OSG_WITH_JPG UInt64 retCode = 0; struct local_error_mgr { struct jpeg_error_mgr pub; jmp_buf setjmp_buffer; }; unsigned char *destData; Image::PixelFormat pixelFormat = osg::Image::OSG_INVALID_PF; unsigned long imageSize; typedef struct local_error_mgr *local_error_ptr; struct local_error_mgr jerr; struct jpeg_decompress_struct cinfo; JSAMPARRAY imagebuffer; int row_stride; cinfo.err = jpeg_std_error(&jerr.pub); if(setjmp(jerr.setjmp_buffer)) { jpeg_destroy_decompress(&cinfo); return 0; } jpeg_create_decompress(&cinfo); jpeg_memory_src(&cinfo, buffer, memSize); jpeg_read_header(&cinfo, TRUE); jpeg_start_decompress(&cinfo); switch(cinfo.output_components) { case 1: pixelFormat = Image::OSG_L_PF; break; case 2: pixelFormat = Image::OSG_LA_PF; break; case 3: pixelFormat = Image::OSG_RGB_PF; break; case 4: pixelFormat = Image::OSG_RGBA_PF; break; }; if(image->set(pixelFormat, cinfo.output_width, cinfo.output_height)) { imageSize = image->getSize(); destData = image->getData() + imageSize; row_stride = cinfo.output_width * cinfo.output_components; imagebuffer = (*cinfo.mem->alloc_sarray) ((j_common_ptr) & cinfo, JPOOL_IMAGE, row_stride, 1); while(cinfo.output_scanline < cinfo.output_height) { destData -= row_stride; jpeg_read_scanlines(&cinfo, imagebuffer, 1); memcpy(destData, *imagebuffer, row_stride); } retCode = imageSize; } else retCode = 0; jpeg_finish_decompress(&cinfo); jpeg_destroy_decompress(&cinfo); return retCode; #else SWARNING << getMimeType() << " read is not compiled into the current binary " << std::endl; return 0; #endif }

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

Tries to restore the image data from the given memblock. Returns the amount of data read. Reimplemented from osg::ImageFileType. Definition at line 525 of file OSGJPGImageFileType.cpp. References _quality, osg::ImageFileType::getMimeType(), and SWARNING. { #ifdef OSG_WITH_JPG if((image->getBpp() != 1 && image->getBpp() != 3) || image->getDepth() != 1) { SWARNING << getMimeType() << " JPEG storeData only works for 2D 1 or 3 bpp images " << std::endl; return 0; } struct local_error_mgr { struct jpeg_error_mgr pub; jmp_buf setjmp_buffer; }; typedef struct local_error_mgr *local_error_ptr; struct local_error_mgr jerr; struct jpeg_compress_struct cinfo; JSAMPARRAY imagebuffer; UChar8 *data; cinfo.err = jpeg_std_error(&jerr.pub); if(setjmp(jerr.setjmp_buffer)) { jpeg_destroy_compress(&cinfo); return 0; } jpeg_create_compress(&cinfo); jpeg_memory_dest(&cinfo, buffer, memSize); cinfo.image_width = image->getWidth(); cinfo.image_height = image->getHeight(); cinfo.input_components = image->getBpp(); cinfo.in_color_space = (image->getBpp() == 1) ? JCS_GRAYSCALE : JCS_RGB; jpeg_set_defaults(&cinfo); jpeg_set_quality(&cinfo, _quality, TRUE); jpeg_start_compress(&cinfo, TRUE); imagebuffer = &data; while(cinfo.next_scanline < cinfo.image_height) { data = image->getData() + (image->getHeight() - 1 - cinfo.next_scanline) * image->getWidth() * image->getBpp(); jpeg_write_scanlines(&cinfo, imagebuffer, 1); } jpeg_finish_compress(&cinfo); jpeg_destroy_compress(&cinfo); return jpeg_mem.dataSize; #else SWARNING << getMimeType() << " write is not compiled into the current binary " << std::endl; return 0; #endif }

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

Class method to get the singleton Object Definition at line 207 of file OSGJPGImageFileType.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(), osg::MNGImageFileType::read(), read(), osg::ImageFileHandler::read(), osg::PNGImageFileType::restoreData(), restoreData(), osg::ImageFileType::restoreData(), osg::ImageFileType::store(), osg::ImageFileHandler::store(), osg::PNGImageFileType::storeData(), storeData(), osg::ImageFileType::storeData(), osg::TIFImageFileType::write(), osg::TGAImageFileType::write(), osg::PNGImageFileType::write(), osg::MNGImageFileType::write(), 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; }

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; }

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

UInt32 osg::JPGImageFileType::_quality [private]

Definition at line 130 of file OSGJPGImageFileType.h. Referenced by getQuality(), setQuality(), storeData(), and write().

JPGImageFileType JPGImageFileType::_the [static, private]

Referenced by the().

---

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

• OSGJPGImageFileType.h
• OSGJPGImageFileType.cpp

---