nn::jpeg::CTR::JpegMpEncoder Class

Header file: nn/jpeg.h

Syntax

class JpegMpEncoder : private ADLFireWall::NonCopyable

Description

This class performs JPEG encoding.

Member Functions

Initialization/Termination
S GetWorkBufferSize Calculates the number of bytes in the work buffer for the encoder object.
JpegMpEncoder Constructs an encoder object.
Initialize Initializes the encoder object.
Finalize Finalizes the encoder object.
~JpegMpEncoder Destructor. Calls Finalize.
Settings Prior to Encoding
SetThumbnailSize Specifies the thumbnail image size and output format.
SetInputBufferWidth Sets the width of the input image buffer.
SetOption Specifies JPEG encoding options.
GetOption Gets the specified encoding options.
Exif Information Registration
S GetDateTimeNow Gets the current date and time and creates a string that can be used as the argument value in a call to SetDateTime.
SetDateTime Registers the date and time the photo was taken for embedding in the JPEG file.
SetSoftware Registers the software name to embed in the Exif IFD of a JPEG file.
SetUserMakerNote Registers various pieces of data to embed in the MakerNote part of a JPEG file.
SetImageUid Registers the unique image ID to embed in the Exif IFD of a JPEG file.
SetOrientation Registers the image orientation to embed in the Exif IFD of a JPEG file.
ClearOrientation Specifies not to embed the image orientation in the JPEG Exif IFD (default operation).
MP Entry Information Registration
SetMpTypeFlags Registers values to embed in the MP entry: the various flags for the individual image type management data and the dependent image entry number.
Storing IFD Information by MP Attribute
SetMpIndividualNum Registers the individual image number to embed in the MP Attribute IFD.
ClearMpIndividualNum Resets the individual image number to embed in the MP Attribute IFD to the default value.
SetMpPanOrientation Registers the image placement to embed in the MP Attribute IFD.
ClearMpPanOrientation Instructs not to embed image location in the MP Attribute IFD (default operation).
SetMpPanOverlapH Registers the horizontal overlap to embed in the MP Attribute IFD.
ClearMpPanOverlapH Instructs not to embed horizontal overlap in the MP Attribute IFD (default operation).
SetMpPanOverlapV Registers the vertical overlap to embed in the MP Attribute IFD.
ClearMpPanOverlapV Instructs not to embed vertical overlap in the MP Attribute IFD. (Default behavior.)
SetMpBaseViewpointNum Registers the base viewpoint number to embed in the MP Attribute IFD.
ClearMpBaseViewpointNum Resets the base viewpoint number to embed in the MP Attribute IFD to the default value.
SetMpConvergenceAngle Registers the convergence angle to embed in the MP Attribute IFD.
ClearMpConvergenceAngle Resets the convergence angle to embed in the MP Attribute IFD to the default value.
SetMpBaselineLength Registers the baseline length to embed in the MP Attribute IFD.
ClearMpBaselineLength Resets the baseline length to embed in the MP Attribute IFD to the default value.
SetMpVerticalDivergence Registers the vertical divergence to embed in the MP Attribute IFD.
ClearMpVerticalDivergence Instructs not to embed horizontal overlap in the MP Attribute IFD (default operation).
SetMpAxisDistanceX Registers the horizontal (X-axis) distance to embed in the MP Attribute IFD.
ClearMpAxisDistanceX Instructs the system not to embed horizontal (X-axis) distance in the MP Attribute IFD.
SetMpAxisDistanceY Registers the vertical (Y-axis) distance to embed in the MP Attribute IFD.
ClearMpAxisDistanceY Instructs the system not to embed vertical (Y-axis) distance in the MP Attribute IFD (default operation).
SetMpAxisDistanceZ Registers the line-of-sight (Z-axis) distance to embed in the MP Attribute IFD.
ClearMpAxisDistanceZ Instructs the system not to embed depth (Z-axis) distance in the MP Attribute IFD.
SetMpYawAngle Registers the yaw angle to embed in the MP Attribute IFD.
ClearMpYawAngle Instructs not to embed image location in the MP Attribute IFD (default operation).
SetMpPitchAngle Registers the pitch angle to embed in the MP Attribute IFD.
ClearMpPitchAngle Instructs not to embed image location in the MP Attribute IFD (default operation).
SetMpRollAngle Registers the roll angle to embed in the MP Attribute IFD.
ClearMpRollAngle Instructs not to embed image location in the MP Attribute IFD (default operation).
Registering GPS_IFD Information
S InitializeGpsData Specifies the GPS IFD structure used for storing GPS data.
S SetGpsVersionId Stores the GPS tag version in GPS IFD.
S ClearGpsVersionId By default, GPS IFD is instructed not to record the GPS tag version.
S SetGpsLatitude Stores latitude in the GPS IFD.
S ClearGpsLatitude By default, GPS IFD is instructed not to record the latitude.
S SetGpsLongitude Stores longitude in the GPS IFD.
S ClearGpsLongitude By default, GPS IFD is instructed not to record the longitude.
S SetGpsAltitude Stores altitude in the GPS IFD.
S ClearGpsAltitude By default, GPS IFD is instructed not to record altitude.
S SetGpsTimeStamp Stores the GPS time stamp (atomic clock time) in GPS IFD.
S ClearGpsTimeStamp By default, GPS IFD is instructed not to record GPS time (atomic clock time).
S SetGpsSatellites Stores the satellite signal used for positioning in the GPS IFD.
S ClearGpsSatellites By default, GPS IFD is instructed not to record the satellite signal.
S SetGpsStatus Stores GPS receiver status in GPS IFD.
S ClearGpsStatus By default, GPS IFD is instructed not to record GPS receiver status.
S SetGpsMeasureMode Stores the GPS positioning method in GPS IFD.
S ClearGpsMeasureMode By default, GPS IFD is instructed not to record the GPS positioning method.
S SetGpsDop Stores the dependability of positioning in GPS IFD.
S ClearGpsDop By default, GPS IFD is instructed not to record the dependability of positioning.
S SetGpsSpeed Stores velocity in the GPS IFD.
S ClearGpsSpeed By default, GPS IFD is instructed not to record the velocity.
S SetGpsTrack Stores the tracking direction in the GPS IFD.
S ClearGpsTrack By default, GPS IFD is instructed not to record the tracking direction.
S SetGpsImgDirection Stores the orientation of the captured image in the GPS IFD.
S ClearGpsImgDirection By default, GPS IFD is instructed not to record the orientation of the captured image.
S SetGpsMapDatum Stores the map data used for positioning in the GPS IFD.
S ClearGpsMapDatum By default, GPS IFD is instructed not to record the map data used for positioning.
S SetGpsDestLatitude Stores the latitude of the destination in the GPS IFD.
S ClearGpsDestLatitude By default, GPS IFD is instructed not to record the latitude of the destination.
S SetGpsDestLongitude Stores the latitude of the destination in the GPS IFD.
S ClearGpsDestLongitude By default, GPS IFD is instructed not to record the longitude of the destination.
S SetGpsDestBearing Stores the destination bearing in the GPS IFD.
S ClearGpsDestBearing By default, GPS IFD is instructed not to record the destination bearing.
S SetGpsDestDistance Stores the distance to the destination in the GPS IFD.
S ClearGpsDestDistance By default, GPS IFD is instructed not to record the distance to the destination.
S SetGpsProcessingMethod Stores the GPS positioning method in GPS IFD.
S ClearGpsProcessingMethod By default, GPS IFD is instructed not to record the name of the positioning system.
S SetGpsAreaInformation Stores the GPS positioning method in GPS IFD.
S ClearGpsAreaInformation By default, GPS IFD is instructed not to record the place name of the detected location.
S SetGpsDateStamp Stores the GPS date stamp in the GPS IFD.
S ClearGpsDateStamp By default, GPS IFD is instructed not to record the GPS date-time stamp.
S SetGpsDifferential Stores the GPS differential in GPS IFD.
S ClearGpsDifferential By default, GPS IFD is instructed not to record the GPS differential.
SetGpsData Embeds GPS_IFD in JPEG.
ClearGpsData By default, JPEG is instructed not to imbed GPS IFD.
Encoding
StartJpegEncoder Runs the JPEG encoder.
StartMpEncoderLR Runs the JPEG encoder on two images and stores the results in Extended MP format (for stereoscopic display).
StartMpEncoderFirst JPEG-encodes an image and stores it as the starting image in MP format.
StartMpEncoderNext JPEG-encodes an image and appends it to the encoded results from the immediately previous call to either StartMpEncoderFirst or this function.
GetMpRegionsToBuildJpegData Gets the memory region information for reconstructing JPEG data from the encoded results of the immediately previous call to the StartMpEncoderFirst, StartMpEncoderNext, or StartMpEncoderLR function.
GetLastError Gets the cause of the error generated by the immediately previous call to the StartMpEncoderFirst, StartMpEncoderNext, or StartMpEncoderLR functions.

Class Hierarchy

ADLFireWall::NonCopyable
  nn::jpeg::CTR::JpegMpEncoder

Revision History

2010/10/21
Added a description of functions used to store GPS information. Organized the descriptions of member functions into separate categories.
2010/04/14
Initial version.

CONFIDENTIAL