Class to import and export graphic formats. More...

#include <graphicfilter.hxx>

Collaboration diagram for GraphicFilter:

Public Member Functions
	GraphicFilter (bool bUseConfig=true)

	~GraphicFilter ()

sal_uInt16	GetImportFormatCount ()

sal_uInt16	GetImportFormatNumber (const OUString &rFormatName)

sal_uInt16	GetImportFormatNumberForShortName (const OUString &rShortName)

sal_uInt16	GetImportFormatNumberForTypeName (const OUString &rType)

OUString	GetImportFormatName (sal_uInt16 nFormat)

OUString	GetImportFormatTypeName (sal_uInt16 nFormat)

OUString	GetImportFormatShortName (sal_uInt16 nFormat)

OUString	GetImportWildcard (sal_uInt16 nFormat, sal_Int32 nEntry)

sal_uInt16	GetExportFormatCount ()

sal_uInt16	GetExportFormatNumber (const OUString &rFormatName)

sal_uInt16	GetExportFormatNumberForMediaType (const OUString &rShortName)

sal_uInt16	GetExportFormatNumberForShortName (const OUString &rShortName)

OUString	GetExportInternalFilterName (sal_uInt16 nFormat)

sal_uInt16	GetExportFormatNumberForTypeName (const OUString &rType)

OUString	GetExportFormatName (sal_uInt16 nFormat)

OUString	GetExportFormatMediaType (sal_uInt16 nFormat)

OUString	GetExportFormatShortName (sal_uInt16 nFormat)

OUString	GetExportWildcard (sal_uInt16 nFormat)

bool	IsExportPixelFormat (sal_uInt16 nFormat)

ErrCode	ExportGraphic (const Graphic &rGraphic, const INetURLObject &rPath, sal_uInt16 nFormat, const css::uno::Sequence< css::beans::PropertyValue > *pFilterData=nullptr)

ErrCode	ExportGraphic (const Graphic &rGraphic, const OUString &rPath, SvStream &rOStm, sal_uInt16 nFormat, const css::uno::Sequence< css::beans::PropertyValue > *pFilterData=nullptr)

ErrCode	CanImportGraphic (const INetURLObject &rPath, sal_uInt16 nFormat, sal_uInt16 *pDeterminedFormat)

ErrCode	ImportGraphic (Graphic &rGraphic, const INetURLObject &rPath, sal_uInt16 nFormat=GRFILTER_FORMAT_DONTKNOW, sal_uInt16 *pDeterminedFormat=nullptr, GraphicFilterImportFlags nImportFlags=GraphicFilterImportFlags::NONE)

ErrCode	CanImportGraphic (const OUString &rPath, SvStream &rStream, sal_uInt16 nFormat, sal_uInt16 *pDeterminedFormat)

ErrCode	ImportGraphic (Graphic &rGraphic, const OUString &rPath, SvStream &rStream, sal_uInt16 nFormat=GRFILTER_FORMAT_DONTKNOW, sal_uInt16 pDeterminedFormat=nullptr, GraphicFilterImportFlags nImportFlags=GraphicFilterImportFlags::NONE, WmfExternal const pExtHeader=nullptr)

void	ImportGraphics (std::vector< std::shared_ptr< Graphic > > &rGraphics, std::vector< std::unique_ptr< SvStream > > vStreams)
	Imports multiple graphics. More...

ErrCode	ImportGraphic (Graphic &rGraphic, const OUString &rPath, SvStream &rStream, sal_uInt16 nFormat, sal_uInt16 pDeterminedFormat, GraphicFilterImportFlags nImportFlags, const css::uno::Sequence< css::beans::PropertyValue > pFilterData, WmfExternal const *pExtHeader=nullptr)

Graphic	ImportUnloadedGraphic (SvStream &rIStream, sal_uInt64 sizeLimit=0, Size *pSizeHint=nullptr)

const FilterErrorEx &	GetLastError () const

void	ResetLastError ()

const Link< ConvertData &, bool >	GetFilterCallback () const

ErrCode	compressAsPNG (const Graphic &rGraphic, SvStream &rOutputStream)

