1 /*
2  * $RCSfile: GIFImageWriterSpi.java,v $
3  *
4  * 
5  * Copyright (c) 2005 Sun Microsystems, Inc. All  Rights Reserved.
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met: 
10  * 
11  * - Redistribution of source code must retain the above copyright 
12  *   notice, this  list of conditions and the following disclaimer.
13  * 
14  * - Redistribution in binary form must reproduce the above copyright
15  *   notice, this list of conditions and the following disclaimer in 
16  *   the documentation and/or other materials provided with the
17  *   distribution.
18  * 
19  * Neither the name of Sun Microsystems, Inc. or the names of 
20  * contributors may be used to endorse or promote products derived 
21  * from this software without specific prior written permission.
22  * 
23  * This software is provided "AS IS," without a warranty of any 
24  * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND 
25  * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, 
26  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
27  * EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL 
28  * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF 
29  * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
30  * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR 
31  * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
32  * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
33  * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
34  * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGES. 
36  * 
37  * You acknowledge that this software is not designed or intended for 
38  * use in the design, construction, operation or maintenance of any 
39  * nuclear facility. 
40  *
41  * $Revision: 1.3 $
42  * $Date: 2006/03/31 19:43:39 $
43  * $State: Exp $
44  */
45
46 package com.github.jaiimageio.impl.plugins.gif;
47
48 import java.awt.image.ColorModel;
49 import java.awt.image.SampleModel;
50 import java.util.Locale;
51
52 import javax.imageio.ImageTypeSpecifier;
53 import javax.imageio.ImageWriter;
54 import javax.imageio.spi.ImageWriterSpi;
55 import javax.imageio.spi.ServiceRegistry;
56
57 import com.github.jaiimageio.impl.common.ImageUtil;
58 import com.github.jaiimageio.impl.common.PackageUtil;
59 import com.github.jaiimageio.impl.common.PaletteBuilder;
60
61 public class GIFImageWriterSpi extends ImageWriterSpi {
62
63     private static final String vendorName = "Sun Microsystems, Inc.";
64
65     private static final String version = "1.0";
66
67     private static final String[] names = { "gif", "GIF" };
68
69     private static final String[] suffixes = { "gif" };
70
71     private static final String[] MIMETypes = { "image/gif" };
72
73     private static final String writerClassName =
74     "com.github.jaiimageio.impl.plugins.gif.GIFImageWriter";
75
76     private static final String[] readerSpiNames = {
77         "com.sun.imageio.plugins.gif.GIFImageReaderSpi"
78     };
79
80     private boolean registered = false;
81
82     public GIFImageWriterSpi() {
83         super(vendorName,
84               version,
85               names,
86               suffixes,
87               MIMETypes,
88               writerClassName,
89               STANDARD_OUTPUT_TYPE,
90               readerSpiNames,
91               true,
92               GIFWritableStreamMetadata.NATIVE_FORMAT_NAME,
93               "com.github.jaiimageio.impl.plugins.gif.GIFStreamMetadataFormat",
94               null, null,
95               true,
96               GIFWritableImageMetadata.NATIVE_FORMAT_NAME,
97               "com.github.jaiimageio.impl.plugins.gif.GIFStreamMetadataFormat",
98               null, null
99               );
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 }
148