digiKam
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DigikamQImageDImgPlugin::DImgQImageLoader Class Reference
+ Inheritance diagram for DigikamQImageDImgPlugin::DImgQImageLoader:

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

 DImgQImageLoader (DImg *const image)
 
bool hasAlpha () const override
 
virtual bool hasLoadedData () const
 
bool isReadOnly () const override
 
bool load (const QString &filePath, DImgLoaderObserver *const observer) override
 
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)
 
bool save (const QString &filePath, DImgLoaderObserver *const observer) override
 
void setLoadFlags (LoadFlags flags)
 
bool sixteenBit () const override
 
 ~DImgQImageLoader () override
 

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
 
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
inherited

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

◆ DImgQImageLoader()

DigikamQImageDImgPlugin::DImgQImageLoader::DImgQImageLoader ( DImg *const  image)
explicit

◆ ~DImgQImageLoader()

DigikamQImageDImgPlugin::DImgQImageLoader::~DImgQImageLoader ( )
override

Member Function Documentation

◆ checkAllocation()

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

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 Digikam::DImgLoader::new_failureTolerant().

◆ checkExifWorkingColorSpace()

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

References Digikam::DImg::getMetadata(), Digikam::IccProfile::isNull(), Digikam::DImgLoader::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 
)
protectedvirtualinherited

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()

bool DigikamQImageDImgPlugin::DImgQImageLoader::hasAlpha ( ) const
overridevirtual

Implements Digikam::DImgLoader.

◆ hasLoadedData()

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

References Digikam::DImgLoader::LoadImageData, Digikam::DImgLoader::LoadPreview, Digikam::DImgLoader::m_image, and Digikam::DImgLoader::m_loadFlags.

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

◆ imageBitsDepth()

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

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

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

◆ imageBytesDepth()

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

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

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

◆ imageData()

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

References Digikam::DImgLoader::m_image.

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), 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
protectedinherited

References Digikam::DImgLoader::m_image.

◆ imageGetAttribute()

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

References Digikam::DImg::attribute(), and Digikam::DImgLoader::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(), save(), and DigikamTIFFDImgPlugin::DImgTIFFLoader::save().

◆ imageGetEmbbededText()

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

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

◆ imageHasAlpha()

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

References Digikam::DImg::hasAlpha(), and Digikam::DImgLoader::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 ( )
protectedinherited

References Digikam::DImgLoader::m_image.

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), 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
protectedinherited

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

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

◆ imageSetAttribute()

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

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

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

◆ imageSetEmbbededText()

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

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

◆ imageSetIccProfile()

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

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

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

◆ imageSixteenBit()

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

References Digikam::DImgLoader::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 ( )
protectedinherited

References Digikam::DImgLoader::m_image.

Referenced by DigikamImageMagickDImgPlugin::DImgImageMagickLoader::load(), DigikamJPEGDImgPlugin::DImgJPEGLoader::load(), DigikamJPEG2000DImgPlugin::DImgJPEG2000Loader::load(), Digikam::DImgPGFLoader::load(), 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()

bool DigikamQImageDImgPlugin::DImgQImageLoader::isReadOnly ( ) const
overridevirtual

Implements Digikam::DImgLoader.

◆ load()

bool DigikamQImageDImgPlugin::DImgQImageLoader::load ( const QString &  filePath,
DImgLoaderObserver *const  observer 
)
overridevirtual

Implements Digikam::DImgLoader.

References Digikam::DImgLoader::imageData(), Digikam::DImgLoader::imageHeight(), Digikam::DImgLoader::imageSetAttribute(), Digikam::DImgLoader::imageSetIccProfile(), Digikam::DImgLoader::imageWidth(), Digikam::DImgLoader::LoadICCData, Digikam::DImgLoader::loadingFailed(), Digikam::DImgLoader::m_loadFlags, Digikam::DImgLoader::new_failureTolerant(), Digikam::DImgLoaderObserver::progressInfo(), Digikam::DImgLoader::readMetadata(), and Digikam::RGB.

◆ loadingFailed()

void Digikam::DImgLoader::loadingFailed ( )
protectedinherited

References Digikam::DImgLoader::m_image.

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

◆ new_failureTolerant() [1/6]

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

◆ new_failureTolerant() [2/6]

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

◆ new_failureTolerant() [3/6]

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

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)
inherited

References Digikam::DImgLoader::checkAllocation().

◆ new_failureTolerant() [5/6]

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

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

◆ new_failureTolerant() [6/6]

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

◆ new_short_failureTolerant() [1/2]

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

◆ new_short_failureTolerant() [2/2]

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

◆ purgeExifWorkingColorSpace()

void Digikam::DImgLoader::purgeExifWorkingColorSpace ( )
protectedinherited

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

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

◆ readMetadata()

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

References Digikam::DImg::createHistoryImageId(), Digikam::HistoryImageId::Current, Digikam::DImageHistory::fromXml(), Digikam::DImgLoader::imageSetAttribute(), Digikam::DImgLoader::LoadImageHistory, Digikam::DImgLoader::LoadMetadata, Digikam::DImgLoader::LoadUniqueHash, Digikam::DImgLoader::m_image, Digikam::DImgLoader::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(), load(), DigikamTIFFDImgPlugin::DImgTIFFLoader::load(), and DigikamRAWDImgPlugin::DImgRAWLoader::load().

◆ save()

bool DigikamQImageDImgPlugin::DImgQImageLoader::save ( const QString &  filePath,
DImgLoaderObserver *const  observer 
)
overridevirtual

Implements Digikam::DImgLoader.

References Digikam::DImg::copyQImage(), Digikam::IccProfile::data(), Digikam::DImg::getIccProfile(), Digikam::DImgLoader::imageGetAttribute(), Digikam::DImgLoader::imageSetAttribute(), Digikam::DImgLoader::m_image, Digikam::DImgLoaderObserver::progressInfo(), and Digikam::DImgLoader::saveMetadata().

◆ saveMetadata()

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

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

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

◆ setLoadFlags()

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

References Digikam::DImgLoader::m_loadFlags.

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

◆ sixteenBit()

bool DigikamQImageDImgPlugin::DImgQImageLoader::sixteenBit ( ) const
overridevirtual

Implements Digikam::DImgLoader.

◆ storeColorProfileInMetadata()

void Digikam::DImgLoader::storeColorProfileInMetadata ( )
protectedinherited

References Digikam::DImg::getIccProfile(), Digikam::DImg::getMetadata(), Digikam::IccProfile::isNull(), Digikam::DImgLoader::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
protectedinherited

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

◆ m_loadFlags

LoadFlags Digikam::DImgLoader::m_loadFlags
protectedinherited

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

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