Sketch Image Loader

Sketch is a powerful and comprehensive image load library on Android, in addition to the basic functions, it also supports Jetpack Compose, GIF, SVG, video thumbnails, gesture zoom, huge images sampling, ExifInterface and other functions.
Sketch Android Jetpack ComposeGIFSVGExifInterface

Features/

• Support http, asset, content, android.resource and other URIs
• Support playing GIFs, WebP, HEIF and other animated image
• Support gesture zoom and large image sampling
• Supports download, conversion results, and memory L3 cache
• Support for correcting image orientation via Exif
• Supports Base64, video frames, SVG images
• Support for Jetpack Compose
• Supports automatic resizing of images according to the size of the view
• Supports loading only pictures to memory or downloading only pictures to disk
• Supports various useful features such as saving cellular data
• Support the extension of URI, cache, decoding, conversion, display, placeholder and other links
• Based on Kotlin and Kotlin coroutines

• httpassetcontentandroid.resource URI
• gifwebpheif
• Exif
• Base64SVG
• Jetpack Compose
• view
• URI
• Kotlin Kotlin

Import/

Published to mavenCentral mavenCentral

dependencies {
    implementation("io.github.panpf.sketch3:sketch:${LAST_VERSION}")
}

${LAST_VERSION}: (Not included 'v' 'v')

There are also optional modules to extend the functionality of sketch:
sketch

dependencies {
    // Support for Jetpack Compose
    //  Jetpack Compose
    implementation("io.github.panpf.sketch3:sketch-compose:${LAST_VERSION}")

    // Supports useful features such as download progress mask, pause loading during list swipe, save cellular traffic, image type corner marker, load apk file and installed app icon
    //  apk  app 
    implementation("io.github.panpf.sketch3:sketch-extensions:${LAST_VERSION}")

    // GifDrawable through Koral's android-gif-drawable library
    //  koral  android-gif-drawable  GifDrawable  gif 
    implementation("io.github.panpf.sketch3:sketch-gif-koral:${LAST_VERSION}")

    // GIF playback is achieved through Android's built-in Movie class
    //  Android  Movie  gif 
    implementation("io.github.panpf.sketch3:sketch-gif-movie:${LAST_VERSION}")

    // Support for OkHttp
    //  OkHttp
    implementation("io.github.panpf.sketch3:sketch-okhttp:${LAST_VERSION}")

    // SVG images are supported
    //  SVG 
    implementation("io.github.panpf.sketch3:sketch-svg:${LAST_VERSION}")

    // Video frames are read through Android's built-in MediaMetadataRetriever class
    //  Android  MediaMetadataRetriever 
    implementation("io.github.panpf.sketch3:sketch-video:${LAST_VERSION}")

    // Video frames are read through wseemann's FFmpegMediaMetadataRetriever library
    //  wseemann  FFmpegMediaMetadataRetriever 
    implementation("io.github.panpf.sketch3:sketch-video-ffmpeg:${LAST_VERSION}")

    // Supports gesture zoom and jumbo sampling
    // 
    implementation("io.github.panpf.sketch3:sketch-zoom:${LAST_VERSION}")
}

R8 / Proguard

Sketch doesn't need to configure any obfuscation rules itself, but you may need to add obfuscation configurations for indirectly dependent Kotlin Coroutines, OkHttp, Okio.
Sketch Kotlin Coroutines, OkHttp, Okio

Get started/

ImageView

Sketch provides a series of extended functions called displayImage for ImageView, which can easily display images
Sketch ImageView displayImage

// http
imageView.displayImage("https://www.sample.com/image.jpg")

// File
imageView.displayImage("/sdcard/download/image.jpg")

// asset
imageView.displayImage("asset://image.jpg")

// There is a lot more...

You can also configure parameters through a trailing lambda function:
lambda

imageView.displayImage("https://www.sample.com/image.jpg") {
    placeholder(R.drawable.placeholder)
    error(R.drawable.error)
    transformations(CircleCropTransformation())
    crossfade()
    // There is a lot more...
}

Jetpack Compose

Need import sketch-compose module sketch-compose

AsyncImage(
  imageUri = "https://www.sample.com/image.jpg",
  modifier = Modifier.size(300.dp, 200.dp),
  contentScale = ContentScale.Crop,
  contentDescription = ""
)

