summaryrefslogtreecommitdiff
path: root/svtools/inc/svtools/filter.hxx
blob: f4039be3c6167410a7b337e83723224a9b6d7cec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef _FILTER_HXX
#define _FILTER_HXX

#include <svtools/fltcall.hxx>
#include "svtools/svtdllapi.h"
#include <tools/stream.hxx>
#include <vcl/graph.hxx>
#include <tools/gen.hxx>
#include <tools/urlobj.hxx>
#include <vcl/field.hxx>
#include <com/sun/star/uno/Sequence.h>
#include <com/sun/star/beans/PropertyValue.hpp>

// -----------------------
// - GraphicFilter-Types -
// -----------------------

struct ImplDirEntryHelper
{
    static BOOL Exists( const INetURLObject& rObj );
    static void Kill( const String& rStr );
};

class Window;
class Graphic;

#define OPT_FILTERSECTION           "Graphic"

#define GRFILTER_OK                 0
#define GRFILTER_OPENERROR          1
#define GRFILTER_IOERROR            2
#define GRFILTER_FORMATERROR        3
#define GRFILTER_VERSIONERROR       4
#define GRFILTER_FILTERERROR        5
#define GRFILTER_ABORT              6
#define GRFILTER_TOOBIG             7

#define GRFILTER_OUTHINT_GREY       1

#define GRFILTER_FORMAT_NOTFOUND    ((USHORT)0xFFFF)
#define GRFILTER_FORMAT_DONTKNOW    ((USHORT)0xFFFF)

#define GRFILTER_I_FLAGS_SET_LOGSIZE_FOR_JPEG       00000001
#define GRFILTER_I_FLAGS_DONT_SET_LOGSIZE_FOR_JPEG  00000002
#define GRFILTER_I_FLAGS_FOR_PREVIEW                00000004
#define GRFILTER_I_FLAGS_ALLOW_PARTIAL_STREAMREAD   00000010

#define IMP_BMP                 "SVBMP"
#define IMP_SVMETAFILE          "SVMETAFILE"
#define IMP_WMF                 "SVWMF"
#define IMP_EMF                 "SVEMF"
#define IMP_SVSGF               "SVSGF"
#define IMP_SVSGV               "SVSGV"
#define IMP_GIF                 "SVIGIF"
#define IMP_PNG                 "SVIPNG"
#define IMP_JPEG                "SVIJPEG"
#define IMP_XBM                 "SVIXBM"
#define IMP_XPM                 "SVIXPM"
#define EXP_BMP                 "SVBMP"
#define EXP_SVMETAFILE          "SVMETAFILE"
#define EXP_WMF                 "SVWMF"
#define EXP_EMF                 "SVEMF"
#define EXP_JPEG                "SVEJPEG"
#define EXP_SVG                 "SVESVG"
#define EXP_PNG                 "SVEPNG"

#define BMP_SHORTNAME           "BMP"
#define GIF_SHORTNAME           "GIF"
#define JPG_SHORTNAME           "JPG"
#define MET_SHORTNAME           "MET"
#define PCT_SHORTNAME           "PCT"
#define PNG_SHORTNAME           "PNG"
#define SVM_SHORTNAME           "SVM"
#define TIF_SHORTNAME           "TIF"
#define WMF_SHORTNAME           "WMF"
#define EMF_SHORTNAME           "EMF"

// ------------------------------------
// - Info-Klasse fuer alle von uns
//  unterstuetzten Grafik-Fileformate
// ------------------------------------

