• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdegraphics API Reference
  • KDE Home
  • Contact Us
 

libs/libkdcraw/libkdcraw

  • KDcrawIface
  • KDcraw
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KDcrawIface::KDcraw Class Reference

#include <kdcraw.h>

Inheritance diagram for KDcrawIface::KDcraw:
Inheritance graph
[legend]

Classes

class  Private
 

Public Member Functions

 KDcraw ()
 
virtual ~KDcraw ()
 
void cancel ()
 
bool decodeHalfRAWImage (const QString &filePath, const RawDecodingSettings &rawDecodingSettings, QByteArray &imageData, int &width, int &height, int &rgbmax)
 
bool decodeRAWImage (const QString &filePath, const RawDecodingSettings &rawDecodingSettings, QByteArray &imageData, int &width, int &height, int &rgbmax)
 
bool extractRAWData (const QString &filePath, QByteArray &rawData, DcrawInfoContainer &identify, unsigned int shotSelect=0)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Static Public Member Functions

static int librawUseGomp ()
 
static int librawUseGPL2DemosaicPack ()
 
static int librawUseGPL3DemosaicPack ()
 
static int librawUseRawSpeed ()
 
static QString librawVersion ()
 
static bool loadEmbeddedPreview (QByteArray &imgData, const QString &path)
 
static bool loadEmbeddedPreview (QImage &image, const QString &path)
 
static bool loadEmbeddedPreview (QByteArray &imgData, const QBuffer &inBuffer)
 
static bool loadFullImage (QImage &image, const QString &path, const RawDecodingSettings &settings=RawDecodingSettings())
 
static bool loadHalfPreview (QImage &image, const QString &path)
 
static bool loadHalfPreview (QByteArray &imgData, const QString &path)
 
static bool loadHalfPreview (QByteArray &imgData, const QBuffer &inBuffer)
 
static bool loadRawPreview (QImage &image, const QString &path)
 
static bool loadRawPreview (QByteArray &imgData, const QString &path)
 
static bool loadRawPreview (QByteArray &imgData, const QBuffer &inBuffer)
 
static bool rawFileIdentify (DcrawInfoContainer &identify, const QString &path)
 
static const char * rawFiles ()
 
static QStringList rawFilesList ()
 
static int rawFilesVersion ()
 
static QStringList supportedCamera ()
 
static QString version ()
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Protected Member Functions

virtual bool checkToCancelWaitingData ()
 
virtual void setWaitingDataProgress (double value)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

bool m_cancel
 
RawDecodingSettings m_rawDecodingSettings
 

Additional Inherited Members

- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Definition at line 55 of file kdcraw.h.

Constructor & Destructor Documentation

KDcrawIface::KDcraw::KDcraw ( )

Standard constructor.

Definition at line 61 of file kdcraw.cpp.

KDcrawIface::KDcraw::~KDcraw ( )
virtual

Standard destructor.

Definition at line 67 of file kdcraw.cpp.

Member Function Documentation

void KDcrawIface::KDcraw::cancel ( )

To cancel 'decodeHalfRAWImage' and 'decodeRAWImage' methods running in a separate thread.

Definition at line 78 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::checkToCancelWaitingData ( )
protectedvirtual

Re-implement this method to control the cancelisation of loop witch wait data from RAW decoding process with your propers envirronement.

By default, this method check if m_cancel is true.

Definition at line 489 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::decodeHalfRAWImage ( const QString &  filePath,
const RawDecodingSettings &  rawDecodingSettings,
QByteArray &  imageData,
int &  width,
int &  height,
int &  rgbmax 
)

Extract a small size of decode RAW data from 'filePath' picture file using 'rawDecodingSettings' settings.

This is a cancelable method which require a class instance to run because RAW pictures decoding can take a while.

This method return:

- A byte array container 'imageData' with picture data. Pixels order is RGB.
  Color depth can be 8 or 16. In 8 bits you can access to color component
  using (uchar*), in 16 bits using (ushort*).

