android_media_ImageReader.cpp revision 5096defdaa4716ce81047a855d6e5ce3f8263600
1/*
2 * Copyright 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17//#define LOG_NDEBUG 0
18#define LOG_TAG "ImageReader_JNI"
19#include <utils/Log.h>
20#include <utils/misc.h>
21#include <utils/List.h>
22#include <utils/String8.h>
23
24#include <cstdio>
25
26#include <gui/CpuConsumer.h>
27#include <gui/Surface.h>
28#include <camera3.h>
29
30#include <android_runtime/AndroidRuntime.h>
31#include <android_runtime/android_view_Surface.h>
32
33#include <jni.h>
34#include <JNIHelp.h>
35
36#include <stdint.h>
37#include <inttypes.h>
38
39#define ALIGN(x, mask) ( ((x) + (mask) - 1) & ~((mask) - 1) )
40
41#define ANDROID_MEDIA_IMAGEREADER_CTX_JNI_ID       "mNativeContext"
42#define ANDROID_MEDIA_SURFACEIMAGE_BUFFER_JNI_ID   "mLockedBuffer"
43#define ANDROID_MEDIA_SURFACEIMAGE_TS_JNI_ID       "mTimestamp"
44
45// ----------------------------------------------------------------------------
46
47using namespace android;
48
49enum {
50    IMAGE_READER_MAX_NUM_PLANES = 3,
51};
52
53enum {
54    ACQUIRE_SUCCESS = 0,
55    ACQUIRE_NO_BUFFERS = 1,
56    ACQUIRE_MAX_IMAGES = 2,
57};
58
59static struct {
60    jfieldID mNativeContext;
61    jmethodID postEventFromNative;
62} gImageReaderClassInfo;
63
64static struct {
65    jfieldID mLockedBuffer;
66    jfieldID mTimestamp;
67} gSurfaceImageClassInfo;
68
69static struct {
70    jclass clazz;
71    jmethodID ctor;
72} gSurfacePlaneClassInfo;
73
74// ----------------------------------------------------------------------------
75
76class JNIImageReaderContext : public CpuConsumer::FrameAvailableListener
77{
78public:
79    JNIImageReaderContext(JNIEnv* env, jobject weakThiz, jclass clazz, int maxImages);
80
81    virtual ~JNIImageReaderContext();
82
83    virtual void onFrameAvailable();
84
85    CpuConsumer::LockedBuffer* getLockedBuffer();
86
87    void returnLockedBuffer(CpuConsumer::LockedBuffer* buffer);
88
89    void setCpuConsumer(const sp<CpuConsumer>& consumer) { mConsumer = consumer; }
90    CpuConsumer* getCpuConsumer() { return mConsumer.get(); }
91
92    void setProducer(const sp<IGraphicBufferProducer>& producer) { mProducer = producer; }
93    IGraphicBufferProducer* getProducer() { return mProducer.get(); }
94
95    void setBufferFormat(int format) { mFormat = format; }
96    int getBufferFormat() { return mFormat; }
97
98    void setBufferWidth(int width) { mWidth = width; }
99    int getBufferWidth() { return mWidth; }
100
101    void setBufferHeight(int height) { mHeight = height; }
102    int getBufferHeight() { return mHeight; }
103
104private:
105    static JNIEnv* getJNIEnv(bool* needsDetach);
106    static void detachJNI();
107
108    List<CpuConsumer::LockedBuffer*> mBuffers;
109    sp<CpuConsumer> mConsumer;
110    sp<IGraphicBufferProducer> mProducer;
111    jobject mWeakThiz;
112    jclass mClazz;
113    int mFormat;
114    int mWidth;
115    int mHeight;
116};
117
118JNIImageReaderContext::JNIImageReaderContext(JNIEnv* env,
119        jobject weakThiz, jclass clazz, int maxImages) :
120    mWeakThiz(env->NewGlobalRef(weakThiz)),
121    mClazz((jclass)env->NewGlobalRef(clazz)) {
122    for (int i = 0; i < maxImages; i++) {
123        CpuConsumer::LockedBuffer *buffer = new CpuConsumer::LockedBuffer;
124        mBuffers.push_back(buffer);
125    }
126}
127
128JNIEnv* JNIImageReaderContext::getJNIEnv(bool* needsDetach) {
129    LOG_ALWAYS_FATAL_IF(needsDetach == NULL, "needsDetach is null!!!");
130    *needsDetach = false;
131    JNIEnv* env = AndroidRuntime::getJNIEnv();
132    if (env == NULL) {
133        JavaVMAttachArgs args = {JNI_VERSION_1_4, NULL, NULL};
134        JavaVM* vm = AndroidRuntime::getJavaVM();
135        int result = vm->AttachCurrentThread(&env, (void*) &args);
136        if (result != JNI_OK) {
137            ALOGE("thread attach failed: %#x", result);
138            return NULL;
139        }
140        *needsDetach = true;
141    }
142    return env;
143}
144
145void JNIImageReaderContext::detachJNI() {
146    JavaVM* vm = AndroidRuntime::getJavaVM();
147    int result = vm->DetachCurrentThread();
148    if (result != JNI_OK) {
149        ALOGE("thread detach failed: %#x", result);
150    }
151}
152
153CpuConsumer::LockedBuffer* JNIImageReaderContext::getLockedBuffer() {
154    if (mBuffers.empty()) {
155        return NULL;
156    }
157    // Return a LockedBuffer pointer and remove it from the list
158    List<CpuConsumer::LockedBuffer*>::iterator it = mBuffers.begin();
159    CpuConsumer::LockedBuffer* buffer = *it;
160    mBuffers.erase(it);
161    return buffer;
162}
163
164void JNIImageReaderContext::returnLockedBuffer(CpuConsumer::LockedBuffer* buffer) {
165    mBuffers.push_back(buffer);
166}
167
168JNIImageReaderContext::~JNIImageReaderContext() {
169    bool needsDetach = false;
170    JNIEnv* env = getJNIEnv(&needsDetach);
171    if (env != NULL) {
172        env->DeleteGlobalRef(mWeakThiz);
173        env->DeleteGlobalRef(mClazz);
174    } else {
175        ALOGW("leaking JNI object references");
176    }
177    if (needsDetach) {
178        detachJNI();
179    }
180
181    // Delete LockedBuffers
182    for (List<CpuConsumer::LockedBuffer *>::iterator it = mBuffers.begin();
183            it != mBuffers.end(); it++) {
184        delete *it;
185    }
186    mBuffers.clear();
187    mConsumer.clear();
188}
189
190void JNIImageReaderContext::onFrameAvailable()
191{
192    ALOGV("%s: frame available", __FUNCTION__);
193    bool needsDetach = false;
194    JNIEnv* env = getJNIEnv(&needsDetach);
195    if (env != NULL) {
196        env->CallStaticVoidMethod(mClazz, gImageReaderClassInfo.postEventFromNative, mWeakThiz);
197    } else {
198        ALOGW("onFrameAvailable event will not posted");
199    }
200    if (needsDetach) {
201        detachJNI();
202    }
203}
204
205// ----------------------------------------------------------------------------
206
207extern "C" {
208
209static JNIImageReaderContext* ImageReader_getContext(JNIEnv* env, jobject thiz)
210{
211    JNIImageReaderContext *ctx;
212    ctx = reinterpret_cast<JNIImageReaderContext *>
213              (env->GetLongField(thiz, gImageReaderClassInfo.mNativeContext));
214    return ctx;
215}
216
217static CpuConsumer* ImageReader_getCpuConsumer(JNIEnv* env, jobject thiz)
218{
219    ALOGV("%s:", __FUNCTION__);
220    JNIImageReaderContext* const ctx = ImageReader_getContext(env, thiz);
221    if (ctx == NULL) {
222        jniThrowRuntimeException(env, "ImageReaderContext is not initialized");
223        return NULL;
224    }
225    return ctx->getCpuConsumer();
226}
227
228static IGraphicBufferProducer* ImageReader_getProducer(JNIEnv* env, jobject thiz)
229{
230    ALOGV("%s:", __FUNCTION__);
231    JNIImageReaderContext* const ctx = ImageReader_getContext(env, thiz);
232    if (ctx == NULL) {
233        jniThrowRuntimeException(env, "ImageReaderContext is not initialized");
234        return NULL;
235    }
236    return ctx->getProducer();
237}
238
239static void ImageReader_setNativeContext(JNIEnv* env,
240        jobject thiz, sp<JNIImageReaderContext> ctx)
241{
242    ALOGV("%s:", __FUNCTION__);
243    JNIImageReaderContext* const p = ImageReader_getContext(env, thiz);
244    if (ctx != 0) {
245        ctx->incStrong((void*)ImageReader_setNativeContext);
246    }
247    if (p) {
248        p->decStrong((void*)ImageReader_setNativeContext);
249    }
250    env->SetLongField(thiz, gImageReaderClassInfo.mNativeContext,
251            reinterpret_cast<jlong>(ctx.get()));
252}
253
254static CpuConsumer::LockedBuffer* Image_getLockedBuffer(JNIEnv* env, jobject image)
255{
256    return reinterpret_cast<CpuConsumer::LockedBuffer*>(
257            env->GetLongField(image, gSurfaceImageClassInfo.mLockedBuffer));
258}
259
260static void Image_setBuffer(JNIEnv* env, jobject thiz,
261        const CpuConsumer::LockedBuffer* buffer)
262{
263    env->SetLongField(thiz, gSurfaceImageClassInfo.mLockedBuffer, reinterpret_cast<jlong>(buffer));
264}
265
266// Some formats like JPEG defined with different values between android.graphics.ImageFormat and
267// graphics.h, need convert to the one defined in graphics.h here.
268static int Image_getPixelFormat(JNIEnv* env, int format)
269{
270    int jpegFormat, rawSensorFormat;
271    jfieldID fid;
272
273    ALOGV("%s: format = 0x%x", __FUNCTION__, format);
274
275    jclass imageFormatClazz = env->FindClass("android/graphics/ImageFormat");
276    ALOG_ASSERT(imageFormatClazz != NULL);
277
278    fid = env->GetStaticFieldID(imageFormatClazz, "JPEG", "I");
279    jpegFormat = env->GetStaticIntField(imageFormatClazz, fid);
280
281    // Translate the JPEG to BLOB for camera purpose.
282    if (format == jpegFormat) {
283        format = HAL_PIXEL_FORMAT_BLOB;
284    }
285
286    return format;
287}
288
289static uint32_t Image_getJpegSize(CpuConsumer::LockedBuffer* buffer)
290{
291    ALOG_ASSERT(buffer != NULL, "Input buffer is NULL!!!");
292    uint32_t size = 0;
293    uint32_t width = buffer->width;
294    uint8_t* jpegBuffer = buffer->data;
295
296    // First check for JPEG transport header at the end of the buffer
297    uint8_t* header = jpegBuffer + (width - sizeof(struct camera3_jpeg_blob));
298    struct camera3_jpeg_blob *blob = (struct camera3_jpeg_blob*)(header);
299    if (blob->jpeg_blob_id == CAMERA3_JPEG_BLOB_ID) {
300        size = blob->jpeg_size;
301        ALOGV("%s: Jpeg size = %d", __FUNCTION__, size);
302    }
303
304    // failed to find size, default to whole buffer
305    if (size == 0) {
306        /*
307         * This is a problem because not including the JPEG header
308         * means that in certain rare situations a regular JPEG blob
309         * will be misidentified as having a header, in which case
310         * we will get a garbage size value.
311         */
312        ALOGW("%s: No JPEG header detected, defaulting to size=width=%d",
313                __FUNCTION__, width);
314        size = width;
315    }
316
317    return size;
318}
319
320static void Image_getLockedBufferInfo(JNIEnv* env, CpuConsumer::LockedBuffer* buffer, int idx,
321                                uint8_t **base, uint32_t *size)
322{
323    ALOG_ASSERT(buffer != NULL, "Input buffer is NULL!!!");
324    ALOG_ASSERT(base != NULL, "base is NULL!!!");
325    ALOG_ASSERT(size != NULL, "size is NULL!!!");
326    ALOG_ASSERT((idx < IMAGE_READER_MAX_NUM_PLANES) && (idx >= 0));
327
328    ALOGV("%s: buffer: %p", __FUNCTION__, buffer);
329
330    uint32_t dataSize, ySize, cSize, cStride;
331    uint8_t *cb, *cr;
332    uint8_t *pData = NULL;
333    int bytesPerPixel = 0;
334
335    dataSize = ySize = cSize = cStride = 0;
336    int32_t fmt = buffer->format;
337    switch (fmt) {
338        case HAL_PIXEL_FORMAT_YCbCr_420_888:
339            pData =
340                (idx == 0) ?
341                    buffer->data :
342                (idx == 1) ?
343                    buffer->dataCb :
344                buffer->dataCr;
345            if (idx == 0) {
346                dataSize = buffer->stride * buffer->height;
347            } else {
348                dataSize = buffer->chromaStride * buffer->height / 2;
349            }
350            break;
351        // NV21
352        case HAL_PIXEL_FORMAT_YCrCb_420_SP:
353            cr = buffer->data + (buffer->stride * buffer->height);
354            cb = cr + 1;
355            ySize = buffer->width * buffer->height;
356            cSize = buffer->width * buffer->height / 2;
357
358            pData =
359                (idx == 0) ?
360                    buffer->data :
361                (idx == 1) ?
362                    cb:
363                cr;
364
365            dataSize = (idx == 0) ? ySize : cSize;
366            break;
367        case HAL_PIXEL_FORMAT_YV12:
368            // Y and C stride need to be 16 pixel aligned.
369            LOG_ALWAYS_FATAL_IF(buffer->stride % 16,
370                                "Stride is not 16 pixel aligned %d", buffer->stride);
371
372            ySize = buffer->stride * buffer->height;
373            cStride = ALIGN(buffer->stride / 2, 16);
374            cr = buffer->data + ySize;
375            cSize = cStride * buffer->height / 2;
376            cb = cr + cSize;
377
378            pData =
379                (idx == 0) ?
380                    buffer->data :
381                (idx == 1) ?
382                    cb :
383                cr;
384            dataSize = (idx == 0) ? ySize : cSize;
385            break;
386        case HAL_PIXEL_FORMAT_Y8:
387            // Single plane, 8bpp.
388            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
389
390            pData = buffer->data;
391            dataSize = buffer->stride * buffer->height;
392            break;
393        case HAL_PIXEL_FORMAT_Y16:
394            bytesPerPixel = 2;
395            // Single plane, 16bpp, strides are specified in pixels, not in bytes
396            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
397
398            pData = buffer->data;
399            dataSize = buffer->stride * buffer->height * bytesPerPixel;
400            break;
401        case HAL_PIXEL_FORMAT_BLOB:
402            // Used for JPEG data, height must be 1, width == size, single plane.
403            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
404            ALOG_ASSERT(buffer->height == 1, "JPEG should has height value %d", buffer->height);
405
406            pData = buffer->data;
407            dataSize = Image_getJpegSize(buffer);
408            break;
409        case HAL_PIXEL_FORMAT_RAW_SENSOR:
410            // Single plane 16bpp bayer data.
411            bytesPerPixel = 2;
412            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
413            pData = buffer->data;
414            dataSize = buffer->stride * buffer->height * bytesPerPixel;
415            break;
416        case HAL_PIXEL_FORMAT_RGBA_8888:
417        case HAL_PIXEL_FORMAT_RGBX_8888:
418            // Single plane, 32bpp.
419            bytesPerPixel = 4;
420            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
421            pData = buffer->data;
422            dataSize = buffer->stride * buffer->height * bytesPerPixel;
423            break;
424        case HAL_PIXEL_FORMAT_RGB_565:
425            // Single plane, 16bpp.
426            bytesPerPixel = 2;
427            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
428            pData = buffer->data;
429            dataSize = buffer->stride * buffer->height * bytesPerPixel;
430            break;
431        case HAL_PIXEL_FORMAT_RGB_888:
432            // Single plane, 24bpp.
433            bytesPerPixel = 3;
434            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
435            pData = buffer->data;
436            dataSize = buffer->stride * buffer->height * bytesPerPixel;
437            break;
438        default:
439            jniThrowExceptionFmt(env, "java/lang/UnsupportedOperationException",
440                                 "Pixel format: 0x%x is unsupported", fmt);
441            break;
442    }
443
444    *base = pData;
445    *size = dataSize;
446}
447
448static jint Image_imageGetPixelStride(JNIEnv* env, CpuConsumer::LockedBuffer* buffer, int idx)
449{
450    ALOGV("%s: buffer index: %d", __FUNCTION__, idx);
451    ALOG_ASSERT((idx < IMAGE_READER_MAX_NUM_PLANES) && (idx >= 0), "Index is out of range:%d", idx);
452
453    int pixelStride = 0;
454    ALOG_ASSERT(buffer != NULL, "buffer is NULL");
455
456    int32_t fmt = buffer->format;
457    switch (fmt) {
458        case HAL_PIXEL_FORMAT_YCbCr_420_888:
459            pixelStride = (idx == 0) ? 1 : buffer->chromaStep;
460            break;
461        case HAL_PIXEL_FORMAT_YCrCb_420_SP:
462            pixelStride = (idx == 0) ? 1 : 2;
463            break;
464        case HAL_PIXEL_FORMAT_Y8:
465            // Single plane 8bpp data.
466            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
467            pixelStride;
468            break;
469        case HAL_PIXEL_FORMAT_YV12:
470            pixelStride = 1;
471            break;
472        case HAL_PIXEL_FORMAT_BLOB:
473            // Used for JPEG data, single plane, row and pixel strides are 0
474            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
475            pixelStride = 0;
476            break;
477        case HAL_PIXEL_FORMAT_Y16:
478        case HAL_PIXEL_FORMAT_RAW_SENSOR:
479        case HAL_PIXEL_FORMAT_RGB_565:
480            // Single plane 16bpp data.
481            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
482            pixelStride = 2;
483            break;
484        case HAL_PIXEL_FORMAT_RGBA_8888:
485        case HAL_PIXEL_FORMAT_RGBX_8888:
486            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
487            pixelStride = 4;
488            break;
489        case HAL_PIXEL_FORMAT_RGB_888:
490            // Single plane, 24bpp.
491            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
492            pixelStride = 3;
493            break;
494        default:
495            jniThrowExceptionFmt(env, "java/lang/UnsupportedOperationException",
496                                 "Pixel format: 0x%x is unsupported", fmt);
497            break;
498    }
499
500    return pixelStride;
501}
502
503static jint Image_imageGetRowStride(JNIEnv* env, CpuConsumer::LockedBuffer* buffer, int idx)
504{
505    ALOGV("%s: buffer index: %d", __FUNCTION__, idx);
506    ALOG_ASSERT((idx < IMAGE_READER_MAX_NUM_PLANES) && (idx >= 0));
507
508    int rowStride = 0;
509    ALOG_ASSERT(buffer != NULL, "buffer is NULL");
510
511    int32_t fmt = buffer->format;
512
513    switch (fmt) {
514        case HAL_PIXEL_FORMAT_YCbCr_420_888:
515            rowStride = (idx == 0) ? buffer->stride : buffer->chromaStride;
516            break;
517        case HAL_PIXEL_FORMAT_YCrCb_420_SP:
518            rowStride = buffer->width;
519            break;
520        case HAL_PIXEL_FORMAT_YV12:
521            LOG_ALWAYS_FATAL_IF(buffer->stride % 16,
522                                "Stride is not 16 pixel aligned %d", buffer->stride);
523            rowStride = (idx == 0) ? buffer->stride : ALIGN(buffer->stride / 2, 16);
524            break;
525        case HAL_PIXEL_FORMAT_BLOB:
526            // Used for JPEG data, single plane, row and pixel strides are 0
527            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
528            rowStride = 0;
529            break;
530        case HAL_PIXEL_FORMAT_Y8:
531            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
532            LOG_ALWAYS_FATAL_IF(buffer->stride % 16,
533                                "Stride is not 16 pixel aligned %d", buffer->stride);
534            rowStride = buffer->stride;
535            break;
536        case HAL_PIXEL_FORMAT_Y16:
537        case HAL_PIXEL_FORMAT_RAW_SENSOR:
538            // In native side, strides are specified in pixels, not in bytes.
539            // Single plane 16bpp bayer data. even width/height,
540            // row stride multiple of 16 pixels (32 bytes)
541            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
542            LOG_ALWAYS_FATAL_IF(buffer->stride % 16,
543                                "Stride is not 16 pixel aligned %d", buffer->stride);
544            rowStride = buffer->stride * 2;
545            break;
546        case HAL_PIXEL_FORMAT_RGB_565:
547            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
548            rowStride = buffer->stride * 2;
549            break;
550        case HAL_PIXEL_FORMAT_RGBA_8888:
551        case HAL_PIXEL_FORMAT_RGBX_8888:
552            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
553            rowStride = buffer->stride * 4;
554            break;
555        case HAL_PIXEL_FORMAT_RGB_888:
556            // Single plane, 24bpp.
557            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
558            rowStride = buffer->stride * 3;
559            break;
560        default:
561            ALOGE("%s Pixel format: 0x%x is unsupported", __FUNCTION__, fmt);
562            jniThrowException(env, "java/lang/UnsupportedOperationException",
563                              "unsupported buffer format");
564          break;
565    }
566
567    return rowStride;
568}
569
570// ----------------------------------------------------------------------------
571
572static void ImageReader_classInit(JNIEnv* env, jclass clazz)
573{
574    ALOGV("%s:", __FUNCTION__);
575
576    jclass imageClazz = env->FindClass("android/media/ImageReader$SurfaceImage");
577    LOG_ALWAYS_FATAL_IF(imageClazz == NULL,
578                        "can't find android/graphics/ImageReader$SurfaceImage");
579    gSurfaceImageClassInfo.mLockedBuffer = env->GetFieldID(
580            imageClazz, ANDROID_MEDIA_SURFACEIMAGE_BUFFER_JNI_ID, "J");
581    LOG_ALWAYS_FATAL_IF(gSurfaceImageClassInfo.mLockedBuffer == NULL,
582                        "can't find android/graphics/ImageReader.%s",
583                        ANDROID_MEDIA_SURFACEIMAGE_BUFFER_JNI_ID);
584
585    gSurfaceImageClassInfo.mTimestamp = env->GetFieldID(
586            imageClazz, ANDROID_MEDIA_SURFACEIMAGE_TS_JNI_ID, "J");
587    LOG_ALWAYS_FATAL_IF(gSurfaceImageClassInfo.mTimestamp == NULL,
588                        "can't find android/graphics/ImageReader.%s",
589                        ANDROID_MEDIA_SURFACEIMAGE_TS_JNI_ID);
590
591    gImageReaderClassInfo.mNativeContext = env->GetFieldID(
592            clazz, ANDROID_MEDIA_IMAGEREADER_CTX_JNI_ID, "J");
593    LOG_ALWAYS_FATAL_IF(gImageReaderClassInfo.mNativeContext == NULL,
594                        "can't find android/graphics/ImageReader.%s",
595                          ANDROID_MEDIA_IMAGEREADER_CTX_JNI_ID);
596
597    gImageReaderClassInfo.postEventFromNative = env->GetStaticMethodID(
598            clazz, "postEventFromNative", "(Ljava/lang/Object;)V");
599    LOG_ALWAYS_FATAL_IF(gImageReaderClassInfo.postEventFromNative == NULL,
600                        "can't find android/graphics/ImageReader.postEventFromNative");
601
602    jclass planeClazz = env->FindClass("android/media/ImageReader$SurfaceImage$SurfacePlane");
603    LOG_ALWAYS_FATAL_IF(planeClazz == NULL, "Can not find SurfacePlane class");
604    // FindClass only gives a local reference of jclass object.
605    gSurfacePlaneClassInfo.clazz = (jclass) env->NewGlobalRef(planeClazz);
606    gSurfacePlaneClassInfo.ctor = env->GetMethodID(gSurfacePlaneClassInfo.clazz, "<init>",
607            "(Landroid/media/ImageReader$SurfaceImage;III)V");
608    LOG_ALWAYS_FATAL_IF(gSurfacePlaneClassInfo.ctor == NULL,
609            "Can not find SurfacePlane constructor");
610}
611
612static void ImageReader_init(JNIEnv* env, jobject thiz, jobject weakThiz,
613                             jint width, jint height, jint format, jint maxImages)
614{
615    status_t res;
616    int nativeFormat;
617
618    ALOGV("%s: width:%d, height: %d, format: 0x%x, maxImages:%d",
619          __FUNCTION__, width, height, format, maxImages);
620
621    nativeFormat = Image_getPixelFormat(env, format);
622
623    sp<IGraphicBufferProducer> gbProducer;
624    sp<IGraphicBufferConsumer> gbConsumer;
625    BufferQueue::createBufferQueue(&gbProducer, &gbConsumer);
626    sp<CpuConsumer> consumer = new CpuConsumer(gbConsumer, maxImages,
627                                               /*controlledByApp*/true);
628    // TODO: throw dvm exOutOfMemoryError?
629    if (consumer == NULL) {
630        jniThrowRuntimeException(env, "Failed to allocate native CpuConsumer");
631        return;
632    }
633
634    jclass clazz = env->GetObjectClass(thiz);
635    if (clazz == NULL) {
636        jniThrowRuntimeException(env, "Can't find android/graphics/ImageReader");
637        return;
638    }
639    sp<JNIImageReaderContext> ctx(new JNIImageReaderContext(env, weakThiz, clazz, maxImages));
640    ctx->setCpuConsumer(consumer);
641    ctx->setProducer(gbProducer);
642    consumer->setFrameAvailableListener(ctx);
643    ImageReader_setNativeContext(env, thiz, ctx);
644    ctx->setBufferFormat(nativeFormat);
645    ctx->setBufferWidth(width);
646    ctx->setBufferHeight(height);
647
648    // Set the width/height/format to the CpuConsumer
649    res = consumer->setDefaultBufferSize(width, height);
650    if (res != OK) {
651        jniThrowException(env, "java/lang/IllegalStateException",
652                          "Failed to set CpuConsumer buffer size");
653        return;
654    }
655    res = consumer->setDefaultBufferFormat(nativeFormat);
656    if (res != OK) {
657        jniThrowException(env, "java/lang/IllegalStateException",
658                          "Failed to set CpuConsumer buffer format");
659    }
660}
661
662static void ImageReader_close(JNIEnv* env, jobject thiz)
663{
664    ALOGV("%s:", __FUNCTION__);
665
666    JNIImageReaderContext* const ctx = ImageReader_getContext(env, thiz);
667    if (ctx == NULL) {
668        // ImageReader is already closed.
669        return;
670    }
671
672    CpuConsumer* consumer = ImageReader_getCpuConsumer(env, thiz);
673    if (consumer != NULL) {
674        consumer->abandon();
675        consumer->setFrameAvailableListener(NULL);
676    }
677    ImageReader_setNativeContext(env, thiz, NULL);
678}
679
680static void ImageReader_imageRelease(JNIEnv* env, jobject thiz, jobject image)
681{
682    ALOGV("%s:", __FUNCTION__);
683    JNIImageReaderContext* ctx = ImageReader_getContext(env, thiz);
684    if (ctx == NULL) {
685        ALOGW("ImageReader#close called before Image#close, consider calling Image#close first");
686        return;
687    }
688
689    CpuConsumer* consumer = ctx->getCpuConsumer();
690    CpuConsumer::LockedBuffer* buffer = Image_getLockedBuffer(env, image);
691    if (!buffer) {
692        ALOGW("Image already released!!!");
693        return;
694    }
695    consumer->unlockBuffer(*buffer);
696    Image_setBuffer(env, image, NULL);
697    ctx->returnLockedBuffer(buffer);
698}
699
700static jint ImageReader_imageSetup(JNIEnv* env, jobject thiz,
701                                             jobject image)
702{
703    ALOGV("%s:", __FUNCTION__);
704    JNIImageReaderContext* ctx = ImageReader_getContext(env, thiz);
705    if (ctx == NULL) {
706        jniThrowRuntimeException(env, "ImageReaderContext is not initialized");
707        return -1;
708    }
709
710    CpuConsumer* consumer = ctx->getCpuConsumer();
711    CpuConsumer::LockedBuffer* buffer = ctx->getLockedBuffer();
712    if (buffer == NULL) {
713        ALOGW("Unable to acquire a lockedBuffer, very likely client tries to lock more than"
714            " maxImages buffers");
715        return ACQUIRE_MAX_IMAGES;
716    }
717    status_t res = consumer->lockNextBuffer(buffer);
718    if (res != NO_ERROR) {
719        ctx->returnLockedBuffer(buffer);
720        if (res != BAD_VALUE /*no buffers*/) {
721            if (res == NOT_ENOUGH_DATA) {
722                return ACQUIRE_MAX_IMAGES;
723            } else {
724                ALOGE("%s Fail to lockNextBuffer with error: %d ",
725                      __FUNCTION__, res);
726                jniThrowExceptionFmt(env, "java/lang/AssertionError",
727                          "Unknown error (%d) when we tried to lock buffer.",
728                          res);
729            }
730        }
731        return ACQUIRE_NO_BUFFERS;
732    }
733
734    if (buffer->format == HAL_PIXEL_FORMAT_YCrCb_420_SP) {
735        jniThrowException(env, "java/lang/UnsupportedOperationException",
736                "NV21 format is not supported by ImageReader");
737        return -1;
738    }
739
740    // Check if the left-top corner of the crop rect is origin, we currently assume this point is
741    // zero, will revist this once this assumption turns out problematic.
742    Point lt = buffer->crop.leftTop();
743    if (lt.x != 0 || lt.y != 0) {
744        jniThrowExceptionFmt(env, "java/lang/UnsupportedOperationException",
745                "crop left top corner [%d, %d] need to be at origin", lt.x, lt.y);
746        return -1;
747    }
748
749    // Check if the producer buffer configurations match what ImageReader configured.
750    // We want to fail for the very first image because this case is too bad.
751    int outputWidth = buffer->width;
752    int outputHeight = buffer->height;
753
754    // Correct width/height when crop is set.
755    if (!buffer->crop.isEmpty()) {
756        outputWidth = buffer->crop.getWidth();
757        outputHeight = buffer->crop.getHeight();
758    }
759
760    int imageReaderWidth = ctx->getBufferWidth();
761    int imageReaderHeight = ctx->getBufferHeight();
762    if ((buffer->format != HAL_PIXEL_FORMAT_BLOB) &&
763            (imageReaderWidth != outputWidth || imageReaderHeight > outputHeight)) {
764        /**
765         * For video decoder, the buffer height is actually the vertical stride,
766         * which is always >= actual image height. For future, decoder need provide
767         * right crop rectangle to CpuConsumer to indicate the actual image height,
768         * see bug 9563986. After this bug is fixed, we can enforce the height equal
769         * check. Right now, only make sure buffer height is no less than ImageReader
770         * height.
771         */
772        jniThrowExceptionFmt(env, "java/lang/IllegalStateException",
773                "Producer buffer size: %dx%d, doesn't match ImageReader configured size: %dx%d",
774                outputWidth, outputHeight, imageReaderWidth, imageReaderHeight);
775        return -1;
776    }
777
778    int imgReaderFmt = ctx->getBufferFormat();
779    int bufFmt = buffer->format;
780    if (imgReaderFmt != bufFmt) {
781        // Special casing for when producer switches to a format compatible with flexible YUV
782        // (HAL_PIXEL_FORMAT_YCbCr_420_888).
783        if (imgReaderFmt == HAL_PIXEL_FORMAT_YCbCr_420_888 && (bufFmt ==
784                HAL_PIXEL_FORMAT_YCrCb_420_SP || bufFmt == HAL_PIXEL_FORMAT_YV12)) {
785            ctx->setBufferFormat(bufFmt);
786            ALOGV("%s: Overriding buffer format YUV_420_888 to %x.", __FUNCTION__, bufFmt);
787        } else {
788            // Return the buffer to the queue.
789            consumer->unlockBuffer(*buffer);
790            ctx->returnLockedBuffer(buffer);
791
792            // Throw exception
793            ALOGE("Producer output buffer format: 0x%x, ImageReader configured format: 0x%x",
794                    buffer->format, ctx->getBufferFormat());
795            String8 msg;
796            msg.appendFormat("The producer output buffer format 0x%x doesn't "
797                    "match the ImageReader's configured buffer format 0x%x.",
798                    buffer->format, ctx->getBufferFormat());
799            jniThrowException(env, "java/lang/UnsupportedOperationException",
800                    msg.string());
801            return -1;
802        }
803    }
804    // Set SurfaceImage instance member variables
805    Image_setBuffer(env, image, buffer);
806    env->SetLongField(image, gSurfaceImageClassInfo.mTimestamp,
807            static_cast<jlong>(buffer->timestamp));
808
809    return ACQUIRE_SUCCESS;
810}
811
812static jobject ImageReader_getSurface(JNIEnv* env, jobject thiz)
813{
814    ALOGV("%s: ", __FUNCTION__);
815
816    IGraphicBufferProducer* gbp = ImageReader_getProducer(env, thiz);
817    if (gbp == NULL) {
818        jniThrowRuntimeException(env, "CpuConsumer is uninitialized");
819        return NULL;
820    }
821
822    // Wrap the IGBP in a Java-language Surface.
823    return android_view_Surface_createFromIGraphicBufferProducer(env, gbp);
824}
825
826static jobject Image_createSurfacePlane(JNIEnv* env, jobject thiz, int idx)
827{
828    int rowStride, pixelStride;
829    ALOGV("%s: buffer index: %d", __FUNCTION__, idx);
830
831    CpuConsumer::LockedBuffer* buffer = Image_getLockedBuffer(env, thiz);
832
833    ALOG_ASSERT(buffer != NULL);
834    if (buffer == NULL) {
835        jniThrowException(env, "java/lang/IllegalStateException", "Image was released");
836    }
837    rowStride = Image_imageGetRowStride(env, buffer, idx);
838    pixelStride = Image_imageGetPixelStride(env, buffer, idx);
839
840    jobject surfPlaneObj = env->NewObject(gSurfacePlaneClassInfo.clazz,
841            gSurfacePlaneClassInfo.ctor, thiz, idx, rowStride, pixelStride);
842
843    return surfPlaneObj;
844}
845
846static jobject Image_getByteBuffer(JNIEnv* env, jobject thiz, int idx)
847{
848    uint8_t *base = NULL;
849    uint32_t size = 0;
850    jobject byteBuffer;
851
852    ALOGV("%s: buffer index: %d", __FUNCTION__, idx);
853
854    CpuConsumer::LockedBuffer* buffer = Image_getLockedBuffer(env, thiz);
855
856    if (buffer == NULL) {
857        jniThrowException(env, "java/lang/IllegalStateException", "Image was released");
858    }
859
860    // Create byteBuffer from native buffer
861    Image_getLockedBufferInfo(env, buffer, idx, &base, &size);
862
863    if (size > static_cast<uint32_t>(INT32_MAX)) {
864        // Byte buffer have 'int capacity', so check the range
865        jniThrowExceptionFmt(env, "java/lang/IllegalStateException",
866                "Size too large for bytebuffer capacity " PRIu32, size);
867        return NULL;
868    }
869
870    byteBuffer = env->NewDirectByteBuffer(base, size);
871    // TODO: throw dvm exOutOfMemoryError?
872    if ((byteBuffer == NULL) && (env->ExceptionCheck() == false)) {
873        jniThrowException(env, "java/lang/IllegalStateException", "Failed to allocate ByteBuffer");
874    }
875
876    return byteBuffer;
877}
878
879} // extern "C"
880
881// ----------------------------------------------------------------------------
882
883static JNINativeMethod gImageReaderMethods[] = {
884    {"nativeClassInit",        "()V",                        (void*)ImageReader_classInit },
885    {"nativeInit",             "(Ljava/lang/Object;IIII)V",  (void*)ImageReader_init },
886    {"nativeClose",            "()V",                        (void*)ImageReader_close },
887    {"nativeReleaseImage",     "(Landroid/media/Image;)V",   (void*)ImageReader_imageRelease },
888    {"nativeImageSetup",       "(Landroid/media/Image;)I",    (void*)ImageReader_imageSetup },
889    {"nativeGetSurface",       "()Landroid/view/Surface;",   (void*)ImageReader_getSurface },
890};
891
892static JNINativeMethod gImageMethods[] = {
893    {"nativeImageGetBuffer",   "(I)Ljava/nio/ByteBuffer;",   (void*)Image_getByteBuffer },
894    {"nativeCreatePlane",      "(I)Landroid/media/ImageReader$SurfaceImage$SurfacePlane;",
895                                                             (void*)Image_createSurfacePlane },
896};
897
898int register_android_media_ImageReader(JNIEnv *env) {
899
900    int ret1 = AndroidRuntime::registerNativeMethods(env,
901                   "android/media/ImageReader", gImageReaderMethods, NELEM(gImageReaderMethods));
902
903    int ret2 = AndroidRuntime::registerNativeMethods(env,
904                   "android/media/ImageReader$SurfaceImage", gImageMethods, NELEM(gImageMethods));
905
906    return (ret1 || ret2);
907}
908