void	preload ()

Static Public Member Functions
static GraphicFilter &	GetGraphicFilter ()

static ErrCode	LoadGraphic (const OUString &rPath, const OUString &rFilter, Graphic &rGraphic, GraphicFilter pFilter=nullptr, sal_uInt16 pDeterminedFormat=nullptr)

Private Member Functions
void	ImplInit ()

ErrCode	ImplSetError (ErrCode nError, const SvStream *pStm=nullptr)

ErrCode	ImpTestOrFindFormat (const OUString &rPath, SvStream &rStream, sal_uInt16 &rFormat)

	DECL_LINK (FilterCallback, ConvertData &, bool)

Private Attributes
OUString	aFilterPath

FilterConfigCache *	pConfig

std::unique_ptr< FilterErrorEx >	pErrorEx

bool const	bUseConfig

Detailed Description

Class to import and export graphic formats.

Definition at line 230 of file graphicfilter.hxx.

Constructor & Destructor Documentation

GraphicFilter::GraphicFilter ( bool bUseConfig = true )

Definition at line 815 of file graphicfilter.cxx.

References ImplInit().

GraphicFilter::~GraphicFilter ( )

Definition at line 821 of file graphicfilter.cxx.

References getListMutex(), pConfig, pErrorEx, and pFilterHdlList.

Member Function Documentation

ErrCode GraphicFilter::CanImportGraphic	(	const INetURLObject &	rPath,
		sal_uInt16	nFormat,
		sal_uInt16 *	pDeterminedFormat
	)

Definition at line 974 of file graphicfilter.cxx.

References utl::UcbStreamHelper::CreateStream(), ERRCODE_GRFILTER_FORMATERROR, INetURLObject::GetMainURL(), INetURLObject::GetProtocol(), INetURLObject::NONE, SAL_WARN_IF, and xStream.

ErrCode GraphicFilter::CanImportGraphic	(	const OUString &	rPath,
		SvStream &	rStream,
		sal_uInt16	nFormat,
		sal_uInt16 *	pDeterminedFormat
	)

Definition at line 989 of file graphicfilter.cxx.

References ERRCODE_NONE, ImplSetError(), ImpTestOrFindFormat(), SvStream::Seek(), and SvStream::Tell().

ErrCode GraphicFilter::compressAsPNG	(	const Graphic &	rGraphic,
		SvStream &	rOutputStream
	)

Definition at line 2364 of file graphicfilter.cxx.

References ExportGraphic(), and GetExportFormatNumberForShortName().

GraphicFilter::DECL_LINK	(	FilterCallback	,
		ConvertData &	,
		bool
	)

private

ErrCode GraphicFilter::ExportGraphic	(	const Graphic &	rGraphic,
		const INetURLObject &	rPath,
		sal_uInt16	nFormat,
		const css::uno::Sequence< css::beans::PropertyValue > *	pFilterData = `nullptr`
	)

Definition at line 1861 of file graphicfilter.cxx.

References utl::UcbStreamHelper::CreateStream(), DirEntryExists(), ERRCODE_GRFILTER_FORMATERROR, ERRCODE_NONE, INetURLObject::GetMainURL(), INetURLObject::GetProtocol(), KillDirEntry(), INetURLObject::NONE, SAL_INFO, SAL_WARN_IF, and xStream.

Referenced by compressAsPNG(), and GraphicNativeTransform::rotateGeneric().

ErrCode GraphicFilter::ExportGraphic	(	const Graphic &	rGraphic,
		const OUString &	rPath,
		SvStream &	rOStm,
		sal_uInt16	nFormat,
		const css::uno::Sequence< css::beans::PropertyValue > *	pFilterData = `nullptr`
	)

Definition at line 1890 of file graphicfilter.cxx.

