19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/*
29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project
39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project *
49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License");
59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License.
69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at
79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project *
89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project *      http://www.apache.org/licenses/LICENSE-2.0
99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project *
109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software
119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS,
129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and
149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License.
159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */
169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.graphics;
189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.res.AssetManager;
209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.res.Resources;
21787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guyimport android.os.Trace;
229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.DisplayMetrics;
23b8151ecd6ef4faa5c16d0a4c3abb45ec84d1f97aAmith Yamasaniimport android.util.Log;
24eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chenimport android.util.TypedValue;
259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
26eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chenimport java.io.FileDescriptor;
279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.FileInputStream;
289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.IOException;
29eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chenimport java.io.InputStream;
309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/**
32eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen * Creates Bitmap objects from various sources, including files, streams,
33eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen * and byte-arrays.
349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */
359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class BitmapFactory {
367b2f8b8fb7064a1d3b6d942b978c30c24c9d7299Romain Guy    private static final int DECODE_BUFFER_SIZE = 16 * 1024;
377b2f8b8fb7064a1d3b6d942b978c30c24c9d7299Romain Guy
389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static class Options {
399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * Create a default Options object, which if left unchanged will give
419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * the same result from the decoder as if null were passed.
429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public Options() {
44207b3ab604bcbe47fa55f26f358cde60cf8a784dRomain Guy            inDither = false;
459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            inScaled = true;
461abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik            inPremultiplied = true;
479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
5037f74cad46c6f1799aec3c52e8f47598237f43d4Chet Haase         * If set, decode methods that take the Options object will attempt to
51c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * reuse this bitmap when loading content. If the decode operation
52c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * cannot use this bitmap, the decode method will return
53c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * <code>null</code> and will throw an IllegalArgumentException. The
54c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * current implementation necessitates that the reused bitmap be
55c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * mutable, and the resulting reused bitmap will continue to remain
56c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * mutable even when decoding a resource which would normally result in
57c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * an immutable bitmap.</p>
589f58361e98be7386a4eadd3aa254e9b7d09d0a3bChris Craik         *
59352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * <p>You should still always use the returned Bitmap of the decode
60352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * method and not assume that reusing the bitmap worked, due to the
61352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * constraints outlined above and failure situations that can occur.
62352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * Checking whether the return value matches the value of the inBitmap
63352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * set in the Options structure will indicate if the bitmap was reused,
64352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * but in all cases you should use the Bitmap returned by the decoding
65352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * function to ensure that you are using the bitmap that was used as the
66352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * decode destination.</p>
67352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         *
68352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * <h3>Usage with BitmapFactory</h3>
69352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         *
70e8222dddaf2e3da14380101e818d4254899e0c0dChet Haase         * <p>As of {@link android.os.Build.VERSION_CODES#KITKAT}, any
71352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * mutable bitmap can be reused by {@link BitmapFactory} to decode any
72352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * other bitmaps as long as the resulting {@link Bitmap#getByteCount()
73352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * byte count} of the decoded bitmap is less than or equal to the {@link
74c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * Bitmap#getAllocationByteCount() allocated byte count} of the reused
75c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * bitmap. This can be because the intrinsic size is smaller, or its
76c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * size post scaling (for density / sample size) is smaller.</p>
77905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik         *
78352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * <p class="note">Prior to {@link android.os.Build.VERSION_CODES#KITKAT}
79c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * additional constraints apply: The image being decoded (whether as a
80c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * resource or as a stream) must be in jpeg or png format. Only equal
81c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * sized bitmaps are supported, with {@link #inSampleSize} set to 1.
82c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * Additionally, the {@link android.graphics.Bitmap.Config
83c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * configuration} of the reused bitmap will override the setting of
84c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         * {@link #inPreferredConfig}, if set.</p>
8537f74cad46c6f1799aec3c52e8f47598237f43d4Chet Haase         *
86352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * <h3>Usage with BitmapRegionDecoder</h3>
87352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         *
88352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * <p>BitmapRegionDecoder will draw its requested content into the Bitmap
89352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * provided, clipping if the output content size (post scaling) is larger
90352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * than the provided Bitmap. The provided Bitmap's width, height, and
91352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * {@link Bitmap.Config} will not be changed.
92352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         *
93352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * <p class="note">BitmapRegionDecoder support for {@link #inBitmap} was
94352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * introduced in {@link android.os.Build.VERSION_CODES#JELLY_BEAN}. All
95352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * formats supported by BitmapRegionDecoder support Bitmap reuse via
96352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * {@link #inBitmap}.</p>
97c84d203da21c3ae3ded94c79c035d41b27809b3bChris Craik         *
9825ba1c86945a441428194d9ebcabbf31be75a45aRomain Guy         * @see Bitmap#reconfigure(int,int, android.graphics.Bitmap.Config)
9937f74cad46c6f1799aec3c52e8f47598237f43d4Chet Haase         */
10037f74cad46c6f1799aec3c52e8f47598237f43d4Chet Haase        public Bitmap inBitmap;
10137f74cad46c6f1799aec3c52e8f47598237f43d4Chet Haase
10237f74cad46c6f1799aec3c52e8f47598237f43d4Chet Haase        /**
1032361098da3b9d9c3eeed410dc72ba62c0e9177cfRomain Guy         * If set, decode methods will always return a mutable Bitmap instead of
1042361098da3b9d9c3eeed410dc72ba62c0e9177cfRomain Guy         * an immutable one. This can be used for instance to programmatically apply
1052361098da3b9d9c3eeed410dc72ba62c0e9177cfRomain Guy         * effects to a Bitmap loaded through BitmapFactory.
1062361098da3b9d9c3eeed410dc72ba62c0e9177cfRomain Guy         */
1072361098da3b9d9c3eeed410dc72ba62c0e9177cfRomain Guy        @SuppressWarnings({"UnusedDeclaration"}) // used in native code
1082361098da3b9d9c3eeed410dc72ba62c0e9177cfRomain Guy        public boolean inMutable;
1092361098da3b9d9c3eeed410dc72ba62c0e9177cfRomain Guy
1102361098da3b9d9c3eeed410dc72ba62c0e9177cfRomain Guy        /**
1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * If set to true, the decoder will return null (no bitmap), but
1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * the out... fields will still be set, allowing the caller to query
1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * the bitmap without having to allocate the memory for its pixels.
1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public boolean inJustDecodeBounds;
1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * If set to a value > 1, requests the decoder to subsample the original
1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * image, returning a smaller image to save memory. The sample size is
1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * the number of pixels in either dimension that correspond to a single
1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * pixel in the decoded bitmap. For example, inSampleSize == 4 returns
1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * an image that is 1/4 the width/height of the original, and 1/16 the
1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * number of pixels. Any value <= 1 is treated the same as 1. Note: the
124758333d70a749fb50276057abc585cbc0decc8d4Adam Koch         * decoder uses a final value based on powers of 2, any other value will
125758333d70a749fb50276057abc585cbc0decc8d4Adam Koch         * be rounded down to the nearest power of 2.
1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public int inSampleSize;
128eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * If this is non-null, the decoder will try to decode into this
1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * internal configuration. If it is null, or the request cannot be met,
1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * the decoder will try to pick the best matching config based on the
1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * system's screen depth, and characteristics of the original image such
1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * as if it has per-pixel alpha (requiring a config that also does).
135207b3ab604bcbe47fa55f26f358cde60cf8a784dRomain Guy         *
136207b3ab604bcbe47fa55f26f358cde60cf8a784dRomain Guy         * Image are loaded with the {@link Bitmap.Config#ARGB_8888} config by
137207b3ab604bcbe47fa55f26f358cde60cf8a784dRomain Guy         * default.
1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
139207b3ab604bcbe47fa55f26f358cde60cf8a784dRomain Guy        public Bitmap.Config inPreferredConfig = Bitmap.Config.ARGB_8888;
140eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
1421abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * If true (which is the default), the resulting bitmap will have its
1431abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * color channels pre-multipled by the alpha channel.
1441abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         *
1451abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * <p>This should NOT be set to false for images to be directly drawn by
1461abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * the view system or through a {@link Canvas}. The view system and
1471abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * {@link Canvas} assume all drawn images are pre-multiplied to simplify
1481abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * draw-time blending, and will throw a RuntimeException when
1491abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * un-premultiplied are drawn.</p>
1501abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         *
1511abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * <p>This is likely only useful if you want to manipulate raw encoded
1521abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * image data, e.g. with RenderScript or custom OpenGL.</p>
1531abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         *
1541abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * <p>This does not affect bitmaps without an alpha channel.</p>
1551abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         *
1568790be6de3644e332ec6a17c855da89ffc13a9bfLeon Scroggins III         * <p>Setting this flag to false while setting {@link #inScaled} to true
1578790be6de3644e332ec6a17c855da89ffc13a9bfLeon Scroggins III         * may result in incorrect colors.</p>
1588790be6de3644e332ec6a17c855da89ffc13a9bfLeon Scroggins III         *
1591abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * @see Bitmap#hasAlpha()
1601abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         * @see Bitmap#isPremultiplied()
1618790be6de3644e332ec6a17c855da89ffc13a9bfLeon Scroggins III         * @see #inScaled
1621abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik         */
1631abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik        public boolean inPremultiplied;
1641abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik
1651abf5d62429e5a9329520b2f7c2b5a5e7a8e72ecChris Craik        /**
1667341d7a104b47996445d069a695e155a07184606Dianne Hackborn         * If dither is true, the decoder will attempt to dither the decoded
1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * image.
1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public boolean inDither;
1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
17211ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * The pixel density to use for the bitmap.  This will always result
17311ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * in the returned bitmap having a density set for it (see
1746e1df0e981c8c588e411b8ad6e55554fe4815655Gilles Debunne         * {@link Bitmap#setDensity(int) Bitmap.setDensity(int)}).  In addition,
17511ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * if {@link #inScaled} is set (which it is by default} and this
17611ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * density does not match {@link #inTargetDensity}, then the bitmap
17711ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * will be scaled to the target density before being returned.
17811ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         *
17911ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * <p>If this is 0,
18011ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * {@link BitmapFactory#decodeResource(Resources, int)},
18111ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * {@link BitmapFactory#decodeResource(Resources, int, android.graphics.BitmapFactory.Options)},
18211ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * and {@link BitmapFactory#decodeResourceStream}
18311ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * will fill in the density associated with the resource.  The other
18411ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * functions will leave it as-is and no density will be applied.
1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         *
18611ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see #inTargetDensity
18711ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see #inScreenDensity
18811ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see #inScaled
18911ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see Bitmap#setDensity(int)
19011ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see android.util.DisplayMetrics#densityDpi
1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public int inDensity;
1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
19511ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * The pixel density of the destination this bitmap will be drawn to.
19611ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * This is used in conjunction with {@link #inDensity} and
19711ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * {@link #inScaled} to determine if and how to scale the bitmap before
19811ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * returning it.
19911ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         *
20011ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * <p>If this is 0,
20111ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * {@link BitmapFactory#decodeResource(Resources, int)},
20211ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * {@link BitmapFactory#decodeResource(Resources, int, android.graphics.BitmapFactory.Options)},
20311ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * and {@link BitmapFactory#decodeResourceStream}
20411ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * will fill in the density associated the Resources object's
20511ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * DisplayMetrics.  The other
20611ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * functions will leave it as-is and no scaling for density will be
20711ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * performed.
20811ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         *
20911ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see #inDensity
21011ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see #inScreenDensity
21111ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see #inScaled
21211ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see android.util.DisplayMetrics#densityDpi
21311ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         */
21411ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn        public int inTargetDensity;
21511ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn
21611ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn        /**
21711ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * The pixel density of the actual screen that is being used.  This is
21811ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * purely for applications running in density compatibility code, where
21911ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * {@link #inTargetDensity} is actually the density the application
22011ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * sees rather than the real screen density.
22111ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         *
22211ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * <p>By setting this, you
22311ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * allow the loading code to avoid scaling a bitmap that is currently
22411ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * in the screen density up/down to the compatibility density.  Instead,
22511ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * if {@link #inDensity} is the same as {@link #inScreenDensity}, the
22611ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * bitmap will be left as-is.  Anything using the resulting bitmap
22711ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * must also used {@link Bitmap#getScaledWidth(int)
22811ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * Bitmap.getScaledWidth} and {@link Bitmap#getScaledHeight
22911ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * Bitmap.getScaledHeight} to account for any different between the
23011ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * bitmap's density and the target's density.
23111ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         *
23211ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * <p>This is never set automatically for the caller by
23311ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * {@link BitmapFactory} itself.  It must be explicitly set, since the
23411ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * caller must deal with the resulting bitmap in a density-aware way.
23511ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         *
23611ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see #inDensity
23711ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see #inTargetDensity
23811ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see #inScaled
23911ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * @see android.util.DisplayMetrics#densityDpi
24011ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         */
24111ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn        public int inScreenDensity;
24211ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn
24311ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn        /**
24411ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * When this flag is set, if {@link #inDensity} and
24511ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * {@link #inTargetDensity} are not 0, the
24611ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * bitmap will be scaled to match {@link #inTargetDensity} when loaded,
24711ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * rather than relying on the graphics system scaling it each time it
24811ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * is drawn to a Canvas.
2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         *
250352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * <p>BitmapRegionDecoder ignores this flag, and will not scale output
251352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         * based on density. (though {@link #inSampleSize} is supported)</p>
252352919efd02808f0d6222f7a2cc657f3455c2049Chris Craik         *
25311ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * <p>This flag is turned on by default and should be turned off if you need
25411ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * a non-scaled version of the bitmap.  Nine-patch bitmaps ignore this
25511ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn         * flag and are always scaled.
2568790be6de3644e332ec6a17c855da89ffc13a9bfLeon Scroggins III         *
2578790be6de3644e332ec6a17c855da89ffc13a9bfLeon Scroggins III         * <p>If {@link #inPremultiplied} is set to false, and the image has alpha,
2588790be6de3644e332ec6a17c855da89ffc13a9bfLeon Scroggins III         * setting this flag to true may result in incorrect colors.
2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public boolean inScaled;
2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
263955d8d69ea6caabce1461dc25b339b9bf9dc61a6Dianne Hackborn         * @deprecated As of {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this is
2640aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         * ignored.
2650aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         *
2660aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         * In {@link android.os.Build.VERSION_CODES#KITKAT} and below, if this
2670aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         * is set to true, then the resulting bitmap will allocate its
268c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         * pixels such that they can be purged if the system needs to reclaim
269c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         * memory. In that instance, when the pixels need to be accessed again
270c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         * (e.g. the bitmap is drawn, getPixels() is called), they will be
271c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         * automatically re-decoded.
272c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         *
273e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * <p>For the re-decode to happen, the bitmap must have access to the
274c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         * encoded data, either by sharing a reference to the input
275c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         * or by making a copy of it. This distinction is controlled by
276c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         * inInputShareable. If this is true, then the bitmap may keep a shallow
277c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         * reference to the input. If this is false, then the bitmap will
278c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         * explicitly make a copy of the input data, and keep that. Even if
279c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         * sharing is allowed, the implementation may still decide to make a
280e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * deep copy of the input data.</p>
281e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         *
282e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * <p>While inPurgeable can help avoid big Dalvik heap allocations (from
283e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * API level 11 onward), it sacrifices performance predictability since any
284e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * image that the view system tries to draw may incur a decode delay which
285e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * can lead to dropped frames. Therefore, most apps should avoid using
286e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * inPurgeable to allow for a fast and fluid UI. To minimize Dalvik heap
287e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * allocations use the {@link #inBitmap} flag instead.</p>
288e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         *
289e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * <p class="note"><strong>Note:</strong> This flag is ignored when used
290e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * with {@link #decodeResource(Resources, int,
291e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * android.graphics.BitmapFactory.Options)} or {@link #decodeFile(String,
292e1693df494dbdedfb5eac56bf59f86afc893b778Adam Koch         * android.graphics.BitmapFactory.Options)}.</p>
293c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         */
2940aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III        @Deprecated
295c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed        public boolean inPurgeable;
296c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed
297c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed        /**
298955d8d69ea6caabce1461dc25b339b9bf9dc61a6Dianne Hackborn         * @deprecated As of {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this is
2990aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         * ignored.
3000aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         *
3010aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         * In {@link android.os.Build.VERSION_CODES#KITKAT} and below, this
3020aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         * field works in conjuction with inPurgeable. If inPurgeable is false,
3030aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         * then this field is ignored. If inPurgeable is true, then this field
3040aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         * determines whether the bitmap can share a reference to the input
3050aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III         * data (inputstream, array, etc.) or if it must make a deep copy.
306c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed         */
3070aa39dc2dcfca20f4d9cbeb1699d48a4808f2c70Leon Scroggins III        @Deprecated
308c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed        public boolean inInputShareable;
309c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed
310c70e06bbfac0d92ec218a32e35d9d7fa80f23cc9Mike Reed        /**
311953f9094a2ec14594fa8501d5f3e2d9e300b1b62Wei-Ta Chen         * If inPreferQualityOverSpeed is set to true, the decoder will try to
312953f9094a2ec14594fa8501d5f3e2d9e300b1b62Wei-Ta Chen         * decode the reconstructed image to a higher quality even at the
313953f9094a2ec14594fa8501d5f3e2d9e300b1b62Wei-Ta Chen         * expense of the decoding speed. Currently the field only affects JPEG
314953f9094a2ec14594fa8501d5f3e2d9e300b1b62Wei-Ta Chen         * decode, in the case of which a more accurate, but slightly slower,
315953f9094a2ec14594fa8501d5f3e2d9e300b1b62Wei-Ta Chen         * IDCT method will be used instead.
316953f9094a2ec14594fa8501d5f3e2d9e300b1b62Wei-Ta Chen         */
317953f9094a2ec14594fa8501d5f3e2d9e300b1b62Wei-Ta Chen        public boolean inPreferQualityOverSpeed;
318953f9094a2ec14594fa8501d5f3e2d9e300b1b62Wei-Ta Chen
319953f9094a2ec14594fa8501d5f3e2d9e300b1b62Wei-Ta Chen        /**
320544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         * The resulting width of the bitmap. If {@link #inJustDecodeBounds} is
321544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         * set to false, this will be width of the output bitmap after any
322544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         * scaling is applied. If true, it will be the width of the input image
323544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         * without any accounting for scaling.
324544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         *
325544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         * <p>outWidth will be set to -1 if there is an error trying to decode.</p>
3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public int outWidth;
3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
330544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         * The resulting height of the bitmap. If {@link #inJustDecodeBounds} is
331544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         * set to false, this will be height of the output bitmap after any
332544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         * scaling is applied. If true, it will be the height of the input image
333544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         * without any accounting for scaling.
334544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         *
335544333b39ec612e0e3426d3ef90b21761ea0d751Chris Craik         * <p>outHeight will be set to -1 if there is an error trying to decode.</p>
3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public int outHeight;
3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
3409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * If known, this string is set to the mimetype of the decoded image.
3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * If not know, or there is an error, it is set to null.
3429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public String outMimeType;
344eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
3459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
3469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * Temp storage to use for decoding.  Suggest 16K or so.
3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public byte[] inTempStorage;
349eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        private native void requestCancel();
3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * Flag to indicate that cancel has been called on this object.  This
3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * is useful if there's an intermediary that wants to first decode the
3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * bounds and then decode the image.  In that case the intermediary
3569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * can check, inbetween the bounds decode and the image decode, to see
3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * if the operation is canceled.
3589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public boolean mCancel;
360eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
3619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
3629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         *  This can be called from another thread while this options object is
3639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         *  inside a decode... call. Calling this will notify the decoder that
3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         *  it should cancel its operation. This is not guaranteed to cancel
3659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         *  the decode, but if it does, the decoder... operation will return
3669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         *  null, or if inJustDecodeBounds is true, will set outWidth/outHeight
3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         *  to -1
3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
3699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public void requestCancelDecode() {
3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mCancel = true;
3719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            requestCancel();
3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Decode a file path into a bitmap. If the specified file name is null,
3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or cannot be decoded into a bitmap, the function returns null.
3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param pathName complete path name for the file to be decoded.
3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param opts null-ok; Options that control downsampling and whether the
3819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *             image should be completely decoded, or just is size returned.
3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return The decoded bitmap, or null if the image data could not be
3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         decoded, or, if opts is non-null, if opts requested only the
3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         size be returned (in opts.outWidth and opts.outHeight)
3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static Bitmap decodeFile(String pathName, Options opts) {
3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        Bitmap bm = null;
3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        InputStream stream = null;
3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            stream = new FileInputStream(pathName);
3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            bm = decodeStream(stream, null, opts);
3929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (Exception e) {
3939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            /*  do nothing.
3949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                If the exception happened on open, bm will be null.
3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            */
396b8151ecd6ef4faa5c16d0a4c3abb45ec84d1f97aAmith Yamasani            Log.e("BitmapFactory", "Unable to decode stream: " + e);
3979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
3989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (stream != null) {
3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                try {
4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    stream.close();
4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                } catch (IOException e) {
4029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    // do nothing here
4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return bm;
4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
4109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Decode a file path into a bitmap. If the specified file name is null,
4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or cannot be decoded into a bitmap, the function returns null.
4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param pathName complete path name for the file to be decoded.
4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the resulting decoded bitmap, or null if it could not be decoded.
4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
4169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static Bitmap decodeFile(String pathName) {
4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return decodeFile(pathName, null);
4189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
4219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Decode a new Bitmap from an InputStream. This InputStream was obtained from
4229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * resources, which we pass to be able to scale the bitmap accordingly.
4239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
42411ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn    public static Bitmap decodeResourceStream(Resources res, TypedValue value,
42511ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn            InputStream is, Rect pad, Options opts) {
4269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (opts == null) {
4289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            opts = new Options();
4299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
4309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
43111ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn        if (opts.inDensity == 0 && value != null) {
432a53b828635fce8b6b2d3e3377d74d72070056623Dianne Hackborn            final int density = value.density;
43311ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn            if (density == TypedValue.DENSITY_DEFAULT) {
43411ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn                opts.inDensity = DisplayMetrics.DENSITY_DEFAULT;
43511ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn            } else if (density != TypedValue.DENSITY_NONE) {
43611ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn                opts.inDensity = density;
4379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
4389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
43911ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn
44011ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn        if (opts.inTargetDensity == 0 && res != null) {
44111ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn            opts.inTargetDensity = res.getDisplayMetrics().densityDpi;
44211ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn        }
44311ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn
44411ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn        return decodeStream(is, pad, opts);
4459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
44811ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn     * Synonym for opening the given resource and calling
44911ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn     * {@link #decodeResourceStream}.
4509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param res   The resources object containing the image data
4529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param id The resource id of the image data
4539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param opts null-ok; Options that control downsampling and whether the
4549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *             image should be completely decoded, or just is size returned.
4559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return The decoded bitmap, or null if the image data could not be
4569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         decoded, or, if opts is non-null, if opts requested only the
4579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         size be returned (in opts.outWidth and opts.outHeight)
4589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
4599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static Bitmap decodeResource(Resources res, int id, Options opts) {
4609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        Bitmap bm = null;
461650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy        InputStream is = null;
462650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy
4639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
4649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            final TypedValue value = new TypedValue();
465650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy            is = res.openRawResource(id, value);
4669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
46711ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn            bm = decodeResourceStream(res, value, is, null, opts);
468650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy        } catch (Exception e) {
4699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            /*  do nothing.
4709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                If the exception happened on open, bm will be null.
4719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                If it happened on close, bm is still valid.
4729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            */
473650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy        } finally {
474650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy            try {
475650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy                if (is != null) is.close();
476650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy            } catch (IOException e) {
477650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy                // Ignore
478650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy            }
4799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
480650a3eb7d621dc8e81573142a4498bbd07bcde27Romain Guy
481decc8cd41eca3770c8f5ee13d81b9cd5f0c25ccdChet Haase        if (bm == null && opts != null && opts.inBitmap != null) {
482decc8cd41eca3770c8f5ee13d81b9cd5f0c25ccdChet Haase            throw new IllegalArgumentException("Problem decoding into existing bitmap");
483decc8cd41eca3770c8f5ee13d81b9cd5f0c25ccdChet Haase        }
484decc8cd41eca3770c8f5ee13d81b9cd5f0c25ccdChet Haase
4859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return bm;
4869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
487eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
4889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
48911ea33471e1a14a8594f0b2cd012d86340dd3bd8Dianne Hackborn     * Synonym for {@link #decodeResource(Resources, int, android.graphics.BitmapFactory.Options)}
4905b15b1717ef95ef8c91f8587fee1f789aec6ae49Shuhrat Dehkanov     * with null Options.
4919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param res The resources object containing the image data
4939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param id The resource id of the image data
494c502744f2ddcc80a34f5197b5d2c0d701c7d6e71Newton Allen     * @return The decoded bitmap, or null if the image could not be decoded.
4959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
4969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static Bitmap decodeResource(Resources res, int id) {
4979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return decodeResource(res, id, null);
4989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
5009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
5019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Decode an immutable bitmap from the specified byte array.
5029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
5039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param data byte array of compressed image data
5049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param offset offset into imageData for where the decoder should begin
5059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *               parsing.
5069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param length the number of bytes, beginning at offset, to parse
5079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param opts null-ok; Options that control downsampling and whether the
5089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *             image should be completely decoded, or just is size returned.
5099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return The decoded bitmap, or null if the image data could not be
5109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         decoded, or, if opts is non-null, if opts requested only the
5119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         size be returned (in opts.outWidth and opts.outHeight)
5129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
5139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static Bitmap decodeByteArray(byte[] data, int offset, int length, Options opts) {
5149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if ((offset | length) < 0 || data.length < offset + length) {
5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw new ArrayIndexOutOfBoundsException();
5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
517ec4a50428d5f26a22df3edaf7e5b08f41d5cb54bAmith Yamasani
518787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy        Bitmap bm;
519787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy
520787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy        Trace.traceBegin(Trace.TRACE_TAG_GRAPHICS, "decodeBitmap");
521787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy        try {
522787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            bm = nativeDecodeByteArray(data, offset, length, opts);
523787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy
524787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            if (bm == null && opts != null && opts.inBitmap != null) {
525787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy                throw new IllegalArgumentException("Problem decoding into existing bitmap");
526787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            }
527787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            setDensityFromOptions(bm, opts);
528787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy        } finally {
529787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            Trace.traceEnd(Trace.TRACE_TAG_GRAPHICS);
530decc8cd41eca3770c8f5ee13d81b9cd5f0c25ccdChet Haase        }
531787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy
532decc8cd41eca3770c8f5ee13d81b9cd5f0c25ccdChet Haase        return bm;
5339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
534eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
5359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
5369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Decode an immutable bitmap from the specified byte array.
5379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
5389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param data byte array of compressed image data
5399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param offset offset into imageData for where the decoder should begin
5409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *               parsing.
5419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param length the number of bytes, beginning at offset, to parse
542c502744f2ddcc80a34f5197b5d2c0d701c7d6e71Newton Allen     * @return The decoded bitmap, or null if the image could not be decoded.
5439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
5449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static Bitmap decodeByteArray(byte[] data, int offset, int length) {
5459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return decodeByteArray(data, offset, length, null);
5469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
547eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
5489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
549905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik     * Set the newly decoded bitmap's density based on the Options.
550905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik     */
551905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik    private static void setDensityFromOptions(Bitmap outputBitmap, Options opts) {
552905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik        if (outputBitmap == null || opts == null) return;
553905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik
554905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik        final int density = opts.inDensity;
555905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik        if (density != 0) {
556905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik            outputBitmap.setDensity(density);
557905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik            final int targetDensity = opts.inTargetDensity;
558905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik            if (targetDensity == 0 || density == targetDensity || density == opts.inScreenDensity) {
559905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik                return;
560905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik            }
561905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik
562905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik            byte[] np = outputBitmap.getNinePatchChunk();
563905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik            final boolean isNinePatch = np != null && NinePatch.isNinePatchChunk(np);
564905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik            if (opts.inScaled || isNinePatch) {
565905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik                outputBitmap.setDensity(targetDensity);
566905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik            }
567905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik        } else if (opts.inBitmap != null) {
568905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik            // bitmap was reused, ensure density is reset
569905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik            outputBitmap.setDensity(Bitmap.getDefaultDensity());
570905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik        }
571905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik    }
572905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik
573905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik    /**
5749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Decode an input stream into a bitmap. If the input stream is null, or
5759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * cannot be used to decode a bitmap, the function returns null.
5769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * The stream's position will be where ever it was after the encoded data
5779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * was read.
578eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen     *
5799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param is The input stream that holds the raw data to be decoded into a
5809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *           bitmap.
5819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param outPadding If not null, return the padding rect for the bitmap if
5829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *                   it exists, otherwise set padding to [-1,-1,-1,-1]. If
5839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *                   no bitmap is returned (null) then padding is
5849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *                   unchanged.
5859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param opts null-ok; Options that control downsampling and whether the
5869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *             image should be completely decoded, or just is size returned.
5879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return The decoded bitmap, or null if the image data could not be
5889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         decoded, or, if opts is non-null, if opts requested only the
5899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         size be returned (in opts.outWidth and opts.outHeight)
590321bc46b3c885a806f2e7e29db8212f7ea6c8670Leon Scroggins III     *
591321bc46b3c885a806f2e7e29db8212f7ea6c8670Leon Scroggins III     * <p class="note">Prior to {@link android.os.Build.VERSION_CODES#KITKAT},
592321bc46b3c885a806f2e7e29db8212f7ea6c8670Leon Scroggins III     * if {@link InputStream#markSupported is.markSupported()} returns true,
593321bc46b3c885a806f2e7e29db8212f7ea6c8670Leon Scroggins III     * <code>is.mark(1024)</code> would be called. As of
594321bc46b3c885a806f2e7e29db8212f7ea6c8670Leon Scroggins III     * {@link android.os.Build.VERSION_CODES#KITKAT}, this is no longer the case.</p>
5959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
5969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static Bitmap decodeStream(InputStream is, Rect outPadding, Options opts) {
5979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        // we don't throw in this case, thus allowing the caller to only check
5989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        // the cache, and not force the image to be decoded.
5999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (is == null) {
6009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return null;
6019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
602eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
603ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III        Bitmap bm = null;
6049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
605787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy        Trace.traceBegin(Trace.TRACE_TAG_GRAPHICS, "decodeBitmap");
606787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy        try {
607787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            if (is instanceof AssetManager.AssetInputStream) {
60836bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat                final long asset = ((AssetManager.AssetInputStream) is).getNativeAsset();
609787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy                bm = nativeDecodeAsset(asset, outPadding, opts);
6105835157d762a5b6bffe3d892c588ebc475bccb44John Reck            } else {
6117315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III                bm = decodeStreamInternal(is, outPadding, opts);
612787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            }
6139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
614787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            if (bm == null && opts != null && opts.inBitmap != null) {
615787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy                throw new IllegalArgumentException("Problem decoding into existing bitmap");
616787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            }
6177b2f8b8fb7064a1d3b6d942b978c30c24c9d7299Romain Guy
618787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            setDensityFromOptions(bm, opts);
619787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy        } finally {
620787e35793f47abdb6cc10f328cd58d362c7bd250Romain Guy            Trace.traceEnd(Trace.TRACE_TAG_GRAPHICS);
621decc8cd41eca3770c8f5ee13d81b9cd5f0c25ccdChet Haase        }
6229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
6239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return bm;
6249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
625905e8246ef0bd20ee28d81ce3da0c5e5fc8e3913Chris Craik
6269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
6277315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III     * Private helper function for decoding an InputStream natively. Buffers the input enough to
6287315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III     * do a rewind as needed, and supplies temporary storage if necessary. is MUST NOT be null.
6297315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III     */
6307315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III    private static Bitmap decodeStreamInternal(InputStream is, Rect outPadding, Options opts) {
6317315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III        // ASSERT(is != null);
6327315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III        byte [] tempStorage = null;
6337315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III        if (opts != null) tempStorage = opts.inTempStorage;
6347315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III        if (tempStorage == null) tempStorage = new byte[DECODE_BUFFER_SIZE];
6357315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III        return nativeDecodeStream(is, tempStorage, outPadding, opts);
6367315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III    }
6377315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III
6387315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III    /**
6399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Decode an input stream into a bitmap. If the input stream is null, or
6409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * cannot be used to decode a bitmap, the function returns null.
6419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * The stream's position will be where ever it was after the encoded data
6429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * was read.
643eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen     *
6449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param is The input stream that holds the raw data to be decoded into a
6459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *           bitmap.
64603f0292744094ec107ffce71301c394503a31dedGilles Debunne     * @return The decoded bitmap, or null if the image data could not be decoded.
6479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
6489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static Bitmap decodeStream(InputStream is) {
6499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return decodeStream(is, null, null);
6509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
6519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
6529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
6539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Decode a bitmap from the file descriptor. If the bitmap cannot be decoded
6549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * return null. The position within the descriptor will not be changed when
6557341d7a104b47996445d069a695e155a07184606Dianne Hackborn     * this returns, so the descriptor can be used again as-is.
6569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
6579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param fd The file descriptor containing the bitmap data to decode
6589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param outPadding If not null, return the padding rect for the bitmap if
6599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *                   it exists, otherwise set padding to [-1,-1,-1,-1]. If
6609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *                   no bitmap is returned (null) then padding is
6619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *                   unchanged.
6629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param opts null-ok; Options that control downsampling and whether the
663ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III     *             image should be completely decoded, or just its size returned.
6649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the decoded bitmap, or null
6659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
6669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static Bitmap decodeFileDescriptor(FileDescriptor fd, Rect outPadding, Options opts) {
667ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III        Bitmap bm;
668ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III
669ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III        Trace.traceBegin(Trace.TRACE_TAG_GRAPHICS, "decodeFileDescriptor");
670ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III        try {
671ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III            if (nativeIsSeekable(fd)) {
672ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III                bm = nativeDecodeFileDescriptor(fd, outPadding, opts);
673ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III            } else {
674ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III                FileInputStream fis = new FileInputStream(fd);
675ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III                try {
6767315f1baee19476363235127bc1438e2a291fa15Leon Scroggins III                    bm = decodeStreamInternal(fis, outPadding, opts);
677ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III                } finally {
678ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III                    try {
679ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III                        fis.close();
680ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III                    } catch (Throwable t) {/* ignore */}
681ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III                }
682ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III            }
683ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III
684a9d0d47076ecf2d1739bb3534abc9deead8ebebdOwen Lin            if (bm == null && opts != null && opts.inBitmap != null) {
685a9d0d47076ecf2d1739bb3534abc9deead8ebebdOwen Lin                throw new IllegalArgumentException("Problem decoding into existing bitmap");
686a9d0d47076ecf2d1739bb3534abc9deead8ebebdOwen Lin            }
687ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III
688ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III            setDensityFromOptions(bm, opts);
689ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III        } finally {
690ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III            Trace.traceEnd(Trace.TRACE_TAG_GRAPHICS);
691decc8cd41eca3770c8f5ee13d81b9cd5f0c25ccdChet Haase        }
692ca32021b43f326af7d3f4ae041f8db297f98a518Leon Scroggins III        return bm;
6939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
694eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
6959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
6969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Decode a bitmap from the file descriptor. If the bitmap cannot be decoded
6979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * return null. The position within the descriptor will not be changed when
6989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * this returns, so the descriptor can be used again as is.
6999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
7009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param fd The file descriptor containing the bitmap data to decode
7019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the decoded bitmap, or null
7029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
7039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static Bitmap decodeFileDescriptor(FileDescriptor fd) {
704984b5df3830fe26a45bee39c7e8dd86714c99ed0Marco Nelissen        return decodeFileDescriptor(fd, null, null);
7059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
706eb949674fd3b83b706f795fc6b16ab1c66250c93Wei-Ta Chen
7079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private static native Bitmap nativeDecodeStream(InputStream is, byte[] storage,
7089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Rect padding, Options opts);
7099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private static native Bitmap nativeDecodeFileDescriptor(FileDescriptor fd,
7109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Rect padding, Options opts);
71136bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat    private static native Bitmap nativeDecodeAsset(long nativeAsset, Rect padding, Options opts);
7129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private static native Bitmap nativeDecodeByteArray(byte[] data, int offset,
7139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            int length, Options opts);
714a9d0d47076ecf2d1739bb3534abc9deead8ebebdOwen Lin    private static native boolean nativeIsSeekable(FileDescriptor fd);
7159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project}
716