Android APIs
public final class

DngCreator

extends Object
implements AutoCloseable
java.lang.Object
   ↳ android.hardware.camera2.DngCreator

Class Overview

The DngCreator class provides functions to write raw pixel data as a DNG file.

This class is designed to be used with the RAW_SENSOR buffers available from CameraDevice, or with Bayer-type raw pixel data that is otherwise generated by an application. The DNG metadata tags will be generated from a CaptureResult object or set directly.

The DNG file format is a cross-platform file format that is used to store pixel data from camera sensors with minimal pre-processing applied. DNG files allow for pixel data to be defined in a user-defined colorspace, and have associated metadata that allow for this pixel data to be converted to the standard CIE XYZ colorspace during post-processing.

For more information on the DNG file format and associated metadata, please refer to the Adobe DNG 1.4.0.0 specification.

Summary

Public Constructors
DngCreator(CameraCharacteristics characteristics, CaptureResult metadata)
Create a new DNG object.
Public Methods
void close()
Closes the object and release any system resources it holds.
void writeImage(OutputStream dngOutput, Image pixels)
Write the pixel data to a DNG file with the currently configured metadata.
Protected Methods
void finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.AutoCloseable

Public Constructors

public DngCreator (CameraCharacteristics characteristics, CaptureResult metadata)

Create a new DNG object.

It is not necessary to call any set methods to write a well-formatted DNG file.

DNG metadata tags will be generated from the corresponding parameters in the CaptureResult object. This removes or overrides all previous tags set.

Parameters
characteristics an object containing the static CameraCharacteristics.
metadata a metadata object to generate tags from.

Public Methods

public void close ()

Closes the object and release any system resources it holds.

public void writeImage (OutputStream dngOutput, Image pixels)

Write the pixel data to a DNG file with the currently configured metadata.

For this method to succeed, the Image input must contain RAW_SENSOR pixel data, otherwise an IllegalArgumentException will be thrown.

Parameters
dngOutput an OutputStream to write the DNG file to.
pixels an Image to write.
Throws
IOException if an error was encountered in the output stream.
IllegalArgumentException if an image with an unsupported format was used.
IllegalStateException if not enough metadata information has been set to write a well-formatted DNG file.

Protected Methods

protected void finalize ()

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable