android_media_ImageReader.cpp revision 4c4064fa66f551f49b7e1017b1ebe65a05f9df21 
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;
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_RAW10:
417            // Single plane 10bpp bayer data.
418            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
419            LOG_ALWAYS_FATAL_IF(buffer->width % 4,
420                                "Width is not multiple of 4 %d", buffer->width);
421            LOG_ALWAYS_FATAL_IF(buffer->height % 2,
422                                "Height is not even %d", buffer->height);
423            LOG_ALWAYS_FATAL_IF(buffer->stride < (buffer->width * 10 / 8),
424                                "stride (%d) should be at least %d",
425                                buffer->stride, buffer->width * 10 / 8);
426            pData = buffer->data;
427            dataSize = buffer->stride * buffer->height;
428            break;
429        case HAL_PIXEL_FORMAT_RGBA_8888:
430        case HAL_PIXEL_FORMAT_RGBX_8888:
431            // Single plane, 32bpp.
432            bytesPerPixel = 4;
433            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
434            pData = buffer->data;
435            dataSize = buffer->stride * buffer->height * bytesPerPixel;
436            break;
437        case HAL_PIXEL_FORMAT_RGB_565:
438            // Single plane, 16bpp.
439            bytesPerPixel = 2;
440            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
441            pData = buffer->data;
442            dataSize = buffer->stride * buffer->height * bytesPerPixel;
443            break;
444        case HAL_PIXEL_FORMAT_RGB_888:
445            // Single plane, 24bpp.
446            bytesPerPixel = 3;
447            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
448            pData = buffer->data;
449            dataSize = buffer->stride * buffer->height * bytesPerPixel;
450            break;
451        default:
452            jniThrowExceptionFmt(env, "java/lang/UnsupportedOperationException",
453                                 "Pixel format: 0x%x is unsupported", fmt);
454            break;
455    }
456
457    *base = pData;
458    *size = dataSize;
459}
460
461static jint Image_imageGetPixelStride(JNIEnv* env, CpuConsumer::LockedBuffer* buffer, int idx)
462{
463    ALOGV("%s: buffer index: %d", __FUNCTION__, idx);
464    ALOG_ASSERT((idx < IMAGE_READER_MAX_NUM_PLANES) && (idx >= 0), "Index is out of range:%d", idx);
465
466    int pixelStride = 0;
467    ALOG_ASSERT(buffer != NULL, "buffer is NULL");
468
469    int32_t fmt = buffer->format;
470    switch (fmt) {
471        case HAL_PIXEL_FORMAT_YCbCr_420_888:
472            pixelStride = (idx == 0) ? 1 : buffer->chromaStep;
473            break;
474        case HAL_PIXEL_FORMAT_YCrCb_420_SP:
475            pixelStride = (idx == 0) ? 1 : 2;
476            break;
477        case HAL_PIXEL_FORMAT_Y8:
478            // Single plane 8bpp data.
479            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
480            pixelStride;
481            break;
482        case HAL_PIXEL_FORMAT_YV12:
483            pixelStride = 1;
484            break;
485        case HAL_PIXEL_FORMAT_BLOB:
486        case HAL_PIXEL_FORMAT_RAW10:
487            // Blob is used for JPEG data, RAW10 is used for 10-bit raw data, they are
488            // single plane, row and pixel strides are 0.
489            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
490            pixelStride = 0;
491            break;
492        case HAL_PIXEL_FORMAT_Y16:
493        case HAL_PIXEL_FORMAT_RAW_SENSOR:
494        case HAL_PIXEL_FORMAT_RGB_565:
495            // Single plane 16bpp data.
496            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
497            pixelStride = 2;
498            break;
499        case HAL_PIXEL_FORMAT_RGBA_8888:
500        case HAL_PIXEL_FORMAT_RGBX_8888:
501            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
502            pixelStride = 4;
503            break;
504        case HAL_PIXEL_FORMAT_RGB_888:
505            // Single plane, 24bpp.
506            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
507            pixelStride = 3;
508            break;
509        default:
510            jniThrowExceptionFmt(env, "java/lang/UnsupportedOperationException",
511                                 "Pixel format: 0x%x is unsupported", fmt);
512            break;
513    }
514
515    return pixelStride;
516}
517
518static jint Image_imageGetRowStride(JNIEnv* env, CpuConsumer::LockedBuffer* buffer, int idx)
519{
520    ALOGV("%s: buffer index: %d", __FUNCTION__, idx);
521    ALOG_ASSERT((idx < IMAGE_READER_MAX_NUM_PLANES) && (idx >= 0));
522
523    int rowStride = 0;
524    ALOG_ASSERT(buffer != NULL, "buffer is NULL");
525
526    int32_t fmt = buffer->format;
527
528    switch (fmt) {
529        case HAL_PIXEL_FORMAT_YCbCr_420_888:
530            rowStride = (idx == 0) ? buffer->stride : buffer->chromaStride;
531            break;
532        case HAL_PIXEL_FORMAT_YCrCb_420_SP:
533            rowStride = buffer->width;
534            break;
535        case HAL_PIXEL_FORMAT_YV12:
536            LOG_ALWAYS_FATAL_IF(buffer->stride % 16,
537                                "Stride is not 16 pixel aligned %d", buffer->stride);
538            rowStride = (idx == 0) ? buffer->stride : ALIGN(buffer->stride / 2, 16);
539            break;
540        case HAL_PIXEL_FORMAT_BLOB:
541            // Blob is used for JPEG data, RAW10 is used for 10-bit raw data, they are
542            // single plane, row and pixel strides are 0.
543            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
544            rowStride = 0;
545            break;
546        case HAL_PIXEL_FORMAT_RAW10:
547            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
548            rowStride = buffer->stride;
549            break;
550        case HAL_PIXEL_FORMAT_Y8:
551            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
552            LOG_ALWAYS_FATAL_IF(buffer->stride % 16,
553                                "Stride is not 16 pixel aligned %d", buffer->stride);
554            rowStride = buffer->stride;
555            break;
556        case HAL_PIXEL_FORMAT_Y16:
557        case HAL_PIXEL_FORMAT_RAW_SENSOR:
558            // In native side, strides are specified in pixels, not in bytes.
559            // Single plane 16bpp bayer data. even width/height,
560            // row stride multiple of 16 pixels (32 bytes)
561            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
562            LOG_ALWAYS_FATAL_IF(buffer->stride % 16,
563                                "Stride is not 16 pixel aligned %d", buffer->stride);
564            rowStride = buffer->stride * 2;
565            break;
566        case HAL_PIXEL_FORMAT_RGB_565:
567            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
568            rowStride = buffer->stride * 2;
569            break;
570        case HAL_PIXEL_FORMAT_RGBA_8888:
571        case HAL_PIXEL_FORMAT_RGBX_8888:
572            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
573            rowStride = buffer->stride * 4;
574            break;
575        case HAL_PIXEL_FORMAT_RGB_888:
576            // Single plane, 24bpp.
577            ALOG_ASSERT(idx == 0, "Wrong index: %d", idx);
578            rowStride = buffer->stride * 3;
579            break;
580        default:
581            ALOGE("%s Pixel format: 0x%x is unsupported", __FUNCTION__, fmt);
582            jniThrowException(env, "java/lang/UnsupportedOperationException",
583                              "unsupported buffer format");
584          break;
585    }
586
587    return rowStride;
588}
589
590// ----------------------------------------------------------------------------
591
592static void ImageReader_classInit(JNIEnv* env, jclass clazz)
593{
594    ALOGV("%s:", __FUNCTION__);
595
596    jclass imageClazz = env->FindClass("android/media/ImageReader$SurfaceImage");
597    LOG_ALWAYS_FATAL_IF(imageClazz == NULL,
598                        "can't find android/graphics/ImageReader$SurfaceImage");
599    gSurfaceImageClassInfo.mLockedBuffer = env->GetFieldID(
600            imageClazz, ANDROID_MEDIA_SURFACEIMAGE_BUFFER_JNI_ID, "J");
601    LOG_ALWAYS_FATAL_IF(gSurfaceImageClassInfo.mLockedBuffer == NULL,
602                        "can't find android/graphics/ImageReader.%s",
603                        ANDROID_MEDIA_SURFACEIMAGE_BUFFER_JNI_ID);
604
605    gSurfaceImageClassInfo.mTimestamp = env->GetFieldID(
606            imageClazz, ANDROID_MEDIA_SURFACEIMAGE_TS_JNI_ID, "J");
607    LOG_ALWAYS_FATAL_IF(gSurfaceImageClassInfo.mTimestamp == NULL,
608                        "can't find android/graphics/ImageReader.%s",
609                        ANDROID_MEDIA_SURFACEIMAGE_TS_JNI_ID);
610
611    gImageReaderClassInfo.mNativeContext = env->GetFieldID(
612            clazz, ANDROID_MEDIA_IMAGEREADER_CTX_JNI_ID, "J");
613    LOG_ALWAYS_FATAL_IF(gImageReaderClassInfo.mNativeContext == NULL,
614                        "can't find android/graphics/ImageReader.%s",
615                          ANDROID_MEDIA_IMAGEREADER_CTX_JNI_ID);
616
617    gImageReaderClassInfo.postEventFromNative = env->GetStaticMethodID(
618            clazz, "postEventFromNative", "(Ljava/lang/Object;)V");
619    LOG_ALWAYS_FATAL_IF(gImageReaderClassInfo.postEventFromNative == NULL,
620                        "can't find android/graphics/ImageReader.postEventFromNative");
621
622    jclass planeClazz = env->FindClass("android/media/ImageReader$SurfaceImage$SurfacePlane");
623    LOG_ALWAYS_FATAL_IF(planeClazz == NULL, "Can not find SurfacePlane class");
624    // FindClass only gives a local reference of jclass object.
625    gSurfacePlaneClassInfo.clazz = (jclass) env->NewGlobalRef(planeClazz);
626    gSurfacePlaneClassInfo.ctor = env->GetMethodID(gSurfacePlaneClassInfo.clazz, "<init>",
627            "(Landroid/media/ImageReader$SurfaceImage;III)V");
628    LOG_ALWAYS_FATAL_IF(gSurfacePlaneClassInfo.ctor == NULL,
629            "Can not find SurfacePlane constructor");
630}
631
632static void ImageReader_init(JNIEnv* env, jobject thiz, jobject weakThiz,
633                             jint width, jint height, jint format, jint maxImages)
634{
635    status_t res;
636    int nativeFormat;
637
638    ALOGV("%s: width:%d, height: %d, format: 0x%x, maxImages:%d",
639          __FUNCTION__, width, height, format, maxImages);
640
641    nativeFormat = Image_getPixelFormat(env, format);
642
643    sp<IGraphicBufferProducer> gbProducer;
644    sp<IGraphicBufferConsumer> gbConsumer;
645    BufferQueue::createBufferQueue(&gbProducer, &gbConsumer);
646    sp<CpuConsumer> consumer = new CpuConsumer(gbConsumer, maxImages,
647                                               /*controlledByApp*/true);
648    // TODO: throw dvm exOutOfMemoryError?
649    if (consumer == NULL) {
650        jniThrowRuntimeException(env, "Failed to allocate native CpuConsumer");
651        return;
652    }
653
654    jclass clazz = env->GetObjectClass(thiz);
655    if (clazz == NULL) {
656        jniThrowRuntimeException(env, "Can't find android/graphics/ImageReader");
657        return;
658    }
659    sp<JNIImageReaderContext> ctx(new JNIImageReaderContext(env, weakThiz, clazz, maxImages));
660    ctx->setCpuConsumer(consumer);
661    ctx->setProducer(gbProducer);
662    consumer->setFrameAvailableListener(ctx);
663    ImageReader_setNativeContext(env, thiz, ctx);
664    ctx->setBufferFormat(nativeFormat);
665    ctx->setBufferWidth(width);
666    ctx->setBufferHeight(height);
667
668    // Set the width/height/format to the CpuConsumer
669    res = consumer->setDefaultBufferSize(width, height);
670    if (res != OK) {
671        jniThrowException(env, "java/lang/IllegalStateException",
672                          "Failed to set CpuConsumer buffer size");
673        return;
674    }
675    res = consumer->setDefaultBufferFormat(nativeFormat);
676    if (res != OK) {
677        jniThrowException(env, "java/lang/IllegalStateException",
678                          "Failed to set CpuConsumer buffer format");
679    }
680}
681
682static void ImageReader_close(JNIEnv* env, jobject thiz)
683{
684    ALOGV("%s:", __FUNCTION__);
685
686    JNIImageReaderContext* const ctx = ImageReader_getContext(env, thiz);
687    if (ctx == NULL) {
688        // ImageReader is already closed.
689        return;
690    }
691
692    CpuConsumer* consumer = ImageReader_getCpuConsumer(env, thiz);
693    if (consumer != NULL) {
694        consumer->abandon();
695        consumer->setFrameAvailableListener(NULL);
696    }
697    ImageReader_setNativeContext(env, thiz, NULL);
698}
699
700static void ImageReader_imageRelease(JNIEnv* env, jobject thiz, jobject image)
701{
702    ALOGV("%s:", __FUNCTION__);
703    JNIImageReaderContext* ctx = ImageReader_getContext(env, thiz);
704    if (ctx == NULL) {
705        ALOGW("ImageReader#close called before Image#close, consider calling Image#close first");
706        return;
707    }
708
709    CpuConsumer* consumer = ctx->getCpuConsumer();
710    CpuConsumer::LockedBuffer* buffer = Image_getLockedBuffer(env, image);
711    if (!buffer) {
712        ALOGW("Image already released!!!");
713        return;
714    }
715    consumer->unlockBuffer(*buffer);
716    Image_setBuffer(env, image, NULL);
717    ctx->returnLockedBuffer(buffer);
718}
719
720static jint ImageReader_imageSetup(JNIEnv* env, jobject thiz,
721                                             jobject image)
722{
723    ALOGV("%s:", __FUNCTION__);
724    JNIImageReaderContext* ctx = ImageReader_getContext(env, thiz);
725    if (ctx == NULL) {
726        jniThrowRuntimeException(env, "ImageReaderContext is not initialized");
727        return -1;
728    }
729
730    CpuConsumer* consumer = ctx->getCpuConsumer();
731    CpuConsumer::LockedBuffer* buffer = ctx->getLockedBuffer();
732    if (buffer == NULL) {
733        ALOGW("Unable to acquire a lockedBuffer, very likely client tries to lock more than"
734            " maxImages buffers");
735        return ACQUIRE_MAX_IMAGES;
736    }
737    status_t res = consumer->lockNextBuffer(buffer);
738    if (res != NO_ERROR) {
739        ctx->returnLockedBuffer(buffer);
740        if (res != BAD_VALUE /*no buffers*/) {
741            if (res == NOT_ENOUGH_DATA) {
742                return ACQUIRE_MAX_IMAGES;
743            } else {
744                ALOGE("%s Fail to lockNextBuffer with error: %d ",
745                      __FUNCTION__, res);
746                jniThrowExceptionFmt(env, "java/lang/AssertionError",
747                          "Unknown error (%d) when we tried to lock buffer.",
748                          res);
749            }
750        }
751        return ACQUIRE_NO_BUFFERS;
752    }
753
754    if (buffer->format == HAL_PIXEL_FORMAT_YCrCb_420_SP) {
755        jniThrowException(env, "java/lang/UnsupportedOperationException",
756                "NV21 format is not supported by ImageReader");
757        return -1;
758    }
759
760    // Check if the left-top corner of the crop rect is origin, we currently assume this point is
761    // zero, will revist this once this assumption turns out problematic.
762    Point lt = buffer->crop.leftTop();
763    if (lt.x != 0 || lt.y != 0) {
764        jniThrowExceptionFmt(env, "java/lang/UnsupportedOperationException",
765                "crop left top corner [%d, %d] need to be at origin", lt.x, lt.y);
766        return -1;
767    }
768
769    // Check if the producer buffer configurations match what ImageReader configured.
770    // We want to fail for the very first image because this case is too bad.
771    int outputWidth = buffer->width;
772    int outputHeight = buffer->height;
773
774    // Correct width/height when crop is set.
775    if (!buffer->crop.isEmpty()) {
776        outputWidth = buffer->crop.getWidth();
777        outputHeight = buffer->crop.getHeight();
778    }
779
780    int imageReaderWidth = ctx->getBufferWidth();
781    int imageReaderHeight = ctx->getBufferHeight();
782    if ((buffer->format != HAL_PIXEL_FORMAT_BLOB) &&
783            (imageReaderWidth != outputWidth || imageReaderHeight > outputHeight)) {
784        /**
785         * For video decoder, the buffer height is actually the vertical stride,
786         * which is always >= actual image height. For future, decoder need provide
787         * right crop rectangle to CpuConsumer to indicate the actual image height,
788         * see bug 9563986. After this bug is fixed, we can enforce the height equal
789         * check. Right now, only make sure buffer height is no less than ImageReader
790         * height.
791         */
792        jniThrowExceptionFmt(env, "java/lang/IllegalStateException",
793                "Producer buffer size: %dx%d, doesn't match ImageReader configured size: %dx%d",
794                outputWidth, outputHeight, imageReaderWidth, imageReaderHeight);
795        return -1;
796    }
797
798    int imgReaderFmt = ctx->getBufferFormat();
799    int bufFmt = buffer->format;
800    if (imgReaderFmt != bufFmt) {
801        // Special casing for when producer switches to a format compatible with flexible YUV
802        // (HAL_PIXEL_FORMAT_YCbCr_420_888).
803        if (imgReaderFmt == HAL_PIXEL_FORMAT_YCbCr_420_888 && (bufFmt ==
804                HAL_PIXEL_FORMAT_YCrCb_420_SP || bufFmt == HAL_PIXEL_FORMAT_YV12)) {
805            ctx->setBufferFormat(bufFmt);
806            ALOGV("%s: Overriding buffer format YUV_420_888 to %x.", __FUNCTION__, bufFmt);
807        } else {
808            // Return the buffer to the queue.
809            consumer->unlockBuffer(*buffer);
810            ctx->returnLockedBuffer(buffer);
811
812            // Throw exception
813            ALOGE("Producer output buffer format: 0x%x, ImageReader configured format: 0x%x",
814                    buffer->format, ctx->getBufferFormat());
815            String8 msg;
816            msg.appendFormat("The producer output buffer format 0x%x doesn't "
817                    "match the ImageReader's configured buffer format 0x%x.",
818                    buffer->format, ctx->getBufferFormat());
819            jniThrowException(env, "java/lang/UnsupportedOperationException",
820                    msg.string());
821            return -1;
822        }
823    }
824    // Set SurfaceImage instance member variables
825    Image_setBuffer(env, image, buffer);
826    env->SetLongField(image, gSurfaceImageClassInfo.mTimestamp,
827            static_cast<jlong>(buffer->timestamp));
828
829    return ACQUIRE_SUCCESS;
830}
831
832static jobject ImageReader_getSurface(JNIEnv* env, jobject thiz)
833{
834    ALOGV("%s: ", __FUNCTION__);
835
836    IGraphicBufferProducer* gbp = ImageReader_getProducer(env, thiz);
837    if (gbp == NULL) {
838        jniThrowRuntimeException(env, "CpuConsumer is uninitialized");
839        return NULL;
840    }
841
842    // Wrap the IGBP in a Java-language Surface.
843    return android_view_Surface_createFromIGraphicBufferProducer(env, gbp);
844}
845
846static jobject Image_createSurfacePlane(JNIEnv* env, jobject thiz, int idx)
847{
848    int rowStride, pixelStride;
849    ALOGV("%s: buffer index: %d", __FUNCTION__, idx);
850
851    CpuConsumer::LockedBuffer* buffer = Image_getLockedBuffer(env, thiz);
852
853    ALOG_ASSERT(buffer != NULL);
854    if (buffer == NULL) {
855        jniThrowException(env, "java/lang/IllegalStateException", "Image was released");
856    }
857    rowStride = Image_imageGetRowStride(env, buffer, idx);
858    pixelStride = Image_imageGetPixelStride(env, buffer, idx);
859
860    jobject surfPlaneObj = env->NewObject(gSurfacePlaneClassInfo.clazz,
861            gSurfacePlaneClassInfo.ctor, thiz, idx, rowStride, pixelStride);
862
863    return surfPlaneObj;
864}
865
866static jobject Image_getByteBuffer(JNIEnv* env, jobject thiz, int idx)
867{
868    uint8_t *base = NULL;
869    uint32_t size = 0;
870    jobject byteBuffer;
871
872    ALOGV("%s: buffer index: %d", __FUNCTION__, idx);
873
874    CpuConsumer::LockedBuffer* buffer = Image_getLockedBuffer(env, thiz);
875
876    if (buffer == NULL) {
877        jniThrowException(env, "java/lang/IllegalStateException", "Image was released");
878    }
879
880    // Create byteBuffer from native buffer
881    Image_getLockedBufferInfo(env, buffer, idx, &base, &size);
882
883    if (size > static_cast<uint32_t>(INT32_MAX)) {
884        // Byte buffer have 'int capacity', so check the range
885        jniThrowExceptionFmt(env, "java/lang/IllegalStateException",
886                "Size too large for bytebuffer capacity " PRIu32, size);
887        return NULL;
888    }
889
890    byteBuffer = env->NewDirectByteBuffer(base, size);
891    // TODO: throw dvm exOutOfMemoryError?
892    if ((byteBuffer == NULL) && (env->ExceptionCheck() == false)) {
893        jniThrowException(env, "java/lang/IllegalStateException", "Failed to allocate ByteBuffer");
894    }
895
896    return byteBuffer;
897}
898
899} // extern "C"
900
901// ----------------------------------------------------------------------------
902
903static JNINativeMethod gImageReaderMethods[] = {
904    {"nativeClassInit",        "()V",                        (void*)ImageReader_classInit },
905    {"nativeInit",             "(Ljava/lang/Object;IIII)V",  (void*)ImageReader_init },
906    {"nativeClose",            "()V",                        (void*)ImageReader_close },
907    {"nativeReleaseImage",     "(Landroid/media/Image;)V",   (void*)ImageReader_imageRelease },
908    {"nativeImageSetup",       "(Landroid/media/Image;)I",    (void*)ImageReader_imageSetup },
909    {"nativeGetSurface",       "()Landroid/view/Surface;",   (void*)ImageReader_getSurface },
910};
911
912static JNINativeMethod gImageMethods[] = {
913    {"nativeImageGetBuffer",   "(I)Ljava/nio/ByteBuffer;",   (void*)Image_getByteBuffer },
914    {"nativeCreatePlane",      "(I)Landroid/media/ImageReader$SurfaceImage$SurfacePlane;",
915                                                             (void*)Image_createSurfacePlane },
916};
917
918int register_android_media_ImageReader(JNIEnv *env) {
919
920    int ret1 = AndroidRuntime::registerNativeMethods(env,
921                   "android/media/ImageReader", gImageReaderMethods, NELEM(gImageReaderMethods));
922
923    int ret2 = AndroidRuntime::registerNativeMethods(env,
924                   "android/media/ImageReader$SurfaceImage", gImageMethods, NELEM(gImageMethods));
925
926    return (ret1 || ret2);
927}
928