/*
Copyright 2013-2015 David Morrissey
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 org.edx.mobile.third_party.subscaleview;
import android.content.ContentResolver;
import android.content.Context;
import android.database.Cursor;
import android.graphics.Bitmap;
import android.graphics.Canvas;
import android.graphics.Color;
import android.graphics.Matrix;
import android.graphics.Paint;
import android.graphics.Paint.Style;
import android.graphics.Point;
import android.graphics.PointF;
import android.graphics.Rect;
import android.graphics.RectF;
import android.media.ExifInterface;
import android.net.Uri;
import android.os.AsyncTask;
import android.os.Build.VERSION;
import android.os.Handler;
import android.os.Message;
import android.provider.MediaStore;
import android.support.annotation.NonNull;
import android.util.AttributeSet;
import android.util.DisplayMetrics;
import android.util.Log;
import android.util.TypedValue;
import android.view.GestureDetector;
import android.view.MotionEvent;
import android.view.View;
import org.edx.mobile.third_party.subscaleview.decoder.CompatDecoderFactory;
import org.edx.mobile.third_party.subscaleview.decoder.DecoderFactory;
import org.edx.mobile.third_party.subscaleview.decoder.ImageDecoder;
import org.edx.mobile.third_party.subscaleview.decoder.ImageRegionDecoder;
import org.edx.mobile.third_party.subscaleview.decoder.SkiaImageDecoder;
import org.edx.mobile.third_party.subscaleview.decoder.SkiaImageRegionDecoder;
import java.lang.ref.WeakReference;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Executor;
/**
* Displays an image subsampled as necessary to avoid loading too much image data into memory. After a pinch to zoom in,
* a set of image tiles subsampled at higher resolution are loaded and displayed over the base layer. During pinch and
* zoom, tiles off screen or higher/lower resolution than required are discarded from memory.
* <p/>
* Tiles are no larger than the max supported bitmap size, so with large images tiling may be used even when zoomed out.
* <p/>
* v prefixes - coordinates, translations and distances measured in screen (view) pixels
* s prefixes - coordinates, translations and distances measured in source image pixels (scaled)
*/
@SuppressWarnings("unused")
public class SubsamplingScaleImageView extends View {
private static final String TAG = SubsamplingScaleImageView.class.getSimpleName();
/**
* Attempt to use EXIF information on the image to rotate it. Works for external files only.
*/
public static final int ORIENTATION_USE_EXIF = -1;
/**
* Display the image file in its native orientation.
*/
public static final int ORIENTATION_0 = 0;
/**
* Rotate the image 90 degrees clockwise.
*/
public static final int ORIENTATION_90 = 90;
/**
* Rotate the image 180 degrees.
*/
public static final int ORIENTATION_180 = 180;
/**
* Rotate the image 270 degrees clockwise.
*/
public static final int ORIENTATION_270 = 270;
private static final List<Integer> VALID_ORIENTATIONS = Arrays.asList(ORIENTATION_0, ORIENTATION_90, ORIENTATION_180, ORIENTATION_270, ORIENTATION_USE_EXIF);
/**
* During zoom animation, keep the point of the image that was tapped in the same place, and scale the image around it.
*/
public static final int ZOOM_FOCUS_FIXED = 1;
/**
* During zoom animation, move the point of the image that was tapped to the center of the screen.
*/
public static final int ZOOM_FOCUS_CENTER = 2;
/**
* Zoom in to and center the tapped point immediately without animating.
*/
public static final int ZOOM_FOCUS_CENTER_IMMEDIATE = 3;
private static final List<Integer> VALID_ZOOM_STYLES = Arrays.asList(ZOOM_FOCUS_FIXED, ZOOM_FOCUS_CENTER, ZOOM_FOCUS_CENTER_IMMEDIATE);
/**
* Quadratic ease out. Not recommended for scale animation, but good for panning.
*/
public static final int EASE_OUT_QUAD = 1;
/**
* Quadratic ease in and out.
*/
public static final int EASE_IN_OUT_QUAD = 2;
private static final List<Integer> VALID_EASING_STYLES = Arrays.asList(EASE_IN_OUT_QUAD, EASE_OUT_QUAD);
/**
* Don't allow the image to be panned off screen. As much of the image as possible is always displayed, centered in the view when it is smaller. This is the best option for galleries.
*/
public static final int PAN_LIMIT_INSIDE = 1;
/**
* Allows the image to be panned until it is just off screen, but no further. The edge of the image will stop when it is flush with the screen edge.
*/
public static final int PAN_LIMIT_OUTSIDE = 2;
/**
* Allows the image to be panned until a corner reaches the center of the screen but no further. Useful when you want to pan any spot on the image to the exact center of the screen.
*/
public static final int PAN_LIMIT_CENTER = 3;
private static final List<Integer> VALID_PAN_LIMITS = Arrays.asList(PAN_LIMIT_INSIDE, PAN_LIMIT_OUTSIDE, PAN_LIMIT_CENTER);
/**
* Scale the image so that both dimensions of the image will be equal to or less than the corresponding dimension of the view. The image is then centered in the view. This is the default behaviour and best for galleries.
*/
public static final int SCALE_TYPE_CENTER_INSIDE = 1;
/**
* Scale the image uniformly so that both dimensions of the image will be equal to or larger than the corresponding dimension of the view. The image is then centered in the view.
*/
public static final int SCALE_TYPE_CENTER_CROP = 2;
/**
* Scale the image so that both dimensions of the image will be equal to or less than the maxScale and equal to or larger than minScale. The image is then centered in the view.
*/
public static final int SCALE_TYPE_CUSTOM = 3;
private static final List<Integer> VALID_SCALE_TYPES = Arrays.asList(SCALE_TYPE_CENTER_CROP, SCALE_TYPE_CENTER_INSIDE, SCALE_TYPE_CUSTOM);
// Bitmap (preview or full image)
private Bitmap bitmap;
// Whether the bitmap is a preview image
private boolean bitmapIsPreview;
// Specifies if a cache handler is also referencing the bitmap. Do not recycle if so.
private boolean bitmapIsCached;
// Uri of full size image
private Uri uri;
// Sample size used to display the whole image when fully zoomed out
private int fullImageSampleSize;
// Map of zoom level to tile grid
private Map<Integer, List<Tile>> tileMap;
// Overlay tile boundaries and other info
private boolean debug;
// Image orientation setting
private int orientation = ORIENTATION_0;
// Max scale allowed (prevent infinite zoom)
private float maxScale = 2F;
// Min scale allowed (prevent infinite zoom)
private float minScale = minScale();
// Density to reach before loading higher resolution tiles
private int minimumTileDpi = -1;
// Pan limiting style
protected int panLimit = PAN_LIMIT_INSIDE;
// Minimum scale type
private int minimumScaleType = SCALE_TYPE_CENTER_INSIDE;
// Whether to use the thread pool executor to load tiles
private boolean parallelLoadingEnabled;
// Gesture detection settings
private boolean panEnabled = true;
private boolean zoomEnabled = true;
private boolean quickScaleEnabled = true;
// Double tap zoom behaviour
private float doubleTapZoomScale = 1F;
private int doubleTapZoomStyle = ZOOM_FOCUS_FIXED;
// Current scale and scale at start of zoom
private float scale;
private float scaleStart;
// Screen coordinate of top-left corner of source image
private PointF vTranslate;
private PointF vTranslateStart;
// Source coordinate to center on, used when new position is set externally before view is ready
private Float pendingScale;
private PointF sPendingCenter;
private PointF sRequestedCenter;
// Source image dimensions and orientation - dimensions relate to the unrotated image
private int sWidth;
private int sHeight;
private int sOrientation;
private Rect sRegion;
private Rect pRegion;
// Is two-finger zooming in progress
private boolean isZooming;
// Is one-finger panning in progress
private boolean isPanning;
// Is quick-scale gesture in progress
private boolean isQuickScaling;
// Max touches used in current gesture
private int maxTouchCount;
// Fling detector
private GestureDetector detector;
// Tile and image decoding
private ImageRegionDecoder decoder;
private final Object decoderLock = new Object();
private DecoderFactory<? extends ImageDecoder> bitmapDecoderFactory = new CompatDecoderFactory<ImageDecoder>(SkiaImageDecoder.class);
private DecoderFactory<? extends ImageRegionDecoder> regionDecoderFactory = new CompatDecoderFactory<ImageRegionDecoder>(SkiaImageRegionDecoder.class);
// Debug values
private PointF vCenterStart;
private float vDistStart;
// Current quickscale state
private final float quickScaleThreshold;
private PointF quickScaleCenter;
private float quickScaleLastDistance;
private PointF quickScaleLastPoint;
private boolean quickScaleMoved;
// Scale and center animation tracking
private Anim anim;
// Whether a ready notification has been sent to subclasses
private boolean readySent;
// Whether a base layer loaded notification has been sent to subclasses
private boolean imageLoadedSent;
// Event listener
private OnImageEventListener onImageEventListener;
// Long click listener
private OnLongClickListener onLongClickListener;
// Long click handler
private Handler handler;
private static final int MESSAGE_LONG_CLICK = 1;
// Paint objects created once and reused for efficiency
private Paint bitmapPaint;
private Paint debugPaint;
private Paint tileBgPaint;
// Volatile fields used to reduce object creation
private ScaleAndTranslate satTemp;
private Matrix matrix;
private RectF sRect;
private float[] srcArray = new float[8];
private float[] dstArray = new float[8];
public SubsamplingScaleImageView(Context context, AttributeSet attr) {
super(context, attr);
setMinimumDpi(160);
setDoubleTapZoomDpi(160);
setGestureDetector(context);
this.handler = new Handler(new Handler.Callback() {
public boolean handleMessage(Message message) {
if (message.what == MESSAGE_LONG_CLICK && onLongClickListener != null) {
maxTouchCount = 0;
SubsamplingScaleImageView.super.setOnLongClickListener(onLongClickListener);
performLongClick();
SubsamplingScaleImageView.super.setOnLongClickListener(null);
}
return true;
}
});
quickScaleThreshold = TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, 20, context.getResources().getDisplayMetrics());
}
public SubsamplingScaleImageView(Context context) {
this(context, null);
}
/**
* Sets the image orientation. It's best to call this before setting the image file or asset, because it may waste
* loading of tiles. However, this can be freely called at any time.
*/
public final void setOrientation(int orientation) {
if (!VALID_ORIENTATIONS.contains(orientation)) {
throw new IllegalArgumentException("Invalid orientation: " + orientation);
}
this.orientation = orientation;
reset(false);
invalidate();
requestLayout();
}
/**
* Set the image source from a bitmap, resource, asset, file or other URI.
*
* @param imageSource Image source.
*/
public final void setImage(ImageSource imageSource) {
setImage(imageSource, null, null);
}
/**
* Set the image source from a bitmap, resource, asset, file or other URI, starting with a given orientation
* setting, scale and center. This is the best method to use when you want scale and center to be restored
* after screen orientation change; it avoids any redundant loading of tiles in the wrong orientation.
*
* @param imageSource Image source.
* @param state State to be restored. Nullable.
*/
public final void setImage(ImageSource imageSource, ImageViewState state) {
setImage(imageSource, null, state);
}
/**
* Set the image source from a bitmap, resource, asset, file or other URI, providing a preview image to be
* displayed until the full size image is loaded.
* <p/>
* You must declare the dimensions of the full size image by calling {@link ImageSource#dimensions(int, int)}
* on the imageSource object. The preview source will be ignored if you don't provide dimensions,
* and if you provide a bitmap for the full size image.
*
* @param imageSource Image source. Dimensions must be declared.
* @param previewSource Optional source for a preview image to be displayed and allow interaction while the full size image loads.
*/
public final void setImage(ImageSource imageSource, ImageSource previewSource) {
setImage(imageSource, previewSource, null);
}
/**
* Set the image source from a bitmap, resource, asset, file or other URI, providing a preview image to be
* displayed until the full size image is loaded, starting with a given orientation setting, scale and center.
* This is the best method to use when you want scale and center to be restored after screen orientation change;
* it avoids any redundant loading of tiles in the wrong orientation.
* <p/>
* You must declare the dimensions of the full size image by calling {@link ImageSource#dimensions(int, int)}
* on the imageSource object. The preview source will be ignored if you don't provide dimensions,
* and if you provide a bitmap for the full size image.
*
* @param imageSource Image source. Dimensions must be declared.
* @param previewSource Optional source for a preview image to be displayed and allow interaction while the full size image loads.
* @param state State to be restored. Nullable.
*/
public final void setImage(ImageSource imageSource, ImageSource previewSource, ImageViewState state) {
if (imageSource == null) {
throw new NullPointerException("imageSource must not be null");
}
reset(true);
if (state != null) {
restoreState(state);
}
if (previewSource != null) {
if (imageSource.getBitmap() != null) {
throw new IllegalArgumentException("Preview image cannot be used when a bitmap is provided for the main image");
}
if (imageSource.getSWidth() <= 0 || imageSource.getSHeight() <= 0) {
throw new IllegalArgumentException("Preview image cannot be used unless dimensions are provided for the main image");
}
this.sWidth = imageSource.getSWidth();
this.sHeight = imageSource.getSHeight();
this.pRegion = previewSource.getSRegion();
if (previewSource.getBitmap() != null) {
this.bitmapIsCached = previewSource.isCached();
onPreviewLoaded(previewSource.getBitmap());
} else {
Uri uri = previewSource.getUri();
if (uri == null && previewSource.getResource() != null) {
uri = Uri.parse(ContentResolver.SCHEME_ANDROID_RESOURCE + "://" + getContext().getPackageName() + "/" + previewSource.getResource());
}
BitmapLoadTask task = new BitmapLoadTask(this, getContext(), bitmapDecoderFactory, uri, true);
execute(task);
}
}
if (imageSource.getBitmap() != null && imageSource.getSRegion() != null) {
onImageLoaded(Bitmap.createBitmap(imageSource.getBitmap(), imageSource.getSRegion().left, imageSource.getSRegion().top, imageSource.getSRegion().width(), imageSource.getSRegion().height()), ORIENTATION_0, false);
} else if (imageSource.getBitmap() != null) {
onImageLoaded(imageSource.getBitmap(), ORIENTATION_0, imageSource.isCached());
} else {
sRegion = imageSource.getSRegion();
uri = imageSource.getUri();
if (uri == null && imageSource.getResource() != null) {
uri = Uri.parse(ContentResolver.SCHEME_ANDROID_RESOURCE + "://" + getContext().getPackageName() + "/" + imageSource.getResource());
}
if (imageSource.getTile() || sRegion != null) {
// Load the bitmap using tile decoding.
TilesInitTask task = new TilesInitTask(this, getContext(), regionDecoderFactory, uri);
execute(task);
} else {
// Load the bitmap as a single image.
BitmapLoadTask task = new BitmapLoadTask(this, getContext(), bitmapDecoderFactory, uri, false);
execute(task);
}
}
}
/**
* Reset all state before setting/changing image or setting new rotation.
*/
private void reset(boolean newImage) {
scale = 0f;
scaleStart = 0f;
vTranslate = null;
vTranslateStart = null;
pendingScale = 0f;
sPendingCenter = null;
sRequestedCenter = null;
isZooming = false;
isPanning = false;
isQuickScaling = false;
maxTouchCount = 0;
fullImageSampleSize = 0;
vCenterStart = null;
vDistStart = 0;
quickScaleCenter = null;
quickScaleLastDistance = 0f;
quickScaleLastPoint = null;
quickScaleMoved = false;
anim = null;
satTemp = null;
matrix = null;
sRect = null;
if (newImage) {
uri = null;
if (decoder != null) {
synchronized (decoderLock) {
decoder.recycle();
decoder = null;
}
}
if (bitmap != null && !bitmapIsCached) {
bitmap.recycle();
}
sWidth = 0;
sHeight = 0;
sOrientation = 0;
sRegion = null;
pRegion = null;
readySent = false;
imageLoadedSent = false;
bitmap = null;
bitmapIsPreview = false;
bitmapIsCached = false;
}
if (tileMap != null) {
for (Map.Entry<Integer, List<Tile>> tileMapEntry : tileMap.entrySet()) {
for (Tile tile : tileMapEntry.getValue()) {
tile.visible = false;
if (tile.bitmap != null) {
tile.bitmap.recycle();
tile.bitmap = null;
}
}
}
tileMap = null;
}
setGestureDetector(getContext());
}
private void setGestureDetector(final Context context) {
this.detector = new GestureDetector(context, new GestureDetector.SimpleOnGestureListener() {
@Override
public boolean onFling(MotionEvent e1, MotionEvent e2, float velocityX, float velocityY) {
if (panEnabled && readySent && vTranslate != null && e1 != null && e2 != null && (Math.abs(e1.getX() - e2.getX()) > 50 || Math.abs(e1.getY() - e2.getY()) > 50) && (Math.abs(velocityX) > 500 || Math.abs(velocityY) > 500) && !isZooming) {
PointF vTranslateEnd = new PointF(vTranslate.x + (velocityX * 0.25f), vTranslate.y + (velocityY * 0.25f));
float sCenterXEnd = ((getWidth() / 2) - vTranslateEnd.x) / scale;
float sCenterYEnd = ((getHeight() / 2) - vTranslateEnd.y) / scale;
new AnimationBuilder(new PointF(sCenterXEnd, sCenterYEnd)).withEasing(EASE_OUT_QUAD).withPanLimited(false).start();
return true;
}
return super.onFling(e1, e2, velocityX, velocityY);
}
@Override
public boolean onSingleTapConfirmed(MotionEvent e) {
performClick();
return true;
}
@Override
public boolean onDoubleTap(MotionEvent e) {
if (zoomEnabled && readySent && vTranslate != null) {
// Hacky solution for #15 - after a double tap the GestureDetector gets in a state
// where the next fling is ignored, so here we replace it with a new one.
setGestureDetector(context);
if (quickScaleEnabled) {
// Store quick scale params. This will become either a double tap zoom or a
// quick scale depending on whether the user swipes.
vCenterStart = new PointF(e.getX(), e.getY());
vTranslateStart = new PointF(vTranslate.x, vTranslate.y);
scaleStart = scale;
isQuickScaling = true;
isZooming = true;
quickScaleCenter = viewToSourceCoord(vCenterStart);
quickScaleLastDistance = -1F;
quickScaleLastPoint = new PointF(quickScaleCenter.x, quickScaleCenter.y);
quickScaleMoved = false;
// We need to get events in onTouchEvent after this.
return false;
} else {
// Start double tap zoom animation.
doubleTapZoom(viewToSourceCoord(new PointF(e.getX(), e.getY())), new PointF(e.getX(), e.getY()));
return true;
}
}
return super.onDoubleTapEvent(e);
}
});
}
/**
* On resize, preserve center and scale. Various behaviours are possible, override this method to use another.
*/
@Override
protected void onSizeChanged(int w, int h, int oldw, int oldh) {
PointF sCenter = getCenter();
if (readySent && sCenter != null) {
this.anim = null;
this.pendingScale = scale;
this.sPendingCenter = sCenter;
}
}
/**
* Measures the width and height of the view, preserving the aspect ratio of the image displayed if wrap_content is
* used. The image will scale within this box, not resizing the view as it is zoomed.
*/
@Override
protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
int widthSpecMode = MeasureSpec.getMode(widthMeasureSpec);
int heightSpecMode = MeasureSpec.getMode(heightMeasureSpec);
int parentWidth = MeasureSpec.getSize(widthMeasureSpec);
int parentHeight = MeasureSpec.getSize(heightMeasureSpec);
boolean resizeWidth = widthSpecMode != MeasureSpec.EXACTLY;
boolean resizeHeight = heightSpecMode != MeasureSpec.EXACTLY;
int width = parentWidth;
int height = parentHeight;
if (sWidth > 0 && sHeight > 0) {
if (resizeWidth && resizeHeight) {
width = sWidth();
height = sHeight();
} else if (resizeHeight) {
height = (int) ((((double) sHeight() / (double) sWidth()) * width));
} else if (resizeWidth) {
width = (int) ((((double) sWidth() / (double) sHeight()) * height));
}
}
width = Math.max(width, getSuggestedMinimumWidth());
height = Math.max(height, getSuggestedMinimumHeight());
setMeasuredDimension(width, height);
}
/**
* Handle touch events. One finger pans, and two finger pinch and zoom plus panning.
*/
@Override
@SuppressWarnings("deprecation")
public boolean onTouchEvent(@NonNull MotionEvent event) {
// During non-interruptible anims, ignore all touch events
if (anim != null && !anim.interruptible) {
getParent().requestDisallowInterceptTouchEvent(true);
return true;
} else {
if (anim != null && anim.listener != null) {
try {
anim.listener.onInterruptedByUser();
} catch (Exception e) {
Log.w(TAG, "Error thrown by animation listener", e);
}
}
anim = null;
}
// Abort if not ready
if (vTranslate == null) {
return true;
}
// Detect flings, taps and double taps
if (!isQuickScaling && (detector == null || detector.onTouchEvent(event))) {
isZooming = false;
isPanning = false;
maxTouchCount = 0;
return true;
}
if (vTranslateStart == null) {
vTranslateStart = new PointF(0, 0);
}
if (vCenterStart == null) {
vCenterStart = new PointF(0, 0);
}
int touchCount = event.getPointerCount();
switch (event.getAction()) {
case MotionEvent.ACTION_DOWN:
case MotionEvent.ACTION_POINTER_1_DOWN:
case MotionEvent.ACTION_POINTER_2_DOWN:
anim = null;
getParent().requestDisallowInterceptTouchEvent(true);
maxTouchCount = Math.max(maxTouchCount, touchCount);
if (touchCount >= 2) {
if (zoomEnabled) {
// Start pinch to zoom. Calculate distance between touch points and center point of the pinch.
float distance = distance(event.getX(0), event.getX(1), event.getY(0), event.getY(1));
scaleStart = scale;
vDistStart = distance;
vTranslateStart.set(vTranslate.x, vTranslate.y);
vCenterStart.set((event.getX(0) + event.getX(1)) / 2, (event.getY(0) + event.getY(1)) / 2);
} else {
// Abort all gestures on second touch
maxTouchCount = 0;
}
// Cancel long click timer
handler.removeMessages(MESSAGE_LONG_CLICK);
} else if (!isQuickScaling) {
// Start one-finger pan
vTranslateStart.set(vTranslate.x, vTranslate.y);
vCenterStart.set(event.getX(), event.getY());
// Start long click timer
handler.sendEmptyMessageDelayed(MESSAGE_LONG_CLICK, 600);
}
return true;
case MotionEvent.ACTION_MOVE:
boolean consumed = false;
if (maxTouchCount > 0) {
if (touchCount >= 2) {
// Calculate new distance between touch points, to scale and pan relative to start values.
float vDistEnd = distance(event.getX(0), event.getX(1), event.getY(0), event.getY(1));
float vCenterEndX = (event.getX(0) + event.getX(1)) / 2;
float vCenterEndY = (event.getY(0) + event.getY(1)) / 2;
if (zoomEnabled && (distance(vCenterStart.x, vCenterEndX, vCenterStart.y, vCenterEndY) > 5 || Math.abs(vDistEnd - vDistStart) > 5 || isPanning)) {
isZooming = true;
isPanning = true;
consumed = true;
scale = Math.min(maxScale, (vDistEnd / vDistStart) * scaleStart);
if (scale <= minScale()) {
// Minimum scale reached so don't pan. Adjust start settings so any expand will zoom in.
vDistStart = vDistEnd;
scaleStart = minScale();
vCenterStart.set(vCenterEndX, vCenterEndY);
vTranslateStart.set(vTranslate);
} else if (panEnabled) {
// Translate to place the source image coordinate that was at the center of the pinch at the start
// at the center of the pinch now, to give simultaneous pan + zoom.
float vLeftStart = vCenterStart.x - vTranslateStart.x;
float vTopStart = vCenterStart.y - vTranslateStart.y;
float vLeftNow = vLeftStart * (scale / scaleStart);
float vTopNow = vTopStart * (scale / scaleStart);
vTranslate.x = vCenterEndX - vLeftNow;
vTranslate.y = vCenterEndY - vTopNow;
} else if (sRequestedCenter != null) {
// With a center specified from code, zoom around that point.
vTranslate.x = (getWidth() / 2) - (scale * sRequestedCenter.x);
vTranslate.y = (getHeight() / 2) - (scale * sRequestedCenter.y);
} else {
// With no requested center, scale around the image center.
vTranslate.x = (getWidth() / 2) - (scale * (sWidth() / 2));
vTranslate.y = (getHeight() / 2) - (scale * (sHeight() / 2));
}
fitToBounds(true);
refreshRequiredTiles(false);
}
} else if (isQuickScaling) {
// One finger zoom
// Stole Google's Magical Formula™ to make sure it feels the exact same
float dist = Math.abs(vCenterStart.y - event.getY()) * 2 + quickScaleThreshold;
if (quickScaleLastDistance == -1F) quickScaleLastDistance = dist;
boolean isUpwards = event.getY() > quickScaleLastPoint.y;
quickScaleLastPoint.set(0, event.getY());
float spanDiff = (Math.abs(1 - (dist / quickScaleLastDistance)) * 0.5F);
if (spanDiff > 0.03f || quickScaleMoved) {
quickScaleMoved = true;
float multiplier = 1;
if (quickScaleLastDistance > 0) {
multiplier = isUpwards ? (1 + spanDiff) : (1 - spanDiff);
}
scale = Math.max(minScale(), Math.min(maxScale, scale * multiplier));
if (panEnabled) {
float vLeftStart = vCenterStart.x - vTranslateStart.x;
float vTopStart = vCenterStart.y - vTranslateStart.y;
float vLeftNow = vLeftStart * (scale / scaleStart);
float vTopNow = vTopStart * (scale / scaleStart);
vTranslate.x = vCenterStart.x - vLeftNow;
vTranslate.y = vCenterStart.y - vTopNow;
} else if (sRequestedCenter != null) {
// With a center specified from code, zoom around that point.
vTranslate.x = (getWidth() / 2) - (scale * sRequestedCenter.x);
vTranslate.y = (getHeight() / 2) - (scale * sRequestedCenter.y);
} else {
// With no requested center, scale around the image center.
vTranslate.x = (getWidth() / 2) - (scale * (sWidth() / 2));
vTranslate.y = (getHeight() / 2) - (scale * (sHeight() / 2));
}
}
quickScaleLastDistance = dist;
fitToBounds(true);
refreshRequiredTiles(false);
consumed = true;
} else if (!isZooming) {
// One finger pan - translate the image. We do this calculation even with pan disabled so click
// and long click behaviour is preserved.
float dx = Math.abs(event.getX() - vCenterStart.x);
float dy = Math.abs(event.getY() - vCenterStart.y);
if (dx > 5 || dy > 5 || isPanning) {
consumed = true;
vTranslate.x = vTranslateStart.x + (event.getX() - vCenterStart.x);
vTranslate.y = vTranslateStart.y + (event.getY() - vCenterStart.y);
float lastX = vTranslate.x;
float lastY = vTranslate.y;
fitToBounds(true);
boolean atXEdge = lastX != vTranslate.x;
boolean edgeXSwipe = atXEdge && dx > dy && !isPanning;
boolean yPan = lastY == vTranslate.y && dy > 15;
if (!edgeXSwipe && (!atXEdge || yPan || isPanning)) {
isPanning = true;
} else if (dx > 5) {
// Haven't panned the image, and we're at the left or right edge. Switch to page swipe.
maxTouchCount = 0;
handler.removeMessages(MESSAGE_LONG_CLICK);
getParent().requestDisallowInterceptTouchEvent(false);
}
if (!panEnabled) {
vTranslate.x = vTranslateStart.x;
vTranslate.y = vTranslateStart.y;
getParent().requestDisallowInterceptTouchEvent(false);
}
refreshRequiredTiles(false);
}
}
}
if (consumed) {
handler.removeMessages(MESSAGE_LONG_CLICK);
invalidate();
return true;
}
break;
case MotionEvent.ACTION_UP:
case MotionEvent.ACTION_POINTER_UP:
case MotionEvent.ACTION_POINTER_2_UP:
handler.removeMessages(MESSAGE_LONG_CLICK);
if (isQuickScaling) {
isQuickScaling = false;
if (!quickScaleMoved) {
doubleTapZoom(quickScaleCenter, vCenterStart);
}
}
if (maxTouchCount > 0 && (isZooming || isPanning)) {
if (isZooming && touchCount == 2) {
// Convert from zoom to pan with remaining touch
isPanning = true;
vTranslateStart.set(vTranslate.x, vTranslate.y);
if (event.getActionIndex() == 1) {
vCenterStart.set(event.getX(0), event.getY(0));
} else {
vCenterStart.set(event.getX(1), event.getY(1));
}
}
if (touchCount < 3) {
// End zooming when only one touch point
isZooming = false;
}
if (touchCount < 2) {
// End panning when no touch points
isPanning = false;
maxTouchCount = 0;
}
// Trigger load of tiles now required
refreshRequiredTiles(true);
return true;
}
if (touchCount == 1) {
isZooming = false;
isPanning = false;
maxTouchCount = 0;
}
return true;
}
return super.onTouchEvent(event);
}
/**
* Double tap zoom handler triggered from gesture detector or on touch, depending on whether
* quick scale is enabled.
*/
private void doubleTapZoom(PointF sCenter, PointF vFocus) {
if (!panEnabled) {
if (sRequestedCenter != null) {
// With a center specified from code, zoom around that point.
sCenter.x = sRequestedCenter.x;
sCenter.y = sRequestedCenter.y;
} else {
// With no requested center, scale around the image center.
sCenter.x = sWidth() / 2;
sCenter.y = sHeight() / 2;
}
}
float doubleTapZoomScale = Math.min(maxScale, SubsamplingScaleImageView.this.doubleTapZoomScale);
boolean zoomIn = scale <= doubleTapZoomScale * 0.9;
float targetScale = zoomIn ? doubleTapZoomScale : minScale();
if (doubleTapZoomStyle == ZOOM_FOCUS_CENTER_IMMEDIATE) {
setScaleAndCenter(targetScale, sCenter);
} else if (doubleTapZoomStyle == ZOOM_FOCUS_CENTER || !zoomIn || !panEnabled) {
new AnimationBuilder(targetScale, sCenter).withInterruptible(false).start();
} else if (doubleTapZoomStyle == ZOOM_FOCUS_FIXED) {
new AnimationBuilder(targetScale, sCenter, vFocus).withInterruptible(false).start();
}
invalidate();
}
/**
* Draw method should not be called until the view has dimensions so the first calls are used as triggers to calculate
* the scaling and tiling required. Once the view is setup, tiles are displayed as they are loaded.
*/
@Override
protected void onDraw(Canvas canvas) {
super.onDraw(canvas);
createPaints();
// If image or view dimensions are not known yet, abort.
if (sWidth == 0 || sHeight == 0 || getWidth() == 0 || getHeight() == 0) {
return;
}
// When using tiles, on first render with no tile map ready, initialise it and kick off async base image loading.
if (tileMap == null && decoder != null) {
initialiseBaseLayer(getMaxBitmapDimensions(canvas));
}
// If image has been loaded or supplied as a bitmap, onDraw may be the first time the view has
// dimensions and therefore the first opportunity to set scale and translate. If this call returns
// false there is nothing to be drawn so return immediately.
if (!checkReady()) {
return;
}
// Set scale and translate before draw.
preDraw();
// If animating scale, calculate current scale and center with easing equations
if (anim != null) {
long scaleElapsed = System.currentTimeMillis() - anim.time;
boolean finished = scaleElapsed > anim.duration;
scaleElapsed = Math.min(scaleElapsed, anim.duration);
scale = ease(anim.easing, scaleElapsed, anim.scaleStart, anim.scaleEnd - anim.scaleStart, anim.duration);
// Apply required animation to the focal point
float vFocusNowX = ease(anim.easing, scaleElapsed, anim.vFocusStart.x, anim.vFocusEnd.x - anim.vFocusStart.x, anim.duration);
float vFocusNowY = ease(anim.easing, scaleElapsed, anim.vFocusStart.y, anim.vFocusEnd.y - anim.vFocusStart.y, anim.duration);
// Find out where the focal point is at this scale and adjust its position to follow the animation path
vTranslate.x -= sourceToViewX(anim.sCenterEnd.x) - vFocusNowX;
vTranslate.y -= sourceToViewY(anim.sCenterEnd.y) - vFocusNowY;
// For translate anims, showing the image non-centered is never allowed, for scaling anims it is during the animation.
fitToBounds(finished || (anim.scaleStart == anim.scaleEnd));
refreshRequiredTiles(finished);
if (finished) {
if (anim.listener != null) {
try {
anim.listener.onComplete();
} catch (Exception e) {
Log.w(TAG, "Error thrown by animation listener", e);
}
}
anim = null;
}
invalidate();
}
if (tileMap != null && isBaseLayerReady()) {
// Optimum sample size for current scale
int sampleSize = Math.min(fullImageSampleSize, calculateInSampleSize(scale));
// First check for missing tiles - if there are any we need the base layer underneath to avoid gaps
boolean hasMissingTiles = false;
for (Map.Entry<Integer, List<Tile>> tileMapEntry : tileMap.entrySet()) {
if (tileMapEntry.getKey() == sampleSize) {
for (Tile tile : tileMapEntry.getValue()) {
if (tile.visible && (tile.loading || tile.bitmap == null)) {
hasMissingTiles = true;
}
}
}
}
// Render all loaded tiles. LinkedHashMap used for bottom up rendering - lower res tiles underneath.
for (Map.Entry<Integer, List<Tile>> tileMapEntry : tileMap.entrySet()) {
if (tileMapEntry.getKey() == sampleSize || hasMissingTiles) {
for (Tile tile : tileMapEntry.getValue()) {
sourceToViewRect(tile.sRect, tile.vRect);
if (!tile.loading && tile.bitmap != null) {
if (tileBgPaint != null) {
canvas.drawRect(tile.vRect, tileBgPaint);
}
if (matrix == null) {
matrix = new Matrix();
}
matrix.reset();
setMatrixArray(srcArray, 0, 0, tile.bitmap.getWidth(), 0, tile.bitmap.getWidth(), tile.bitmap.getHeight(), 0, tile.bitmap.getHeight());
if (getRequiredRotation() == ORIENTATION_0) {
setMatrixArray(dstArray, tile.vRect.left, tile.vRect.top, tile.vRect.right, tile.vRect.top, tile.vRect.right, tile.vRect.bottom, tile.vRect.left, tile.vRect.bottom);
} else if (getRequiredRotation() == ORIENTATION_90) {
setMatrixArray(dstArray, tile.vRect.right, tile.vRect.top, tile.vRect.right, tile.vRect.bottom, tile.vRect.left, tile.vRect.bottom, tile.vRect.left, tile.vRect.top);
} else if (getRequiredRotation() == ORIENTATION_180) {
setMatrixArray(dstArray, tile.vRect.right, tile.vRect.bottom, tile.vRect.left, tile.vRect.bottom, tile.vRect.left, tile.vRect.top, tile.vRect.right, tile.vRect.top);
} else if (getRequiredRotation() == ORIENTATION_270) {
setMatrixArray(dstArray, tile.vRect.left, tile.vRect.bottom, tile.vRect.left, tile.vRect.top, tile.vRect.right, tile.vRect.top, tile.vRect.right, tile.vRect.bottom);
}
matrix.setPolyToPoly(srcArray, 0, dstArray, 0, 4);
canvas.drawBitmap(tile.bitmap, matrix, bitmapPaint);
if (debug) {
canvas.drawRect(tile.vRect, debugPaint);
}
} else if (tile.loading && debug) {
canvas.drawText("LOADING", tile.vRect.left + 5, tile.vRect.top + 35, debugPaint);
}
if (tile.visible && debug) {
canvas.drawText("ISS " + tile.sampleSize + " RECT " + tile.sRect.top + "," + tile.sRect.left + "," + tile.sRect.bottom + "," + tile.sRect.right, tile.vRect.left + 5, tile.vRect.top + 15, debugPaint);
}
}
}
}
if (debug) {
canvas.drawText("Scale: " + String.format("%.2f", scale), 5, 15, debugPaint);
canvas.drawText("Translate: " + String.format("%.2f", vTranslate.x) + ":" + String.format("%.2f", vTranslate.y), 5, 35, debugPaint);
PointF center = getCenter();
canvas.drawText("Source center: " + String.format("%.2f", center.x) + ":" + String.format("%.2f", center.y), 5, 55, debugPaint);
if (anim != null) {
PointF vCenterStart = sourceToViewCoord(anim.sCenterStart);
PointF vCenterEndRequested = sourceToViewCoord(anim.sCenterEndRequested);
PointF vCenterEnd = sourceToViewCoord(anim.sCenterEnd);
canvas.drawCircle(vCenterStart.x, vCenterStart.y, 10, debugPaint);
canvas.drawCircle(vCenterEndRequested.x, vCenterEndRequested.y, 20, debugPaint);
canvas.drawCircle(vCenterEnd.x, vCenterEnd.y, 25, debugPaint);
canvas.drawCircle(getWidth() / 2, getHeight() / 2, 30, debugPaint);
}
}
} else if (bitmap != null) {
float xScale = scale, yScale = scale;
if (bitmapIsPreview) {
xScale = scale * ((float) sWidth / bitmap.getWidth());
yScale = scale * ((float) sHeight / bitmap.getHeight());
}
if (matrix == null) {
matrix = new Matrix();
}
matrix.reset();
matrix.postScale(xScale, yScale);
matrix.postRotate(getRequiredRotation());
matrix.postTranslate(vTranslate.x, vTranslate.y);
if (getRequiredRotation() == ORIENTATION_180) {
matrix.postTranslate(scale * sWidth, scale * sHeight);
} else if (getRequiredRotation() == ORIENTATION_90) {
matrix.postTranslate(scale * sHeight, 0);
} else if (getRequiredRotation() == ORIENTATION_270) {
matrix.postTranslate(0, scale * sWidth);
}
if (tileBgPaint != null) {
if (sRect == null) {
sRect = new RectF();
}
sRect.set(0f, 0f, sWidth, sHeight);
matrix.mapRect(sRect);
canvas.drawRect(sRect, tileBgPaint);
}
canvas.drawBitmap(bitmap, matrix, bitmapPaint);
}
}
/**
* Helper method for setting the values of a tile matrix array.
*/
private void setMatrixArray(float[] array, float f0, float f1, float f2, float f3, float f4, float f5, float f6, float f7) {
array[0] = f0;
array[1] = f1;
array[2] = f2;
array[3] = f3;
array[4] = f4;
array[5] = f5;
array[6] = f6;
array[7] = f7;
}
/**
* Checks whether the base layer of tiles or full size bitmap is ready.
*/
private boolean isBaseLayerReady() {
if (bitmap != null && !bitmapIsPreview) {
return true;
} else if (tileMap != null) {
boolean baseLayerReady = true;
for (Map.Entry<Integer, List<Tile>> tileMapEntry : tileMap.entrySet()) {
if (tileMapEntry.getKey() == fullImageSampleSize) {
for (Tile tile : tileMapEntry.getValue()) {
if (tile.loading || tile.bitmap == null) {
baseLayerReady = false;
}
}
}
}
return baseLayerReady;
}
return false;
}
/**
* Check whether view and image dimensions are known and either a preview, full size image or
* base layer tiles are loaded. First time, send ready event to listener. The next draw will
* display an image.
*/
private boolean checkReady() {
boolean ready = getWidth() > 0 && getHeight() > 0 && sWidth > 0 && sHeight > 0 && (bitmap != null || isBaseLayerReady());
if (!readySent && ready) {
preDraw();
readySent = true;
onReady();
if (onImageEventListener != null) {
onImageEventListener.onReady();
}
}
return ready;
}
/**
* Check whether either the full size bitmap or base layer tiles are loaded. First time, send image
* loaded event to listener.
*/
private boolean checkImageLoaded() {
boolean imageLoaded = isBaseLayerReady();
if (!imageLoadedSent && imageLoaded) {
preDraw();
imageLoadedSent = true;
onImageLoaded();
if (onImageEventListener != null) {
onImageEventListener.onImageLoaded();
}
}
return imageLoaded;
}
/**
* Creates Paint objects once when first needed.
*/
private void createPaints() {
if (bitmapPaint == null) {
bitmapPaint = new Paint();
bitmapPaint.setAntiAlias(true);
bitmapPaint.setFilterBitmap(true);
bitmapPaint.setDither(true);
}
if (debugPaint == null && debug) {
debugPaint = new Paint();
debugPaint.setTextSize(18);
debugPaint.setColor(Color.MAGENTA);
debugPaint.setStyle(Style.STROKE);
}
}
/**
* Called on first draw when the view has dimensions. Calculates the initial sample size and starts async loading of
* the base layer image - the whole source subsampled as necessary.
*/
private synchronized void initialiseBaseLayer(Point maxTileDimensions) {
satTemp = new ScaleAndTranslate(0f, new PointF(0, 0));
fitToBounds(true, satTemp);
// Load double resolution - next level will be split into four tiles and at the center all four are required,
// so don't bother with tiling until the next level 16 tiles are needed.
fullImageSampleSize = calculateInSampleSize(satTemp.scale);
if (fullImageSampleSize > 1) {
fullImageSampleSize /= 2;
}
if (fullImageSampleSize == 1 && sRegion == null && sWidth() < maxTileDimensions.x && sHeight() < maxTileDimensions.y) {
// Whole image is required at native resolution, and is smaller than the canvas max bitmap size.
// Use BitmapDecoder for better image support.
decoder.recycle();
decoder = null;
BitmapLoadTask task = new BitmapLoadTask(this, getContext(), bitmapDecoderFactory, uri, false);
execute(task);
} else {
initialiseTileMap(maxTileDimensions);
List<Tile> baseGrid = tileMap.get(fullImageSampleSize);
for (Tile baseTile : baseGrid) {
TileLoadTask task = new TileLoadTask(this, decoder, baseTile);
execute(task);
}
refreshRequiredTiles(true);
}
}
/**
* Loads the optimum tiles for display at the current scale and translate, so the screen can be filled with tiles
* that are at least as high resolution as the screen. Frees up bitmaps that are now off the screen.
*
* @param load Whether to load the new tiles needed. Use false while scrolling/panning for performance.
*/
private void refreshRequiredTiles(boolean load) {
if (decoder == null || tileMap == null) {
return;
}
int sampleSize = Math.min(fullImageSampleSize, calculateInSampleSize(scale));
// Load tiles of the correct sample size that are on screen. Discard tiles off screen, and those that are higher
// resolution than required, or lower res than required but not the base layer, so the base layer is always present.
for (Map.Entry<Integer, List<Tile>> tileMapEntry : tileMap.entrySet()) {
for (Tile tile : tileMapEntry.getValue()) {
if (tile.sampleSize < sampleSize || (tile.sampleSize > sampleSize && tile.sampleSize != fullImageSampleSize)) {
tile.visible = false;
if (tile.bitmap != null) {
tile.bitmap.recycle();
tile.bitmap = null;
}
}
if (tile.sampleSize == sampleSize) {
if (tileVisible(tile)) {
tile.visible = true;
if (!tile.loading && tile.bitmap == null && load) {
TileLoadTask task = new TileLoadTask(this, decoder, tile);
execute(task);
}
} else if (tile.sampleSize != fullImageSampleSize) {
tile.visible = false;
if (tile.bitmap != null) {
tile.bitmap.recycle();
tile.bitmap = null;
}
}
} else if (tile.sampleSize == fullImageSampleSize) {
tile.visible = true;
}
}
}
}
/**
* Determine whether tile is visible.
*/
private boolean tileVisible(Tile tile) {
float sVisLeft = viewToSourceX(0),
sVisRight = viewToSourceX(getWidth()),
sVisTop = viewToSourceY(0),
sVisBottom = viewToSourceY(getHeight());
return !(sVisLeft > tile.sRect.right || tile.sRect.left > sVisRight || sVisTop > tile.sRect.bottom || tile.sRect.top > sVisBottom);
}
/**
* Sets scale and translate ready for the next draw.
*/
private void preDraw() {
if (getWidth() == 0 || getHeight() == 0 || sWidth <= 0 || sHeight <= 0) {
return;
}
// If waiting to translate to new center position, set translate now
if (sPendingCenter != null && pendingScale != null) {
scale = pendingScale;
if (vTranslate == null) {
vTranslate = new PointF();
}
vTranslate.x = (getWidth() / 2) - (scale * sPendingCenter.x);
vTranslate.y = (getHeight() / 2) - (scale * sPendingCenter.y);
sPendingCenter = null;
pendingScale = null;
fitToBounds(true);
refreshRequiredTiles(true);
}
// On first display of base image set up position, and in other cases make sure scale is correct.
fitToBounds(false);
}
/**
* Calculates sample size to fit the source image in given bounds.
*/
private int calculateInSampleSize(float scale) {
if (minimumTileDpi > 0) {
DisplayMetrics metrics = getResources().getDisplayMetrics();
float averageDpi = (metrics.xdpi + metrics.ydpi) / 2;
scale = (minimumTileDpi / averageDpi) * scale;
}
int reqWidth = (int) (sWidth() * scale);
int reqHeight = (int) (sHeight() * scale);
// Raw height and width of image
int inSampleSize = 1;
if (reqWidth == 0 || reqHeight == 0) {
return 32;
}
if (sHeight() > reqHeight || sWidth() > reqWidth) {
// Calculate ratios of height and width to requested height and width
final int heightRatio = Math.round((float) sHeight() / (float) reqHeight);
final int widthRatio = Math.round((float) sWidth() / (float) reqWidth);
// Choose the smallest ratio as inSampleSize value, this will guarantee
// a final image with both dimensions larger than or equal to the
// requested height and width.
inSampleSize = heightRatio < widthRatio ? heightRatio : widthRatio;
}
// We want the actual sample size that will be used, so round down to nearest power of 2.
int power = 1;
while (power * 2 < inSampleSize) {
power = power * 2;
}
return power;
}
/**
* Adjusts hypothetical future scale and translate values to keep scale within the allowed range and the image on screen. Minimum scale
* is set so one dimension fills the view and the image is centered on the other dimension. Used to calculate what the target of an
* animation should be.
*
* @param center Whether the image should be centered in the dimension it's too small to fill. While animating this can be false to avoid changes in direction as bounds are reached.
* @param sat The scale we want and the translation we're aiming for. The values are adjusted to be valid.
*/
protected void fitToBounds(boolean center, ScaleAndTranslate sat) {
if (panLimit == PAN_LIMIT_OUTSIDE && isReady()) {
center = false;
}
PointF vTranslate = sat.vTranslate;
float scale = limitedScale(sat.scale);
float scaleWidth = scale * sWidth();
float scaleHeight = scale * sHeight();
if (panLimit == PAN_LIMIT_CENTER && isReady()) {
vTranslate.x = Math.max(vTranslate.x, getWidth() / 2 - scaleWidth);
vTranslate.y = Math.max(vTranslate.y, getHeight() / 2 - scaleHeight);
} else if (center) {
vTranslate.x = Math.max(vTranslate.x, getWidth() - scaleWidth);
vTranslate.y = Math.max(vTranslate.y, getHeight() - scaleHeight);
} else {
vTranslate.x = Math.max(vTranslate.x, -scaleWidth);
vTranslate.y = Math.max(vTranslate.y, -scaleHeight);
}
// Asymmetric padding adjustments
float xPaddingRatio = getPaddingLeft() > 0 || getPaddingRight() > 0 ? getPaddingLeft() / (float) (getPaddingLeft() + getPaddingRight()) : 0.5f;
float yPaddingRatio = getPaddingTop() > 0 || getPaddingBottom() > 0 ? getPaddingTop() / (float) (getPaddingTop() + getPaddingBottom()) : 0.5f;
float maxTx;
float maxTy;
if (panLimit == PAN_LIMIT_CENTER && isReady()) {
maxTx = Math.max(0, getWidth() / 2);
maxTy = Math.max(0, getHeight() / 2);
} else if (center) {
maxTx = Math.max(0, (getWidth() - scaleWidth) * xPaddingRatio);
maxTy = Math.max(0, (getHeight() - scaleHeight) * yPaddingRatio);
} else {
maxTx = Math.max(0, getWidth());
maxTy = Math.max(0, getHeight());
}
vTranslate.x = Math.min(vTranslate.x, maxTx);
vTranslate.y = Math.min(vTranslate.y, maxTy);
sat.scale = scale;
}
/**
* Adjusts current scale and translate values to keep scale within the allowed range and the image on screen. Minimum scale
* is set so one dimension fills the view and the image is centered on the other dimension.
*
* @param center Whether the image should be centered in the dimension it's too small to fill. While animating this can be false to avoid changes in direction as bounds are reached.
*/
private void fitToBounds(boolean center) {
boolean init = false;
if (vTranslate == null) {
init = true;
vTranslate = new PointF(0, 0);
}
if (satTemp == null) {
satTemp = new ScaleAndTranslate(0, new PointF(0, 0));
}
satTemp.scale = scale;
satTemp.vTranslate.set(vTranslate);
fitToBounds(center, satTemp);
scale = satTemp.scale;
vTranslate.set(satTemp.vTranslate);
if (init) {
vTranslate.set(vTranslateForSCenter(sWidth() / 2, sHeight() / 2, scale));
}
}
/**
* Once source image and view dimensions are known, creates a map of sample size to tile grid.
*/
private void initialiseTileMap(Point maxTileDimensions) {
this.tileMap = new LinkedHashMap<Integer, List<Tile>>();
int sampleSize = fullImageSampleSize;
int xTiles = 1;
int yTiles = 1;
while (true) {
int sTileWidth = sWidth() / xTiles;
int sTileHeight = sHeight() / yTiles;
int subTileWidth = sTileWidth / sampleSize;
int subTileHeight = sTileHeight / sampleSize;
while (subTileWidth + xTiles + 1 > maxTileDimensions.x || (subTileWidth > getWidth() * 1.25 && sampleSize < fullImageSampleSize)) {
xTiles += 1;
sTileWidth = sWidth() / xTiles;
subTileWidth = sTileWidth / sampleSize;
}
while (subTileHeight + yTiles + 1 > maxTileDimensions.y || (subTileHeight > getHeight() * 1.25 && sampleSize < fullImageSampleSize)) {
yTiles += 1;
sTileHeight = sHeight() / yTiles;
subTileHeight = sTileHeight / sampleSize;
}
List<Tile> tileGrid = new ArrayList<Tile>(xTiles * yTiles);
for (int x = 0; x < xTiles; x++) {
for (int y = 0; y < yTiles; y++) {
Tile tile = new Tile();
tile.sampleSize = sampleSize;
tile.visible = sampleSize == fullImageSampleSize;
tile.sRect = new Rect(
x * sTileWidth,
y * sTileHeight,
x == xTiles - 1 ? sWidth() : (x + 1) * sTileWidth,
y == yTiles - 1 ? sHeight() : (y + 1) * sTileHeight
);
tile.vRect = new Rect(0, 0, 0, 0);
tile.fileSRect = new Rect(tile.sRect);
tileGrid.add(tile);
}
}
tileMap.put(sampleSize, tileGrid);
if (sampleSize == 1) {
break;
} else {
sampleSize /= 2;
}
}
}
/**
* Async task used to get image details without blocking the UI thread.
*/
private static class TilesInitTask extends AsyncTask<Void, Void, int[]> {
private final WeakReference<SubsamplingScaleImageView> viewRef;
private final WeakReference<Context> contextRef;
private final WeakReference<DecoderFactory<? extends ImageRegionDecoder>> decoderFactoryRef;
private final Uri source;
private ImageRegionDecoder decoder;
private Exception exception;
public TilesInitTask(SubsamplingScaleImageView view, Context context, DecoderFactory<? extends ImageRegionDecoder> decoderFactory, Uri source) {
this.viewRef = new WeakReference<SubsamplingScaleImageView>(view);
this.contextRef = new WeakReference<Context>(context);
this.decoderFactoryRef = new WeakReference<DecoderFactory<? extends ImageRegionDecoder>>(decoderFactory);
this.source = source;
}
@Override
protected int[] doInBackground(Void... params) {
try {
String sourceUri = source.toString();
Context context = contextRef.get();
DecoderFactory<? extends ImageRegionDecoder> decoderFactory = decoderFactoryRef.get();
SubsamplingScaleImageView view = viewRef.get();
if (context != null && decoderFactory != null && view != null) {
decoder = decoderFactory.make();
Point dimensions = decoder.init(context, source);
int sWidth = dimensions.x;
int sHeight = dimensions.y;
int exifOrientation = view.getExifOrientation(sourceUri);
if (view.sRegion != null) {
sWidth = view.sRegion.width();
sHeight = view.sRegion.height();
}
return new int[]{sWidth, sHeight, exifOrientation};
}
} catch (Exception e) {
Log.e(TAG, "Failed to initialise bitmap decoder", e);
this.exception = e;
}
return null;
}
@Override
protected void onPostExecute(int[] xyo) {
final SubsamplingScaleImageView view = viewRef.get();
if (view != null) {
if (decoder != null && xyo != null && xyo.length == 3) {
view.onTilesInited(decoder, xyo[0], xyo[1], xyo[2]);
} else if (exception != null && view.onImageEventListener != null) {
view.onImageEventListener.onImageLoadError(exception);
}
}
}
}
/**
* Called by worker task when decoder is ready and image size and EXIF orientation is known.
*/
private synchronized void onTilesInited(ImageRegionDecoder decoder, int sWidth, int sHeight, int sOrientation) {
// If actual dimensions don't match the declared size, reset everything.
if (this.sWidth > 0 && this.sHeight > 0 && (this.sWidth != sWidth || this.sHeight != sHeight)) {
reset(false);
if (bitmap != null) {
if (!bitmapIsCached) {
bitmap.recycle();
}
bitmap = null;
bitmapIsPreview = false;
bitmapIsCached = false;
}
}
this.decoder = decoder;
this.sWidth = sWidth;
this.sHeight = sHeight;
this.sOrientation = sOrientation;
checkReady();
checkImageLoaded();
invalidate();
requestLayout();
}
/**
* Async task used to load images without blocking the UI thread.
*/
private static class TileLoadTask extends AsyncTask<Void, Void, Bitmap> {
private final WeakReference<SubsamplingScaleImageView> viewRef;
private final WeakReference<ImageRegionDecoder> decoderRef;
private final WeakReference<Tile> tileRef;
private Exception exception;
public TileLoadTask(SubsamplingScaleImageView view, ImageRegionDecoder decoder, Tile tile) {
this.viewRef = new WeakReference<SubsamplingScaleImageView>(view);
this.decoderRef = new WeakReference<ImageRegionDecoder>(decoder);
this.tileRef = new WeakReference<Tile>(tile);
tile.loading = true;
}
@Override
protected Bitmap doInBackground(Void... params) {
try {
SubsamplingScaleImageView view = viewRef.get();
ImageRegionDecoder decoder = decoderRef.get();
Tile tile = tileRef.get();
if (decoder != null && tile != null && view != null && decoder.isReady() && tile.visible) {
synchronized (view.decoderLock) {
// Update tile's file sRect according to rotation
view.fileSRect(tile.sRect, tile.fileSRect);
if (view.sRegion != null) {
tile.fileSRect.offset(view.sRegion.left, view.sRegion.top);
}
return decoder.decodeRegion(tile.fileSRect, tile.sampleSize);
}
} else if (tile != null) {
tile.loading = false;
}
} catch (Exception e) {
Log.e(TAG, "Failed to decode tile", e);
this.exception = e;
}
return null;
}
@Override
protected void onPostExecute(Bitmap bitmap) {
final SubsamplingScaleImageView subsamplingScaleImageView = viewRef.get();
final Tile tile = tileRef.get();
if (subsamplingScaleImageView != null && tile != null) {
if (bitmap != null) {
tile.bitmap = bitmap;
tile.loading = false;
subsamplingScaleImageView.onTileLoaded();
} else if (exception != null && subsamplingScaleImageView.onImageEventListener != null) {
subsamplingScaleImageView.onImageEventListener.onTileLoadError(exception);
}
}
}
}
/**
* Called by worker task when a tile has loaded. Redraws the view.
*/
private synchronized void onTileLoaded() {
checkReady();
checkImageLoaded();
if (isBaseLayerReady() && bitmap != null) {
if (!bitmapIsCached) {
bitmap.recycle();
}
bitmap = null;
bitmapIsPreview = false;
bitmapIsCached = false;
}
invalidate();
}
/**
* Async task used to load bitmap without blocking the UI thread.
*/
private static class BitmapLoadTask extends AsyncTask<Void, Void, Integer> {
private final WeakReference<SubsamplingScaleImageView> viewRef;
private final WeakReference<Context> contextRef;
private final WeakReference<DecoderFactory<? extends ImageDecoder>> decoderFactoryRef;
private final Uri source;
private final boolean preview;
private Bitmap bitmap;
private Exception exception;
public BitmapLoadTask(SubsamplingScaleImageView view, Context context, DecoderFactory<? extends ImageDecoder> decoderFactory, Uri source, boolean preview) {
this.viewRef = new WeakReference<SubsamplingScaleImageView>(view);
this.contextRef = new WeakReference<Context>(context);
this.decoderFactoryRef = new WeakReference<DecoderFactory<? extends ImageDecoder>>(decoderFactory);
this.source = source;
this.preview = preview;
}
@Override
protected Integer doInBackground(Void... params) {
try {
String sourceUri = source.toString();
Context context = contextRef.get();
DecoderFactory<? extends ImageDecoder> decoderFactory = decoderFactoryRef.get();
SubsamplingScaleImageView subsamplingScaleImageView = viewRef.get();
if (context != null && decoderFactory != null && subsamplingScaleImageView != null) {
bitmap = decoderFactory.make().decode(context, source);
return subsamplingScaleImageView.getExifOrientation(sourceUri);
}
} catch (Exception e) {
Log.e(TAG, "Failed to load bitmap", e);
this.exception = e;
}
return null;
}
@Override
protected void onPostExecute(Integer orientation) {
SubsamplingScaleImageView subsamplingScaleImageView = viewRef.get();
if (subsamplingScaleImageView != null) {
if (bitmap != null && orientation != null) {
if (preview) {
subsamplingScaleImageView.onPreviewLoaded(bitmap);
} else {
subsamplingScaleImageView.onImageLoaded(bitmap, orientation, false);
}
} else if (exception != null && subsamplingScaleImageView.onImageEventListener != null) {
if (preview) {
subsamplingScaleImageView.onImageEventListener.onPreviewLoadError(exception);
} else {
subsamplingScaleImageView.onImageEventListener.onImageLoadError(exception);
}
}
}
}
}
/**
* Called by worker task when preview image is loaded.
*/
private synchronized void onPreviewLoaded(Bitmap previewBitmap) {
if (bitmap != null || imageLoadedSent) {
previewBitmap.recycle();
return;
}
if (pRegion != null) {
bitmap = Bitmap.createBitmap(previewBitmap, pRegion.left, pRegion.top, pRegion.width(), pRegion.height());
} else {
bitmap = previewBitmap;
}
bitmapIsPreview = true;
if (checkReady()) {
invalidate();
requestLayout();
}
}
/**
* Called by worker task when full size image bitmap is ready (tiling is disabled).
*/
private synchronized void onImageLoaded(Bitmap bitmap, int sOrientation, boolean bitmapIsCached) {
// If actual dimensions don't match the declared size, reset everything.
if (this.sWidth > 0 && this.sHeight > 0 && (this.sWidth != bitmap.getWidth() || this.sHeight != bitmap.getHeight())) {
reset(false);
}
if (this.bitmap != null && !this.bitmapIsCached) {
this.bitmap.recycle();
}
this.bitmapIsPreview = false;
this.bitmapIsCached = bitmapIsCached;
this.bitmap = bitmap;
this.sWidth = bitmap.getWidth();
this.sHeight = bitmap.getHeight();
this.sOrientation = sOrientation;
boolean ready = checkReady();
boolean imageLoaded = checkImageLoaded();
if (ready || imageLoaded) {
invalidate();
requestLayout();
}
}
/**
* Helper method for load tasks. Examines the EXIF info on the image file to determine the orientation.
* This will only work for external files, not assets, resources or other URIs.
*/
private int getExifOrientation(String sourceUri) {
int exifOrientation = ORIENTATION_0;
if (sourceUri.startsWith(ContentResolver.SCHEME_CONTENT)) {
try {
final String[] columns = {MediaStore.Images.Media.ORIENTATION};
final Cursor cursor = getContext().getContentResolver().query(Uri.parse(sourceUri), columns, null, null, null);
if (cursor != null) {
if (cursor.moveToFirst()) {
int orientation = cursor.getInt(0);
if (VALID_ORIENTATIONS.contains(orientation) && orientation != ORIENTATION_USE_EXIF) {
exifOrientation = orientation;
} else {
Log.w(TAG, "Unsupported orientation: " + orientation);
}
}
cursor.close();
}
} catch (Exception e) {
Log.w(TAG, "Could not get orientation of image from media store");
}
} else if (sourceUri.startsWith(ImageSource.FILE_SCHEME) && !sourceUri.startsWith(ImageSource.ASSET_SCHEME)) {
try {
ExifInterface exifInterface = new ExifInterface(sourceUri.substring(ImageSource.FILE_SCHEME.length() - 1));
int orientationAttr = exifInterface.getAttributeInt(ExifInterface.TAG_ORIENTATION, ExifInterface.ORIENTATION_NORMAL);
if (orientationAttr == ExifInterface.ORIENTATION_NORMAL || orientationAttr == ExifInterface.ORIENTATION_UNDEFINED) {
exifOrientation = ORIENTATION_0;
} else if (orientationAttr == ExifInterface.ORIENTATION_ROTATE_90) {
exifOrientation = ORIENTATION_90;
} else if (orientationAttr == ExifInterface.ORIENTATION_ROTATE_180) {
exifOrientation = ORIENTATION_180;
} else if (orientationAttr == ExifInterface.ORIENTATION_ROTATE_270) {
exifOrientation = ORIENTATION_270;
} else {
Log.w(TAG, "Unsupported EXIF orientation: " + orientationAttr);
}
} catch (Exception e) {
Log.w(TAG, "Could not get EXIF orientation of image");
}
}
return exifOrientation;
}
private void execute(AsyncTask<Void, Void, ?> asyncTask) {
if (parallelLoadingEnabled && VERSION.SDK_INT >= 11) {
try {
Field executorField = AsyncTask.class.getField("THREAD_POOL_EXECUTOR");
Executor executor = (Executor) executorField.get(null);
Method executeMethod = AsyncTask.class.getMethod("executeOnExecutor", new Class[]{Executor.class, Object[].class});
executeMethod.invoke(asyncTask, executor, null);
return;
} catch (Exception e) {
Log.i(TAG, "Failed to execute AsyncTask on thread pool executor, falling back to single threaded executor", e);
}
}
asyncTask.execute();
}
private static class Tile {
private Rect sRect;
private int sampleSize;
private Bitmap bitmap;
private boolean loading;
private boolean visible;
// Volatile fields instantiated once then updated before use to reduce GC.
private Rect vRect;
private Rect fileSRect;
}
private static class Anim {
private float scaleStart; // Scale at start of anim
private float scaleEnd; // Scale at end of anim (target)
private PointF sCenterStart; // Source center point at start
private PointF sCenterEnd; // Source center point at end, adjusted for pan limits
private PointF sCenterEndRequested; // Source center point that was requested, without adjustment
private PointF vFocusStart; // View point that was double tapped
private PointF vFocusEnd; // Where the view focal point should be moved to during the anim
private long duration = 500; // How long the anim takes
private boolean interruptible = true; // Whether the anim can be interrupted by a touch
private int easing = EASE_IN_OUT_QUAD; // Easing style
private long time = System.currentTimeMillis(); // Start time
private OnAnimationEventListener listener; // Event listener
}
protected static class ScaleAndTranslate {
private ScaleAndTranslate(float scale, PointF vTranslate) {
this.scale = scale;
this.vTranslate = vTranslate;
}
public float scale;
public PointF vTranslate;
}
/**
* Set scale, center and orientation from saved state.
*/
private void restoreState(ImageViewState state) {
if (state != null && state.getCenter() != null && VALID_ORIENTATIONS.contains(state.getOrientation())) {
this.orientation = state.getOrientation();
this.pendingScale = state.getScale();
this.sPendingCenter = state.getCenter();
invalidate();
}
}
/**
* In SDK 14 and above, use canvas max bitmap width and height instead of the default 2048, to avoid redundant tiling.
*/
private Point getMaxBitmapDimensions(Canvas canvas) {
if (VERSION.SDK_INT >= 14) {
try {
int maxWidth = (Integer) Canvas.class.getMethod("getMaximumBitmapWidth").invoke(canvas);
int maxHeight = (Integer) Canvas.class.getMethod("getMaximumBitmapHeight").invoke(canvas);
return new Point(maxWidth, maxHeight);
} catch (Exception e) {
// Return default
}
}
return new Point(2048, 2048);
}
/**
* Get source width taking rotation into account.
*/
@SuppressWarnings("SuspiciousNameCombination")
protected int sWidth() {
int rotation = getRequiredRotation();
if (rotation == 90 || rotation == 270) {
return sHeight;
} else {
return sWidth;
}
}
/**
* Get source height taking rotation into account.
*/
@SuppressWarnings("SuspiciousNameCombination")
protected int sHeight() {
int rotation = getRequiredRotation();
if (rotation == 90 || rotation == 270) {
return sWidth;
} else {
return sHeight;
}
}
/**
* Converts source rectangle from tile, which treats the image file as if it were in the correct orientation already,
* to the rectangle of the image that needs to be loaded.
*/
@SuppressWarnings("SuspiciousNameCombination")
private void fileSRect(Rect sRect, Rect target) {
if (getRequiredRotation() == 0) {
target.set(sRect);
} else if (getRequiredRotation() == 90) {
target.set(sRect.top, sHeight - sRect.right, sRect.bottom, sHeight - sRect.left);
} else if (getRequiredRotation() == 180) {
target.set(sWidth - sRect.right, sHeight - sRect.bottom, sWidth - sRect.left, sHeight - sRect.top);
} else {
target.set(sWidth - sRect.bottom, sRect.left, sWidth - sRect.top, sRect.right);
}
}
/**
* Determines the rotation to be applied to tiles, based on EXIF orientation or chosen setting.
*/
private int getRequiredRotation() {
if (orientation == ORIENTATION_USE_EXIF) {
return sOrientation;
} else {
return orientation;
}
}
/**
* Pythagoras distance between two points.
*/
private float distance(float x0, float x1, float y0, float y1) {
float x = x0 - x1;
float y = y0 - y1;
return (float) Math.sqrt(x * x + y * y);
}
/**
* Releases all resources the view is using and resets the state, nulling any fields that use significant memory.
* After you have called this method, the view can be re-used by setting a new image. Settings are remembered
* but state (scale and center) is forgotten. You can restore these yourself if required.
*/
public void recycle() {
reset(true);
bitmapPaint = null;
debugPaint = null;
tileBgPaint = null;
}
/**
* Convert screen to source x coordinate.
*/
private float viewToSourceX(float vx) {
if (vTranslate == null) {
return Float.NaN;
}
return (vx - vTranslate.x) / scale;
}
/**
* Convert screen to source y coordinate.
*/
private float viewToSourceY(float vy) {
if (vTranslate == null) {
return Float.NaN;
}
return (vy - vTranslate.y) / scale;
}
/**
* Convert screen coordinate to source coordinate.
*/
public final PointF viewToSourceCoord(PointF vxy) {
return viewToSourceCoord(vxy.x, vxy.y, new PointF());
}
/**
* Convert screen coordinate to source coordinate.
*/
public final PointF viewToSourceCoord(float vx, float vy) {
return viewToSourceCoord(vx, vy, new PointF());
}
/**
* Convert screen coordinate to source coordinate.
*/
public final PointF viewToSourceCoord(PointF vxy, PointF sTarget) {
return viewToSourceCoord(vxy.x, vxy.y, sTarget);
}
/**
* Convert screen coordinate to source coordinate.
*/
public final PointF viewToSourceCoord(float vx, float vy, PointF sTarget) {
if (vTranslate == null) {
return null;
}
sTarget.set(viewToSourceX(vx), viewToSourceY(vy));
return sTarget;
}
/**
* Convert source to screen x coordinate.
*/
private float sourceToViewX(float sx) {
if (vTranslate == null) {
return Float.NaN;
}
return (sx * scale) + vTranslate.x;
}
/**
* Convert source to screen y coordinate.
*/
private float sourceToViewY(float sy) {
if (vTranslate == null) {
return Float.NaN;
}
return (sy * scale) + vTranslate.y;
}
/**
* Convert source coordinate to screen coordinate.
*/
public final PointF sourceToViewCoord(PointF sxy) {
return sourceToViewCoord(sxy.x, sxy.y, new PointF());
}
/**
* Convert source coordinate to screen coordinate.
*/
public final PointF sourceToViewCoord(float sx, float sy) {
return sourceToViewCoord(sx, sy, new PointF());
}
/**
* Convert source coordinate to screen coordinate.
*/
public final PointF sourceToViewCoord(PointF sxy, PointF vTarget) {
return sourceToViewCoord(sxy.x, sxy.y, vTarget);
}
/**
* Convert source coordinate to screen coordinate.
*/
public final PointF sourceToViewCoord(float sx, float sy, PointF vTarget) {
if (vTranslate == null) {
return null;
}
vTarget.set(sourceToViewX(sx), sourceToViewY(sy));
return vTarget;
}
/**
* Convert source rect to screen rect, integer values.
*/
private Rect sourceToViewRect(Rect sRect, Rect vTarget) {
vTarget.set(
(int) sourceToViewX(sRect.left),
(int) sourceToViewY(sRect.top),
(int) sourceToViewX(sRect.right),
(int) sourceToViewY(sRect.bottom)
);
return vTarget;
}
/**
* Get the translation required to place a given source coordinate at the center of the screen, with the center
* adjusted for asymmetric padding. Accepts the desired scale as an argument, so this is independent of current
* translate and scale. The result is fitted to bounds, putting the image point as near to the screen center as permitted.
*/
private PointF vTranslateForSCenter(float sCenterX, float sCenterY, float scale) {
int vxCenter = getPaddingLeft() + (getWidth() - getPaddingRight() - getPaddingLeft()) / 2;
int vyCenter = getPaddingTop() + (getHeight() - getPaddingBottom() - getPaddingTop()) / 2;
if (satTemp == null) {
satTemp = new ScaleAndTranslate(0, new PointF(0, 0));
}
satTemp.scale = scale;
satTemp.vTranslate.set(vxCenter - (sCenterX * scale), vyCenter - (sCenterY * scale));
fitToBounds(true, satTemp);
return satTemp.vTranslate;
}
/**
* Given a requested source center and scale, calculate what the actual center will have to be to keep the image in
* pan limits, keeping the requested center as near to the middle of the screen as allowed.
*/
private PointF limitedSCenter(float sCenterX, float sCenterY, float scale, PointF sTarget) {
PointF vTranslate = vTranslateForSCenter(sCenterX, sCenterY, scale);
int vxCenter = getPaddingLeft() + (getWidth() - getPaddingRight() - getPaddingLeft()) / 2;
int vyCenter = getPaddingTop() + (getHeight() - getPaddingBottom() - getPaddingTop()) / 2;
float sx = (vxCenter - vTranslate.x) / scale;
float sy = (vyCenter - vTranslate.y) / scale;
sTarget.set(sx, sy);
return sTarget;
}
/**
* Returns the minimum allowed scale.
*/
private float minScale() {
int vPadding = getPaddingBottom() + getPaddingTop();
int hPadding = getPaddingLeft() + getPaddingRight();
if (minimumScaleType == SCALE_TYPE_CENTER_CROP) {
return Math.max((getWidth() - hPadding) / (float) sWidth(), (getHeight() - vPadding) / (float) sHeight());
} else if (minimumScaleType == SCALE_TYPE_CUSTOM && minScale > 0) {
return minScale;
} else {
return Math.min((getWidth() - hPadding) / (float) sWidth(), (getHeight() - vPadding) / (float) sHeight());
}
}
/**
* Adjust a requested scale to be within the allowed limits.
*/
protected float limitedScale(float targetScale) {
targetScale = Math.max(minScale(), targetScale);
targetScale = Math.min(maxScale, targetScale);
return targetScale;
}
/**
* Apply a selected type of easing.
*
* @param type Easing type, from static fields
* @param time Elapsed time
* @param from Start value
* @param change Target value
* @param duration Anm duration
* @return Current value
*/
private float ease(int type, long time, float from, float change, long duration) {
switch (type) {
case EASE_IN_OUT_QUAD:
return easeInOutQuad(time, from, change, duration);
case EASE_OUT_QUAD:
return easeOutQuad(time, from, change, duration);
default:
throw new IllegalStateException("Unexpected easing type: " + type);
}
}
/**
* Quadratic easing for fling. With thanks to Robert Penner - http://gizma.com/easing/
*
* @param time Elapsed time
* @param from Start value
* @param change Target value
* @param duration Anm duration
* @return Current value
*/
private float easeOutQuad(long time, float from, float change, long duration) {
float progress = (float) time / (float) duration;
return -change * progress * (progress - 2) + from;
}
/**
* Quadratic easing for scale and center animations. With thanks to Robert Penner - http://gizma.com/easing/
*
* @param time Elapsed time
* @param from Start value
* @param change Target value
* @param duration Anm duration
* @return Current value
*/
private float easeInOutQuad(long time, float from, float change, long duration) {
float timeF = time / (duration / 2f);
if (timeF < 1) {
return (change / 2f * timeF * timeF) + from;
} else {
timeF--;
return (-change / 2f) * (timeF * (timeF - 2) - 1) + from;
}
}
/**
* Swap the default region decoder implementation for one of your own. You must do this before setting the image file or
* asset, and you cannot use a custom decoder when using layout XML to set an asset name. Your class must have a
* public default constructor.
*
* @param regionDecoderClass The {@link ImageRegionDecoder} implementation to use.
*/
public final void setRegionDecoderClass(Class<? extends ImageRegionDecoder> regionDecoderClass) {
if (regionDecoderClass == null) {
throw new IllegalArgumentException("Decoder class cannot be set to null");
}
this.regionDecoderFactory = new CompatDecoderFactory<ImageRegionDecoder>(regionDecoderClass);
}
/**
* Swap the default region decoder implementation for one of your own. You must do this before setting the image file or
* asset, and you cannot use a custom decoder when using layout XML to set an asset name.
*
* @param regionDecoderFactory The {@link DecoderFactory} implementation that produces {@link ImageRegionDecoder}
* instances.
*/
public final void setRegionDecoderFactory(DecoderFactory<? extends ImageRegionDecoder> regionDecoderFactory) {
if (regionDecoderFactory == null) {
throw new IllegalArgumentException("Decoder factory cannot be set to null");
}
this.regionDecoderFactory = regionDecoderFactory;
}
/**
* Swap the default bitmap decoder implementation for one of your own. You must do this before setting the image file or
* asset, and you cannot use a custom decoder when using layout XML to set an asset name. Your class must have a
* public default constructor.
*
* @param bitmapDecoderClass The {@link ImageDecoder} implementation to use.
*/
public final void setBitmapDecoderClass(Class<? extends ImageDecoder> bitmapDecoderClass) {
if (bitmapDecoderClass == null) {
throw new IllegalArgumentException("Decoder class cannot be set to null");
}
this.bitmapDecoderFactory = new CompatDecoderFactory<ImageDecoder>(bitmapDecoderClass);
}
/**
* Swap the default bitmap decoder implementation for one of your own. You must do this before setting the image file or
* asset, and you cannot use a custom decoder when using layout XML to set an asset name.
*
* @param bitmapDecoderFactory The {@link DecoderFactory} implementation that produces {@link ImageDecoder} instances.
*/
public final void setBitmapDecoderFactory(DecoderFactory<? extends ImageDecoder> bitmapDecoderFactory) {
if (bitmapDecoderFactory == null) {
throw new IllegalArgumentException("Decoder factory cannot be set to null");
}
this.bitmapDecoderFactory = bitmapDecoderFactory;
}
/**
* Set the pan limiting style. See static fields. Normally {@link #PAN_LIMIT_INSIDE} is best, for image galleries.
*/
public final void setPanLimit(int panLimit) {
if (!VALID_PAN_LIMITS.contains(panLimit)) {
throw new IllegalArgumentException("Invalid pan limit: " + panLimit);
}
this.panLimit = panLimit;
if (isReady()) {
fitToBounds(true);
invalidate();
}
}
/**
* Set the minimum scale type. See static fields. Normally {@link #SCALE_TYPE_CENTER_INSIDE} is best, for image galleries.
*/
public final void setMinimumScaleType(int scaleType) {
if (!VALID_SCALE_TYPES.contains(scaleType)) {
throw new IllegalArgumentException("Invalid scale type: " + scaleType);
}
this.minimumScaleType = scaleType;
if (isReady()) {
fitToBounds(true);
invalidate();
}
}
/**
* Set the maximum scale allowed. A value of 1 means 1:1 pixels at maximum scale. You may wish to set this according
* to screen density - on a retina screen, 1:1 may still be too small. Consider using {@link #setMinimumDpi(int)},
* which is density aware.
*/
public final void setMaxScale(float maxScale) {
this.maxScale = maxScale;
}
/**
* Set the minimum scale allowed. A value of 1 means 1:1 pixels at minimum scale. You may wish to set this according
* to screen density. Consider using {@link #setMaximumDpi(int)}, which is density aware.
*/
public final void setMinScale(float minScale) {
this.minScale = minScale;
}
/**
* This is a screen density aware alternative to {@link #setMaxScale(float)}; it allows you to express the maximum
* allowed scale in terms of the minimum pixel density. This avoids the problem of 1:1 scale still being
* too small on a high density screen. A sensible starting point is 160 - the default used by this view.
*
* @param dpi Source image pixel density at maximum zoom.
*/
public final void setMinimumDpi(int dpi) {
DisplayMetrics metrics = getResources().getDisplayMetrics();
float averageDpi = (metrics.xdpi + metrics.ydpi) / 2;
setMaxScale(averageDpi / dpi);
}
/**
* This is a screen density aware alternative to {@link #setMinScale(float)}; it allows you to express the minimum
* allowed scale in terms of the maximum pixel density.
*
* @param dpi Source image pixel density at minimum zoom.
*/
public final void setMaximumDpi(int dpi) {
DisplayMetrics metrics = getResources().getDisplayMetrics();
float averageDpi = (metrics.xdpi + metrics.ydpi) / 2;
setMinScale(averageDpi / dpi);
}
/**
* Returns the maximum allowed scale.
*/
public float getMaxScale() {
return maxScale;
}
/**
* Returns the minimum allowed scale.
*/
public final float getMinScale() {
return minScale();
}
/**
* By default, image tiles are at least as high resolution as the screen. For a retina screen this may not be
* necessary, and may increase the likelihood of an OutOfMemoryError. This method sets a DPI at which higher
* resolution tiles should be loaded. Using a lower number will on average use less memory but result in a lower
* quality image. 160-240dpi will usually be enough. This should be called before setting the image source,
* because it affects which tiles get loaded. When using an untiled source image this method has no effect.
*
* @param minimumTileDpi Tile loading threshold.
*/
public void setMinimumTileDpi(int minimumTileDpi) {
DisplayMetrics metrics = getResources().getDisplayMetrics();
float averageDpi = (metrics.xdpi + metrics.ydpi) / 2;
this.minimumTileDpi = (int) Math.min(averageDpi, minimumTileDpi);
if (isReady()) {
reset(false);
invalidate();
}
}
/**
* Returns the source point at the center of the view.
*/
public final PointF getCenter() {
int mX = getWidth() / 2;
int mY = getHeight() / 2;
return viewToSourceCoord(mX, mY);
}
/**
* Returns the current scale value.
*/
public final float getScale() {
return scale;
}
/**
* Externally change the scale and translation of the source image. This may be used with getCenter() and getScale()
* to restore the scale and zoom after a screen rotate.
*
* @param scale New scale to set.
* @param sCenter New source image coordinate to center on the screen, subject to boundaries.
*/
public final void setScaleAndCenter(float scale, PointF sCenter) {
this.anim = null;
this.pendingScale = scale;
this.sPendingCenter = sCenter;
this.sRequestedCenter = sCenter;
invalidate();
}
/**
* Fully zoom out and return the image to the middle of the screen. This might be useful if you have a view pager
* and want images to be reset when the user has moved to another page.
*/
public final void resetScaleAndCenter() {
this.anim = null;
this.pendingScale = limitedScale(0);
if (isReady()) {
this.sPendingCenter = new PointF(sWidth() / 2, sHeight() / 2);
} else {
this.sPendingCenter = new PointF(0, 0);
}
invalidate();
}
/**
* Call to find whether the view is initialised, has dimensions, and will display an image on
* the next draw. If a preview has been provided, it may be the preview that will be displayed
* and the full size image may still be loading. If no preview was provided, this is called once
* the base layer tiles of the full size image are loaded.
*/
public final boolean isReady() {
return readySent;
}
/**
* Called once when the view is initialised, has dimensions, and will display an image on the
* next draw. This is triggered at the same time as {@link OnImageEventListener#onReady()} but
* allows a subclass to receive this event without using a listener.
*/
protected void onReady() {
}
/**
* Call to find whether the main image (base layer tiles where relevant) have been loaded. Before
* this event the view is blank unless a preview was provided.
*/
public final boolean isImageLoaded() {
return imageLoadedSent;
}
/**
* Called once when the full size image or its base layer tiles have been loaded.
*/
protected void onImageLoaded() {
}
/**
* Get source width, ignoring orientation. If {@link #getOrientation()} returns 90 or 270, you can use {@link #getSHeight()}
* for the apparent width.
*/
public final int getSWidth() {
return sWidth;
}
/**
* Get source height, ignoring orientation. If {@link #getOrientation()} returns 90 or 270, you can use {@link #getSWidth()}
* for the apparent height.
*/
public final int getSHeight() {
return sHeight;
}
/**
* Returns the orientation setting. This can return {@link #ORIENTATION_USE_EXIF}, in which case it doesn't tell you
* the applied orientation of the image. For that, use {@link #getAppliedOrientation()}.
*/
public final int getOrientation() {
return orientation;
}
/**
* Returns the actual orientation of the image relative to the source file. This will be based on the source file's
* EXIF orientation if you're using ORIENTATION_USE_EXIF. Values are 0, 90, 180, 270.
*/
public final int getAppliedOrientation() {
return getRequiredRotation();
}
/**
* Get the current state of the view (scale, center, orientation) for restoration after rotate. Will return null if
* the view is not ready.
*/
public final ImageViewState getState() {
if (vTranslate != null && sWidth > 0 && sHeight > 0) {
return new ImageViewState(getScale(), getCenter(), getOrientation());
}
return null;
}
/**
* Returns true if zoom gesture detection is enabled.
*/
public final boolean isZoomEnabled() {
return zoomEnabled;
}
/**
* Enable or disable zoom gesture detection. Disabling zoom locks the the current scale.
*/
public final void setZoomEnabled(boolean zoomEnabled) {
this.zoomEnabled = zoomEnabled;
}
/**
* Returns true if double tap & swipe to zoom is enabled.
*/
public final boolean isQuickScaleEnabled() {
return quickScaleEnabled;
}
/**
* Enable or disable double tap & swipe to zoom.
*/
public final void setQuickScaleEnabled(boolean quickScaleEnabled) {
this.quickScaleEnabled = quickScaleEnabled;
}
/**
* Returns true if pan gesture detection is enabled.
*/
public final boolean isPanEnabled() {
return panEnabled;
}
/**
* Enable or disable pan gesture detection. Disabling pan causes the image to be centered.
*/
public final void setPanEnabled(boolean panEnabled) {
this.panEnabled = panEnabled;
if (!panEnabled && vTranslate != null) {
vTranslate.x = (getWidth() / 2) - (scale * (sWidth() / 2));
vTranslate.y = (getHeight() / 2) - (scale * (sHeight() / 2));
if (isReady()) {
refreshRequiredTiles(true);
invalidate();
}
}
}
/**
* Set a solid color to render behind tiles, useful for displaying transparent PNGs.
*
* @param tileBgColor Background color for tiles.
*/
public final void setTileBackgroundColor(int tileBgColor) {
if (Color.alpha(tileBgColor) == 0) {
tileBgPaint = null;
} else {
tileBgPaint = new Paint();
tileBgPaint.setStyle(Style.FILL);
tileBgPaint.setColor(tileBgColor);
}
invalidate();
}
/**
* Set the scale the image will zoom in to when double tapped. This also the scale point where a double tap is interpreted
* as a zoom out gesture - if the scale is greater than 90% of this value, a double tap zooms out. Avoid using values
* greater than the max zoom.
*
* @param doubleTapZoomScale New value for double tap gesture zoom scale.
*/
public final void setDoubleTapZoomScale(float doubleTapZoomScale) {
this.doubleTapZoomScale = doubleTapZoomScale;
}
/**
* A density aware alternative to {@link #setDoubleTapZoomScale(float)}; this allows you to express the scale the
* image will zoom in to when double tapped in terms of the image pixel density. Values lower than the max scale will
* be ignored. A sensible starting point is 160 - the default used by this view.
*
* @param dpi New value for double tap gesture zoom scale.
*/
public final void setDoubleTapZoomDpi(int dpi) {
DisplayMetrics metrics = getResources().getDisplayMetrics();
float averageDpi = (metrics.xdpi + metrics.ydpi) / 2;
setDoubleTapZoomScale(averageDpi / dpi);
}
/**
* Set the type of zoom animation to be used for double taps. See static fields.
*
* @param doubleTapZoomStyle New value for zoom style.
*/
public final void setDoubleTapZoomStyle(int doubleTapZoomStyle) {
if (!VALID_ZOOM_STYLES.contains(doubleTapZoomStyle)) {
throw new IllegalArgumentException("Invalid zoom style: " + doubleTapZoomStyle);
}
this.doubleTapZoomStyle = doubleTapZoomStyle;
}
/**
* Toggle parallel loading. When enabled, tiles are loaded using the thread pool executor available
* in SDK 11+. In older versions this has no effect. Parallel loading may use more memory and there
* is a possibility that it will make the tile loading unreliable, but it reduces the chances of
* an app's background processes blocking loading.
*
* @param parallelLoadingEnabled Whether to run AsyncTasks using a thread pool executor.
*/
public void setParallelLoadingEnabled(boolean parallelLoadingEnabled) {
this.parallelLoadingEnabled = parallelLoadingEnabled;
}
/**
* Enables visual debugging, showing tile boundaries and sizes.
*/
public final void setDebug(boolean debug) {
this.debug = debug;
}
/**
* {@inheritDoc}
*/
@Override
public void setOnLongClickListener(OnLongClickListener onLongClickListener) {
this.onLongClickListener = onLongClickListener;
}
/**
* Add a listener allowing notification of load and error events.
*/
public void setOnImageEventListener(OnImageEventListener onImageEventListener) {
this.onImageEventListener = onImageEventListener;
}
/**
* Creates a panning animation builder, that when started will animate the image to place the given coordinates of
* the image in the center of the screen. If doing this would move the image beyond the edges of the screen, the
* image is instead animated to move the center point as near to the center of the screen as is allowed - it's
* guaranteed to be on screen.
*
* @param sCenter Target center point
* @return {@link AnimationBuilder} instance. Call {@link AnimationBuilder#start()} to start the anim.
*/
public AnimationBuilder animateCenter(PointF sCenter) {
if (!isReady()) {
return null;
}
return new AnimationBuilder(sCenter);
}
/**
* Creates a scale animation builder, that when started will animate a zoom in or out. If this would move the image
* beyond the panning limits, the image is automatically panned during the animation.
*
* @param scale Target scale.
* @return {@link AnimationBuilder} instance. Call {@link AnimationBuilder#start()} to start the anim.
*/
public AnimationBuilder animateScale(float scale) {
if (!isReady()) {
return null;
}
return new AnimationBuilder(scale);
}
/**
* Creates a scale animation builder, that when started will animate a zoom in or out. If this would move the image
* beyond the panning limits, the image is automatically panned during the animation.
*
* @param scale Target scale.
* @return {@link AnimationBuilder} instance. Call {@link AnimationBuilder#start()} to start the anim.
*/
public AnimationBuilder animateScaleAndCenter(float scale, PointF sCenter) {
if (!isReady()) {
return null;
}
return new AnimationBuilder(scale, sCenter);
}
/**
* Builder class used to set additional options for a scale animation. Create an instance using {@link #animateScale(float)},
* then set your options and call {@link #start()}.
*/
public final class AnimationBuilder {
private final float targetScale;
private final PointF targetSCenter;
private final PointF vFocus;
private long duration = 500;
private int easing = EASE_IN_OUT_QUAD;
private boolean interruptible = true;
private boolean panLimited = true;
private OnAnimationEventListener listener;
private AnimationBuilder(PointF sCenter) {
this.targetScale = scale;
this.targetSCenter = sCenter;
this.vFocus = null;
}
private AnimationBuilder(float scale) {
this.targetScale = scale;
this.targetSCenter = getCenter();
this.vFocus = null;
}
private AnimationBuilder(float scale, PointF sCenter) {
this.targetScale = scale;
this.targetSCenter = sCenter;
this.vFocus = null;
}
private AnimationBuilder(float scale, PointF sCenter, PointF vFocus) {
this.targetScale = scale;
this.targetSCenter = sCenter;
this.vFocus = vFocus;
}
/**
* Desired duration of the anim in milliseconds. Default is 500.
*
* @param duration duration in milliseconds.
* @return this builder for method chaining.
*/
public AnimationBuilder withDuration(long duration) {
this.duration = duration;
return this;
}
/**
* Whether the animation can be interrupted with a touch. Default is true.
*
* @param interruptible interruptible flag.
* @return this builder for method chaining.
*/
public AnimationBuilder withInterruptible(boolean interruptible) {
this.interruptible = interruptible;
return this;
}
/**
* Set the easing style. See static fields. {@link #EASE_IN_OUT_QUAD} is recommended, and the default.
*
* @param easing easing style.
* @return this builder for method chaining.
*/
public AnimationBuilder withEasing(int easing) {
if (!VALID_EASING_STYLES.contains(easing)) {
throw new IllegalArgumentException("Unknown easing type: " + easing);
}
this.easing = easing;
return this;
}
/**
* Add an animation event listener.
*
* @param listener The listener.
* @return this builder for method chaining.
*/
public AnimationBuilder withOnAnimationEventListener(OnAnimationEventListener listener) {
this.listener = listener;
return this;
}
/**
* Only for internal use. When set to true, the animation proceeds towards the actual end point - the nearest
* point to the center allowed by pan limits. When false, animation is in the direction of the requested end
* point and is stopped when the limit for each axis is reached. The latter behaviour is used for flings but
* nothing else.
*/
private AnimationBuilder withPanLimited(boolean panLimited) {
this.panLimited = panLimited;
return this;
}
/**
* Starts the animation.
*/
public void start() {
if (anim != null && anim.listener != null) {
try {
anim.listener.onInterruptedByNewAnim();
} catch (Exception e) {
Log.w(TAG, "Error thrown by animation listener", e);
}
}
int vxCenter = getPaddingLeft() + (getWidth() - getPaddingRight() - getPaddingLeft()) / 2;
int vyCenter = getPaddingTop() + (getHeight() - getPaddingBottom() - getPaddingTop()) / 2;
float targetScale = limitedScale(this.targetScale);
PointF targetSCenter = panLimited ? limitedSCenter(this.targetSCenter.x, this.targetSCenter.y, targetScale, new PointF()) : this.targetSCenter;
anim = new Anim();
anim.scaleStart = scale;
anim.scaleEnd = targetScale;
anim.time = System.currentTimeMillis();
anim.sCenterEndRequested = targetSCenter;
anim.sCenterStart = getCenter();
anim.sCenterEnd = targetSCenter;
anim.vFocusStart = sourceToViewCoord(targetSCenter);
anim.vFocusEnd = new PointF(
vxCenter,
vyCenter
);
anim.duration = duration;
anim.interruptible = interruptible;
anim.easing = easing;
anim.time = System.currentTimeMillis();
anim.listener = listener;
if (vFocus != null) {
// Calculate where translation will be at the end of the anim
float vTranslateXEnd = vFocus.x - (targetScale * anim.sCenterStart.x);
float vTranslateYEnd = vFocus.y - (targetScale * anim.sCenterStart.y);
ScaleAndTranslate satEnd = new ScaleAndTranslate(targetScale, new PointF(vTranslateXEnd, vTranslateYEnd));
// Fit the end translation into bounds
fitToBounds(true, satEnd);
// Adjust the position of the focus point at end so image will be in bounds
anim.vFocusEnd = new PointF(
vFocus.x + (satEnd.vTranslate.x - vTranslateXEnd),
vFocus.y + (satEnd.vTranslate.y - vTranslateYEnd)
);
}
invalidate();
}
}
/**
* An event listener for animations, allows events to be triggered when an animation completes,
* is aborted by another animation starting, or is aborted by a touch event. Note that none of
* these events are triggered if the activity is paused, the image is swapped, or in other cases
* where the view's internal state gets wiped or draw events stop.
*/
public static interface OnAnimationEventListener {
/**
* The animation has completed, having reached its endpoint.
*/
void onComplete();
/**
* The animation has been aborted before reaching its endpoint because the user touched the screen.
*/
void onInterruptedByUser();
/**
* The animation has been aborted before reaching its endpoint because a new animation has been started.
*/
void onInterruptedByNewAnim();
}
/**
* Default implementation of {@link OnAnimationEventListener} for extension. This does nothing in any method.
*/
public static class DefaultOnAnimationEventListener implements OnAnimationEventListener {
@Override
public void onComplete() {
}
@Override
public void onInterruptedByUser() {
}
@Override
public void onInterruptedByNewAnim() {
}
}
/**
* An event listener, allowing subclasses and activities to be notified of significant events.
*/
public static interface OnImageEventListener {
/**
* Called when the dimensions of the image and view are known, and either a preview image,
* the full size image, or base layer tiles are loaded. This indicates the scale and translate
* are known and the next draw will display an image. This event can be used to hide a loading
* graphic, or inform a subclass that it is safe to draw overlays.
*/
void onReady();
/**
* Called when the full size image is ready. When using tiling, this means the lowest resolution
* base layer of tiles are loaded, and when tiling is disabled, the image bitmap is loaded.
* This event could be used as a trigger to enable gestures if you wanted interaction disabled
* while only a preview is displayed, otherwise for most cases {@link #onReady()} is the best
* event to listen to.
*/
void onImageLoaded();
/**
* Called when a preview image could not be loaded. This method cannot be relied upon; certain
* encoding types of supported image formats can result in corrupt or blank images being loaded
* and displayed with no detectable error. The view will continue to load the full size image.
*
* @param e The exception thrown. This error is logged by the view.
*/
void onPreviewLoadError(Exception e);
/**
* Indicates an error initiliasing the decoder when using a tiling, or when loading the full
* size bitmap when tiling is disabled. This method cannot be relied upon; certain encoding
* types of supported image formats can result in corrupt or blank images being loaded and
* displayed with no detectable error.
*
* @param e The exception thrown. This error is also logged by the view.
*/
void onImageLoadError(Exception e);
/**
* Called when an image tile could not be loaded. This method cannot be relied upon; certain
* encoding types of supported image formats can result in corrupt or blank images being loaded
* and displayed with no detectable error. Most cases where an unsupported file is used will
* result in an error caught by {@link #onImageLoadError(Exception)}.
*
* @param e The exception thrown. This error is logged by the view.
*/
void onTileLoadError(Exception e);
}
/**
* Default implementation of {@link OnImageEventListener} for extension. This does nothing in any method.
*/
public static class DefaultOnImageEventListener implements OnImageEventListener {
@Override
public void onReady() {
}
@Override
public void onImageLoaded() {
}
@Override
public void onPreviewLoadError(Exception e) {
}
@Override
public void onImageLoadError(Exception e) {
}
@Override
public void onTileLoadError(Exception e) {
}
}
}