digiKam
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Digikam::DImgLoader Class Referenceabstract
+ Inheritance diagram for Digikam::DImgLoader:

Public Types

enum  LoadFlag {
  LoadItemInfo = 1 , LoadMetadata = 2 , LoadICCData = 4 , LoadImageData = 8 ,
  LoadUniqueHash = 16 , LoadImageHistory = 32 , LoadPreview = 64 , LoadAll = LoadItemInfo | LoadMetadata | LoadICCData | LoadImageData | LoadUniqueHash | LoadImageHistory
}
 

Public Member Functions

virtual bool hasAlpha () const =0
 
virtual bool hasLoadedData () const
 
virtual bool isReadOnly () const =0
 
virtual bool load (const QString &filePath, DImgLoaderObserver *const observer)=0
 
template<typename Type >
Q_INLINE_TEMPLATE Type * new_failureTolerant (quint64 w, quint64 h, uint typesPerPixel)
 
template<typename Type >
Q_INLINE_TEMPLATE Type * new_failureTolerant (size_t size)
 
virtual bool save (const QString &filePath, DImgLoaderObserver *const observer)=0
 
void setLoadFlags (LoadFlags flags)
 
virtual bool sixteenBit () const =0
 
virtual ~DImgLoader ()
 

Static Public Member Functions

static qint64 checkAllocation (qint64 fullSize)
 
static unsigned char * new_failureTolerant (quint64 w, quint64 h, uint typesPerPixel)
 
template<typename Type >
static Type * new_failureTolerant (quint64 w, quint64 h, uint typesPerPixel)
 
static unsigned char * new_failureTolerant (size_t unsecureSize)
 
template<typename Type >
static Type * new_failureTolerant (size_t unsecureSize)
 
static unsigned short * new_short_failureTolerant (quint64 w, quint64 h, uint typesPerPixel)
 
static unsigned short * new_short_failureTolerant (size_t unsecureSize)
 

Protected Member Functions

bool checkExifWorkingColorSpace () const
 
 DImgLoader (DImg *const image)
 
virtual int granularity (DImgLoaderObserver *const observer, int total, float progressSlice=1.0F)
 
int imageBitsDepth () const
 
int imageBytesDepth () const
 
unsigned char *& imageData ()
 
QMap< QString, QString > & imageEmbeddedText () const
 
QVariant imageGetAttribute (const QString &key) const
 
QString imageGetEmbbededText (const QString &key) const
 
bool imageHasAlpha () const
 
unsigned int & imageHeight ()
 
quint64 imageNumBytes () const
 
void imageSetAttribute (const QString &key, const QVariant &value)
 
void imageSetEmbbededText (const QString &key, const QString &text)
 
void imageSetIccProfile (const IccProfile &profile)
 
bool imageSixteenBit () const
 
unsigned int & imageWidth ()
 
void loadingFailed ()
 
void purgeExifWorkingColorSpace ()
 
virtual bool readMetadata (const QString &filePath)
 
virtual bool saveMetadata (const QString &filePath)
 
void storeColorProfileInMetadata ()
 

Protected Attributes

DImg * m_image
 
LoadFlags m_loadFlags
 

Member Enumeration Documentation

◆ LoadFlag

enum Digikam::DImgLoader::LoadFlag

This is the list of loading modes usable by DImg image plugins

Enumerator
LoadItemInfo 

Load image information without image data.

Image info as width and height

LoadMetadata 

Image metadata.

LoadICCData 

Image color profile.

LoadImageData 

Full image data.

LoadUniqueHash 

Image unique hash.

LoadImageHistory 

Image version history.

LoadPreview 

Special mode to load reduced image data.

Load embedded preview image instead full size image

LoadAll 

Helper to load all information, metadata and full image.

Constructor & Destructor Documentation

◆ ~DImgLoader()

Digikam::DImgLoader::~DImgLoader ( )
virtual