References vcl::PNGWriter::ChunkData::aData, aFilterPath, Bitmap, ConvertGDIMetaFileToEMF(), ConvertGDIMetaFileToWMF(), Graphic::Draw(), egiGraphicExport(), Emf, epsGraphicExport(), ERRCODE_GRFILTER_FILTERERROR, ERRCODE_GRFILTER_FORMATERROR, ERRCODE_GRFILTER_IOERROR, ERRCODE_NONE, etiGraphicExport(), eType, EXP_BMP, EXP_EMF, EXP_JPEG, EXP_PNG, EXP_SVG, EXP_SVMETAFILE, EXP_WMF, ExportJPEG(), VclPtr< reference_type >::get(), Graphic::GetBitmapEx(), vcl::PNGWriter::GetChunks(), SvMemoryStream::GetData(), SvStream::GetError(), FilterConfigCache::GetExportFilterName(), GetExportFormatCount(), FilterConfigCache::GetExportFormatExtension(), FilterConfigCache::GetExternalFilterName(), INetURLObject::GetFileExtension(), FilterConfigItem::GetFilterData(), Graphic::GetGDIMetaFile(), Graphic::GetPrefMapMode(), Graphic::GetPrefSize(), comphelper::getProcessComponentContext(), Graphic::GetType(), Graphic::getVectorGraphicData(), GRFILTER_FORMAT_DONTKNOW, Size::Height(), i, ImpCreateFullFilterPath(), ImpGetScaledGraphic(), ImplSetError(), FilterConfigCache::IsExportInternalFilter(), FilterConfigCache::IsExportPixelFormat(), MapMode, N24Bit, NNONE, vcl::PNGWriter::ChunkData::nType, NULL, pConfig, FilterConfigItem::ReadBool(), FilterConfigItem::ReadInt32(), ResetLastError(), SAL_INFO, Size::setHeight(), SvStream::SetVersion(), Size::setWidth(), Svg, SvStream::Tell(), Size::Width(), Wmf, Write, GDIMetaFile::Write(), SvStream::WriteBytes(), and WriteDIB().

sal_uInt16 GraphicFilter::GetExportFormatCount ( )

Definition at line 919 of file graphicfilter.cxx.

References FilterConfigCache::GetExportFormatCount(), and pConfig.

Referenced by ExportGraphic().

OUString GraphicFilter::GetExportFormatMediaType ( sal_uInt16 nFormat )

Definition at line 954 of file graphicfilter.cxx.

References FilterConfigCache::GetExportFormatMediaType(), and pConfig.

OUString GraphicFilter::GetExportFormatName ( sal_uInt16 nFormat )

Definition at line 949 of file graphicfilter.cxx.

References FilterConfigCache::GetExportFormatName(), and pConfig.

sal_uInt16 GraphicFilter::GetExportFormatNumber ( const OUString & rFormatName )

Definition at line 924 of file graphicfilter.cxx.

References FilterConfigCache::GetExportFormatNumber(), and pConfig.

sal_uInt16 GraphicFilter::GetExportFormatNumberForMediaType ( const OUString & rShortName )

Definition at line 929 of file graphicfilter.cxx.

References FilterConfigCache::GetExportFormatNumberForMediaType(), and pConfig.

sal_uInt16 GraphicFilter::GetExportFormatNumberForShortName ( const OUString & rShortName )

Definition at line 934 of file graphicfilter.cxx.

References FilterConfigCache::GetExportFormatNumberForShortName(), and pConfig.

Referenced by compressAsPNG(), and GraphicNativeTransform::rotateGeneric().

sal_uInt16 GraphicFilter::GetExportFormatNumberForTypeName ( const OUString & rType )

Definition at line 944 of file graphicfilter.cxx.

References FilterConfigCache::GetExportFormatNumberForTypeName(), and pConfig.

OUString GraphicFilter::GetExportFormatShortName ( sal_uInt16 nFormat )

Definition at line 959 of file graphicfilter.cxx.

References FilterConfigCache::GetExportFormatShortName(), and pConfig.

OUString GraphicFilter::GetExportInternalFilterName ( sal_uInt16 nFormat )

Definition at line 939 of file graphicfilter.cxx.

References FilterConfigCache::GetExportInternalFilterName(), and pConfig.

OUString GraphicFilter::GetExportWildcard ( sal_uInt16 nFormat )

Definition at line 964 of file graphicfilter.cxx.

