001/*
002 * $RCSfile: GIFImageWriterSpi.java,v $
003 *
004 * 
005 * Copyright (c) 2005 Sun Microsystems, Inc. All  Rights Reserved.
006 * 
007 * Redistribution and use in source and binary forms, with or without
008 * modification, are permitted provided that the following conditions
009 * are met: 
010 * 
011 * - Redistribution of source code must retain the above copyright 
012 *   notice, this  list of conditions and the following disclaimer.
013 * 
014 * - Redistribution in binary form must reproduce the above copyright
015 *   notice, this list of conditions and the following disclaimer in 
016 *   the documentation and/or other materials provided with the
017 *   distribution.
018 * 
019 * Neither the name of Sun Microsystems, Inc. or the names of 
020 * contributors may be used to endorse or promote products derived 
021 * from this software without specific prior written permission.
022 * 
023 * This software is provided "AS IS," without a warranty of any 
024 * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND 
025 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, 
026 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
027 * EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL 
028 * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF 
029 * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
030 * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR 
031 * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
032 * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
033 * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
034 * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
035 * POSSIBILITY OF SUCH DAMAGES. 
036 * 
037 * You acknowledge that this software is not designed or intended for 
038 * use in the design, construction, operation or maintenance of any 
039 * nuclear facility. 
040 *
041 * $Revision: 1.3 $
042 * $Date: 2006/03/31 19:43:39 $
043 * $State: Exp $
044 */
045
046package com.github.jaiimageio.impl.plugins.gif;
047
048import java.awt.image.ColorModel;
049import java.awt.image.SampleModel;
050import java.util.Locale;
051
052import javax.imageio.ImageTypeSpecifier;
053import javax.imageio.ImageWriter;
054import javax.imageio.spi.ImageWriterSpi;
055import javax.imageio.spi.ServiceRegistry;
056
057import com.github.jaiimageio.impl.common.ImageUtil;
058import com.github.jaiimageio.impl.common.PackageUtil;
059import com.github.jaiimageio.impl.common.PaletteBuilder;
060
061public class GIFImageWriterSpi extends ImageWriterSpi {
062
063    private static final String vendorName = "Sun Microsystems, Inc.";
064
065    private static final String version = "1.0";
066
067    private static final String[] names = { "gif", "GIF" };
068
069    private static final String[] suffixes = { "gif" };
070
071    private static final String[] MIMETypes = { "image/gif" };
072
073    private static final String writerClassName =
074    "com.github.jaiimageio.impl.plugins.gif.GIFImageWriter";
075
076    private static final String[] readerSpiNames = {
077        "com.sun.imageio.plugins.gif.GIFImageReaderSpi"
078    };
079
080    private boolean registered = false;
081
082    public GIFImageWriterSpi() {
083        super(vendorName,
084              version,
085              names,
086              suffixes,
087              MIMETypes,
088              writerClassName,
089              STANDARD_OUTPUT_TYPE,
090              readerSpiNames,
091              true,
092              GIFWritableStreamMetadata.NATIVE_FORMAT_NAME,
093              "com.github.jaiimageio.impl.plugins.gif.GIFStreamMetadataFormat",
094              null, null,
095              true,
096              GIFWritableImageMetadata.NATIVE_FORMAT_NAME,
097              "com.github.jaiimageio.impl.plugins.gif.GIFStreamMetadataFormat",
098              null, null
099              );
100    }
101
102    public boolean canEncodeImage(ImageTypeSpecifier type) {
103        if (type == null) {
104            throw new IllegalArgumentException("type == null!");
105        }
106
107        SampleModel sm = type.getSampleModel();
108        ColorModel cm = type.getColorModel();
109
110        boolean canEncode = sm.getNumBands() == 1 &&
111            sm.getSampleSize(0) <= 8 &&
112            sm.getWidth() <= 65535 &&
113            sm.getHeight() <= 65535 &&
114            (cm == null || cm.getComponentSize()[0] <= 8);
115
116        if (canEncode) {
117            return true;
118        } else {
119            return PaletteBuilder.canCreatePalette(type);
120        }
121    }
122
123    public String getDescription(Locale locale) {
124        String desc = PackageUtil.getSpecificationTitle() + 
125            " GIF Image Writer";  
126        return desc;
127    }
128
129    public void onRegistration(ServiceRegistry registry,
130                               Class category) {
131        if (registered) {
132            return;
133        }
134        
135        registered = true;
136        
137        // By JDK 1.8, the GIFImageWriter will have been in JDK core for 
138        // atleast two FCS releases, so we can set JIIO's to lower priority
139        // With JDK 1.9, we can entirely de-register the JIIO one
140        ImageUtil.processOnRegistration(registry, category, "GIF", this,
141                                        9, 8); // JDK version 1.9, 1.8
142    }
143
144    public ImageWriter createWriterInstance(Object extension) {
145        return new GIFImageWriter(this);
146    }
147}