ossimJ2kInfo Class Reference

TIFF info class. More...

#include <ossimJ2kInfo.h>

Inheritance diagram for ossimJ2kInfo:

Public Member Functions
	ossimJ2kInfo ()
	default constructor More...
virtual	~ossimJ2kInfo ()
	virtual destructor More...
virtual bool	open (const ossimFilename &file)
	open method. More...
virtual std::ostream &	print (std::ostream &out) const
	Print method. More...
Public Member Functions inherited from ossimInfoBase
	ossimInfoBase ()
	default constructor More...
virtual bool	open (std::shared_ptr< ossim::istream > &str, const std::string &connectionString)
	open method. More...
void	setProcessOverviewFlag (bool flag)
	Sets the overview flag. More...
bool	getProcessOverviewFlag () const
	Method to get the overview flag. More...
virtual bool	getKeywordlist (ossimKeywordlist &kwl) const
	Method to dump info to a keyword list. More...
virtual bool	getKeywordlist (ossimKeywordlist &kwl, ossim_uint32 entryIndex) const
	Method to dump info to a keyword list. More...
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Protected Member Functions
void	readUInt16 (ossim_uint16 &s, std::ifstream &str) const
	Initializes s reference. More...
std::ostream &	printCodMarker (std::ostream &out, const std::string &prefix, std::ifstream &str) const
	Prints 0xff52 COD_MARKER (0xff52). More...
std::ostream &	printSizMarker (std::ostream &out, const std::string &prefix, std::ifstream &str) const
	Prints 0xff51 SIZ_MARKER (0xff51). More...
std::ostream &	printSotMarker (std::ostream &out, const std::string &prefix, std::ifstream &str) const
	Prints 0xff90 SOT_MARKER (0xff90) More...
std::ostream &	printUnknownMarker (std::ostream &out, const std::string &prefix, std::ifstream &str, ossim_uint16 marker) const
	Prints unhandle segment. More...
Protected Member Functions inherited from ossimInfoBase
virtual	~ossimInfoBase ()
	virtual destructor More...
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimFilename	m_file
ossimEndian *	m_endian
Protected Attributes inherited from ossimInfoBase
bool	theOverviewFlag

Detailed Description

TIFF info class.

Encapsulates the listgeo functionality.

Definition at line 27 of file ossimJ2kInfo.h.

Constructor & Destructor Documentation

ossimJ2kInfo()

ossimJ2kInfo::ossimJ2kInfo

(

)

default constructor

Definition at line 32 of file ossimJ2kInfo.cpp.

References ossim::byteOrder(), m_endian, and OSSIM_LITTLE_ENDIAN.

   : ossimInfoBase(),
     m_file(),
     m_endian(0)
{
   // See if we need to byte swap.  J2k, JP2 boxes are big endian.
   if (ossim::byteOrder() == OSSIM_LITTLE_ENDIAN)
   {
      m_endian = new ossimEndian();
   }
}

~ossimJ2kInfo()

ossimJ2kInfo::~ossimJ2kInfo ( )

virtual

virtual destructor

Definition at line 44 of file ossimJ2kInfo.cpp.

References m_endian.

{
   if (m_endian)
   {
      delete m_endian;
      m_endian = 0;
   }
}

Member Function Documentation

open()

bool ossimJ2kInfo::open ( const ossimFilename &  file )

virtual

open method.

Parameters

file	File name to open.

Returns

true on success false on error.

Reimplemented from ossimInfoBase.

Reimplemented in ossimJp2Info.

Definition at line 53 of file ossimJ2kInfo.cpp.

References ossimString::c_str(), and readUInt16().

{
   bool result = false;

   //---
   // Open the file.
   //---
   std::ifstream str(file.c_str(), std::ios_base::binary|std::ios_base::in);
   if (str.good()) 
   {
      //---
      // Check for the Start Of Codestream (SOC) and Size (SIZ) markers which
      // are required as first and second fields in the main header.
      //---
      ossim_uint16 soc;
      ossim_uint16 siz;
      readUInt16(soc, str);
      readUInt16(siz, str);

      const ossim_uint16 SOC_MARKER = 0xff4f; // start of codestream marker
      const ossim_uint16 SIZ_MARKER = 0xff51; // size maker
      
      if ( (soc == SOC_MARKER) && (siz == SIZ_MARKER) )
      {
         result = true; // Is a j2k...
      }
   }

   if (result)
   {
      
      m_file = file;
   }
   else
   {
      m_file.clear();
      if (m_endian)
      {
         delete m_endian;
         m_endian = 0;
      }
   }

   return result;
}

print()

std::ostream & ossimJ2kInfo::print ( std::ostream &  out ) const

virtual

Print method.

Parameters

out	Stream to print to.

Returns

std::ostream&

Implements ossimInfoBase.

Reimplemented in ossimJp2Info.

Definition at line 99 of file ossimJ2kInfo.cpp.

{
   static const char MODULE[] = "ossimJ2kInfo::print";

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << MODULE << " DEBUG Entered...\n";
   }

   if ( m_file.size() )
   {  
      // Open the file.
      std::ifstream str(m_file.c_str(), std::ios_base::binary|std::ios_base::in);
      if (str.good())
      {
         ossim_uint16 marker;
         readUInt16(marker, str); // SOC
         readUInt16(marker, str); // SIZ
         
         std::string prefix = "j2k.";
         
         // SIZ marker required next.
         printSizMarker(out, prefix, str);
         
         readUInt16(marker, str);

         const ossim_uint16 COD_MARKER = 0xff52; // cod maker
         const ossim_uint16 EOC_MARKER = 0xffd9; // End of codestream marker.
         const ossim_uint16 SOT_MARKER = 0xff90; // start of tile marker
         
         while ( str.good() && (marker != EOC_MARKER) )
         {
            switch(marker)
            {
               case COD_MARKER:
               {
                  printCodMarker(out, prefix, str);
                  break;
               }
               case SOT_MARKER:
               {
                  printSotMarker(out, prefix, str);
                  break;
               }
               default:
               {
                  printUnknownMarker(out, prefix, str, marker);
               }
            }
            
            readUInt16(marker, str);
            
         }
      }
   }

   return out;
}