#define GFF_NOT ( (USHORT)0x0000 )
#define GFF_BMP ( (USHORT)0x0001 )
#define GFF_GIF ( (USHORT)0x0002 )
#define GFF_JPG ( (USHORT)0x0003 )
#define GFF_PCD ( (USHORT)0x0004 )
#define GFF_PCX ( (USHORT)0x0005 )
#define GFF_PNG ( (USHORT)0x0006 )
#define GFF_TIF ( (USHORT)0x0007 )
#define GFF_XBM ( (USHORT)0x0008 )
#define GFF_XPM ( (USHORT)0x0009 )
#define GFF_PBM ( (USHORT)0x000a )
#define GFF_PGM ( (USHORT)0x000b )
#define GFF_PPM ( (USHORT)0x000c )
#define GFF_RAS ( (USHORT)0x000d )
#define GFF_TGA ( (USHORT)0x000e )
#define GFF_PSD ( (USHORT)0x000f )
#define GFF_EPS ( (USHORT)0x0010 )
#define GFF_DXF ( (USHORT)0x00f1 )
#define GFF_MET ( (USHORT)0x00f2 )
#define GFF_PCT ( (USHORT)0x00f3 )
#define GFF_SGF ( (USHORT)0x00f4 )
#define GFF_SVM ( (USHORT)0x00f5 )
#define GFF_WMF ( (USHORT)0x00f6 )
#define GFF_SGV ( (USHORT)0x00f7 )
#define GFF_EMF ( (USHORT)0x00f8 )
#define GFF_XXX ( (USHORT)0xffff )

// ---------------
// - RequestInfo -
// ---------------

struct RequestInfo
{
    BYTE*   pBuffer;
    ULONG   nRealBufferSize;
};

// ---------------------
// - GraphicDescriptor -
// ---------------------

class SVT_DLLPUBLIC GraphicDescriptor
{
    SvStream*           pFileStm;
    Link                aReqLink;
    String              aPathExt;
    Size                aPixSize;
    Size                aLogSize;
    SvStream*           pMemStm;
    SvStream*           pBaseStm;
    ULONG               nStmPos;
    USHORT              nBitsPerPixel;
    USHORT              nPlanes;
    USHORT              nFormat;
    BOOL                bCompressed;
    BOOL                bDataReady;
    BOOL                bLinked;
    BOOL                bLinkChanged;
    BOOL                bWideSearch;
    BOOL                bBaseStm;
    long                nExtra1;
    long                nExtra2;

    void                ImpConstruct();

//#if 0 // _SOLAR__PRIVATE