References FilterConfigCache::GetExportWildcard(), and pConfig.

const Link< ConvertData &, bool > GraphicFilter::GetFilterCallback ( ) const

Definition at line 2239 of file graphicfilter.cxx.

References LINK.

GraphicFilter & GraphicFilter::GetGraphicFilter ( )

static

Definition at line 2309 of file graphicfilter.cxx.

Referenced by vcl::graphic::loadFromURL(), LoadGraphic(), GfxLink::LoadNative(), GraphicNativeTransform::rotateGeneric(), and GraphicNativeTransform::rotateJPEG().

sal_uInt16 GraphicFilter::GetImportFormatCount ( )

Definition at line 872 of file graphicfilter.cxx.

References FilterConfigCache::GetImportFormatCount(), and pConfig.

Referenced by LoadGraphic().

OUString GraphicFilter::GetImportFormatName ( sal_uInt16 nFormat )

Definition at line 892 of file graphicfilter.cxx.

References FilterConfigCache::GetImportFormatName(), and pConfig.

sal_uInt16 GraphicFilter::GetImportFormatNumber ( const OUString & rFormatName )

Definition at line 877 of file graphicfilter.cxx.

References FilterConfigCache::GetImportFormatNumber(), and pConfig.

Referenced by LoadGraphic().

sal_uInt16 GraphicFilter::GetImportFormatNumberForShortName ( const OUString & rShortName )

Definition at line 882 of file graphicfilter.cxx.

References FilterConfigCache::GetImportFormatNumberForShortName(), and pConfig.

Referenced by GfxLink::LoadNative().

sal_uInt16 GraphicFilter::GetImportFormatNumberForTypeName ( const OUString & rType )

Definition at line 887 of file graphicfilter.cxx.

References FilterConfigCache::GetImportFormatNumberForTypeName(), and pConfig.

OUString GraphicFilter::GetImportFormatShortName ( sal_uInt16 nFormat )

Definition at line 909 of file graphicfilter.cxx.

References FilterConfigCache::GetImportFormatShortName(), and pConfig.

Referenced by ImportGraphic(), and ImportUnloadedGraphic().

OUString GraphicFilter::GetImportFormatTypeName ( sal_uInt16 nFormat )

Definition at line 897 of file graphicfilter.cxx.

References FilterConfigCache::GetImportFilterTypeName(), and pConfig.

OUString GraphicFilter::GetImportWildcard	(	sal_uInt16	nFormat,
		sal_Int32	nEntry
	)

Definition at line 914 of file graphicfilter.cxx.

References FilterConfigCache::GetImportWildcard(), and pConfig.

const FilterErrorEx& GraphicFilter::GetLastError ( ) const

inline

Definition at line 300 of file graphicfilter.hxx.

void GraphicFilter::ImplInit ( )

private

Definition at line 840 of file graphicfilter.cxx.

References aFilterPath, bUseConfig, getListMutex(), pConfig, pErrorEx, and pFilterHdlList.

Referenced by GraphicFilter().

ErrCode GraphicFilter::ImplSetError	(	ErrCode	nError,
		const SvStream *	pStm = `nullptr`
	)

private

Definition at line 866 of file graphicfilter.cxx.

References ERRCODE_NONE, SvStream::GetError(), and pErrorEx.

Referenced by CanImportGraphic(), ExportGraphic(), ImportGraphic(), and ImportUnloadedGraphic().

ErrCode GraphicFilter::ImportGraphic	(	Graphic &	rGraphic,
		const INetURLObject &	rPath,
		sal_uInt16	nFormat = `GRFILTER_FORMAT_DONTKNOW`,
		sal_uInt16 *	pDeterminedFormat = `nullptr`,
		GraphicFilterImportFlags	nImportFlags = `GraphicFilterImportFlags::NONE`
	)

Definition at line 1004 of file graphicfilter.cxx.

References utl::UcbStreamHelper::CreateStream(), ERRCODE_GRFILTER_FORMATERROR, INetURLObject::GetMainURL(), INetURLObject::GetProtocol(), INetURLObject::NONE, SAL_WARN_IF, and xStream.