// config params
AsyncImage(
  rqeuest = DisplayRequest(LocalContext.current, "https://www.sample.com/image.jpg") {
    placeholder(R.drawable.placeholder)
    error(R.drawable.error)
    transformations(BlurTransformation())
    crossfade()
    // There is a lot more...
  },
  modifier = Modifier.size(300.dp, 200.dp),
  contentScale = ContentScale.Crop,
  contentDescription = ""
)

Document/

Basic features/

• Started/
• AnimatedImageGIFWEBPHEIF
• ResizeModify the image size/
• TransformationTransformation image/
• TransitionDisplay images in cool transitions/
• StateImagePlaceholder and error images/
• ListenerListen for request status and download progress/
• CacheLearn about downloads, results, memory caching/
• FetcherLearn about Fetcher and extend new URI types/ Fetcher URI
• DecoderLearn about Decoder and expand into new image types/ Decoder
• TargetApply the load results to the target/
• HttpStackLearn about the HTTP section and using okhttp/ http okhttp
• SVGDecode SVG still images/ SVG
• VideoFramesDecode video frames/
• ExifCorrect the image orientation/
• ImageOptionsManage image configurations in a unified manner/
• RequestInterceptorIntercept ImageRequest/ ImageRequest
• DecodeInterceptorIntercept Bitmap or Drawable decoding/ Bitmap Drawable
• BitmapPoolReuse Bitmap to reduce GC/ Bitmap GC
• DownloadRequestDownload the image to disk/
• LoadRequestLoad the image to get the Bitmap/ Bitmap
• Preload images into memory/
• Lifecycle
• Jetpack Compose

Featured features/

• SketchImageViewConfigure the request through XML attributes/ XML
• SketchZoomImageViewGesture zoom and large image sampling/
• Improve the clarity of long images in grid lists/
• Displays the download progress/
• Displays the image type corner/
• Pause image downloads on cellular data to save data/
• The list slides to pause the loading of images/
• Displays an icon for an apk file or installed app/ APK APP
• Log/

Changelog/

Please review the CHANGELOG.md file
CHANGELOG.md

About version 3.0/ 3.0

• The maven groupId was changed to 'io.github.panpf.sketch3', so version 2.* will not prompt for an upgrade
• The package name was changed to 'com.github.panpf.sketch' so it does not conflict with version 2.*
• Based on the kotlin coroutine rewrite, APIs and functions are all refactored as a new library
• There is no longer a requirement to use a SketchImageView, any ImageView and its subclasses will do, and any View can be supported in combination with a custom Target
• The Zoom function is split into independent modules that can be relied on separately, and the large image sampling function is refactored and supports multi-threaded decoding, which is faster
• The gif module now directly depends on the android-gif-drawable library, no longer modified twice, and can be upgraded by itself
• Support for Jetpack Compose
• Support for request and decode interceptors
• Referring to coil v2.2.0 and combining with the original functionality of sketch, there are the following differences compared to coil:
  • sketch supports a minimum of API 16, while coil supports only API 21
  • Sketch supports bitmap reuse, while coil does not
  • Sketch supports more granular resizing of images
  • sketch clearly distinguishes between display, load, and download requests
  • sketch provides image scaling and display components and supports large image sampling

• maven groupId io.github.panpf.sketch3 2.*
• com.github.panpf.sketch 2.*
• kotlin API
• SketchImageView ImageView Target View
• Zoom
• gif android-gif-drawable
• Jetpack Compose
• coil v2.2.0 sketch coil
• sketch API 16 coil API 21
• sketch bitmap coil
• sketch
• sketch
• sketch

Special thanks/

• coil-kt/coil: frameworkcompose
• bumptech/glide: BitmapPool
• chrisbanes/PhotoView: Zoom
• koral--/android-gif-drawable: gif-koral
• wseemann/FFmpegMediaMetadataRetriever: video-ffmpeg
• BigBadaboom/androidsvg: svg

License

Copyright (C) 2022 panpf <[email protected]>

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.

[comment]: <> (header)

[comment]: <> (wiki)

[comment]: <> (links)

[comment]: <> (footer)