◆ DImgLoader()

Digikam::DImgLoader::DImgLoader ( DImg *const  image)
explicitprotected

Member Function Documentation

◆ checkAllocation()

qint64 Digikam::DImgLoader::checkAllocation ( qint64  fullSize)
static

Value returned : -1 : unsupported platform 0 : parse failure from supported platform 1 : parse done with success from supported platform

References Digikam::KMemoryInfo::AvailableMemory, Digikam::KMemoryInfo::bytes(), Digikam::KMemoryInfo::currentInfo(), and Digikam::KMemoryInfo::isValid().

Referenced by new_failureTolerant().

◆ checkExifWorkingColorSpace()

bool Digikam::DImgLoader::checkExifWorkingColorSpace ( ) const
protected

References Digikam::DImg::getMetadata(), Digikam::IccProfile::isNull(), m_image, and Digikam::DImg::setIccProfile().

Referenced by DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::load().

◆ granularity()

int Digikam::DImgLoader::granularity ( DImgLoaderObserver *const  observer,
int  total,
float  progressSlice = 1.0F 
)
protectedvirtual

References Digikam::DImgLoaderObserver::granularity().

Referenced by DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), DigikamTIFFDImgPlugin::DImgTIFFLoader::load(), Digikam::DImgHEIFLoader::save(), DigikamJPEGDImgPlugin::DImgJPEGLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ hasAlpha()

virtual bool Digikam::DImgLoader::hasAlpha ( ) const
pure virtual

Implemented in DigikamTIFFDImgPlugin::DImgTIFFLoader, DigikamRAWDImgPlugin::DImgRAWLoader, DigikamQImageDImgPlugin::DImgQImageLoader, DigikamPNGDImgPlugin::DImgPNGLoader, Digikam::DImgPGFLoader, DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader, DigikamJPEGDImgPlugin::DImgJPEGLoader, DigikamImageMagickDImgPlugin::DImgImageMagickLoader, and Digikam::DImgHEIFLoader.

Referenced by Digikam::DImg::load().

◆ hasLoadedData()

bool Digikam::DImgLoader::hasLoadedData ( ) const
virtual

References LoadImageData, LoadPreview, m_image, and m_loadFlags.

Referenced by Digikam::DImg::load().

◆ imageBitsDepth()

int Digikam::DImgLoader::imageBitsDepth ( ) const
protected

References Digikam::DImg::bitsDepth(), and m_image.

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), Digikam::DImgPGFLoader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ imageBytesDepth()

int Digikam::DImgLoader::imageBytesDepth ( ) const
protected

References Digikam::DImg::bytesDepth(), and m_image.

Referenced by Digikam::DImgHEIFLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ imageData()

unsigned char *& Digikam::DImgLoader::imageData ( )
protected

References m_image.

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), DigikamQImageDImgPlugin::DImgQImageLoader::load(), DigikamTIFFDImgPlugin::DImgTIFFLoader::load(), Digikam::DImgHEIFLoader::save(), DigikamImageMagickDImgPlugin::DImgImageMagickLoader::save(), DigikamJPEGDImgPlugin::DImgJPEGLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), Digikam::DImgPGFLoader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ imageEmbeddedText()

QMap< QString, QString > & Digikam::DImgLoader::imageEmbeddedText ( ) const
protected

References m_image.

◆ imageGetAttribute()

QVariant Digikam::DImgLoader::imageGetAttribute ( const QString &  key) const
protected

References Digikam::DImg::attribute(), and m_image.

Referenced by DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), Digikam::DImgPGFLoader::load(), Digikam::DImgHEIFLoader::save(), DigikamImageMagickDImgPlugin::DImgImageMagickLoader::save(), DigikamJPEGDImgPlugin::DImgJPEGLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), Digikam::DImgPGFLoader::save(), DigikamQImageDImgPlugin::DImgQImageLoader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ imageGetEmbbededText()

