1 /*
   2  * Copyright (c) 2005, 2012, 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 
  26 #ifndef SPLASHSCREEN_IMPL_H
  27 #define SPLASHSCREEN_IMPL_H
  28 
  29 #include "splashscreen_config.h"
  30 #include "splashscreen_gfx.h"
  31 
  32 SPLASHEXPORT int SplashLoadMemory(void *pdata, int size); /* requires preloading the file */
  33 SPLASHEXPORT int SplashLoadFile(const char *filename);  // FIXME: range checking for SplashLoadMemory
  34 
  35 SPLASHEXPORT void SplashInit(void);
  36 SPLASHEXPORT void SplashClose(void);
  37 
  38 SPLASHEXPORT void
  39 SplashSetFileJarName(const char* fileName, const char* jarName);
  40 
  41 typedef struct SplashImage
  42 {
  43     rgbquad_t *bitmapBits;
  44     int delay;                  /* before next image display, in msec                                                       */
  45 #if defined(WITH_WIN32)
  46     HRGN hRgn;
  47 #elif defined(WITH_X11)
  48     XRectangle *rects;
  49     int numRects;
  50 #endif
  51 } SplashImage;
  52 
  53 #define SPLASH_COLOR_MAP_SIZE 0x100
  54 
  55 typedef struct Splash
  56 {
  57     ImageFormat screenFormat;   /* must be preset before image decoding */
  58     DitherSettings dithers[3];
  59     ImageFormat imageFormat;
  60     rgbquad_t colorMap[SPLASH_COLOR_MAP_SIZE];
  61     int byteAlignment;          /* must be preset before image decoding */
  62     int maskRequired;           /* must be preset before image decoding */
  63     int width;                  /* in pixels */
  64     int height;                 /* in pixels */
  65     int frameCount;
  66     SplashImage *frames;        /* dynamically allocated array of frame descriptors */
  67     unsigned time;              /* in msec, origin is not important */
  68     rgbquad_t *overlayData;     /* overlay image data, always rgbquads */
  69     ImageRect overlayRect;
  70     ImageFormat overlayFormat;
  71     void *screenData;
  72     int screenStride;           /* stored scanline length in bytes */
  73     int currentFrame;           // currentFrame==-1 means image is not loaded
  74     int loopCount;
  75     int x, y;
  76     rgbquad_t colorIndex[SPLASH_COLOR_MAP_SIZE];
  77     int isVisible;
  78     char*       fileName;       /* stored in 16-bit unicode (jchars) */
  79     int         fileNameLen;
  80     char*       jarName;        /* stored in 16-bit unicode (jchars) */
  81     int         jarNameLen;
  82 #if defined(WITH_WIN32)
  83     BOOL isLayered;
  84     HWND hWnd;
  85     HPALETTE hPalette;
  86     CRITICAL_SECTION lock;
  87 #elif defined(WITH_X11)
  88     int controlpipe[2];
  89     Display *display;
  90     Window window;
  91     Screen *screen;
  92     Visual *visual;
  93     Colormap cmap;
  94     pthread_mutex_t lock;
  95     Cursor cursor;
  96     XWMHints* wmHints;
  97 #elif defined(WITH_MACOSX)
  98     pthread_mutex_t lock;
  99     int controlpipe[2];
 100     NSWindow * window;
 101 #endif
 102 } Splash;
 103 
 104 /* various shared and/or platform dependent splash screen functions */
 105 
 106 /*************** Platform-specific ******************/
 107 
 108 /* To be implemented in the platform-specific native code. */
 109 
 110 
 111 void SplashInitPlatform(Splash * splash);
 112 void SplashCreateThread(Splash * splash);
 113 void SplashCleanupPlatform(Splash * splash);
 114 void SplashDonePlatform(Splash * splash);
 115 
 116 unsigned SplashTime();
 117 char* SplashConvertStringAlloc(const char* in, int *size);
 118 
 119 void SplashLock(Splash * splash);
 120 void SplashUnlock(Splash * splash);
 121 
 122 void SplashInitFrameShape(Splash * splash, int imageIndex);
 123 
 124 void SplashUpdate(Splash * splash);
 125 void SplashReconfigure(Splash * splash);
 126 void SplashClosePlatform(Splash * splash);
 127 
 128 
 129 
 130 /********************* Shared **********************/
 131 Splash *SplashGetInstance();
 132 
 133 int SplashIsStillLooping(Splash * splash);
 134 void SplashNextFrame(Splash * splash);
 135 void SplashStart(Splash * splash);
 136 void SplashDone(Splash * splash);
 137 
 138 void SplashUpdateScreenData(Splash * splash);
 139 
 140 void SplashCleanup(Splash * splash);
 141 
 142 
 143 typedef struct SplashStream {
 144     int (*read)(void* pStream, void* pData, int nBytes);
 145     int (*peek)(void* pStream);
 146     void (*close)(void* pStream);
 147     union {
 148         struct {
 149             FILE* f;
 150         } stdio;
 151         struct {
 152             unsigned char* pData;
 153             unsigned char* pDataEnd;
 154         } mem;
 155     } arg;
 156 } SplashStream;
 157 
 158 int SplashStreamInitFile(SplashStream * stream, const char* filename);
 159 int SplashStreamInitMemory(SplashStream * stream, void * pData, int size);
 160 
 161 /* image decoding */
 162 int SplashDecodeGifStream(Splash * splash, SplashStream * stream);
 163 int SplashDecodeJpegStream(Splash * splash, SplashStream * stream);
 164 int SplashDecodePngStream(Splash * splash, SplashStream * stream);
 165 
 166 /* utility functions */
 167 
 168 int BitmapToYXBandedRectangles(ImageRect * pSrcRect, RECT_T * out);
 169 
 170 #define SAFE_TO_ALLOC(c, sz)                                               \
 171     (((c) > 0) && ((sz) > 0) &&                                            \
 172      ((0xffffffffu / ((unsigned int)(c))) > (unsigned int)(sz)))
 173 
 174 #define dbgprintf printf
 175 
 176 #endif