    BOOL                ImpDetectBMP( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectGIF( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectJPG( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectPCD( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectPCX( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectPNG( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectTIF( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectXBM( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectXPM( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectPBM( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectPGM( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectPPM( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectRAS( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectTGA( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectPSD( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectEPS( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectDXF( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectMET( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectPCT( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectSGF( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectSVM( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectWMF( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectSGV( SvStream& rStm, BOOL bExtendedInfo );
    BOOL                ImpDetectEMF( SvStream& rStm, BOOL bExtendedInfo );

//#endif

    GraphicDescriptor( const GraphicDescriptor& );
    GraphicDescriptor& operator=( const GraphicDescriptor& );

protected:

    BOOL                IsDataReady() const;
    BOOL                IsWideSearch() const;
    SvStream&           GetSearchStream() const;
    const String&       GetPathExtension() const;

public:

    // Default-Ctor, um anschliessend einen Link zu setzen, mit dem
    // die Daten vom Aufrufer im ::Detect() angefordert werden.
    // da einige Formate ( Mtf's ) keinen eindeutigen Header besitzen,
    // ist es sinnvoll den vollen Filenamen (inkl. Ext. ) mitanzugeben,
    // da so das Format ueber die Extension ermittelt werden kann
    GraphicDescriptor( const String* pPath = NULL );

    // Ctor, um einen Filenamen zu setzen. Es muss ::Detect() gerufen werden,
    // um das File zu identifizieren;
    // wenn das File keinen eindeutigen Header besitzt ( Mtf's ) wird das
    // Format anhand der Extension bestimmt
    GraphicDescriptor( const INetURLObject& rPath );

    // Ctor, um einen Stream zu setzen. Es muss ::Detect() gerufen werden,
    // um das File zu identifizieren;
    // da einige Formate ( Mtf's ) keinen eindeutigen Header besitzen,
    // ist es sinnvoll den Filenamen (inkl. Ext. ) mitanzugeben,
    // da so das Format ueber die Extension ermittelt werden kann
    GraphicDescriptor( SvStream& rInStream, const String* pPath = NULL );

    // Dtor
    virtual ~GraphicDescriptor();

    // Startet die Detektion;
    // bei bExtendedInfo == TRUE werden soweit wie moeglich
    // Daten aus dem jeweiligen FileHeader ermittelt
    // ( Groesse, Farbtiefe usw. )
    virtual BOOL    Detect( BOOL bExtendedInfo = FALSE );

    // liefert das Fileformat nach erfolgreicher  Detektion zurueck;
    // wenn kein Format erkannt wurde, ist das Formart GFF_NOT
    USHORT          GetFileFormat() const { return nFormat; }

    // liefert die Pixel-Bildgroesse oder 0-Size zurueck
    const Size&     GetSizePixel() const { return (Size&) aPixSize; }

    // liefert die logische Bildgroesse in 1/100mm oder 0-Size zurueck
    const Size&     GetSize_100TH_MM() const { return (Size&) aLogSize; }

    // liefert die Bits/Pixel oder 0 zurueck
    USHORT          GetBitsPerPixel() const { return nBitsPerPixel; }

    // liefert die Anzahl der Planes oder 0 zurueck
    USHORT          GetPlanes() const { return nPlanes; }

    // zeigt an, ob das Bild evtl. komprimiert (wie auch immer) ist
    BOOL            IsCompressed() const { return bCompressed; }

    // setzt den LinkHdl zum Setzen der Bytes;
    // der Handler muss einen Pointer auf die RequestInfo-Struktur
    // zurueckgeben; die Anzahl der minimal zur Verfuegung zu stellenden
    // Daten muss im Handler ueber ::GetRequestedByteCount() erfragt werden;
    // die tatsaechlich zur Verfuegung gestellte BYTE-Anzahl
    // wird in der RequestInfo-Struktur gesetzt
    void            SetRequestHdl( const Link& rRequestHdl );

    // gibt den LinkHdl zum Setzen der Bytes zurueck
    const Link&     GetRequestHdl() const { return aReqLink; }

    // muss im ReqHdl gerufen werden, um zu erfahren, wieviele
    // Bytes _mindestens_ bereitgestellt werden muessen
    ULONG           GetRequestedByteCount() const;

    // gibt die Filternummer des Filters zurueck,
    // der im GraphicFilter zum Lesen dieses Formats
    // benoetigt wird
    static String GetImportFormatShortName( sal_uInt16 nFormat );
};

// -----------------
// - GraphicFilter -
// -----------------

struct FilterErrorEx
{
    ULONG   nFilterError;
    ULONG   nStreamError;
    long    nDummy1;
    long    nDummy2;
    long    nDummy3;
    long    nDummy4;

            FilterErrorEx() : nFilterError( 0UL ), nStreamError( 0UL ) {}
};

// -----------------------------------------------------------------------------

struct ConvertData;
class FilterConfigCache;
class SVT_DLLPUBLIC GraphicFilter
{
    friend class SvFilterOptionsDialog;

private:

    void            ImplInit();
    ULONG           ImplSetError( ULONG nError, const SvStream* pStm = NULL );
    sal_uInt16      ImpTestOrFindFormat( const String& rPath, SvStream& rStream, sal_uInt16& rFormat );

                    DECL_LINK( FilterCallback, ConvertData* pData );

protected:

    String              aFilterPath;
    FilterConfigCache*  pConfig;
    FilterErrorEx*      pErrorEx;
    sal_Bool            bAbort;
    sal_Bool            bUseConfig;
    sal_Bool            bDummy1;
    sal_Bool            bDummy2;
    sal_Bool            bDummy3;
    sal_Bool            bDummy4;
    long                nExpGraphHint;
    long                nDummy2;
    void*               pDummy1;
    void*               pDummy2;

public:

                    GraphicFilter( sal_Bool bUseConfig = sal_True );
                    ~GraphicFilter();

    void            SetFilterPath( const String& rFilterPath ) { aFilterPath = rFilterPath; };

    USHORT          GetImportFormatCount();
    USHORT          GetImportFormatNumber( const String& rFormatName );
    USHORT          GetImportFormatNumberForMediaType( const String& rMediaType );
    USHORT          GetImportFormatNumberForShortName( const String& rShortName );
    sal_uInt16      GetImportFormatNumberForTypeName( const String& rType );
    String          GetImportFormatName( USHORT nFormat );
    String          GetImportFormatTypeName( USHORT nFormat );
    String          GetImportFormatMediaType( USHORT nFormat );
    String          GetImportFormatShortName( USHORT nFormat );
    String          GetImportOSFileType( USHORT nFormat );
    String          GetImportWildcard( USHORT nFormat, sal_Int32 nEntry = 0 );
    BOOL            IsImportPixelFormat( USHORT nFormat );

    USHORT          GetExportFormatCount();
    USHORT          GetExportFormatNumber( const String& rFormatName );
    USHORT          GetExportFormatNumberForMediaType( const String& rShortName );
    USHORT          GetExportFormatNumberForShortName( const String& rShortName );
    sal_uInt16      GetExportFormatNumberForTypeName( const String& rType );
    String          GetExportFormatName( USHORT nFormat );
    String          GetExportFormatTypeName( USHORT nFormat );
    String          GetExportFormatMediaType( USHORT nFormat );
    String          GetExportFormatShortName( USHORT nFormat );
    String          GetExportOSFileType( USHORT nFormat );
    String          GetExportWildcard( USHORT nFormat, sal_Int32 nEntry = 0 );
    BOOL            IsExportPixelFormat( USHORT nFormat );

    BOOL            HasImportDialog( USHORT nFormat );
    BOOL            DoImportDialog( Window* pWindow, USHORT nFormat );

    BOOL            HasExportDialog( USHORT nFormat );
    BOOL            DoExportDialog( Window* pWindow, USHORT nFormat );
    BOOL            DoExportDialog( Window* pWindow, USHORT nFormat, FieldUnit eFieldUnit );

    USHORT          ExportGraphic( const Graphic& rGraphic, const INetURLObject& rPath,
                                    USHORT nFormat = GRFILTER_FORMAT_DONTKNOW,
                                        const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >* pFilterData = NULL );
    USHORT          ExportGraphic( const Graphic& rGraphic, const String& rPath,
                                    SvStream& rOStm, USHORT nFormat = GRFILTER_FORMAT_DONTKNOW,
                                        const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >* pFilterData = NULL );
    long            GetExportGraphicHint() const { return nExpGraphHint; }

    USHORT          CanImportGraphic( const INetURLObject& rPath,
                                      USHORT nFormat = GRFILTER_FORMAT_DONTKNOW,
                                      USHORT * pDeterminedFormat = NULL);

    USHORT          ImportGraphic( Graphic& rGraphic, const INetURLObject& rPath,
                                   USHORT nFormat = GRFILTER_FORMAT_DONTKNOW,
                                   USHORT * pDeterminedFormat = NULL, sal_uInt32 nImportFlags = 0 );

    USHORT          CanImportGraphic( const String& rPath, SvStream& rStream,
                                      USHORT nFormat = GRFILTER_FORMAT_DONTKNOW,
                                      USHORT * pDeterminedFormat = NULL);

    USHORT          ImportGraphic( Graphic& rGraphic, const String& rPath,
                                   SvStream& rStream,
                                   USHORT nFormat = GRFILTER_FORMAT_DONTKNOW,
                                   USHORT * pDeterminedFormat = NULL, sal_uInt32 nImportFlags = 0 );

    USHORT          ImportGraphic( Graphic& rGraphic, const String& rPath,
                                   SvStream& rStream,
                                   USHORT nFormat,
                                   USHORT * pDeterminedFormat, sal_uInt32 nImportFlags,
                                   com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >* pFilterData );

    BOOL            Setup( USHORT nFormat );

    void            Abort() { bAbort = TRUE; }

    const FilterErrorEx&    GetLastError() const;
    void                    ResetLastError();

    const Link      GetFilterCallback() const;
    static          GraphicFilter* GetGraphicFilter();
    static int      LoadGraphic( const String& rPath, const String& rFilter,
                     Graphic& rGraphic,
                     GraphicFilter* pFilter = NULL,
                     USHORT* pDeterminedFormat = NULL );
};

// ------------------------------------
// - Windows Metafile Lesen/Schreiben -
// ------------------------------------

SVT_DLLPUBLIC BOOL ReadWindowMetafile( SvStream& rStream, GDIMetaFile& rMTF, FilterConfigItem* pConfigItem );
SVT_DLLPUBLIC BOOL WriteWindowMetafile( SvStream& rStream, const GDIMetaFile& rMTF );
SVT_DLLPUBLIC BOOL WriteWindowMetafileBits( SvStream& rStream, const GDIMetaFile& rMTF );

#endif  //_FILTER_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */