ImageWriter

close

public void close ()

Free up all the resources associated with this ImageWriter.

After calling this method, this ImageWriter cannot be used. Calling any methods on this ImageWriter and Images previously provided by dequeueInputImage() will result in an IllegalStateException, and attempting to write into ByteBuffers returned by an earlier Plane#getBuffer call will have undefined behavior.

dequeueInputImage

public Image dequeueInputImage ()

Dequeue the next available input Image for the application to produce data into.

This method requests a new input Image from ImageWriter. The application owns this Image after this call. Once the application fills the Image data, it is expected to return this Image back to ImageWriter for downstream consumer components (e.g. CameraDevice) to consume. The Image can be returned to ImageWriter via queueInputImage(Image) or Image.close().

This call will block if all available input images have been queued by the application and the downstream consumer has not yet consumed any. When an Image is consumed by the downstream consumer and released, an OnImageReleasedListener.onImageReleased callback will be fired, which indicates that there is one input Image available. For non- PRIVATE formats ( ImageWriter.getFormat() != ImageFormat.PRIVATE), it is recommended to dequeue the next Image only after this callback is fired, in the steady state.

If the format of ImageWriter is PRIVATE ( ImageWriter.getFormat() == ImageFormat.PRIVATE), the image buffer is accessible to the application only through the hardware buffer obtained through Image.getHardwareBuffer(). (On Android versions prior to P, dequeueing private buffers will cause an IllegalStateException to be thrown). Alternatively, the application can acquire images from some other component (e.g. an ImageReader), and queue them directly to this ImageWriter via the queueInputImage() method.

getDataSpace

public int getDataSpace ()

Get the ImageWriter dataspace.

Use this function if the ImageWriter instance is created by builder pattern ImageWriter.Builder and Builder.setDataSpace.

getFormat

public int getFormat ()

Get the ImageWriter format.

This format may be different than the Image format returned by Image.getFormat(). However, if the ImageWriter format is PRIVATE, calling dequeueInputImage() will result in an IllegalStateException.

getHardwareBufferFormat

public int getHardwareBufferFormat ()

Get the ImageWriter hardwareBuffer format.

Use this function if the ImageWriter instance is created by builder pattern ImageWriter.Builder and using Builder.setHardwareBufferFormat and Builder.setDataSpace.

getHeight

public int getHeight ()

The height of Images, in pixels.

If Builder.setWidthAndHeight is not called, the default height of the Image depends on the Surface provided by customer end-point.

getMaxImages

public int getMaxImages ()

Maximum number of Images that can be dequeued from the ImageWriter simultaneously (for example, with dequeueInputImage()).

An Image is considered dequeued after it's returned by dequeueInputImage() from ImageWriter, and until the Image is sent back to ImageWriter via queueInputImage(Image), or Image.close().

Attempting to dequeue more than maxImages concurrently will result in the dequeueInputImage() function throwing an IllegalStateException.

getUsage

public long getUsage ()

Get the ImageWriter usage flag.

It is not recommended to use this function if Builder.setUsage is not called. Invalid usage value will be returned if so.

getWidth

public int getWidth ()

The width of Images, in pixels.

If Builder.setWidthAndHeight is not called, the default width of the Image depends on the Surface provided by customer end-point.

newInstance

public static ImageWriter newInstance (Surface surface, 
                int maxImages, 
                int format)

Create a new ImageWriter with given number of max Images and format.

The maxImages parameter determines the maximum number of Image objects that can be be dequeued from the ImageWriter simultaneously. Requesting more buffers will use up more memory, so it is important to use only the minimum number necessary.

The format specifies the image format of this ImageWriter. The format from the surface will be overridden with this format. For example, if the surface is obtained from a SurfaceTexture, the default format may be PixelFormat.RGBA_8888. If the application creates an ImageWriter with this surface and ImageFormat.PRIVATE, this ImageWriter will be able to operate with ImageFormat.PRIVATE Images.

Note that the consumer end-point may or may not be able to support Images with different format, for such case, the application should only use this method if the consumer is able to consume such images.

The input Image size depends on the Surface that is provided by the downstream consumer end-point.

newInstance

public static ImageWriter newInstance (Surface surface, 
                int maxImages)

Create a new ImageWriter.

The maxImages parameter determines the maximum number of Image objects that can be be dequeued from the ImageWriter simultaneously. Requesting more buffers will use up more memory, so it is important to use only the minimum number necessary.

The input Image size and format depend on the Surface that is provided by the downstream consumer end-point.

queueInputImage

public void queueInputImage (Image image)

Queue an input Image back to ImageWriter for the downstream consumer to access.

The input Image could be from ImageReader (acquired via ImageReader.acquireNextImage or ImageReader.acquireLatestImage), or from this ImageWriter (acquired via dequeueInputImage()). In the former case, the Image data will be moved to this ImageWriter. Note that the Image properties (size, format, strides, etc.) must be the same as the properties of the images dequeued from this ImageWriter. In the latter case, the application has filled the input image with data. This method then passes the filled buffer to the downstream consumer. In both cases, it's up to the caller to ensure that the Image timestamp (in nanoseconds) is correctly set, as the downstream component may want to use it to indicate the Image data capture time.

After this method is called and the downstream consumer consumes and releases the Image, an OnImageReleasedListener.onImageReleased callback will fire. The application can use this callback to avoid sending Images faster than the downstream consumer processing rate in steady state.

Passing in an Image from some other component (e.g. an ImageReader) requires a free input Image from this ImageWriter as the destination. In this case, this call will block, as dequeueInputImage() does, if there are no free Images available. To avoid blocking, the application should ensure that there is at least one free Image available in this ImageWriter before calling this method.

After this call, the input Image is no longer valid for further access, as if the Image is closed. Attempting to access the ByteBuffers returned by an earlier Plane#getBuffer call will result in an IllegalStateException.

setOnImageReleasedListener

public void setOnImageReleasedListener (ImageWriter.OnImageReleasedListener listener, 
                Handler handler)

Register a listener to be invoked when an input Image is returned to the ImageWriter.

finalize

protected void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.