QString Digikam::DImgLoader::imageGetEmbbededText ( const QString &  key) const
protected

References Digikam::DImg::embeddedText, and m_image.

◆ imageHasAlpha()

bool Digikam::DImgLoader::imageHasAlpha ( ) const
protected

References Digikam::DImg::hasAlpha(), and m_image.

Referenced by Digikam::DImgHEIFLoader::save(), DigikamImageMagickDImgPlugin::DImgImageMagickLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), Digikam::DImgPGFLoader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ imageHeight()

unsigned int & Digikam::DImgLoader::imageHeight ( )
protected

References m_image.

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), DigikamQImageDImgPlugin::DImgQImageLoader::load(), DigikamTIFFDImgPlugin::DImgTIFFLoader::load(), DigikamRAWDImgPlugin::DImgRAWLoader::load(), Digikam::DImgHEIFLoader::save(), DigikamImageMagickDImgPlugin::DImgImageMagickLoader::save(), DigikamJPEGDImgPlugin::DImgJPEGLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), Digikam::DImgPGFLoader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ imageNumBytes()

quint64 Digikam::DImgLoader::imageNumBytes ( ) const
protected

References m_image, and Digikam::DImg::numBytes().

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::save().

◆ imageSetAttribute()

void Digikam::DImgLoader::imageSetAttribute ( const QString &  key,
const QVariant &  value 
)
protected

References m_image, Digikam::DImg::setAttribute(), and value.

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), DigikamQImageDImgPlugin::DImgQImageLoader::load(), DigikamTIFFDImgPlugin::DImgTIFFLoader::load(), DigikamRAWDImgPlugin::DImgRAWLoader::load(), readMetadata(), DigikamImageMagickDImgPlugin::DImgImageMagickLoader::save(), DigikamJPEGDImgPlugin::DImgJPEGLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), Digikam::DImgPGFLoader::save(), DigikamQImageDImgPlugin::DImgQImageLoader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ imageSetEmbbededText()

void Digikam::DImgLoader::imageSetEmbbededText ( const QString &  key,
const QString &  text 
)
protected

References m_image, and Digikam::DImg::setEmbeddedText().

◆ imageSetIccProfile()

void Digikam::DImgLoader::imageSetIccProfile ( const IccProfile &  profile)
protected

References m_image, and Digikam::DImg::setIccProfile().

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), DigikamQImageDImgPlugin::DImgQImageLoader::load(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::load().

◆ imageSixteenBit()

bool Digikam::DImgLoader::imageSixteenBit ( ) const
protected

References m_image, and Digikam::DImg::sixteenBit.

Referenced by Digikam::DImgHEIFLoader::save(), DigikamJPEGDImgPlugin::DImgJPEGLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), Digikam::DImgPGFLoader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ imageWidth()

unsigned int & Digikam::DImgLoader::imageWidth ( )
protected

References m_image.

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), DigikamQImageDImgPlugin::DImgQImageLoader::load(), DigikamTIFFDImgPlugin::DImgTIFFLoader::load(), DigikamRAWDImgPlugin::DImgRAWLoader::load(), Digikam::DImgHEIFLoader::save(), DigikamImageMagickDImgPlugin::DImgImageMagickLoader::save(), DigikamJPEGDImgPlugin::DImgJPEGLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), Digikam::DImgPGFLoader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ isReadOnly()

virtual bool Digikam::DImgLoader::isReadOnly ( ) const
pure virtual

Implemented in DigikamTIFFDImgPlugin::DImgTIFFLoader, DigikamRAWDImgPlugin::DImgRAWLoader, DigikamQImageDImgPlugin::DImgQImageLoader, DigikamPNGDImgPlugin::DImgPNGLoader, Digikam::DImgPGFLoader, DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader, DigikamJPEGDImgPlugin::DImgJPEGLoader, DigikamImageMagickDImgPlugin::DImgImageMagickLoader, and Digikam::DImgHEIFLoader.