Referenced by ImportGraphic(), vcl::graphic::loadFromURL(), LoadGraphic(), GfxLink::LoadNative(), GraphicNativeTransform::rotateGeneric(), and GraphicNativeTransform::rotateJPEG().

ErrCode GraphicFilter::ImportGraphic	(	Graphic &	rGraphic,
		const OUString &	rPath,
		SvStream &	rStream,
		sal_uInt16	nFormat = `GRFILTER_FORMAT_DONTKNOW`,
		sal_uInt16 *	pDeterminedFormat = `nullptr`,
		GraphicFilterImportFlags	nImportFlags = `GraphicFilterImportFlags::NONE`,
		WmfExternal const *	pExtHeader = `nullptr`
	)

Definition at line 1019 of file graphicfilter.cxx.

References ImportGraphic().

ErrCode GraphicFilter::ImportGraphic	(	Graphic &	rGraphic,
		const OUString &	rPath,
		SvStream &	rStream,
		sal_uInt16	nFormat,
		sal_uInt16 *	pDeterminedFormat,
		GraphicFilterImportFlags	nImportFlags,
		const css::uno::Sequence< css::beans::PropertyValue > *	pFilterData,
		WmfExternal const *	pExtHeader = `nullptr`
	)

Definition at line 1441 of file graphicfilter.cxx.

References aFilterPath, ZCodec::BeginCompression(), Graphic::Clear(), ZCodec::Decompress(), DontSetLogsizeForJpeg, Emf, ZCodec::EndCompression(), ERRCODE_GRFILTER_FILTERERROR, ERRCODE_GRFILTER_FORMATERROR, ERRCODE_GRFILTER_OPENERROR, ERRCODE_GRFILTER_TOOBIG, ERRCODE_IO_PENDING, ERRCODE_NONE, ForPreview, Graphic::GetBitmapExRef(), BitmapEx::GetBitmapRef(), vcl::PNGReader::GetChunks(), Graphic::GetContext(), SvStream::GetError(), FilterConfigCache::GetExternalFilterName(), ImpFilterLibCache::GetFilter(), FilterConfigCache::GetImportFilterName(), GetImportFormatShortName(), ImpFilterLibCacheEntry::GetImportFunction(), GRFILTER_FORMAT_DONTKNOW, Size::Height(), IMP_BMP, IMP_EMF, IMP_GIF, IMP_JPEG, IMP_MOV, IMP_PDF, IMP_PNG, IMP_SVG, IMP_SVMETAFILE, IMP_WMF, IMP_XBM, IMP_XPM, ImplSetError(), ImportGIF(), ImportJPEG(), vcl::ImportPDF(), ImportXBM(), ImportXPM(), ImpTestOrFindFormat(), Graphic::IsDummyContext(), utl::ConfigManager::IsFuzzing(), Graphic::IsGfxLink(), FilterConfigCache::IsImportInternalFilter(), MET_SHORTNAME, NativeBmp, NativeGif, NativeJpg, NativeMet, NativeMov, NativePct, NativePdf, NativePng, NativeSvg, NativeTif, NativeWmf, NONE, OnlyCreateBitmap, pConfig, PCT_SHORTNAME, PMGCHUNG_msOG, vcl::PNGReader::Read(), SvStream::ReadBytes(), ReadGraphic(), SvStream::remainingSize(), SvStream::ResetError(), ResetLastError(), SvStream::Seek(), Graphic::SetDefaultType(), Graphic::SetDummyContext(), Graphic::SetGfxLink(), SetLogsizeForJpeg, STREAM_SEEK_TO_BEGIN, STREAM_SEEK_TO_END, Svg, SvStream::Tell(), TIF_SHORTNAME, UseExistingBitmap, Size::Width(), Wmf, and ZCODEC_DEFAULT_COMPRESSION.

void GraphicFilter::ImportGraphics	(	std::vector< std::shared_ptr< Graphic > > &	rGraphics,
		std::vector< std::unique_ptr< SvStream > >	vStreams
	)

Imports multiple graphics.

