1 /* 2 * Copyright (C) 2017 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 /** 18 * @addtogroup AHardwareBuffer 19 * @{ 20 */ 21 22 /** 23 * @file hardware_buffer_jni.h 24 * @brief JNI glue for native hardware buffers. 25 */ 26 27 #ifndef ANDROID_HARDWARE_BUFFER_JNI_H 28 #define ANDROID_HARDWARE_BUFFER_JNI_H 29 30 #include <sys/cdefs.h> 31 32 #include <android/hardware_buffer.h> 33 34 #include <jni.h> 35 36 __BEGIN_DECLS 37 38 /** 39 * Return the AHardwareBuffer wrapped by a Java HardwareBuffer object. 40 * 41 * This method does not acquire any additional reference to the AHardwareBuffer 42 * that is returned. To keep the AHardwareBuffer alive after the Java 43 * HardwareBuffer object is closed, explicitly or by the garbage collector, be 44 * sure to use AHardwareBuffer_acquire() to acquire an additional reference. 45 * 46 * Available since API level 26. 47 */ 48 AHardwareBuffer* AHardwareBuffer_fromHardwareBuffer(JNIEnv* env, 49 jobject hardwareBufferObj) __INTRODUCED_IN(26); 50 51 /** 52 * Return a new Java HardwareBuffer object that wraps the passed native 53 * AHardwareBuffer object. The Java HardwareBuffer will acquire a reference to 54 * the internal buffer and manage its lifetime. For example: 55 * 56 * <pre><code> 57 * AHardwareBuffer* buffer; 58 * AHardwareBuffer_allocate(..., &buffer); // `buffer` has reference count 1 59 * jobject java_result = AHardwareBuffer_toHardwareBuffer(buffer); // `buffer` has reference count 2. 60 * AHardwareBuffer_release(buffer); // `buffer` has reference count 1 61 * return result; // The underlying buffer is kept alive by `java_result` and 62 * // will be set to 0 when it is closed on the Java side with 63 * // HardwareBuffer::close(). 64 * </code></pre> 65 * 66 * Available since API level 26. 67 */ 68 jobject AHardwareBuffer_toHardwareBuffer(JNIEnv* env, 69 AHardwareBuffer* hardwareBuffer) __INTRODUCED_IN(26); 70 71 __END_DECLS 72 73 #endif // ANDROID_HARDWARE_BUFFER_JNI_H 74 75 /** @} */ 76