Referenced by Digikam::DImg::load(), and Digikam::DImg::save().

◆ load()

virtual bool Digikam::DImgLoader::load ( const QString &  filePath,
DImgLoaderObserver *const  observer 
)
pure virtual

Implemented in DigikamRAWDImgPlugin::DImgRAWLoader, DigikamTIFFDImgPlugin::DImgTIFFLoader, DigikamQImageDImgPlugin::DImgQImageLoader, DigikamPNGDImgPlugin::DImgPNGLoader, Digikam::DImgPGFLoader, DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader, DigikamJPEGDImgPlugin::DImgJPEGLoader, DigikamImageMagickDImgPlugin::DImgImageMagickLoader, and Digikam::DImgHEIFLoader.

Referenced by Digikam::DImg::load().

◆ loadingFailed()

void Digikam::DImgLoader::loadingFailed ( )
protected

References m_image.

Referenced by Digikam::DImgHEIFLoader::load(), DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), DigikamQImageDImgPlugin::DImgQImageLoader::load(), DigikamTIFFDImgPlugin::DImgTIFFLoader::load(), and DigikamRAWDImgPlugin::DImgRAWLoader::load().

◆ new_failureTolerant() [1/6]

unsigned char * Digikam::DImgLoader::new_failureTolerant ( quint64  w,
quint64  h,
uint  typesPerPixel 
)
static

◆ new_failureTolerant() [2/6]

template<typename Type >
static Type* Digikam::DImgLoader::new_failureTolerant ( quint64  w,
quint64  h,
uint  typesPerPixel 
)
static

◆ new_failureTolerant() [3/6]

template<typename Type >
Q_INLINE_TEMPLATE Type* Digikam::DImgLoader::new_failureTolerant ( quint64  w,
quint64  h,
uint  typesPerPixel 
)

Allows safe multiplication of requested pixel number and bytes per pixel, avoiding particularly 32 bits overflow and exceeding the size_t type

◆ new_failureTolerant() [4/6]

template<typename Type >
Q_INLINE_TEMPLATE Type* Digikam::DImgLoader::new_failureTolerant ( size_t  size)

References checkAllocation().

◆ new_failureTolerant() [5/6]

unsigned char * Digikam::DImgLoader::new_failureTolerant ( size_t  unsecureSize)
static

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), DigikamQImageDImgPlugin::DImgQImageLoader::load(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::load().

◆ new_failureTolerant() [6/6]

template<typename Type >
static Type* Digikam::DImgLoader::new_failureTolerant ( size_t  unsecureSize)
static

◆ new_short_failureTolerant() [1/2]

unsigned short * Digikam::DImgLoader::new_short_failureTolerant ( quint64  w,
quint64  h,
uint  typesPerPixel 
)
static

◆ new_short_failureTolerant() [2/2]

unsigned short * Digikam::DImgLoader::new_short_failureTolerant ( size_t  unsecureSize)
static

◆ purgeExifWorkingColorSpace()

void Digikam::DImgLoader::purgeExifWorkingColorSpace ( )
protected

References Digikam::DImg::getMetadata(), m_image, and Digikam::DImg::setMetadata().

Referenced by DigikamJPEGDImgPlugin::DImgJPEGLoader::save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ readMetadata()

bool Digikam::DImgLoader::readMetadata ( const QString &  filePath)
protectedvirtual

References Digikam::DImg::createHistoryImageId(), Digikam::HistoryImageId::Current, Digikam::DImageHistory::fromXml(), imageSetAttribute(), LoadImageHistory, LoadMetadata, LoadUniqueHash, m_image, m_loadFlags, Digikam::DImg::setItemHistory(), and Digikam::DImg::setMetadata().

Referenced by Digikam::DImgHEIFLoader::load(), DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), DigikamQImageDImgPlugin::DImgQImageLoader::load(), DigikamTIFFDImgPlugin::DImgTIFFLoader::load(), and DigikamRAWDImgPlugin::DImgRAWLoader::load().

