Merge "camera2: Add DNG creator class."

This commit is contained in:
Ruben Brunk
2014-04-25 01:10:07 +00:00
committed by Android (Google) Code Review
2 changed files with 266 additions and 0 deletions

View File

@@ -13377,6 +13377,18 @@ package android.media {
ctor public DeniedByServerException(java.lang.String); ctor public DeniedByServerException(java.lang.String);
} }
public final class DngCreator {
ctor public DngCreator(android.hardware.camera2.CameraCharacteristics, android.hardware.camera2.CaptureResult);
method public android.media.DngCreator setDescription(java.lang.String);
method public android.media.DngCreator setLocation(android.location.Location);
method public android.media.DngCreator setOrientation(int);
method public android.media.DngCreator setThumbnail(android.graphics.Bitmap);
method public android.media.DngCreator setThumbnail(android.media.Image);
method public void writeByteBuffer(java.io.OutputStream, java.nio.ByteBuffer, int, long) throws java.io.IOException;
method public void writeImage(java.io.OutputStream, android.media.Image) throws java.io.IOException;
method public void writeInputStream(java.io.OutputStream, java.io.InputStream, int, long) throws java.io.IOException;
}
public class ExifInterface { public class ExifInterface {
ctor public ExifInterface(java.lang.String) throws java.io.IOException; ctor public ExifInterface(java.lang.String) throws java.io.IOException;
method public double getAltitude(double); method public double getAltitude(double);

View File

@@ -0,0 +1,254 @@
/*
* Copyright 2014 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.media;
import android.graphics.Bitmap;
import android.hardware.camera2.CameraCharacteristics;
import android.hardware.camera2.CaptureResult;
import android.location.Location;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.ByteBuffer;
/**
* The {@link DngCreator} class provides functions to write raw pixel data as a DNG file.
*
* <p>
* This class is designed to be used with the {@link android.graphics.ImageFormat#RAW_SENSOR}
* buffers available from {@link android.hardware.camera2.CameraDevice}, or with Bayer-type raw
* pixel data that is otherwise generated by an application. The DNG metadata tags will be
* generated from a {@link android.hardware.camera2.CaptureResult} object or set directly.
* </p>
*
* <p>
* 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.
* </p>
*
* <p>
* For more information on the DNG file format and associated metadata, please refer to the
* <a href=
* "https://wwwimages2.adobe.com/content/dam/Adobe/en/products/photoshop/pdfs/dng_spec_1.4.0.0.pdf">
* Adobe DNG 1.4.0.0 specification</a>.
* </p>
*/
public final class DngCreator {
/**
* Create a new DNG object.
*
* <p>
* It is not necessary to call any set methods to write a well-formatted DNG file.
* </p>
* <p>
* DNG metadata tags will be generated from the corresponding parameters in the
* {@link android.hardware.camera2.CaptureResult} object. This removes or overrides
* all previous tags set.
* </p>
*
* @param characteristics an object containing the static
* {@link android.hardware.camera2.CameraCharacteristics}.
* @param metadata a metadata object to generate tags from.
*/
public DngCreator(CameraCharacteristics characteristics, CaptureResult metadata) {/*TODO*/}
/**
* Set the orientation value to write.
*
* <p>
* This will be written as the TIFF "Orientation" tag {@code (0x0112)}.
* Calling this will override any prior settings for this tag.
* </p>
*
* @param orientation the orientation value to set, one of:
* <ul>
* <li>{@link android.media.ExifInterface#ORIENTATION_NORMAL}</li>
* <li>{@link android.media.ExifInterface#ORIENTATION_FLIP_HORIZONTAL}</li>
* <li>{@link android.media.ExifInterface#ORIENTATION_ROTATE_180}</li>
* <li>{@link android.media.ExifInterface#ORIENTATION_FLIP_VERTICAL}</li>
* <li>{@link android.media.ExifInterface#ORIENTATION_TRANSPOSE}</li>
* <li>{@link android.media.ExifInterface#ORIENTATION_ROTATE_90}</li>
* <li>{@link android.media.ExifInterface#ORIENTATION_TRANSVERSE}</li>
* <li>{@link android.media.ExifInterface#ORIENTATION_ROTATE_270}</li>
* </ul>
* @return this {@link #DngCreator} object.
*/
public DngCreator setOrientation(int orientation) {
return this;
}
/**
* Set the thumbnail image.
*
* <p>
* Pixel data will be converted to a Baseline TIFF RGB image, with 8 bits per color channel.
* The alpha channel will be discarded.
* </p>
*
* <p>
* The given bitmap should not be altered while this object is in use.
* </p>
*
* @param pixels a {@link android.graphics.Bitmap} of pixel data.
* @return this {@link #DngCreator} object.
*/
public DngCreator setThumbnail(Bitmap pixels) {
return this;
}
/**
* Set the thumbnail image.
*
* <p>
* Pixel data is interpreted as a {@link android.graphics.ImageFormat#YUV_420_888} image.
* </p>
*
* <p>
* The given image should not be altered while this object is in use.
* </p>
*
* @param pixels an {@link android.media.Image} object with the format
* {@link android.graphics.ImageFormat#YUV_420_888}.
* @return this {@link #DngCreator} object.
*/
public DngCreator setThumbnail(Image pixels) {
return this;
}
/**
* Set image location metadata.
*
* <p>
* The given location object must contain at least a valid time, latitude, and longitude
* (equivalent to the values returned by {@link android.location.Location#getTime()},
* {@link android.location.Location#getLatitude()}, and
* {@link android.location.Location#getLongitude()} methods).
* </p>
*
* @param location an {@link android.location.Location} object to set.
* @return this {@link #DngCreator} object.
*
* @throws java.lang.IllegalArgumentException if the given location object doesn't
* contain enough information to set location metadata.
*/
public DngCreator setLocation(Location location) { return this; }
/**
* Set the user description string to write.
*
* <p>
* This is equivalent to setting the TIFF "ImageDescription" tag {@code (0x010E)}.
* </p>
*
* @param description the user description string.
* @return this {@link #DngCreator} object.
*/
public DngCreator setDescription(String description) {
return this;
}
/**
* Write the {@link android.graphics.ImageFormat#RAW_SENSOR} pixel data to a DNG file with
* the currently configured metadata.
*
* <p>
* Raw pixel data must have 16 bits per pixel, and the input must contain at least
* {@code offset + 2 * (stride * (height - 1) + width * height)} bytes. The width and height of
* the input are taken from the width and height set in the {@link DngCreator} metadata tags,
* and will typically be equal to the width and height of
* {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE}.
* If insufficient metadata is set to write a well-formatted DNG file, and
* {@link java.lang.IllegalStateException} will be thrown.
* </p>
*
* <p>
* When reading from the pixel input, {@code stride} pixels will be skipped
* after each row (excluding the last).
* </p>
*
* @param dngOutput an {@link java.io.OutputStream} to write the DNG file to.
* @param pixels an {@link java.io.InputStream} of pixel data to write.
* @param stride the stride of the raw image in pixels.
* @param offset the offset of the raw image in bytes. This indicates how many bytes will
* be skipped in the input before any pixel data is read.
*
* @throws IOException if an error was encountered in the input or output stream.
* @throws java.lang.IllegalStateException if not enough metadata information has been
* set to write a well-formatted DNG file.
*/
public void writeInputStream(OutputStream dngOutput, InputStream pixels, int stride,
long offset) throws IOException {
/*TODO*/
}
/**
* Write the {@link android.graphics.ImageFormat#RAW_SENSOR} pixel data to a DNG file with
* the currently configured metadata.
*
* <p>
* Raw pixel data must have 16 bits per pixel, and the input must contain at least
* {@code offset + 2 * (stride * (height - 1) + width * height)} bytes. The width and height of
* the input are taken from the width and height set in the {@link DngCreator} metadata tags,
* and will typically be equal to the width and height of
* {@link android.hardware.camera2.CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE}.
* If insufficient metadata is set to write a well-formatted DNG file, and
* {@link java.lang.IllegalStateException} will be thrown.
* </p>
*
* <p>
* When reading from the pixel input, {@code stride} pixels will be skipped
* after each row (excluding the last).
* </p>
*
* @param dngOutput an {@link java.io.OutputStream} to write the DNG file to.
* @param pixels an {@link java.nio.ByteBuffer} of pixel data to write.
* @param stride the stride of the raw image in pixels.
* @param offset the offset of the raw image in bytes. This indicates how many bytes will
* be skipped in the input before any pixel data is read.
*
* @throws IOException if an error was encountered in the input or output stream.
* @throws java.lang.IllegalStateException if not enough metadata information has been
* set to write a well-formatted DNG file.
*/
public void writeByteBuffer(OutputStream dngOutput, ByteBuffer pixels, int stride,
long offset) throws IOException {/*TODO*/}
/**
* Write the pixel data to a DNG file with the currently configured metadata.
*
* <p>
* For this method to succeed, the {@link android.media.Image} input must contain
* {@link android.graphics.ImageFormat#RAW_SENSOR} pixel data, otherwise an
* {@link java.lang.IllegalArgumentException} will be thrown.
* </p>
*
* @param dngOutput an {@link java.io.OutputStream} to write the DNG file to.
* @param pixels an {@link android.media.Image} to write.
*
* @throws java.io.IOException if an error was encountered in the output stream.
* @throws java.lang.IllegalArgumentException if an image with an unsupported format was used.
* @throws java.lang.IllegalStateException if not enough metadata information has been
* set to write a well-formatted DNG file.
*/
public void writeImage(OutputStream dngOutput, Image pixels) throws IOException {/*TODO*/}
}