The table below summarizes the theoretical support for graphical formats within FOP. In other words, within the constraints of the limitations listed here, these formats should work. However, many of them have not been tested, and there may be limitations that have not yet been discovered or documented. The packages needed to support some formats are not included in the FOP distribution and must be installed separately. Follow the links in the "Support Thru" column for more details.
Format | Type | FOP native support | Batik SVG | Batik codecs | Image I/O | JAI | JIMI |
---|---|---|---|---|---|---|---|
BMP (Microsoft Windows Bitmap) | bitmap | X | |||||
EPS (Encapsulated PostScript) | metafile (both bitmap and vector), probably most frequently used for vector drawings | (X) | |||||
GIF (Graphics Interchange Format) | bitmap | X | X | X | X | ||
JPEG (Joint Photographic Experts Group) | bitmap | (X) | X | ||||
PNG (Portable Network Graphic) | bitmap | X | X | ||||
SVG (Scalable Vector Graphics) | vector (with embedded bitmaps) | X | |||||
TIFF (Tag Image Format File) | bitmap | (X) | X | X | X | ||
EMF (Windows Enhanced Metafile) | vector (with embedded bitmaps) | (X) |
FOP has native ability to handle some graphic file formats.
Apache XML Graphics Commons contains codecs for PNG and TIFF access. FOP can use these.
For JDKs 1.4 or higher, FOP provides a wrapper to load images through the JDK's Image I/O API (JSR 015). Image I/O allows to dynamically add additional image codecs. An example of such an add-on library are the JAI Image I/O Tools available from Sun.
Because of licensing issues, the JIMI image library is not included in the FOP distribution. First, download and install it. Then, copy the file "JimiProClasses.zip" from the archive to {fop-install-dir}/lib/jimi-1.0.jar. Please note that FOP binary distributions are compiled with JIMI support, so there is no need for you to build FOP to add the support. If jimi-1.0.jar is installed in the right place, it will automatically be used by FOP, otherwise it will not.
FOP has been compiled with JAI support, but JAI is not included in the FOP distribution. To use it, install JAI, then copy the jai_core.jar and the jai_codec.jar files to {fop-install-dir}/lib. JAI is much faster than JIMI, but is not available for all platforms. See What platforms are supported? on the JAI FAQ page for more details.
Current FOP distributions include a distribution of the Apache Batik version 1.6. It is automatically installed with FOP. Because Batik's API changes frequently, it is highly recommended that you use the version that ships with FOP, at least when running FOP.
Batik must be run in a graphical environment. It uses AWT classes for rendering SVG, which in turn require an X server on Unixish systems. If you run a server without X, or if you can't connect to the X server due to security restrictions or policies (a so-called "headless" environment), SVG rendering will fail.
Here are some workarounds:
-Djava.awt.headless=true
command line option.FOP native support for BMP images is limited to the RGB color-space.
FOP provides support for two output targets:
Other output targets can't be supported at the moment because FOP lacks a PostScript interpreter. Furthermore, FOP is not able to parse the preview bitmaps sometimes contained in EPS files.
FOP native support of JPEG does not include all variants, especially those containing unusual color lookup tables and color profiles. If you have trouble with a JPEG image in FOP, try opening it with an image processing program (such as Photoshop or Gimp) and then saving it. Specifying 24-bit color output may also help. For the PDF and PostScript renderers most JPEG images can be passed through without decompression. User reports indicate that grayscale, RGB, and CMYK color-spaces are all rendered properly.
If using JAI for PNG support, only RGB and RGBA color-spaces are supported for FOP rendering.
Transparency is supported but not guaranteed to work with every output format.
FOP uses Apache Batik for SVG support.
This format can be handled as an fo:instream-foreign-object
or in a separate
file referenced with fo:external-graphic
.
The SVG is rendered into PDF by using PDF commands to draw and fill lines and curves. This means that the graphical objects created with this remain as vector graphics. The same applies to PostScript output. For other output formats the SVG graphic will be converted to a bitmap image.
There are a number of SVG things that cannot be converted directly into PDF. Parts of the graphic such as effects, patterns and images are inserted into the PDF as a raster graphic. The resolution of these raster images can be controlled through the "target resolution" setting in the configuration.
Currently transparency is limited in PDF so many svg images that contain effects or graphics with transparent areas may not be displayed correctly.
If possible, Batik will use normal PDF or PostScript text when inserting text. It does this by checking if the text can be drawn normally and the font is supported. This example svg text.svg / text.pdf shows how various types and effects with text are handled. Note that tspan and outlined text are not yet implemented.
Otherwise, text is converted and drawn as a set of shapes by Batik, using the stroking text painter. This means that a typical character will have about 10 curves (each curve consists of at least 20 characters). This can make the output files large and when it is viewed the viewer may not normally draw those fine curves very well (In Adobe Acrobat, turning on "Smooth Line Art" in the preferences will fix this). If the text is inserted into the output file using the inbuilt text commands it will use a single character.
Note that because SVG text can be rendered as either text or a vector graphic, you may need to consider settings in your viewer for both. The Acrobat viewer has both "smooth line art" and "smooth text" settings that may need to be set for SVG images to be displayed nicely on your screen (see Edit / Preferences / Display). This setting will not affect the printing of your document, which should be OK in any case, but will only affect the quality of the screen display.
Currently, SVG images are rendered with the dimensions specified in the SVG file, within the viewport specified in the fo:external-graphic element. For everything to work properly, the two should be equal. The SVG standard leaves this issue as an implementation detail. FOP will probably implement a scaling mechanism in the future.
If you use pixels to specify the size of an SVG graphic the "source resolution" setting in the configuration will be used to determine the size of a pixel. The use of pixels to specify sizes is discouraged as they may be interpreted differently in different environments.
FOP-native TIFF support is limited to PDF and PostScript output only. Also, according to user reports, FOP's native support for TIFF is limited to images with the following characteristics (all must be true for successful rendering):
JAI: Supports RGB and RGBA only for FOP rendering.
Windows Enhanced Metafiles (EMF) are only supported in RTF output.
Some bitmapped image file formats store a dots-per-inch (dpi) or other resolution values. FOP tries to use this resolution information whenever possible to determine the image's intrinsic size. This size is used during the layout process when it is not superceeded by an explicit size on fo:external-graphic (content-width and content-height properties).
Please note that not all images contain resolution information. If it's not available 72 dpi is assumed (the default resolution of PDF and PostScript).
Bitmap images are generally embedded into the output format at their original resolution (as is). No resampling of the image is performed. Explicit resampling is on our wishlist, but hasn't been implemented, yet. Bitmaps included in SVG graphics may be resampled to the resolution specified in the "target resolution" setting in the configuration if SVG filters are applied. This can be used as a work-around to resample images in FO documents.
FOP caches images between runs. There is one cache per FopFactory instance. The URI is used as a key to identify images which means that when a particular URI appears again, the image is taken from the cache. If you have a servlet that generates a different image each time it is called with the same URL you need to use a constantly changing dummy parameter on the URL to avoid caching.
The image cache has been improved considerably in the redesigned code. Therefore, a resetCache() method like in earlier versions of FOP has become unnecessary. If you still experience OutOfMemoryErrors, please notify us.