Android Image Cropper

Powerful (Zoom, Rotation, Multi-Source), customizable (Shape, Limits, Style), optimized (Async, Sampling, Matrix) and simple image cropping library for Android.

Usage

For a working implementation, please have a look at the Sample Project

See GitHub Wiki for more info.

Include the library

compile 'com.theartofdev.edmodo:android-image-cropper:2.1.+'

Using Activity

2. Add CropImageActivity into your AndroidManifest.xml

<activity android:name="com.theartofdev.edmodo.cropper.CropImageActivity"/>

3. Start CropImageActivity using builder pattern from your activity

CropImage.activity(imageUri)
   .setGuidelines(CropImageView.Guidelines.ON)
   .start(this);

4. Override onActivityResult method in your activity to get crop result

@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
    if (requestCode == CropImage.CROP_IMAGE_ACTIVITY_REQUEST_CODE) {
        CropImage.ActivityResult result = CropImage.getActivityResult(data);
        if (resultCode == RESULT_OK) {
            Uri resultUri = result.getUri();
        } else if (resultCode == CropImage.CROP_IMAGE_ACTIVITY_RESULT_ERROR_CODE) {
            Exception error = result.getError();
        }
    }
}

Using View

2. Add CropImageView into your activity

<!-- Image Cropper fill the remaining available height -->
<com.theartofdev.edmodo.cropper.CropImageView
   xmlns:custom="http://schemas.android.com/apk/res-auto"
   android:id="@+id/cropImageView"
   android:layout_width="match_parent"
   android:layout_height="0dp"
   android:layout_weight="1"/>

3. Set image to crop

cropImageView.setImageBitmap(bitmap);
// or
cropImageView.setImageUriAsync(uri);

4. Get cropped image

Bitmap cropped = cropImageView.getCroppedImage();
// or (must subscribe to async event using cropImageView.setOnGetCroppedImageCompleteListener(listener))
cropImageView.getCroppedImageAsync();

Features

• Built-in CropImageActivity.
• Set cropping image as Bitmap, Resource or Android URI (Gallery, Camera, Dropbox, etc.).
• Image rotation during cropping.
• Auto zoom-in/out to relevant cropping area.
• Auto rotate bitmap by image Exif data.
• Set result image min/max limits in pixels.
• Set initial crop window size/location.
• Bitmap memory optimization.
• API Level 10.
• More..

Customizations

• Cropping window shape: Rectangular or Oval (cube/circle by fixing aspect ratio).
• Cropping window aspect ratio: Free, 1:1, 4:3, 16:9 or Custom.
• Guidelines appearance: Off / Always On / Show on Toch.
• Cropping window Border line, border corner and guidelines thickness and color.
• Cropping background color.

For more information, see the GitHub Wiki.

Posts

• Android cropping image from camera or gallery
• Android Image Cropper async support and custom progress UI
• Adding auto-zoom feature to Android-Image-Cropper

Change log

2.1.1

• Built-in CropImageActivity for quick start and common scenarios.
• Save cropped image to Uri API saveCroppedImageAsync(Uri).
• Handle possible out-of-memory in image load by down-sampling until succeed.
• Minor fixes.

2.0.1 (Beta)

• Fix counter clockwise rotation resulting in negative degrees (#54).

2.0.0 (Beta)

• Auto-zoom: zoom-in when crop window takes less than 50% of the image, zoom-out when more than 65%.
• Handle cropping of non-straight angles rotations for URI loaded images.
• Improve performance for image rotation.
• Improve performance for rotation due to exif orientation data.
• Improve performance for orientation change.
• Preserve crop window on rotations for straight angles - 90/180/270.
• Preserve crop window on orientation change.
• Handle max allowed texture size on device by down-sampling to be within the limit.
• API breaking changes:
• Renamed CropImageHelper to CropImage
• Removed getActualCropRect() and getActualCropRectNoRotation(), replaced by 'getCropPoints()' and 'getCropRect()'.
• Moved to custom CropImageView.ScaleType for 'setScaleType()'
• Removed CropShape from getCroppedImage API, added CropImage.toOvalBitmap.
• Known issues:
• Boundaries and orientation change for non-straight angle rotation of images.

See full change log.

License

Originally forked from edmodo/cropper.

Copyright 2016, Arthur Teplitzki, 2013, Edmodo, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or 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.