Site iconJava PDF Blog

Replacing the deprecated Java JPEG classes for Java 7

In the early days of Java, Sun produced a really handy set of classes to handle JPEG images. These included some really nifty little features like the ability to easily set the amount of compression and the resolution. When ImageIO came along, the class was deprecated. This means that it is still in Java but not guaranteed to be in any later releases. ImageIO was more complicated to use for JPEG images and we felt the earlier code produced better results so we continued to use it.

How do I update my old code?

The old JPEG classes have now been removed and will no longer compile. Here is the old and new versions so you can see the changes if you are still using these classes.

public static void saveAsJPEG(String jpgFlag,BufferedImage image_to_save, float JPEGcompression, FileOutputStream fos) throws IOException {

    //useful documentation at http://docs.oracle.com/javase/7/docs/api/javax/imageio/metadata/doc-files/jpeg_metadata.html
    //useful example program at http://johnbokma.com/java/obtaining-image-metadata.html to output JPEG data

    //old jpeg class
    //com.sun.image.codec.jpeg.JPEGImageEncoder jpegEncoder = com.sun.image.codec.jpeg.JPEGCodec.createJPEGEncoder(fos);
    //com.sun.image.codec.jpeg.JPEGEncodeParam jpegEncodeParam = jpegEncoder.getDefaultJPEGEncodeParam(image_to_save);

    // Image writer
    JPEGImageWriter imageWriter = (JPEGImageWriter) ImageIO.getImageWritersBySuffix(“jpeg”).next();
    ImageOutputStream ios = ImageIO.createImageOutputStream(fos);
    imageWriter.setOutput(ios);

    //and metadata
    IIOMetadata imageMetaData = imageWriter.getDefaultImageMetadata(new ImageTypeSpecifier(image_to_save), null);

    if (jpgFlag != null){

        int dpi = 96;

        try {
            dpi = Integer.parseInt(jpgFlag);
        } catch (Exception e) {
            e.printStackTrace();
        }

        //old metadata
        //jpegEncodeParam.setDensityUnit(com.sun.image.codec.jpeg.JPEGEncodeParam.DENSITY_UNIT_DOTS_INCH);
        //jpegEncodeParam.setXDensity(dpi);
        //jpegEncodeParam.setYDensity(dpi);

        //new metadata
        Element tree = (Element) imageMetaData.getAsTree(“javax_imageio_jpeg_image_1.0?);
        Element jfif = (Element)tree.getElementsByTagName(“app0JFIF”).item(0);
        jfif.setAttribute(“Xdensity”, Integer.toString(dpi));
        jfif.setAttribute(“Ydensity”, Integer.toString(dpi));

    }

    if(JPEGcompression>=0 && JPEGcompression<=1f){

        //old compression
        //jpegEncodeParam.setQuality(JPEGcompression,false);

        // new Compression
        JPEGImageWriteParam jpegParams = (JPEGImageWriteParam) imageWriter.getDefaultWriteParam();
        jpegParams.setCompressionMode(JPEGImageWriteParam.MODE_EXPLICIT);
        jpegParams.setCompressionQuality(JPEGcompression);

    }

    //old write and clean
    //jpegEncoder.encode(image_to_save, jpegEncodeParam);

    //new Write and clean up
    imageWriter.write(imageMetaData, new IIOImage(image_to_save, null, null), null);
    ios.close();
    imageWriter.dispose();

}

Are there any other alternatives?

We were not happy with ImageIO’s JPEG performance, so we developed our own solution called JDeli. You can find out how to read and write JPEG images in Java with JDeli and other libraries in these articles