/tools/src/main/java/org/apache/pdfbox/tools/PDFToImage.java
Java | 323 lines | 263 code | 20 blank | 40 comment | 56 complexity | 3be8eae9325b8b8c4446a0ae3e0e0a83 MD5 | raw file
Possible License(s): BSD-3-Clause, Apache-2.0
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You 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.
- */
- package org.apache.pdfbox.tools;
- import java.awt.HeadlessException;
- import java.awt.Toolkit;
- import java.awt.image.BufferedImage;
- import java.io.File;
- import java.io.IOException;
- import javax.imageio.ImageIO;
- import org.apache.pdfbox.pdmodel.PDDocument;
- import org.apache.pdfbox.pdmodel.PDPage;
- import org.apache.pdfbox.pdmodel.common.PDRectangle;
- import org.apache.pdfbox.rendering.ImageType;
- import org.apache.pdfbox.rendering.PDFRenderer;
- import org.apache.pdfbox.tools.imageio.ImageIOUtil;
- /**
- * Convert a PDF document to an image.
- *
- * @author Ben Litchfield
- */
- public final class PDFToImage
- {
- private static final String PASSWORD = "-password";
- private static final String START_PAGE = "-startPage";
- private static final String END_PAGE = "-endPage";
- private static final String PAGE = "-page";
- private static final String IMAGE_TYPE = "-imageType";
- private static final String FORMAT = "-format";
- private static final String OUTPUT_PREFIX = "-outputPrefix";
- private static final String PREFIX = "-prefix";
- private static final String COLOR = "-color";
- private static final String RESOLUTION = "-resolution";
- private static final String DPI = "-dpi";
- private static final String CROPBOX = "-cropbox";
- private static final String TIME = "-time";
- /**
- * private constructor.
- */
- private PDFToImage()
- {
- //static class
- }
- /**
- * Infamous main method.
- *
- * @param args Command line arguments, should be one and a reference to a file.
- *
- * @throws IOException If there is an error parsing the document.
- */
- public static void main( String[] args ) throws IOException
- {
- // suppress the Dock icon on OS X
- System.setProperty("apple.awt.UIElement", "true");
- String password = "";
- String pdfFile = null;
- String outputPrefix = null;
- String imageFormat = "jpg";
- int startPage = 1;
- int endPage = Integer.MAX_VALUE;
- String color = "rgb";
- int dpi;
- float cropBoxLowerLeftX = 0;
- float cropBoxLowerLeftY = 0;
- float cropBoxUpperRightX = 0;
- float cropBoxUpperRightY = 0;
- boolean showTime = false;
- try
- {
- dpi = Toolkit.getDefaultToolkit().getScreenResolution();
- }
- catch( HeadlessException e )
- {
- dpi = 96;
- }
- for( int i = 0; i < args.length; i++ )
- {
- if( args[i].equals( PASSWORD ) )
- {
- i++;
- if( i >= args.length )
- {
- usage();
- }
- password = args[i];
- }
- else if( args[i].equals( START_PAGE ) )
- {
- i++;
- if( i >= args.length )
- {
- usage();
- }
- startPage = Integer.parseInt( args[i] );
- }
- else if( args[i].equals( END_PAGE ) )
- {
- i++;
- if( i >= args.length )
- {
- usage();
- }
- endPage = Integer.parseInt( args[i] );
- }
- else if( args[i].equals( PAGE ) )
- {
- i++;
- if( i >= args.length )
- {
- usage();
- }
- startPage = Integer.parseInt( args[i] );
- endPage = Integer.parseInt( args[i] );
- }
- else if( args[i].equals(IMAGE_TYPE) || args[i].equals(FORMAT) )
- {
- i++;
- imageFormat = args[i];
- }
- else if( args[i].equals( OUTPUT_PREFIX ) || args[i].equals( PREFIX ) )
- {
- i++;
- outputPrefix = args[i];
- }
- else if( args[i].equals( COLOR ) )
- {
- i++;
- color = args[i];
- }
- else if( args[i].equals( RESOLUTION ) || args[i].equals( DPI ) )
- {
- i++;
- dpi = Integer.parseInt(args[i]);
- }
- else if( args[i].equals( CROPBOX ) )
- {
- i++;
- cropBoxLowerLeftX = Float.valueOf(args[i]);
- i++;
- cropBoxLowerLeftY = Float.valueOf(args[i]);
- i++;
- cropBoxUpperRightX = Float.valueOf(args[i]);
- i++;
- cropBoxUpperRightY = Float.valueOf(args[i]);
- }
- else if( args[i].equals( TIME ) )
- {
- showTime = true;
- }
- else
- {
- if( pdfFile == null )
- {
- pdfFile = args[i];
- }
- }
- }
- if( pdfFile == null )
- {
- usage();
- }
- else
- {
- if(outputPrefix == null)
- {
- outputPrefix = pdfFile.substring( 0, pdfFile.lastIndexOf( '.' ));
- }
- PDDocument document = null;
- try
- {
- document = PDDocument.load(new File(pdfFile), password);
- ImageType imageType = null;
- if ("bilevel".equalsIgnoreCase(color))
- {
- imageType = ImageType.BINARY;
- }
- else if ("gray".equalsIgnoreCase(color))
- {
- imageType = ImageType.GRAY;
- }
- else if ("rgb".equalsIgnoreCase(color))
- {
- imageType = ImageType.RGB;
- }
- else if ("rgba".equalsIgnoreCase(color))
- {
- imageType = ImageType.ARGB;
- }
-
- if (imageType == null)
- {
- System.err.println( "Error: Invalid color." );
- System.exit( 2 );
- }
- //if a CropBox has been specified, update the CropBox:
- //changeCropBoxes(PDDocument document,float a, float b, float c,float d)
- if ( cropBoxLowerLeftX!=0 || cropBoxLowerLeftY!=0
- || cropBoxUpperRightX!=0 || cropBoxUpperRightY!=0 )
- {
- changeCropBox(document,
- cropBoxLowerLeftX, cropBoxLowerLeftY,
- cropBoxUpperRightX, cropBoxUpperRightY);
- }
- long startTime = System.nanoTime();
- // render the pages
- boolean success = true;
- endPage = Math.min(endPage, document.getNumberOfPages());
- PDFRenderer renderer = new PDFRenderer(document);
- for (int i = startPage - 1; i < endPage; i++)
- {
- BufferedImage image = renderer.renderImageWithDPI(i, dpi, imageType);
- String fileName = outputPrefix + (i + 1) + "." + imageFormat;
- success &= ImageIOUtil.writeImage(image, fileName, dpi);
- }
- // performance stats
- long endTime = System.nanoTime();
- long duration = endTime - startTime;
- int count = 1 + endPage - startPage;
- if (showTime)
- {
- System.err.printf("Rendered %d page%s in %dms\n", count, count == 1 ? "" : "s",
- duration / 1000000);
- }
- if (!success)
- {
- System.err.println( "Error: no writer found for image format '"
- + imageFormat + "'" );
- System.exit(1);
- }
- }
- finally
- {
- if( document != null )
- {
- document.close();
- }
- }
- }
- }
- /**
- * This will print the usage requirements and exit.
- */
- private static void usage()
- {
- String message = "Usage: java -jar pdfbox-app-x.y.z.jar PDFToImage [options] <inputfile>\n"
- + "\nOptions:\n"
- + " -password <password> : Password to decrypt document\n"
- + " -format <string> : Image format: " + getImageFormats() + "\n"
- + " -prefix <string> : Filename prefix for image files\n"
- + " -page <number> : The only page to extract (1-based)\n"
- + " -startPage <int> : The first page to start extraction (1-based)\n"
- + " -endPage <int> : The last page to extract(inclusive)\n"
- + " -color <int> : The color depth (valid: bilevel, indexed, gray, rgb, rgba)\n"
- + " -dpi <int> : The DPI of the output image\n"
- + " -cropbox <int> <int> <int> <int> : The page area to export\n"
- + " -time : Prints timing information to stdout\n"
- + " <inputfile> : The PDF document to use\n";
-
- System.err.println(message);
- System.exit( 1 );
- }
- private static String getImageFormats()
- {
- StringBuilder retval = new StringBuilder();
- String[] formats = ImageIO.getReaderFormatNames();
- for( int i = 0; i < formats.length; i++ )
- {
- if (formats[i].equalsIgnoreCase(formats[i]))
- {
- retval.append( formats[i] );
- if( i + 1 < formats.length )
- {
- retval.append( ", " );
- }
- }
- }
- return retval.toString();
- }
- private static void changeCropBox(PDDocument document, float a, float b, float c, float d)
- {
- for (PDPage page : document.getPages())
- {
- System.out.println("resizing page");
- PDRectangle rectangle = new PDRectangle();
- rectangle.setLowerLeftX(a);
- rectangle.setLowerLeftY(b);
- rectangle.setUpperRightX(c);
- rectangle.setUpperRightY(d);
- page.setCropBox(rectangle);
- }
- }
- }