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 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
|
<?xml version="1.0"?>
<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
<!--
Copyright 2001-2002 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- ========================================================================= -->
<!-- author tkormann@apache.org -->
<!-- version $Id: rasterizerTutorial.xml,v 1.11 2004/08/18 07:17:19 vhardy Exp $ -->
<!-- ========================================================================= -->
<document>
<header>
<title>Image Transcoder Tutorial</title>
<subtitle>A brief introduction to the image transcoder API</subtitle>
<authors>
<person name="Thierry Kormann" email="tkormann@apache.org"/>
</authors>
</header>
<body>
<!-- ##################################################################### -->
<s1 title="Introduction">
<p>
The goal of the transcoder API (package
<code>org.apache.batik.transcoder</code>) is to provide a generic
API for transcoding an input to an output. First, this document
explains the basic transcoder API that <code>Transcoder</code>,
<code>TranscoderInput</code> and <code>TranscoderOutput</code>
define -- and thus all transcoders have in common. Next, it
describes how to use the image transcoder API (package
<code>org.apache.batik.transcoder.image</code>) which lets you
rasterize an SVG document fragment to a raster image such as JPEG,
PNG or Tiff.
</p>
<ul>
<li><link href="#transcoderAPI">The Transcoder API</link></li>
<li><link href="#howtousetranscoderAPI">How to Use the Image Transcoder API</link></li>
<ul>
<li><link href="#createImage">Creating an Image</link></li>
<li><link href="#definSizeOfImage">Defining the Size of the Image</link></li>
<li><link href="#selectAreaOfIntrest">Selecting an Area of Interest</link></li>
<li><link href="#otherTransHints">Other Transcoding Hints</link></li>
<li><link href="#genImagefromSVGDOM">Generating an Image from an SVG DOM Tree</link></li>
</ul>
</ul>
</s1>
<anchor id="transcoderAPI"/>
<s1 title="The Transcoder API">
<p>
The <code>org.apache.batik.transcoder</code> package defines 5 major classes:
</p>
<dl>
<dt><code>Transcoder</code></dt>
<dd>
Defines the interface that all transcoders implement. You can
transcode a specific input using a specific output by invoking the
<code>transcode</code> method. Although there is no assumption on the
input and output format, a specific transcoder may or may not support
a particular type of input or output. For example, the image
transcoders accept an SVG <code>org.w3c.dom.Document</code>, a
<code>Reader</code>, an <code>InputStream</code>, or a
<code>URI</code> as an input but only supports a byte stream for the
output.
<br /><br />
</dd>
<dt><code>TranscoderInput</code></dt>
<dd>
Defines the input of a transcoder. There are various ways to create an
input and the most commons are already part of the API. The default
implementation lets you create an input using a
<code>org.w3c.dom.Document</code>, a <code>Reader</code>, an
<code>InputStream</code>, a <code>org.xml.sax.XMLReader</code>, or a
<code>URI</code>.
<br /><br />
</dd>
<dt><code>TranscoderOutput</code></dt>
<dd>
Defines the output of a transcoder. There are various ways to create an
output and the most commons are already part of the API. The default
implementation lets you create an output using a
<code>org.w3c.dom.Document</code>, a <code>Writer</code>, an
<code>OutputStream</code>, a <code>org.xml.sax.XMLFilter</code>, or a
<code>URI</code>.
<br /><br />
</dd>
<dt><code>TranscodingHints</code></dt>
<dd>
The <code>TranscodingHints</code> class contains different hints which can
be used to control the various options or parameters of a
transcoder. Each transcoder provides its own set of hints. A hint is
specified by (key, value) pair. For example, the
<code>JPEGTranscoder</code> provides a hint to control the encoding quality.
<br /><br />
</dd>
<dt><code>ErrorHandler</code></dt>
<dd>
This class provides a way to get the errors and/or warnings that might
occur while transcoding. A default implementation is provided but
you can, for example, implement your own handler that display a dialog
instead of stack trace.
</dd>
</dl>
</s1>
<!-- ##################################################################### -->
<anchor id="howousetranscoderAPI"/>
<s1 title="How to Use the Image Transcoder API">
<p>
The <code>org.apache.batik.transcoder.image</code> package provides an
easy way to transcode an SVG document to a raster image such as JPEG,
PNG or Tiff. Additional raster image formats can be added by subclassing the
<code>ImageTranscoder</code> and implementing the
<code>writeImage</code> method. Although, in next sections, the
examples will use the JPEG transcoder, the PNG transcoder works the
same way.
</p>
<anchor id="createImage"/>
<s2 title="Creating an Image">
<p>
The following example, using the <code>JPEGTranscoder</code> shows how to
trasnform an SVG document to a JPEG image.
</p>
<source>
SaveAsJpeg.java
===============
import java.io.*;
import org.apache.batik.transcoder.image.JPEGTranscoder;
import org.apache.batik.transcoder.TranscoderInput;
import org.apache.batik.transcoder.TranscoderOutput;
public class SaveAsJPEG {
public static void main(String [] args) throws Exception {
// create a JPEG transcoder
<strong>JPEGTranscoder t = new JPEGTranscoder();</strong>
// set the transcoding hints
<strong>t.addTranscodingHint(JPEGTranscoder.KEY_QUALITY,
new Float(.8));</strong>
// create the transcoder input
String svgURI = new File(args[0]).toURL().toString();
<strong>TranscoderInput input = new TranscoderInput(svgURI);</strong>
// create the transcoder output
OutputStream ostream = new FileOutputStream("out.jpg");
<strong>TranscoderOutput output = new TranscoderOutput(ostream);</strong>
// save the image
<strong>t.transcode(input, output);</strong>
// flush and close the stream then exit
ostream.flush();
ostream.close();
System.exit(0);
}
}
</source>
<p>
The code creates a <code>JPEGTranscoder</code> and sets the
transcoding hints. The first hint indicates the XML parser to use. The
second hint sets the encoding quality. Then, an input and an output
are created. The input is created using the first command line
argument which should represent a URI. The output is a byte stream
representing a file called "out.jpg". Finally, the
<code>transcode</code> method is invoked and the byte stream is
closed.
</p>
<p>
Although not shown above, the program might have specified additional
hints to indicate a user style sheet, the preferred language of the
document or the background color.
</p>
<p>
<strong>Try this:</strong>
</p>
<ol>
<li>Compile and run the program: SaveAsJPEG.java. You will need an SVG document.<br />
<code>% java SaveAsJPEG <filename>.svg</code></li>
<li>Take a look at: out.jpg</li>
</ol>
</s2>
<anchor id="definSizeOfImage"/>
<s2 title="Defining the Size of the Image">
<p>
By adding the following line of code to the previous example, you will
specify the raster image size (in pixels). The new transcoding hint
<code>KEY_WIDTH</code> lets you specify the raster image width. As the
raster image height is not provided (using the
<code>KEY_HEIGHT</code>), the transcoder will compute the raster image
dimension by keeping the aspect ratio of the SVG document.
</p>
<source>
t.addTranscodingHint(JPEGTranscoder.KEY_WIDTH, new Integer(100));
</source>
<p>
The transcoder will have the same behavior if you specify the
<code>KEY_HEIGHT</code> without initializing the
<code>KEY_WIDTH</code>. In all cases (though both keys are provided),
the transcoder will preserve the apsect ratio of the SVG document.
</p>
</s2>
<anchor id="selectAreaOfIntrest"/>
<s2 title="Selecting an Area of Interest">
<p>
The image transcoder lets you specify an area of interest (ie. a part
of the SVG document). The key <code>KEY_AOI</code> enables to select
the region of the SVG document to render. The value of this key must
be a <code>java.awt.Rectangle</code> specified in pixels and described
in the SVG document's space. The following example shows how you can
split an SVG document into 4 tiles.
</p>
<source>
SaveAsJPEGTiles.java
====================
import java.io.*;
import java.awt.*;
import org.apache.batik.transcoder.image.JPEGTranscoder;
import org.apache.batik.transcoder.TranscoderInput;
import org.apache.batik.transcoder.TranscoderOutput;
public class SaveAsJPEGTiles {
JPEGTranscoder trans = new JPEGTranscoder();
public SaveAsJPEGTiles() {
trans.addTranscodingHint(JPEGTranscoder.KEY_QUALITY,
new Float(.8));
}
public void tile(String inputFilename,
String outputFilename,
Rectangle aoi) throws Exception {
<strong>trans.addTranscodingHint(JPEGTranscoder.KEY_WIDTH,
new Float(aoi.width));</strong>
<strong>trans.addTranscodingHint(JPEGTranscoder.KEY_HEIGHT,
new Float(aoi.height));</strong>
<strong>trans.addTranscodingHint(JPEGTranscoder.KEY_AOI, aoi);</strong>
String svgURI = new File(inputFilename).toURL().toString();
TranscoderInput input = new TranscoderInput(svgURI);
OutputStream ostream = new FileOutputStream(outputFilename);
TranscoderOutput output = new TranscoderOutput(ostream);
trans.transcode(input, output);
ostream.flush();
ostream.close();
}
public static void main(String [] args) throws Exception {
SaveAsJPEGTiles p = new SaveAsJPEGTiles();
<strong>String in = "samples/anne.svg";
int documentWidth = 450;
int documentHeight = 500;</strong>
int dw2 = documentWidth / 2;
int dh2 = documentHeight / 2;
p.tile(in, "tileTopLeft.jpg", new Rectangle(0, 0, dw2, dh2));
p.tile(in, "tileTopRight.jpg", new Rectangle(dw2, 0, dw2, dh2));
p.tile(in, "tileBottomLeft.jpg", new Rectangle(0, dh2, dw2, dh2));
p.tile(in, "tileBottomRight.jpg", new Rectangle(dw2, dh2, dw2, dh2));
System.exit(0);
}
}
</source>
<p>
This code splits the same document "anne.svg" into four tiles of the
same size. Considering the document and its original size, we can
determine four regions. Then we rasterize each region using the
<code>KEY_AOI</code> key. Note that we also specify the image width
and height to be the same as the area of interest width and height (so
we keep a 1:1 zoom factor). You can of course combine the
<code>KEY_WIDTH</code>, <code>KEY_HEIGHT</code> keys with the
<code>KEY_AOI</code>. In that case, first the area of interest will
determine which part of the SVG document has to be rendered - then
that part could be zoom in or out depending on the specified raster
image size.
</p>
<p>
<strong>Try this:</strong>
</p>
<ol>
<li>Compile and run the program: SaveAsJPEGTiles.java. You will need the "anne.svg" document.<br />
<code>% java SaveAsJPEGTiles</code></li>
<li>Take a look at: tileTopRight.jpg, tileTopRight.jpg, tileBottomRight.jpg
and tileBottomLeft.jpg</li>
</ol>
</s2>
<anchor id="otherTransHints"/>
<s2 title="Other Transcoding Hints">
<p>
The <code>ImageTranscoder</code> provides additional
<code>TranscodingHints</code> that lets you customize the generated
images.
</p>
<dl>
<dt><code>ImageTranscoder.KEY_MEDIA</code></dt>
<dd>
This hint lets you choose the CSS medium to use. The author of the SVG document
to transcode can control CSS media using the <link
href="http://www.w3.org/TR/REC-CSS2/media.html">CSS media rule</link>. Example:
<br />
<br />
<code>
trans.addTranscodingHint(ImageTranscoder.KEY_MEDIA, "print");
</code>
<br />
<br />
</dd>
<dt><code>ImageTranscoder.KEY_ALTERNATE_STYLESHEET</code></dt>
<dd>
This hint lets you choose an alternate stylesheet the author of the SVG
document to transcode might have provided using the <link
href="http://www.w3.org/TR/xml-stylesheet/">xml-stylesheet</link> processing
instruction. Example:
<br />
<br />
<code>
trans.addTranscodingHint(ImageTranscoder.KEY_ALTERNATE_STYLESHEET, alternateStylesheetName);
</code>
<br />
<br />
</dd>
<dt><code>ImageTranscoder.KEY_USER_STYLESHEET_URI</code></dt>
<dd>
This hint lets you use a user stylesheet. User stylesheet can override some
styles of the SVG document to transcode. Example:
<br />
<br />
<code>
trans.addTranscodingHint(ImageTranscoder.KEY_USER_STYLESHEET_URI, "http://...");
</code>
<br />
<br />
</dd>
<dt><code>ImageTranscoder.KEY_PIXEL_TO_MM</code></dt>
<dd>
This hint lets you use the pixel to millimeter conversion factor. This factor
is used to determine how units are converted into pixels. Example:
<br />
<br />
<code>// 96dpi</code>
<br />
<code>
trans.addTranscodingHint(ImageTranscoder.KEY_PIXEL_TO_MM, new Float(0.2645833f));
</code>
<br />
or
<br />
<code>// 72dpi</code>
<br />
<code>
trans.addTranscodingHint(ImageTranscoder.KEY_PIXEL_TO_MM, new Float(0.3528f));
</code>
<br />
<br />
</dd>
<dt><code>ImageTranscoder.KEY_BACKGROUND_COLOR</code></dt>
<dd>
This hint lets you choose a background color. Example:
<br />
<br />
<code>
trans.addTranscodingHint(ImageTranscoder.KEY_BACKGROUND_COLOR, Color.white);
</code>
<br />
<br />
</dd>
</dl>
</s2>
<anchor id="genImagefromSVGDOM"/>
<s2 title="Generating an Image from an SVG DOM Tree">
<p>
The following code creates and saves an SVG DOM tree.
</p>
<source>
DOMRasterizer.java
==================
import java.io.*;
import org.apache.batik.transcoder.image.JPEGTranscoder;
import org.apache.batik.transcoder.TranscoderInput;
import org.apache.batik.transcoder.TranscoderOutput;
import org.apache.batik.dom.svg.SVGDOMImplementation;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.DOMImplementation;
public class DOMRasterizer {
public Document createDocument() {
<strong>DOMImplementation impl = SVGDOMImplementation.getDOMImplementation();
String svgNS = SVGDOMImplementation.SVG_NAMESPACE_URI;
Document document =
impl.createDocument(svgNS, "svg", null);
Element root = document.getDocumentElement();</strong>
root.setAttributeNS(null, "width", "450");
root.setAttributeNS(null, "height", "500");
Element e;
e = document.createElementNS(svgNS, "rect");
e.setAttributeNS(null, "x", "10");
e.setAttributeNS(null, "y", "10");
e.setAttributeNS(null, "width", "200");
e.setAttributeNS(null, "height", "300");
e.setAttributeNS(null, "style", "fill:red;stroke:black;stroke-width:4");
root.appendChild(e);
e = document.createElementNS(svgNS, "circle");
e.setAttributeNS(null, "cx", "225");
e.setAttributeNS(null, "cy", "250");
e.setAttributeNS(null, "r", "100");
e.setAttributeNS(null, "style", "fill:green;fill-opacity:.5");
root.appendChild(e);
return document;
}
public void save(Document document) throws Exception {
JPEGTranscoder t = new JPEGTranscoder();
t.addTranscodingHint(JPEGTranscoder.KEY_QUALITY,
new Float(.8));
<strong>TranscoderInput input = new TranscoderInput(document);</strong>
OutputStream ostream = new FileOutputStream("out.jpg");
TranscoderOutput output = new TranscoderOutput(ostream);
t.transcode(input, output);
ostream.flush();
ostream.close();
}
public static void main(String [] args) throws Exception {
DOMRasterizer rasterizer = new DOMRasterizer();
Document document = rasterizer.createDocument();
rasterizer.save(document);
System.exit(0);
}
}
</source>
<p>
This code is divided into two distinct parts.
</p>
<dl>
<dt>Creating an SVG DOM tree</dt>
<dd>
<br />See the <code>createDocument</code> method<br /> Three steps are
required at this time. The first one consists on getting the Batik SVG
DOM implementation (via the SVGDOMImplementation class). Then, you can
create a <code>org.w3c.dom.Document</code> (which is an SVG Document by
the way) by invoking the <code>createDocument</code> method with the
svg namespace URI and the "svg" document element. At last, you can get
the document element and start building your DOM tree. <br /><br />
</dd>
<dt>Rasterizing your DOM</dt>
<dd>
<br />See the <code>save</code> method<br /> Similar to the previous
examples, you can transcode an SVG document to a raster image by
creating a <code>TranscoderInput</code> with this time, the SVG Document.
<br /><br />
</dd>
</dl>
<p>
<strong>Try this:</strong>
</p>
<ol>
<li>Compile and run the program: DOMRasterizer.java.<br />
<code>% java DOMRasterizer</code></li>
<li>Take a look at: out.jpg</li>
</ol>
</s2>
</s1>
</body>
</document>
|