The resulting graphic is added to rGraphics on success, nullptr is added on failure.

Definition at line 1081 of file graphicfilter.cxx.

References comphelper::ThreadPool::createThreadTaskTag(), GraphicImportTask::doImport(), ERRCODE_GRFILTER_FILTERERROR, ERRCODE_NONE, FilterConfigCache::GetImportFilterName(), comphelper::ThreadPool::getSharedOptimalPool(), GRFILTER_FORMAT_DONTKNOW, IMP_JPEG, ImportJPEG(), ImpTestOrFindFormat(), GraphicImportContext::m_nImportFlags, GraphicImportContext::m_nStatus, GraphicImportContext::m_nStreamBegin, GraphicImportContext::m_pAccess, GraphicImportContext::m_pGraphic, GraphicImportContext::m_pStream, OnlyCreateBitmap, pConfig, comphelper::ThreadPool::pushTask(), ResetLastError(), and SetLogsizeForJpeg.

Graphic GraphicFilter::ImportUnloadedGraphic	(	SvStream &	rIStream,
		sal_uInt64	sizeLimit = `0`,
		Size *	pSizeHint = `nullptr`
	)

Definition at line 1178 of file graphicfilter.cxx.

References aFilterPath, ZCodec::BeginCompression(), ZCodec::Decompress(), ZCodec::EndCompression(), ERRCODE_GRFILTER_FILTERERROR, ERRCODE_GRFILTER_TOOBIG, ERRCODE_NONE, vcl::PNGReader::GetChunks(), SvStream::GetError(), FilterConfigCache::GetExternalFilterName(), ImpFilterLibCache::GetFilter(), FilterConfigCache::GetImportFilterName(), GetImportFormatShortName(), ImpFilterLibCacheEntry::GetImportFunction(), GRFILTER_FORMAT_DONTKNOW, IMP_BMP, IMP_EMF, IMP_GIF, IMP_JPEG, IMP_MOV, IMP_PDF, IMP_PNG, IMP_SVG, IMP_WMF, Graphic::ImplGetImpGraphic(), ImplSetError(), ImpGraphic::ImplSetPrepared(), ImpTestOrFindFormat(), IsGIFAnimated(), FilterConfigCache::IsImportInternalFilter(), MET_SHORTNAME, NativeBmp, NativeGif, NativeJpg, NativeMet, NativeMov, NativePct, NativePdf, NativePng, NativeSvg, NativeTif, NativeWmf, NONE, pConfig, PCT_SHORTNAME, PMGCHUNG_msOG, SvStream::ReadBytes(), SvStream::remainingSize(), ResetLastError(), SvStream::Seek(), Graphic::SetGfxLink(), STREAM_SEEK_TO_BEGIN, SvStream::Tell(), TIF_SHORTNAME, and ZCODEC_DEFAULT_COMPRESSION.

ErrCode GraphicFilter::ImpTestOrFindFormat	(	const OUString &	rPath,
		SvStream &	rStream,
		sal_uInt16 &	rFormat
	)

private

Definition at line 494 of file graphicfilter.cxx.

References ERRCODE_GRFILTER_FORMATERROR, ERRCODE_NONE, FilterConfigCache::GetImportFilterType(), FilterConfigCache::GetImportFormatExtension(), FilterConfigCache::GetImportFormatNumberForExtension(), GRFILTER_FORMAT_DONTKNOW, ImpGetExtension(), ImpPeekGraphicFormat(), pConfig, and FilterConfigItem::WriteInt32().

Referenced by CanImportGraphic(), ImportGraphic(), ImportGraphics(), and ImportUnloadedGraphic().

bool GraphicFilter::IsExportPixelFormat ( sal_uInt16 nFormat )

Definition at line 969 of file graphicfilter.cxx.

References FilterConfigCache::IsExportPixelFormat(), and pConfig.

ErrCode GraphicFilter::LoadGraphic	(	const OUString &	rPath,
		const OUString &	rFilter,
		Graphic &	rGraphic,
		GraphicFilter *	pFilter = `nullptr`,
		sal_uInt16 *	pDeterminedFormat = `nullptr`
	)