◆ save()

virtual bool Digikam::DImgLoader::save ( const QString &  filePath,
DImgLoaderObserver *const  observer 
)
pure virtual

Implemented in DigikamTIFFDImgPlugin::DImgTIFFLoader, DigikamQImageDImgPlugin::DImgQImageLoader, DigikamPNGDImgPlugin::DImgPNGLoader, Digikam::DImgPGFLoader, DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader, DigikamJPEGDImgPlugin::DImgJPEGLoader, DigikamImageMagickDImgPlugin::DImgImageMagickLoader, Digikam::DImgHEIFLoader, and DigikamRAWDImgPlugin::DImgRAWLoader.

Referenced by Digikam::DImg::save().

◆ saveMetadata()

bool Digikam::DImgLoader::saveMetadata ( const QString &  filePath)
protectedvirtual

References Digikam::DImg::getMetadata(), and m_image.

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::save(), DigikamJPEGDImgPlugin::DImgJPEGLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), Digikam::DImgPGFLoader::save(), and DigikamQImageDImgPlugin::DImgQImageLoader::save().

◆ setLoadFlags()

void Digikam::DImgLoader::setLoadFlags ( LoadFlags  flags)

References m_loadFlags.

Referenced by Digikam::DImg::load().

◆ sixteenBit()

virtual bool Digikam::DImgLoader::sixteenBit ( ) const
pure virtual

Implemented in DigikamTIFFDImgPlugin::DImgTIFFLoader, DigikamRAWDImgPlugin::DImgRAWLoader, DigikamQImageDImgPlugin::DImgQImageLoader, DigikamPNGDImgPlugin::DImgPNGLoader, Digikam::DImgPGFLoader, DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader, DigikamJPEGDImgPlugin::DImgJPEGLoader, DigikamImageMagickDImgPlugin::DImgImageMagickLoader, and Digikam::DImgHEIFLoader.

Referenced by Digikam::DImg::load().

◆ storeColorProfileInMetadata()

void Digikam::DImgLoader::storeColorProfileInMetadata ( )
protected

References Digikam::DImg::getIccProfile(), Digikam::DImg::getMetadata(), Digikam::IccProfile::isNull(), m_image, and Digikam::DImg::setMetadata().

Referenced by DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), and Digikam::DImgPGFLoader::save().

Member Data Documentation

◆ m_image

DImg* Digikam::DImgLoader::m_image
protected

Referenced by checkExifWorkingColorSpace(), hasLoadedData(), imageBitsDepth(), imageBytesDepth(), imageData(), imageEmbeddedText(), imageGetAttribute(), imageGetEmbbededText(), imageHasAlpha(), imageHeight(), imageNumBytes(), imageSetAttribute(), imageSetEmbbededText(), imageSetIccProfile(), imageSixteenBit(), imageWidth(), loadingFailed(), DigikamRAWDImgPlugin::DImgRAWLoader::postProcess(), purgeExifWorkingColorSpace(), readMetadata(), DigikamImageMagickDImgPlugin::DImgImageMagickLoader::save(), DigikamJPEGDImgPlugin::DImgJPEGLoader::save(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::save(), DigikamQImageDImgPlugin::DImgQImageLoader::save(), DigikamTIFFDImgPlugin::DImgTIFFLoader::save(), saveMetadata(), and storeColorProfileInMetadata().

◆ m_loadFlags

LoadFlags Digikam::DImgLoader::m_loadFlags
protected

Referenced by hasLoadedData(), DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), DigikamQImageDImgPlugin::DImgQImageLoader::load(), DigikamTIFFDImgPlugin::DImgTIFFLoader::load(), DigikamRAWDImgPlugin::DImgRAWLoader::load(), readMetadata(), and setLoadFlags().

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