- Size size of image in number of pixels ('width' and 'height').
- The max average of RGB components from decoded picture.
- 'false' is returned if decoding failed, else 'true'.

Definition at line 474 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::decodeRAWImage ( const QString &  filePath,
const RawDecodingSettings &  rawDecodingSettings,
QByteArray &  imageData,
int &  width,
int &  height,
int &  rgbmax 
)

Extract a full size of RAW data from 'filePath' picture file using 'rawDecodingSettings' settings.

This is a cancelable method which require a class instance to run because RAW pictures decoding can take a while.

This method return:

- A byte array container 'imageData' with picture data. Pixels order is RGB.
  Color depth can be 8 or 16. In 8 bits you can access to color component
  using (uchar*), in 16 bits using (ushort*).

- Size size of image in number of pixels ('width' and 'height').
- The max average of RGB components from decoded picture.
- 'false' is returned if decoding failed, else 'true'.

Definition at line 482 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::extractRAWData ( const QString &  filePath,
QByteArray &  rawData,
DcrawInfoContainer &  identify,
unsigned int  shotSelect = 0 
)

Extract Raw image data undemosaiced and without post processing from 'filePath' picture file.

This is a cancelable method which require a class instance to run because RAW pictures loading can take a while.

This method return:

- A byte array container 'rawData' with raw data.
- All info about Raw image into 'identify' container.
- 'false' is returned if loadding failed, else 'true'.

Definition at line 350 of file kdcraw.cpp.

int KDcrawIface::KDcraw::librawUseGomp ( )
static

Return true or false if LibRaw use parallel demosaicing or not (libgomp support).

Return -1 if undefined.

Definition at line 530 of file kdcraw.cpp.

int KDcrawIface::KDcraw::librawUseGPL2DemosaicPack ( )
static

Return true or false if LibRaw use Demosaic Pack GPL2 or not.

Return -1 if undefined.

Definition at line 556 of file kdcraw.cpp.

int KDcrawIface::KDcraw::librawUseGPL3DemosaicPack ( )
static

Return true or false if LibRaw use Demosaic Pack GPL3 or not.

Return -1 if undefined.

Definition at line 569 of file kdcraw.cpp.

int KDcrawIface::KDcraw::librawUseRawSpeed ( )
static

Return true or false if LibRaw use RawSpeed codec or not.

Return -1 if undefined.

Definition at line 543 of file kdcraw.cpp.

QString KDcrawIface::KDcraw::librawVersion ( )
static

Return LibRaw version string.

Definition at line 525 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::loadEmbeddedPreview ( QByteArray &  imgData,
const QString &  path 
)
static

Get the embedded JPEG preview image from RAW picture as a QByteArray which will include Exif Data.

This is fast and non cancelable. This method does not require a class instance to run.

Definition at line 114 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::loadEmbeddedPreview ( QImage &  image,
const QString &  path 
)
static

Get the embedded JPEG preview image from RAW picture as a QImage.

This is fast and non cancelable This method does not require a class instance to run.

Definition at line 95 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::loadEmbeddedPreview ( QByteArray &  imgData,
const QBuffer &  inBuffer 
)
static

Get the embedded JPEG preview image from RAW image passed in QBuffer as a QByteArray which will include Exif Data.

This is fast and non cancelable. This method does not require a class instance to run.

Definition at line 137 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::loadFullImage ( QImage &  image,
const QString &  path,
const RawDecodingSettings &  settings = RawDecodingSettings() 
)
static

Get the full decoded RAW picture.

This is a more slower than loadHalfPreview() method and non cancelable. This method does not require a class instance to run.

Definition at line 258 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::loadHalfPreview ( QImage &  image,
const QString &  path 
)
static

Get the half decoded RAW picture.

This is slower than loadEmbeddedPreview() method and non cancelable. This method does not require a class instance to run.

Definition at line 155 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::loadHalfPreview ( QByteArray &  imgData,
const QString &  path 
)
static

Get the half decoded RAW picture as JPEG data in QByteArray.