printCodMarker()

std::ostream & ossimJ2kInfo::printCodMarker ( std::ostream &  out, const std::string &  prefix, std::ifstream &  str  ) const

protected

Prints 0xff52 COD_MARKER (0xff52).

Parameters

out	Stream to output to.
prefix	This will be prepended to key. e.g. Where prefix = "j2k." and key is "file_name" key becomes: "j2k.file_name:"
str	Input stream to pass to j2k record for parsing. Should be just pass the marker.

Returns

output stream.

Definition at line 168 of file ossimJ2kInfo.cpp.

References ossimJ2kCodRecord::parseStream(), and ossimJ2kCodRecord::print().

{
   ossimJ2kCodRecord siz;
   siz.parseStream(str);
   siz.print(out, prefix);
   return out;
}

printSizMarker()

std::ostream & ossimJ2kInfo::printSizMarker ( std::ostream &  out, const std::string &  prefix, std::ifstream &  str  ) const

protected

Prints 0xff51 SIZ_MARKER (0xff51).

Parameters

out	Stream to output to.
prefix	This will be prepended to key. e.g. Where prefix = "j2k." and key is "file_name" key becomes: "j2k.file_name:"
str	Input stream to pass to j2k record for parsing. Should be just pass the marker.

Returns

output stream.

Definition at line 178 of file ossimJ2kInfo.cpp.

References ossimJ2kSizRecord::parseStream(), and ossimJ2kSizRecord::print().

{
   ossimJ2kSizRecord siz;
   siz.parseStream(str);
   siz.print(out, prefix);
   return out;
}

printSotMarker()

std::ostream & ossimJ2kInfo::printSotMarker ( std::ostream &  out, const std::string &  prefix, std::ifstream &  str  ) const

protected

Prints 0xff90 SOT_MARKER (0xff90)

Parameters

out	Stream to output to.
prefix	This will be prepended to key. e.g. Where prefix = "j2k." and key is "file_name" key becomes: "j2k.file_name:"
str	Input stream to pass to j2k record for parsing. Should be just pass the marker.

Returns

output stream.

Definition at line 188 of file ossimJ2kInfo.cpp.

References ossimJ2kSotRecord::parseStream(), ossimJ2kSotRecord::print(), and ossimJ2kSotRecord::thePsot.

{
   // Get the stream posistion.
   std::streamoff pos = str.tellg();
   
   ossimJ2kSotRecord sot;
   sot.parseStream(str);
   pos += sot.thePsot - 2;

   // Seek past the tile to the next marker.
   str.seekg(pos, std::ios_base::beg);
   
   sot.print(out,prefix);
   return out;
}

printUnknownMarker()

std::ostream & ossimJ2kInfo::printUnknownMarker ( std::ostream &  out, const std::string &  prefix, std::ifstream &  str, ossim_uint16  marker  ) const

protected

Prints unhandle segment.

This will only print the marker and record length.

Parameters

out	Stream to output to.
prefix	This will be prepended to key. e.g. Where prefix = "j2k." and key is "file_name" key becomes: "j2k.file_name:"
str	Input stream to pass to j2k record for parsing. Should be just pass the marker.
marker.	The marker.

Returns

output stream.

Definition at line 207 of file ossimJ2kInfo.cpp.

References readUInt16().

{
   // Capture the original flags.
   std::ios_base::fmtflags f = out.flags();

   ossim_uint16 segmentLength;
   readUInt16(segmentLength, str);

   std::string pfx = prefix;
   pfx += "unknown.";

   out.setf(std::ios_base::hex, std::ios_base::basefield);
   out << pfx << "marker: 0x" << std::setfill('0') << std::setw(4)
       << marker << "\n";
   out.setf(std::ios_base::fmtflags(0), std::ios_base::basefield);
   
   out << pfx << "length: " << segmentLength
       << std::endl;

   // Reset flags.
   out.setf(f);

   // Seek to the next marker.
   str.seekg( (segmentLength-2), std::ios_base::cur);

   return out;
}

readUInt16()

void ossimJ2kInfo::readUInt16 ( ossim_uint16 &  s, std::ifstream &  str  ) const

protected

Initializes s reference.

Does byte swapping as needed.

Definition at line 159 of file ossimJ2kInfo.cpp.

References m_endian, and ossimEndian::swap().

Referenced by open(), and printUnknownMarker().

{
   str.read((char*)&s, 2);
   if (m_endian)
   {
      m_endian->swap(s);
   }
}

Member Data Documentation

m_endian

ossimEndian* ossimJ2kInfo::m_endian

protected

Definition at line 121 of file ossimJ2kInfo.h.

Referenced by ossimJ2kInfo(), readUInt16(), ossimJp2Info::readUInt32(), ossimJp2Info::readUInt64(), and ~ossimJ2kInfo().

m_file

ossimFilename ossimJ2kInfo::m_file

protected

Definition at line 120 of file ossimJ2kInfo.h.

Referenced by ossimJp2Info::getBox(), ossimJp2Info::open(), and ossimJp2Info::print().

---

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

• ossimJ2kInfo.h
• ossimJ2kInfo.cpp