Home | History | Annotate | Download | only in graphics
      1 #ifndef GraphicsJNI_DEFINED
      2 #define GraphicsJNI_DEFINED
      3 
      4 #include "SkBitmap.h"
      5 #include "SkDevice.h"
      6 #include "SkPixelRef.h"
      7 #include "SkMallocPixelRef.h"
      8 #include "SkPoint.h"
      9 #include "SkRect.h"
     10 #include "../images/SkBitmapRegionDecoder.h"
     11 #include "../images/SkImageDecoder.h"
     12 #include <jni.h>
     13 
     14 class SkCanvas;
     15 class SkPaint;
     16 class SkPicture;
     17 
     18 class GraphicsJNI {
     19 public:
     20     // returns true if an exception is set (and dumps it out to the Log)
     21     static bool hasException(JNIEnv*);
     22 
     23     static void get_jrect(JNIEnv*, jobject jrect, int* L, int* T, int* R, int* B);
     24     static void set_jrect(JNIEnv*, jobject jrect, int L, int T, int R, int B);
     25 
     26     static SkIRect* jrect_to_irect(JNIEnv*, jobject jrect, SkIRect*);
     27     static void irect_to_jrect(const SkIRect&, JNIEnv*, jobject jrect);
     28 
     29     static SkRect* jrectf_to_rect(JNIEnv*, jobject jrectf, SkRect*);
     30     static SkRect* jrect_to_rect(JNIEnv*, jobject jrect, SkRect*);
     31     static void rect_to_jrectf(const SkRect&, JNIEnv*, jobject jrectf);
     32 
     33     static void set_jpoint(JNIEnv*, jobject jrect, int x, int y);
     34 
     35     static SkIPoint* jpoint_to_ipoint(JNIEnv*, jobject jpoint, SkIPoint* point);
     36     static void ipoint_to_jpoint(const SkIPoint& point, JNIEnv*, jobject jpoint);
     37 
     38     static SkPoint* jpointf_to_point(JNIEnv*, jobject jpointf, SkPoint* point);
     39     static void point_to_jpointf(const SkPoint& point, JNIEnv*, jobject jpointf);
     40 
     41     static SkCanvas* getNativeCanvas(JNIEnv*, jobject canvas);
     42     static SkPaint*  getNativePaint(JNIEnv*, jobject paint);
     43     static SkBitmap* getNativeBitmap(JNIEnv*, jobject bitmap);
     44     static SkPicture* getNativePicture(JNIEnv*, jobject picture);
     45     static SkRegion* getNativeRegion(JNIEnv*, jobject region);
     46 
     47     /** Return the corresponding native config from the java Config enum,
     48         or kNo_Config if the java object is null.
     49     */
     50     static SkBitmap::Config getNativeBitmapConfig(JNIEnv*, jobject jconfig);
     51 
     52     /** Create a java Bitmap object given the native bitmap (required) and optional
     53         storage array (may be null).
     54     */
     55     static jobject createBitmap(JNIEnv* env, SkBitmap* bitmap, jbyteArray buffer,
     56                                 bool isMutable, jbyteArray ninepatch, int density = -1);
     57 
     58     static jobject createBitmap(JNIEnv* env, SkBitmap* bitmap, bool isMutable,
     59                                 jbyteArray ninepatch, int density = -1);
     60 
     61     static jobject createRegion(JNIEnv* env, SkRegion* region);
     62 
     63     static jobject createBitmapRegionDecoder(JNIEnv* env, SkBitmapRegionDecoder* bitmap);
     64 
     65     static jbyteArray allocateJavaPixelRef(JNIEnv* env, SkBitmap* bitmap,
     66                                      SkColorTable* ctable);
     67 
     68     /** Copy the colors in colors[] to the bitmap, convert to the correct
     69         format along the way.
     70     */
     71     static bool SetPixels(JNIEnv* env, jintArray colors, int srcOffset,
     72                           int srcStride, int x, int y, int width, int height,
     73                           const SkBitmap& dstBitmap);
     74 
     75     static jbyteArray getBitmapStorageObj(SkPixelRef *pixref);
     76 };
     77 
     78 class AndroidPixelRef : public SkMallocPixelRef {
     79 public:
     80     AndroidPixelRef(JNIEnv* env, void* storage, size_t size, jbyteArray storageObj,
     81                     SkColorTable* ctable);
     82 
     83     virtual ~AndroidPixelRef();
     84 
     85     jbyteArray getStorageObj() { return fStorageObj; }
     86 
     87     void setLocalJNIRef(jbyteArray arr);
     88 
     89     /** Used to hold a ref to the pixels when the Java bitmap may be collected.
     90      *  If specified, 'localref' is a valid JNI local reference to the byte array
     91      *  containing the pixel data.
     92      *
     93      *  'localref' may only be NULL if setLocalJNIRef() was already called with
     94      *  a JNI local ref that is still valid.
     95      */
     96     virtual void globalRef(void* localref=NULL);
     97 
     98     /** Release a ref that was acquired using globalRef(). */
     99     virtual void globalUnref();
    100 
    101 private:
    102     JavaVM* fVM;
    103     bool fOnJavaHeap; // If true, the memory was allocated on the Java heap
    104 
    105     jbyteArray fStorageObj; // The Java byte[] object used as the bitmap backing store
    106     bool fHasGlobalRef; // If true, fStorageObj holds a JNI global ref
    107 
    108     mutable int32_t fGlobalRefCnt;
    109 };
    110 
    111 /** A helper class for accessing Java-heap-allocated bitmaps.
    112  *  This should be used when calling into a JNI method that retains a
    113  *  reference to the bitmap longer than the lifetime of the Java Bitmap.
    114  *
    115  *  After creating an instance of this class, a call to
    116  *  AndroidPixelRef::globalRef() will allocate a JNI global reference
    117  *  to the backing buffer object.
    118  */
    119 class JavaHeapBitmapRef {
    120 public:
    121 
    122     JavaHeapBitmapRef(JNIEnv *env, SkBitmap* nativeBitmap, jbyteArray buffer);
    123     ~JavaHeapBitmapRef();
    124 
    125 private:
    126     JNIEnv* fEnv;
    127     SkBitmap* fNativeBitmap;
    128     jbyteArray fBuffer;
    129 };
    130 
    131 /** Allocator which allocates the backing buffer in the Java heap.
    132  *  Instances can only be used to perform a single allocation, which helps
    133  *  ensure that the allocated buffer is properly accounted for with a
    134  *  reference in the heap (or a JNI global reference).
    135  */
    136 class JavaPixelAllocator : public SkBitmap::Allocator {
    137 public:
    138     JavaPixelAllocator(JNIEnv* env);
    139     // overrides
    140     virtual bool allocPixelRef(SkBitmap* bitmap, SkColorTable* ctable);
    141 
    142     /** Return the Java array object created for the last allocation.
    143      *  This returns a local JNI reference which the caller is responsible
    144      *  for storing appropriately (usually by passing it to the Bitmap
    145      *  constructor).
    146      */
    147     jbyteArray getStorageObj() { return fStorageObj; }
    148 
    149     /** Same as getStorageObj(), but also resets the allocator so that it
    150      *  can allocate again.
    151      */
    152     jbyteArray getStorageObjAndReset() {
    153         jbyteArray result = fStorageObj;
    154         fStorageObj = NULL;
    155         fAllocCount = 0;
    156         return result;
    157     };
    158 
    159 private:
    160     JavaVM* fVM;
    161     bool fAllocateInJavaHeap;
    162     jbyteArray fStorageObj;
    163     int fAllocCount;
    164 };
    165 
    166 enum JNIAccess {
    167     kRO_JNIAccess,
    168     kRW_JNIAccess
    169 };
    170 
    171 class AutoJavaFloatArray {
    172 public:
    173     AutoJavaFloatArray(JNIEnv* env, jfloatArray array,
    174                        int minLength = 0, JNIAccess = kRW_JNIAccess);
    175     ~AutoJavaFloatArray();
    176 
    177     float* ptr() const { return fPtr; }
    178     int    length() const { return fLen; }
    179 
    180 private:
    181     JNIEnv*     fEnv;
    182     jfloatArray fArray;
    183     float*      fPtr;
    184     int         fLen;
    185     int         fReleaseMode;
    186 };
    187 
    188 class AutoJavaIntArray {
    189 public:
    190     AutoJavaIntArray(JNIEnv* env, jintArray array, int minLength = 0);
    191     ~AutoJavaIntArray();
    192 
    193     jint* ptr() const { return fPtr; }
    194     int    length() const { return fLen; }
    195 
    196 private:
    197     JNIEnv*     fEnv;
    198     jintArray fArray;
    199     jint*      fPtr;
    200     int         fLen;
    201 };
    202 
    203 class AutoJavaShortArray {
    204 public:
    205     AutoJavaShortArray(JNIEnv* env, jshortArray array,
    206                        int minLength = 0, JNIAccess = kRW_JNIAccess);
    207     ~AutoJavaShortArray();
    208 
    209     jshort* ptr() const { return fPtr; }
    210     int    length() const { return fLen; }
    211 
    212 private:
    213     JNIEnv*     fEnv;
    214     jshortArray fArray;
    215     jshort*      fPtr;
    216     int         fLen;
    217     int         fReleaseMode;
    218 };
    219 
    220 class AutoJavaByteArray {
    221 public:
    222     AutoJavaByteArray(JNIEnv* env, jbyteArray array, int minLength = 0);
    223     ~AutoJavaByteArray();
    224 
    225     jbyte* ptr() const { return fPtr; }
    226     int    length() const { return fLen; }
    227 
    228 private:
    229     JNIEnv*     fEnv;
    230     jbyteArray fArray;
    231     jbyte*      fPtr;
    232     int         fLen;
    233 };
    234 
    235 void doThrowNPE(JNIEnv* env);
    236 void doThrowAIOOBE(JNIEnv* env); // Array Index Out Of Bounds Exception
    237 void doThrowIAE(JNIEnv* env, const char* msg = NULL);   // Illegal Argument
    238 void doThrowRE(JNIEnv* env, const char* msg = NULL);   // Runtime
    239 void doThrowISE(JNIEnv* env, const char* msg = NULL);   // Illegal State
    240 void doThrowOOME(JNIEnv* env, const char* msg = NULL);   // Out of memory
    241 void doThrowIOE(JNIEnv* env, const char* msg = NULL);   // IO Exception
    242 
    243 #define NPE_CHECK_RETURN_ZERO(env, object)    \
    244     do { if (NULL == (object)) { doThrowNPE(env); return 0; } } while (0)
    245 
    246 #define NPE_CHECK_RETURN_VOID(env, object)    \
    247     do { if (NULL == (object)) { doThrowNPE(env); return; } } while (0)
    248 
    249 #endif
    250