This is slower than loadEmbeddedPreview() method and non cancelable. This method does not require a class instance to run.

Definition at line 192 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::loadHalfPreview ( QByteArray &  imgData,
const QBuffer &  inBuffer 
)
static

Get the half decoded RAW picture passed in QBuffer as JPEG data in QByteArray.

This is slower than loadEmbeddedPreview() method and non cancelable. This method does not require a class instance to run.

Definition at line 228 of file kdcraw.cpp.

bool KDcrawIface::KDcraw::loadRawPreview ( QImage &  image,
const QString &  path 
)
static

Get the preview of RAW picture as a QImage.

It tries loadEmbeddedPreview() first and if it fails, calls loadHalfPreview().

Definition at line 83 of file kdcraw.cpp.

static bool KDcrawIface::KDcraw::loadRawPreview ( QByteArray &  imgData,
const QString &  path 
)
static

Get the preview of RAW picture as a QByteArray holding JPEG data.

It tries loadEmbeddedPreview() first and if it fails, calls loadHalfPreview().

static bool KDcrawIface::KDcraw::loadRawPreview ( QByteArray &  imgData,
const QBuffer &  inBuffer 
)
static

Get the preview of RAW picture passed in QBuffer as a QByteArray holding JPEG data.

It tries loadEmbeddedPreview() first and if it fails, calls loadHalfPreview().

bool KDcrawIface::KDcraw::rawFileIdentify ( DcrawInfoContainer &  identify,
const QString &  path 
)
static

Get the camera settings witch have taken RAW file.

Look into dcrawinfocontainer.h for more details. This is a fast and non cancelable method witch do not require a class instance to run.

Definition at line 313 of file kdcraw.cpp.

const char * KDcrawIface::KDcraw::rawFiles ( )
static

Return the string of all RAW file type mime supported.

Definition at line 498 of file kdcraw.cpp.

QStringList KDcrawIface::KDcraw::rawFilesList ( )
static

Return the list of all RAW file type mime supported, as a QStringList, without wildcard and suffix dot.

Definition at line 503 of file kdcraw.cpp.

int KDcrawIface::KDcraw::rawFilesVersion ( )
static

Returns a version number for the list of supported RAW file types.

This version is incremented if the list of supported formats has changed between library releases.

Definition at line 509 of file kdcraw.cpp.

void KDcrawIface::KDcraw::setWaitingDataProgress ( double  value)
protectedvirtual

Re-implement this method to control the pseudo progress value during RAW decoding (when dcraw run with an internal loop without feedback) with your proper environment.

By default, this method does nothing. Progress value average for this stage is 0%-n%, with 'n' == 40% max (see setWaitingDataProgress() method).

Definition at line 494 of file kdcraw.cpp.

QStringList KDcrawIface::KDcraw::supportedCamera ( )
static

Provide a list of supported RAW Camera name.

Definition at line 514 of file kdcraw.cpp.

QString KDcrawIface::KDcraw::version ( )
static

Return a string version of libkdcraw release.

Definition at line 73 of file kdcraw.cpp.

Member Data Documentation

bool KDcrawIface::KDcraw::m_cancel
protected

Used internally to cancel RAW decoding operation.

Normally, you don't need to use it directly, excepted if you derivated this class. Usual way is to use cancel() method

Definition at line 232 of file kdcraw.h.

RawDecodingSettings KDcrawIface::KDcraw::m_rawDecodingSettings
protected

The settings container used to perform RAW pictures decoding.

See 'rawdecodingsetting.h' for details.

Definition at line 237 of file kdcraw.h.


The documentation for this class was generated from the following files:
  • kdcraw.h
  • kdcraw.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:19:36 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

libs/libkdcraw/libkdcraw

Skip menu "libs/libkdcraw/libkdcraw"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdegraphics API Reference

Skip menu "kdegraphics API Reference"
  •     libkdcraw
  •     libkexiv2
  •     libkipi
  •     libksane
  • okular

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal