1 /*
2 * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25 package java.awt;
26
27 import java.io.IOException;
28 import java.awt.image.*;
29 import java.net.URL;
30 import java.net.URLConnection;
31 import java.io.File;
32 import sun.util.logging.PlatformLogger;
33 import sun.awt.image.SunWritableRaster;
34
35 /**
36 * The splash screen can be displayed at application startup, before the
37 * Java Virtual Machine (JVM) starts. The splash screen is displayed as an
38 * undecorated window containing an image. You can use GIF, JPEG, or PNG files
39 * for the image. Animation is supported for the GIF format, while transparency
40 * is supported both for GIF and PNG. The window is positioned at the center
41 * of the screen. The position on multi-monitor systems is not specified. It is
42 * platform and implementation dependent. The splash screen window is closed
43 * automatically as soon as the first window is displayed by Swing/AWT (may be
44 * also closed manually using the Java API, see below).
45 * <P>
46 * If your application is packaged in a jar file, you can use the
47 * "SplashScreen-Image" option in a manifest file to show a splash screen.
48 * Place the image in the jar archive and specify the path in the option.
49 * The path should not have a leading slash.
50 * <BR>
51 * For example, in the {@code manifest.mf} file:
52 * <PRE>
53 * Manifest-Version: 1.0
54 * Main-Class: Test
55 * SplashScreen-Image: filename.gif
56 * </PRE>
57 * <P>
58 * If the Java implementation provides the command-line interface and you run
59 * your application by using the command line or a shortcut, use the Java
60 * application launcher option to show a splash screen. The Oracle reference
61 * implementation allows you to specify the splash screen image location with
62 * the {@code -splash:} option.
63 * <BR>
64 * For example:
65 * <PRE>
66 * java -splash:filename.gif Test
67 * </PRE>
68 * The command line interface has higher precedence over the manifest
69 * setting.
70 * <p>
71 * The splash screen will be displayed as faithfully as possible to present the
72 * whole splash screen image given the limitations of the target platform and
73 * display.
74 * <p>
75 * It is implied that the specified image is presented on the screen "as is",
76 * i.e. preserving the exact color values as specified in the image file. Under
77 * certain circumstances, though, the presented image may differ, e.g. when
78 * applying color dithering to present a 32 bits per pixel (bpp) image on a 16
79 * or 8 bpp screen. The native platform display configuration may also affect
80 * the colors of the displayed image (e.g. color profiles, etc.)
81 * <p>
82 * The {@code SplashScreen} class provides the API for controlling the splash
83 * screen. This class may be used to close the splash screen, change the splash
84 * screen image, get the splash screen native window position/size, and paint
85 * in the splash screen. It cannot be used to create the splash screen. You
86 * should use the options provided by the Java implementation for that.
87 * <p>
88 * This class cannot be instantiated. Only a single instance of this class
89 * can exist, and it may be obtained by using the {@link #getSplashScreen()}
90 * static method. In case the splash screen has not been created at
91 * application startup via the command line or manifest file option,
92 * the {@code getSplashScreen} method returns {@code null}.
93 *
94 * @author Oleg Semenov
95 * @since 1.6
96 */
97 public final class SplashScreen {
98
99 SplashScreen(long ptr) { // non-public constructor
100 splashPtr = ptr;
101 }
102
103 /**
104 * Returns the {@code SplashScreen} object used for
105 * Java startup splash screen control on systems that support display.
106 *
107 * @throws UnsupportedOperationException if the splash screen feature is not
108 * supported by the current toolkit
109 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
110 * returns true
111 * @return the {@link SplashScreen} instance, or {@code null} if there is
112 * none or it has already been closed
113 */
114 public static SplashScreen getSplashScreen() {
115 synchronized (SplashScreen.class) {
116 if (GraphicsEnvironment.isHeadless()) {
117 throw new HeadlessException();
118 }
119 // SplashScreen class is now a singleton
120 if (!wasClosed && theInstance == null) {
121 java.security.AccessController.doPrivileged(
122 new java.security.PrivilegedAction<Void>() {
123 public Void run() {
124 System.loadLibrary("splashscreen");
125 return null;
126 }
127 });
128 long ptr = _getInstance();
129 if (ptr != 0 && _isVisible(ptr)) {
130 theInstance = new SplashScreen(ptr);
131 }
132 }
133 return theInstance;
134 }
135 }
136
137 /**
138 * Changes the splash screen image. The new image is loaded from the
139 * specified URL; GIF, JPEG and PNG image formats are supported.
140 * The method returns after the image has finished loading and the window
141 * has been updated.
142 * The splash screen window is resized according to the size of
143 * the image and is centered on the screen.
144 *
145 * @param imageURL the non-{@code null} URL for the new
146 * splash screen image
147 * @throws NullPointerException if {@code imageURL} is {@code null}
148 * @throws IOException if there was an error while loading the image
149 * @throws IllegalStateException if the splash screen has already been
150 * closed
151 */
152 public void setImageURL(URL imageURL) throws NullPointerException, IOException, IllegalStateException {
153 checkVisible();
154 URLConnection connection = imageURL.openConnection();
155 connection.connect();
156 int length = connection.getContentLength();
157 java.io.InputStream stream = connection.getInputStream();
158 byte[] buf = new byte[length];
159 int off = 0;
160 while(true) {
161 // check for available data
162 int available = stream.available();
163 if (available <= 0) {
164 // no data available... well, let's try reading one byte
165 // we'll see what happens then
166 available = 1;
167 }
168 // check for enough room in buffer, realloc if needed
169 // the buffer always grows in size 2x minimum
170 if (off + available > length) {
171 length = off*2;
172 if (off + available > length) {
173 length = available+off;
174 }
175 byte[] oldBuf = buf;
176 buf = new byte[length];
177 System.arraycopy(oldBuf, 0, buf, 0, off);
178 }
179 // now read the data
180 int result = stream.read(buf, off, available);
181 if (result < 0) {
182 break;
183 }
184 off += result;
185 }
186 synchronized(SplashScreen.class) {
187 checkVisible();
188 if (!_setImageData(splashPtr, buf)) {
189 throw new IOException("Bad image format or i/o error when loading image");
190 }
191 this.imageURL = imageURL;
192 }
193 }
194
195 private void checkVisible() {
196 if (!isVisible()) {
197 throw new IllegalStateException("no splash screen available");
198 }
199 }
200 /**
201 * Returns the current splash screen image.
202 *
203 * @return URL for the current splash screen image file
204 * @throws IllegalStateException if the splash screen has already been closed
205 */
206 @SuppressWarnings("deprecation")
207 public URL getImageURL() throws IllegalStateException {
208 synchronized (SplashScreen.class) {
209 checkVisible();
210 if (imageURL == null) {
211 try {
212 String fileName = _getImageFileName(splashPtr);
213 String jarName = _getImageJarName(splashPtr);
214 if (fileName != null) {
215 if (jarName != null) {
216 imageURL = new URL("jar:"+(new File(jarName).toURL().toString())+"!/"+fileName);
217 } else {
218 imageURL = new File(fileName).toURL();
219 }
220 }
221 }
222 catch(java.net.MalformedURLException e) {
223 if (log.isLoggable(PlatformLogger.Level.FINE)) {
224 log.fine("MalformedURLException caught in the getImageURL() method", e);
225 }
226 }
227 }
228 return imageURL;
229 }
230 }
231
232 /**
233 * Returns the bounds of the splash screen window as a {@link Rectangle}.
234 * This may be useful if, for example, you want to replace the splash
235 * screen with your window at the same location.
236 * <p>
237 * You cannot control the size or position of the splash screen.
238 * The splash screen size is adjusted automatically when the image changes.
239 * <p>
240 * The image may contain transparent areas, and thus the reported bounds may
241 * be larger than the visible splash screen image on the screen.
242 *
243 * @return a {@code Rectangle} containing the splash screen bounds
244 * @throws IllegalStateException if the splash screen has already been closed
245 */
246 public Rectangle getBounds() throws IllegalStateException {
247 synchronized (SplashScreen.class) {
248 checkVisible();
249 float scale = _getScaleFactor(splashPtr);
250 Rectangle bounds = _getBounds(splashPtr);
251 assert scale > 0;
252 if (scale > 0 && scale != 1) {
253 bounds.setSize((int) (bounds.getWidth() / scale),
254 (int) (bounds.getWidth() / scale));
255 }
256 return bounds;
257 }
258 }
259
260 /**
261 * Returns the size of the splash screen window as a {@link Dimension}.
262 * This may be useful if, for example,
263 * you want to draw on the splash screen overlay surface.
264 * <p>
265 * You cannot control the size or position of the splash screen.
266 * The splash screen size is adjusted automatically when the image changes.
267 * <p>
268 * The image may contain transparent areas, and thus the reported size may
269 * be larger than the visible splash screen image on the screen.
270 *
271 * @return a {@link Dimension} object indicating the splash screen size
272 * @throws IllegalStateException if the splash screen has already been closed
273 */
274 public Dimension getSize() throws IllegalStateException {
275 return getBounds().getSize();
276 }
277
278 /**
279 * Creates a graphics context (as a {@link Graphics2D} object) for the splash
280 * screen overlay image, which allows you to draw over the splash screen.
281 * Note that you do not draw on the main image but on the image that is
282 * displayed over the main image using alpha blending. Also note that drawing
283 * on the overlay image does not necessarily update the contents of splash
284 * screen window. You should call {@code update()} on the
285 * {@code SplashScreen} when you want the splash screen to be
286 * updated immediately.
287 * <p>
288 * The pixel (0, 0) in the coordinate space of the graphics context
289 * corresponds to the origin of the splash screen native window bounds (see
290 * {@link #getBounds()}).
291 *
292 * @return graphics context for the splash screen overlay surface
293 * @throws IllegalStateException if the splash screen has already been closed
294 */
295 public Graphics2D createGraphics() throws IllegalStateException {
296 synchronized (SplashScreen.class) {
297 checkVisible();
298 if (image==null) {
299 // get unscaled splash image size
300 Dimension dim = _getBounds(splashPtr).getSize();
301 image = new BufferedImage(dim.width, dim.height,
302 BufferedImage.TYPE_INT_ARGB);
303 }
304 float scale = _getScaleFactor(splashPtr);
305 Graphics2D g = image.createGraphics();
306 assert (scale > 0);
307 if (scale <= 0) {
308 scale = 1;
309 }
310 g.scale(scale, scale);
311 return g;
312 }
313 }
314
315 /**
316 * Updates the splash window with current contents of the overlay image.
317 *
318 * @throws IllegalStateException if the overlay image does not exist;
319 * for example, if {@code createGraphics} has never been called,
320 * or if the splash screen has already been closed
321 */
322 public void update() throws IllegalStateException {
323 BufferedImage image;
324 synchronized (SplashScreen.class) {
325 checkVisible();
326 image = this.image;
327 }
328 if (image == null) {
329 throw new IllegalStateException("no overlay image available");
330 }
331 DataBuffer buf = image.getRaster().getDataBuffer();
332 if (!(buf instanceof DataBufferInt)) {
333 throw new AssertionError("Overlay image DataBuffer is of invalid type == "+buf.getClass().getName());
334 }
335 int numBanks = buf.getNumBanks();
336 if (numBanks!=1) {
337 throw new AssertionError("Invalid number of banks =="+numBanks+" in overlay image DataBuffer");
338 }
339 if (!(image.getSampleModel() instanceof SinglePixelPackedSampleModel)) {
340 throw new AssertionError("Overlay image has invalid sample model == "+image.getSampleModel().getClass().getName());
341 }
342 SinglePixelPackedSampleModel sm = (SinglePixelPackedSampleModel)image.getSampleModel();
343 int scanlineStride = sm.getScanlineStride();
344 Rectangle rect = image.getRaster().getBounds();
345 // Note that we steal the data array here, but just for reading
346 // so we do not need to mark the DataBuffer dirty...
347 int[] data = SunWritableRaster.stealData((DataBufferInt)buf, 0);
348 synchronized(SplashScreen.class) {
349 checkVisible();
350 _update(splashPtr, data, rect.x, rect.y, rect.width, rect.height, scanlineStride);
351 }
352 }
353
354 /**
355 * Hides the splash screen, closes the window, and releases all associated
356 * resources.
357 *
358 * @throws IllegalStateException if the splash screen has already been closed
359 */
360 public void close() throws IllegalStateException {
361 synchronized (SplashScreen.class) {
362 checkVisible();
363 _close(splashPtr);
364 image = null;
365 SplashScreen.markClosed();
366 }
367 }
368
369 static void markClosed() {
370 synchronized (SplashScreen.class) {
371 wasClosed = true;
372 theInstance = null;
373 }
374 }
375
376
377 /**
378 * Determines whether the splash screen is visible. The splash screen may
379 * be hidden using {@link #close()}, it is also hidden automatically when
380 * the first AWT/Swing window is made visible.
381 * <p>
382 * Note that the native platform may delay presenting the splash screen
383 * native window on the screen. The return value of {@code true} for this
384 * method only guarantees that the conditions to hide the splash screen
385 * window have not occurred yet.
386 *
387 * @return true if the splash screen is visible (has not been closed yet),
388 * false otherwise
389 */
390 public boolean isVisible() {
391 synchronized (SplashScreen.class) {
392 return !wasClosed && _isVisible(splashPtr);
393 }
394 }
395
396 private BufferedImage image; // overlay image
397
398 private final long splashPtr; // pointer to native Splash structure
399 private static boolean wasClosed = false;
400
401 private URL imageURL;
402
403 /**
404 * The instance reference for the singleton.
405 * ({@code null} if no instance exists yet.)
406 *
407 * @see #getSplashScreen
408 * @see #close
409 */
410 private static SplashScreen theInstance = null;
411
412 private static final PlatformLogger log = PlatformLogger.getLogger("java.awt.SplashScreen");
413
414 private static native void _update(long splashPtr, int[] data, int x, int y, int width, int height, int scanlineStride);
415 private static native boolean _isVisible(long splashPtr);
416 private static native Rectangle _getBounds(long splashPtr);
417 private static native long _getInstance();
418 private static native void _close(long splashPtr);
419 private static native String _getImageFileName(long splashPtr);
420 private static native String _getImageJarName(long SplashPtr);
421 private static native boolean _setImageData(long SplashPtr, byte[] data);
422 private static native float _getScaleFactor(long SplashPtr);
423
424 }