[ { "path": ".github/ISSUE_TEMPLATE.md", "content": "We use GitHub Issues for bugs.\n\nIf you have a non-bug question, please ask on Stack Overflow: http://stackoverflow.com/questions/tagged/fresco\n\n--- Please use this template, and delete everything above this line before submitting your issue --- \n\n### Description\n\n[FILL THIS OUT: Explain what you did, what you expected to happen, and what actually happens.]\n\n### Reproduction\n\n[FILL THIS OUT: How can we reproduce the bug? Provide URLs to relevant images if possible, or a sample project.]\n\n### Solution\n\n[OPTIONAL: Do you know what needs to be done to address this issue? Ideally, provide a pull request which fixes this issue.]\n\n### Additional Information\n\n* Fresco version: [FILL THIS OUT]\n* Platform version: [FILL THIS OUT: specific to a particular Android version? Device?]\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "Thanks for submitting a PR! Please read these instructions carefully:\n\n- [ ] Explain the **motivation** for making this change.\n- [ ] Provide a **test plan** demonstrating that the code is solid.\n- [ ] Match the **code formatting** of the rest of the codebase.\n- [ ] Target the `main` branch\n\n## Motivation (required)\n\nWhat existing problem does the pull request solve?\n\n## Test Plan (required)\n\nA good test plan has the exact commands you ran and their output, provides screenshots or videos if the pull request changes UI or updates the website. See [What is a Test Plan?][1] to learn more. \n\nIf you have added code that should be tested, add tests.\n\n## Next Steps\n\nSign the [CLA][2], if you haven't already.\n\nSmall pull requests are much easier to review and more likely to get merged. Make sure the PR does only one thing, otherwise please split it.\n\nMake sure all **tests pass** on [Circle CI][4]. PRs that break tests are unlikely to be merged.\n\nFor more info, see the [Contributing guide][4].\n\n[1]: https://medium.com/@martinkonicek/what-is-a-test-plan-8bfc840ec171#.y9lcuqqi9\n[2]: https://code.facebook.com/cla\n[3]: http://circleci.com/gh/facebook/fresco\n[4]: https://github.com/facebook/fresco/blob/main/CONTRIBUTING.md\n" }, { "path": ".github/stale.yml", "content": "# Configuration for probot-stale - https://github.com/probot/stale\n# Number of days of inactivity before an issue becomes stale\ndaysUntilStale: 7\n# Number of days of inactivity before a stale issue is closed\ndaysUntilClose: 7\n# Issues with these labels will never be considered stale\nexemptLabels:\n - bug\n - enhancement\n - good first issue\n - help wanted\n - question\n# Label to use when marking an issue as stale\nstaleLabel: stale\n# Comment to post when marking an issue as stale. Set to `false` to disable\nmarkComment: >\n Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community's attention? This issue may be closed if no further activity occurs.\n You may also label this issue as \"bug\" or \"enhancement\" and I will leave it open.\n Thank you for your contributions.\n# Comment to post when closing a stale issue. Set to `false` to disable\ncloseComment: >\n Closing this issue after a prolonged period of inactivity. If this issue is still present in the latest release, please feel free to reopen with up-to-date information.\nonly: issues\n" }, { "path": ".github/workflows/build.yml", "content": "name: facebook/fresco/build\non:\n push:\n branches:\n - main\n pull_request:\n branches:\n - main\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n - name: Print pre-setup debug info\n run: ./ci/print-debug-info.sh\n - uses: nttld/setup-ndk@v1\n id: setup-ndk\n with:\n ndk-version: r27b\n - name: Install JDK\n uses: actions/setup-java@v5\n with:\n distribution: 'temurin'\n java-version: |\n 11\n 17\n cache: gradle\n - name: Print post-setup debug info\n run: |\n ./ci/print-debug-info.sh\n echo \"Printing Gradle Wrapper version\"\n ./gradlew --version\n env:\n ANDROID_NDK_HOME: ${{ steps.setup-ndk.outputs.ndk-path }}\n - name: Build & run tests\n run: ./ci/build-and-test.sh\n env:\n ANDROID_NDK_HOME: ${{ steps.setup-ndk.outputs.ndk-path }}\n - name: Copy Results\n run: |\n mkdir -p ./gh_actions/test-results/junit\n find . -type f -regex \".*/build/test-results/.*xml\" -exec cp {} ./gh_actions/test-results/junit \\;\n - uses: actions/upload-artifact@v6\n with:\n path: \"./gh_actions/test-results\"\n" }, { "path": ".github/workflows/gradle-wrapper-validation.yml", "content": "name: \"Validate Gradle Wrapper\"\non: [push, pull_request]\n\njobs:\n validation:\n name: \"Validation\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n - uses: gradle/actions/wrapper-validation@v3\n" }, { "path": ".github/workflows/release.yml", "content": "name: Publish\n\non:\n push:\n tags:\n - v*\n workflow_dispatch:\n inputs:\n tag:\n description: \"Tag to upload artifacts to\"\n required: false\n\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n - name: Install JDK\n uses: actions/setup-java@v5\n with:\n distribution: 'temurin'\n java-version: |\n 11\n 17\n cache: gradle\n - name: Setup Android SDK\n uses: android-actions/setup-android@v3\n - name: Install NDK\n id: setup-ndk\n uses: nttld/setup-ndk@v1\n with:\n ndk-version: r27b\n - name: Register NDK\n run: |\n echo $PATH\n echo 'ndk.path=/opt/hostedtoolcache/ndk/r27b/x64' >> local.properties\n - name: Write GPG Sec Ring\n run: echo '${{ secrets.GPG_KEY_CONTENTS }}' | base64 -d > /tmp/secring.gpg\n - name: Update gradle.properties\n run: echo -e \"signing.secretKeyRingFile=/tmp/secring.gpg\\nsigning.keyId=${{ secrets.SIGNING_KEY_ID }}\\nsigning.password=${{ secrets.SIGNING_PASSWORD }}\\nmavenCentralPassword=${{ secrets.SONATYPE_NEXUS_PASSWORD }}\\nmavenCentralUsername=${{ secrets.SONATYPE_NEXUS_USERNAME }}\" >> gradle.properties\n - name: Upload Android Archives\n run: ./gradlew publish --no-daemon --no-parallel --info --stacktrace\n env:\n ANDROID_NDK_HOME: ${{ steps.setup-ndk.outputs.ndk-path }}\n - name: Release and close\n run: ./gradlew closeAndReleaseRepository\n env:\n ANDROID_NDK_HOME: ${{ steps.setup-ndk.outputs.ndk-path }}\n - name: Clean secrets\n if: always()\n run: rm /tmp/secring.gpg\n" }, { "path": ".gitignore", "content": ".gradle\n.DS_Store\n.idea\nbuild/\nlocal.properties\nlocalhost/\nobj/\n*.iml\nGemfile.lock\n_site/\n\n# Kotlin 2.0\n# https://kotlinlang.org/docs/whatsnew20.html#new-directory-for-kotlin-data-in-gradle-projects\n.kotlin\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to make participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, sex characteristics, gender identity and expression,\nlevel of experience, education, socio-economic status, nationality, personal\nappearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or\n advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic\n address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies within all project spaces, and it also applies when\nan individual is representing the project or its community in public spaces.\nExamples of representing a project or community include using an official\nproject e-mail address, posting via an official social media account, or acting\nas an appointed representative at an online or offline event. Representation of\na project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at . All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see\nhttps://www.contributor-covenant.org/faq\n\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing to Fresco\n\nWe want to make contributing to this project as easy and transparent as\npossible.\n\n## Security bugs\n\nFacebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a GitHub issue.\n\n## Pull Requests\n\nWe welcome pull requests.\n\n1. Fork the repo and create your branch from `main`.\n2. If you've added code that should be tested, add tests.\n3. If you've changed APIs, update the documentation. \n4. Make sure the test suite passes.\n5. Make sure your code passes lint.\n6. If you haven't already, complete the [Contributor License Agreement](https://code.facebook.com/cla) (\"CLA\").\n\n## Getting started\n\nIn Android Studio, choose `File > Open..`. and select the `fresco` folder.\n\n### Specify a path to the NDK\n\nFresco uses native code for a few features. To build Fresco you'll need to specify the path to the NDK.\n\nIn Android Studio, go to `File > Project Structure` and in the dialog set the `Android NDK location`. Android Studio stores the NDK location in to your `local.properties` file.\n\n### Run a sample app\n\nSelect the **Showcase** app and click run:\n\n![Running a sample Fresco app](https://cloud.githubusercontent.com/assets/346214/24415877/d48d894c-13da-11e7-8601-09627661de67.png)\n\nYou can use the drawer to select one of the demos:\n\n\"Fresco\n\nNow you can change any code in Fresco and see the changes in the app.\n\nHave fun hacking on Fresco! 😎\n\n## Testing your changes\n\nYou can check your code compiles using:\n\n```\ncd fresco\n./gradlew assembleDebug\n```\n\nYou can run tests locally using:\n\n```\ncd fresco\n./gradlew test\n```\n\nCircle CI will run the same tests and report on your pull request.\n\n## Contributor License Agreement (\"CLA\")\n\nIn order to accept your pull request, we need you to submit a CLA. You only need\nto do this once to work on any of Facebook's open source projects.\n\nComplete your CLA here: .\n\n## Our Development Process\n\nEach pull request is first submitted into Facebook's internal repositories by a\nFacebook team member. Once the commit has successfully passed Facebook's internal\ntest suite, it will be exported back out from Facebook's repository. We endeavour\nto do this as soon as possible for all commits.\n\n## Coding Style \n\n* 2 spaces for indentation rather than tabs\n* 100 character line length\n* Although officially archived, we still follow the practice of Oracle's \n[Coding Conventions for the Java Programming Language](http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html).\n\n## License\n\nBy contributing to Fresco, you agree that your contributions will be licensed\nunder its MIT license.\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) Meta Platforms, Inc. and affiliates.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "# Fresco\n\n\"Fresco\n\n[![Build Status](https://github.com/facebook/fresco/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/facebook/fresco/actions/workflows/build.yml?query=event%3Apush)\n[![License](https://img.shields.io/badge/license-MIT-brightgreen)](https://github.com/facebook/fresco/blob/main/LICENSE)\n\nFresco is a powerful system for displaying images in Android applications.\n\nFresco takes care of image loading and display, so you don't have to. It will load images from the network, local storage, or local resources, and display a placeholder until the image has arrived. It has two levels of cache; one in memory and another in internal storage.\n\nIn Android 4.x and lower, Fresco puts images in a special region of Android memory. This lets your application run faster - and suffer the dreaded `OutOfMemoryError` much less often.\n\nFresco also supports:\n\n* streaming of progressive JPEGs\n* display of animated GIFs and WebPs\n* extensive customization of image loading and display\n* and much more!\n\nFind out more at our [website](http://frescolib.org/index.html).\n\n## Requirements\n\nFresco can be included in any Android application.\n\nFresco supports Android 2.3 (Gingerbread) and later.\n\n## Using Fresco in your application\n\nIf you are building with Gradle, simply add the following line to the `dependencies` section of your `build.gradle` file:\n\n```groovy\nimplementation 'com.facebook.fresco:fresco:3.6.0'\n```\n\nFor full details, visit the documentation on our web site, available in English and Chinese:\n\n\n\n\n\n## Join the Fresco community\n\nPlease use our [issues page](https://github.com/facebook/fresco/issues) to let us know of any problems.\n\nFor pull requests, please see the [CONTRIBUTING](https://github.com/facebook/fresco/blob/main/CONTRIBUTING.md) file for information on how to help out. See our [documentation](http://frescolib.org/docs/building-from-source.html) for information on how to build from source.\n\n\n## License\nFresco is [MIT-licensed](https://github.com/facebook/fresco/blob/main/LICENSE).\n" }, { "path": "animated-base/.gitignore", "content": "nativedeps/\n" }, { "path": "animated-base/build.gradle", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nimport com.facebook.fresco.buildsrc.Deps\nimport com.facebook.fresco.buildsrc.GradleDeps\nimport com.facebook.fresco.buildsrc.TestDeps\n\napply plugin: 'com.android.library'\napply plugin: 'kotlin-android'\n\nkotlin {\n jvmToolchain(11)\n}\n\ndependencies {\n compileOnly Deps.inferAnnotation\n compileOnly Deps.javaxAnnotation\n compileOnly Deps.jsr305\n compileOnly Deps.AndroidX.androidxAnnotation\n\n api project(':fbcore')\n api project(':imagepipeline-base')\n api project(':imagepipeline')\n api project(':imagepipeline-native')\n api project(':memory-types:ashmem')\n api project(':memory-types:nativememory')\n api project(':memory-types:simple')\n api project(':animated-drawable')\n implementation Deps.Bolts.tasks\n implementation project(':vito:core')\n implementation project(':vito:options')\n implementation project(':middleware')\n\n testCompileOnly Deps.inferAnnotation\n testImplementation project(':imagepipeline-test')\n testImplementation project(':imagepipeline-base-test')\n testImplementation TestDeps.assertjCore\n testImplementation TestDeps.junit\n testImplementation TestDeps.festAssertCore\n testImplementation TestDeps.mockitoCore3\n testImplementation TestDeps.mockitoInline3\n testImplementation TestDeps.mockitoKotlin3\n testImplementation(TestDeps.robolectric) {\n exclude group: 'commons-logging', module: 'commons-logging'\n exclude group: 'org.apache.httpcomponents', module: 'httpclient'\n }\n}\n\nandroid {\n ndkVersion GradleDeps.Native.version\n\n buildToolsVersion FrescoConfig.buildToolsVersion\n compileSdkVersion FrescoConfig.compileSdkVersion\n\n namespace \"com.facebook.imagepipeline.animated\"\n\n defaultConfig {\n minSdkVersion FrescoConfig.minSdkVersion\n targetSdkVersion FrescoConfig.targetSdkVersion\n }\n lintOptions {\n abortOnError false\n }\n testOptions {\n unitTests.returnDefaultValues = true\n }\n}\n\napply plugin: \"com.vanniktech.maven.publish\"\n" }, { "path": "animated-base/gradle.properties", "content": "POM_NAME=AnimatedBase\nPOM_DESCRIPTION=Base classes for animation support\nPOM_ARTIFACT_ID=animated-base\nPOM_PACKAGING=aar\n\n" }, { "path": "animated-base/src/main/AndroidManifest.xml", "content": "\n\n\n" }, { "path": "animated-base/src/main/java/com/facebook/fresco/animation/bitmap/cache/AnimationFrameCacheKey.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.cache\n\nimport android.net.Uri\nimport com.facebook.cache.common.CacheKey\n\n/* Frame cache key for animation */\n\nclass AnimationFrameCacheKey\n@JvmOverloads\nconstructor(imageId: Int, private val deepEquals: Boolean = false) : CacheKey {\n\n private val animationUriString: String = URI_PREFIX + imageId\n\n override fun containsUri(uri: Uri): Boolean = uri.toString().startsWith(animationUriString)\n\n override fun getUriString(): String = animationUriString\n\n override fun isResourceIdForDebugging(): Boolean = false\n\n override fun equals(o: Any?): Boolean {\n if (!deepEquals) {\n return super.equals(o)\n }\n\n if (this === o) {\n return true\n }\n if (o == null || javaClass != o.javaClass) {\n return false\n }\n\n val that = o as AnimationFrameCacheKey\n return animationUriString == that.animationUriString\n }\n\n override fun hashCode(): Int {\n if (!deepEquals) {\n return super.hashCode()\n }\n return animationUriString.hashCode()\n }\n\n companion object {\n private const val URI_PREFIX = \"anim://\"\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/fresco/animation/bitmap/cache/FrescoFrameCache.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.cache\n\nimport android.graphics.Bitmap\nimport android.util.SparseArray\nimport androidx.annotation.VisibleForTesting\nimport com.facebook.common.logging.FLog\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.bitmap.BitmapAnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapAnimationBackend.FrameType\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache.FrameCacheListener\nimport com.facebook.imagepipeline.animated.impl.AnimatedFrameCache\nimport com.facebook.imagepipeline.image.CloseableBitmap\nimport com.facebook.imagepipeline.image.CloseableImage\nimport com.facebook.imagepipeline.image.CloseableStaticBitmap\nimport com.facebook.imagepipeline.image.ImmutableQualityInfo\nimport com.facebook.imageutils.BitmapUtil\nimport javax.annotation.concurrent.GuardedBy\n\n/** Bitmap frame cache that uses Fresco's [AnimatedFrameCache] to cache frames. */\nclass FrescoFrameCache(\n private val animatedFrameCache: AnimatedFrameCache,\n private val enableBitmapReusing: Boolean,\n) : BitmapFrameCache {\n\n @GuardedBy(\"this\")\n private val preparedPendingFrames = SparseArray?>()\n\n @GuardedBy(\"this\") private var lastRenderedItem: CloseableReference? = null\n\n @Synchronized\n override fun getCachedFrame(frameNumber: Int): CloseableReference? =\n convertToBitmapReferenceAndClose(animatedFrameCache[frameNumber])\n\n @Synchronized\n override fun getFallbackFrame(frameNumber: Int): CloseableReference? =\n convertToBitmapReferenceAndClose(CloseableReference.cloneOrNull(lastRenderedItem))\n\n @Synchronized\n override fun getBitmapToReuseForFrame(\n frameNumber: Int,\n width: Int,\n height: Int,\n ): CloseableReference? {\n if (!enableBitmapReusing) {\n return null\n }\n return convertToBitmapReferenceAndClose(animatedFrameCache.forReuse)\n }\n\n @Synchronized\n override fun contains(frameNumber: Int): Boolean = animatedFrameCache.contains(frameNumber)\n\n @get:Synchronized\n override val sizeInBytes: Int\n get() = // This currently does not include the size of the animated frame cache\n getBitmapSizeBytes(lastRenderedItem) + preparedPendingFramesSizeBytes\n\n @Synchronized\n override fun clear() {\n CloseableReference.closeSafely(lastRenderedItem)\n lastRenderedItem = null\n for (i in 0 until preparedPendingFrames.size()) {\n CloseableReference.closeSafely(preparedPendingFrames.valueAt(i))\n }\n preparedPendingFrames.clear()\n // The frame cache will free items when needed\n }\n\n @Synchronized\n override fun onFrameRendered(\n frameNumber: Int,\n bitmapReference: CloseableReference,\n @BitmapAnimationBackend.FrameType frameType: Int,\n ) {\n checkNotNull(bitmapReference)\n\n // Close up prepared references.\n removePreparedReference(frameNumber)\n\n // Create the new image reference and cache it.\n var closableReference: CloseableReference? = null\n try {\n closableReference = createImageReference(bitmapReference)\n if (closableReference != null) {\n CloseableReference.closeSafely(lastRenderedItem)\n lastRenderedItem = animatedFrameCache.cache(frameNumber, closableReference)\n }\n } finally {\n CloseableReference.closeSafely(closableReference)\n }\n }\n\n @Synchronized\n override fun onFramePrepared(\n frameNumber: Int,\n bitmapReference: CloseableReference,\n @BitmapAnimationBackend.FrameType frameType: Int,\n ) {\n checkNotNull(bitmapReference)\n var closableReference: CloseableReference? = null\n try {\n closableReference = createImageReference(bitmapReference)\n if (closableReference == null) {\n return\n }\n val newReference = animatedFrameCache.cache(frameNumber, closableReference)\n if (CloseableReference.isValid(newReference)) {\n val oldReference = preparedPendingFrames[frameNumber]\n CloseableReference.closeSafely(oldReference)\n // For performance reasons, we don't clone the reference and close the original one\n // but cache the reference directly.\n preparedPendingFrames.put(frameNumber, newReference)\n FLog.v(\n TAG,\n \"cachePreparedFrame(%d) cached. Pending frames: %s\",\n frameNumber,\n preparedPendingFrames,\n )\n }\n } finally {\n CloseableReference.closeSafely(closableReference)\n }\n }\n\n override fun setFrameCacheListener(frameCacheListener: FrameCacheListener?) {\n // TODO (t15557326) Not supported for now\n }\n\n @get:Synchronized\n private val preparedPendingFramesSizeBytes: Int\n get() {\n var size = 0\n for (i in 0 until preparedPendingFrames.size()) {\n size += getBitmapSizeBytes(preparedPendingFrames.valueAt(i))\n }\n return size\n }\n\n @Synchronized\n private fun removePreparedReference(frameNumber: Int) {\n val existingPendingReference = preparedPendingFrames[frameNumber]\n if (existingPendingReference != null) {\n preparedPendingFrames.delete(frameNumber)\n CloseableReference.closeSafely(existingPendingReference)\n FLog.v(\n TAG,\n \"removePreparedReference(%d) removed. Pending frames: %s\",\n frameNumber,\n preparedPendingFrames,\n )\n }\n }\n\n override fun onAnimationPrepared(frameBitmaps: Map>): Boolean =\n true\n\n override fun isAnimationReady(): Boolean = false\n\n companion object {\n private val TAG: Class<*> = FrescoFrameCache::class.java\n\n /**\n * Converts the given image reference to a bitmap reference and closes the original image\n * reference.\n *\n * @param closeableImage the image to convert. It will be closed afterwards and will be invalid\n * @return the closeable bitmap reference to be used\n */\n @JvmStatic\n @VisibleForTesting\n fun convertToBitmapReferenceAndClose(\n closeableImage: CloseableReference?\n ): CloseableReference? {\n try {\n if (\n CloseableReference.isValid(closeableImage) &&\n closeableImage!!.get() is CloseableStaticBitmap\n ) {\n val closeableStaticBitmap = closeableImage.get() as CloseableStaticBitmap\n if (closeableStaticBitmap != null) {\n // We return a clone of the underlying bitmap reference that has to be manually closed\n // and then close the passed CloseableStaticBitmap in order to preserve correct\n // cache size calculations.\n return closeableStaticBitmap.cloneUnderlyingBitmapReference()\n }\n }\n // Not a bitmap reference, so we return null\n return null\n } finally {\n CloseableReference.closeSafely(closeableImage)\n }\n }\n\n private fun getBitmapSizeBytes(imageReference: CloseableReference?): Int {\n if (!CloseableReference.isValid(imageReference)) {\n return 0\n }\n return getBitmapSizeBytes(imageReference!!.get())\n }\n\n private fun getBitmapSizeBytes(image: CloseableImage?): Int {\n if (image !is CloseableBitmap) {\n return 0\n }\n return BitmapUtil.getSizeInBytes(image.underlyingBitmap)\n }\n\n private fun createImageReference(\n bitmapReference: CloseableReference\n ): CloseableReference? {\n // The given CloseableStaticBitmap will be cached and then released by the resource releaser\n // of the closeable reference\n val closeableImage =\n CloseableStaticBitmap.of(bitmapReference, ImmutableQualityInfo.FULL_QUALITY, 0)\n return CloseableReference.of(closeableImage)\n }\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/fresco/animation/bitmap/wrapper/AnimatedDrawableBackendAnimationInformation.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.wrapper\n\nimport com.facebook.fresco.animation.backend.AnimationInformation\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend\n\n/** [AnimationInformation] that wraps an [AnimatedDrawableBackend]. */\nclass AnimatedDrawableBackendAnimationInformation(\n private val animatedDrawableBackend: AnimatedDrawableBackend\n) : AnimationInformation {\n\n override fun getFrameCount(): Int = animatedDrawableBackend.frameCount\n\n override fun getFrameDurationMs(frameNumber: Int): Int =\n animatedDrawableBackend.getDurationMsForFrame(frameNumber)\n\n override fun getLoopCount(): Int = animatedDrawableBackend.loopCount\n\n override fun getLoopDurationMs(): Int = animatedDrawableBackend.durationMs\n\n override fun width(): Int = animatedDrawableBackend.width\n\n override fun height(): Int = animatedDrawableBackend.height\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/fresco/animation/bitmap/wrapper/AnimatedDrawableBackendFrameRenderer.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.wrapper\n\nimport android.graphics.Bitmap\nimport android.graphics.Rect\nimport com.facebook.common.logging.FLog\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\nimport com.facebook.fresco.animation.bitmap.BitmapFrameRenderer\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend\nimport com.facebook.imagepipeline.animated.impl.AnimatedImageCompositor\nimport com.facebook.imagepipeline.animated.impl.AnimatedImageCompositor.Callback\n\n/** [BitmapFrameRenderer] that wraps around an [AnimatedDrawableBackend]. */\nclass AnimatedDrawableBackendFrameRenderer(\n private val bitmapFrameCache: BitmapFrameCache,\n private var animatedDrawableBackend: AnimatedDrawableBackend,\n private val isNewRenderImplementation: Boolean,\n) : BitmapFrameRenderer {\n\n private var animatedImageCompositor: AnimatedImageCompositor\n\n private val callback: AnimatedImageCompositor.Callback =\n object : AnimatedImageCompositor.Callback {\n override fun onIntermediateResult(frameNumber: Int, bitmap: Bitmap) {\n // We currently don't cache intermediate bitmaps here\n }\n\n override fun getCachedBitmap(frameNumber: Int): CloseableReference? =\n bitmapFrameCache.getCachedFrame(frameNumber)\n }\n\n override fun setBounds(bounds: Rect?) {\n val newBackend = animatedDrawableBackend.forNewBounds(bounds)\n if (newBackend !== animatedDrawableBackend) {\n animatedDrawableBackend = newBackend\n animatedImageCompositor =\n AnimatedImageCompositor(animatedDrawableBackend, isNewRenderImplementation, callback)\n }\n }\n\n override val intrinsicWidth: Int\n get() = animatedDrawableBackend.width\n\n override val intrinsicHeight: Int\n get() = animatedDrawableBackend.height\n\n init {\n animatedImageCompositor =\n AnimatedImageCompositor(\n this@AnimatedDrawableBackendFrameRenderer.animatedDrawableBackend,\n isNewRenderImplementation,\n callback,\n )\n }\n\n override fun renderFrame(frameNumber: Int, targetBitmap: Bitmap): Boolean {\n try {\n animatedImageCompositor.renderFrame(frameNumber, targetBitmap)\n } catch (exception: IllegalStateException) {\n FLog.e(TAG, exception, \"Rendering of frame unsuccessful. Frame number: %d\", frameNumber)\n return false\n }\n return true\n }\n\n companion object {\n private val TAG: Class<*> = AnimatedDrawableBackendFrameRenderer::class.java\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/fresco/animation/drawable/animator/AnimatedDrawableValueAnimatorHelper.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.drawable.animator\n\nimport android.animation.ValueAnimator\nimport android.animation.ValueAnimator.AnimatorUpdateListener\nimport android.graphics.drawable.Drawable\nimport com.facebook.fresco.animation.drawable.AnimatedDrawable2\nimport com.facebook.fresco.animation.drawable.animator.AnimatedDrawable2ValueAnimatorHelper.createValueAnimator\n\n/**\n * Helper class to create [ValueAnimator]s for animated drawables. Currently, this class only\n * supports API 11 (Honeycomb) and above.\n *\n * Supported drawable types: - [AnimatedDrawable2]\n */\nobject AnimatedDrawableValueAnimatorHelper {\n\n /**\n * Create a value animator for the given animation drawable and max animation duration in ms.\n *\n * @param drawable the drawable to create the animator for\n * @param maxDurationMs the max duration in ms\n * @return the animator to use\n */\n @JvmStatic\n fun createValueAnimator(drawable: Drawable?, maxDurationMs: Int): ValueAnimator? =\n if (drawable is AnimatedDrawable2) {\n AnimatedDrawable2ValueAnimatorHelper.createValueAnimator(\n checkNotNull((drawable as AnimatedDrawable2?)),\n maxDurationMs,\n )\n } else {\n null\n }\n\n /**\n * Create a value animator for the given animation drawable.\n *\n * @param drawable the drawable to create the animator for\n * @return the animator to use\n */\n @JvmStatic\n fun createValueAnimator(drawable: Drawable?): ValueAnimator? {\n if (drawable is AnimatedDrawable2) {\n val animatedDrawable2 = drawable\n return createValueAnimator(\n animatedDrawable2,\n animatedDrawable2.loopCount,\n animatedDrawable2.loopDurationMs,\n )\n }\n return null\n }\n\n /**\n * Create an animator update listener to be used to update the drawable to be animated.\n *\n * @param drawable the drawable to create the animator update listener for\n * @return the listener to use\n */\n @JvmStatic\n fun createAnimatorUpdateListener(drawable: Drawable?): AnimatorUpdateListener? =\n if (drawable is AnimatedDrawable2) {\n AnimatedDrawable2ValueAnimatorHelper.createAnimatorUpdateListener(\n checkNotNull((drawable as AnimatedDrawable2?))\n )\n } else {\n null\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/fresco/animation/factory/AnimatedFactoryV2Impl.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.factory\n\nimport android.content.Context\nimport android.graphics.Rect\nimport com.facebook.cache.common.CacheKey\nimport com.facebook.common.executors.DefaultSerialExecutorService\nimport com.facebook.common.executors.SerialExecutorService\nimport com.facebook.common.executors.UiThreadImmediateExecutorService\nimport com.facebook.common.internal.DoNotStrip\nimport com.facebook.common.internal.Supplier\nimport com.facebook.common.internal.Suppliers\nimport com.facebook.common.time.RealtimeSinceBootClock\nimport com.facebook.fresco.animation.bitmap.preparation.ondemandanimation.FrameLoaderListener\nimport com.facebook.fresco.animation.drawable.AnimatedDrawable2\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult\nimport com.facebook.imagepipeline.animated.factory.AnimatedFactory\nimport com.facebook.imagepipeline.animated.impl.AnimatedDrawableBackendImpl\nimport com.facebook.imagepipeline.animated.impl.AnimatedDrawableBackendProvider\nimport com.facebook.imagepipeline.animated.util.AnimatedDrawableUtil\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.cache.CountingMemoryCache\nimport com.facebook.imagepipeline.core.ExecutorSupplier\nimport com.facebook.imagepipeline.drawable.DrawableFactory\nimport com.facebook.imagepipeline.image.CloseableImage\nimport javax.annotation.concurrent.NotThreadSafe\n\n/**\n * [AnimatedFactory] implementation for animations v2 that creates [AnimatedDrawable2] drawables.\n *\n * This factory handles the creation of animated drawables for GIF and WebP formats. It manages the\n * backend providers and utilities needed for animation processing.\n */\n@NotThreadSafe\n@DoNotStrip\nclass AnimatedFactoryV2Impl\n@DoNotStrip\nconstructor(\n private val platformBitmapFactory: PlatformBitmapFactory,\n private val executorSupplier: ExecutorSupplier,\n private val backingCache: CountingMemoryCache,\n private val downscaleFrameToDrawableDimensions: Boolean,\n private val useBufferLoaderStrategy: Boolean,\n var animationFpsLimit: Int,\n var bufferLengthMilliseconds: Int,\n var serialExecutorService: SerialExecutorService?,\n private val enableBufferFrameLoaderFix: Boolean = false,\n private val frameLoaderListener: FrameLoaderListener? = null,\n private val enableSingleFrameRendering: Boolean = false,\n) : AnimatedFactory {\n\n private var animatedDrawableBackendProvider: AnimatedDrawableBackendProvider? = null\n private var animatedDrawableUtil: AnimatedDrawableUtil? = null\n private var animatedDrawableFactory: DrawableFactory? = null\n\n override fun getAnimatedDrawableFactory(context: Context?): DrawableFactory? {\n if (animatedDrawableFactory == null) {\n animatedDrawableFactory = createDrawableFactory()\n }\n return animatedDrawableFactory\n }\n\n private fun createDrawableFactory(): DefaultBitmapAnimationDrawableFactory {\n val cachingStrategySupplier: Supplier = Supplier {\n DefaultBitmapAnimationDrawableFactory.CACHING_STRATEGY_FRESCO_CACHE_NO_REUSING\n }\n\n val finalSerialExecutorService =\n serialExecutorService ?: DefaultSerialExecutorService(executorSupplier.forDecode())\n\n val numberOfFramesToPrepareSupplier: Supplier = Supplier { NUMBER_OF_FRAMES_TO_PREPARE }\n\n val useDeepEquals = Suppliers.BOOLEAN_FALSE\n\n return DefaultBitmapAnimationDrawableFactory(\n getAnimatedDrawableBackendProvider(),\n UiThreadImmediateExecutorService.getInstance(),\n finalSerialExecutorService,\n RealtimeSinceBootClock.get(),\n platformBitmapFactory,\n backingCache,\n cachingStrategySupplier,\n numberOfFramesToPrepareSupplier,\n useDeepEquals,\n Suppliers.of(useBufferLoaderStrategy),\n Suppliers.of(downscaleFrameToDrawableDimensions),\n Suppliers.of(animationFpsLimit),\n Suppliers.of(bufferLengthMilliseconds),\n null,\n enableBufferFrameLoaderFix,\n frameLoaderListener,\n enableSingleFrameRendering,\n )\n }\n\n private fun getAnimatedDrawableUtil(): AnimatedDrawableUtil {\n return animatedDrawableUtil ?: AnimatedDrawableUtil().also { animatedDrawableUtil = it }\n }\n\n private fun getAnimatedDrawableBackendProvider(): AnimatedDrawableBackendProvider {\n if (animatedDrawableBackendProvider == null) {\n animatedDrawableBackendProvider =\n object : AnimatedDrawableBackendProvider {\n override fun get(\n animatedImageResult: AnimatedImageResult,\n bounds: Rect?,\n ): AnimatedDrawableBackend {\n return AnimatedDrawableBackendImpl(\n getAnimatedDrawableUtil(),\n animatedImageResult,\n bounds,\n downscaleFrameToDrawableDimensions,\n )\n }\n }\n }\n return animatedDrawableBackendProvider as AnimatedDrawableBackendProvider\n }\n\n companion object {\n private const val NUMBER_OF_FRAMES_TO_PREPARE = 3\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/fresco/animation/factory/DefaultBitmapAnimationDrawableFactory.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.factory\n\nimport android.content.res.Resources\nimport android.graphics.Bitmap\nimport android.graphics.Rect\nimport android.graphics.drawable.Drawable\nimport com.facebook.cache.common.CacheKey\nimport com.facebook.common.internal.Preconditions\nimport com.facebook.common.internal.Supplier\nimport com.facebook.common.internal.Suppliers\nimport com.facebook.common.time.MonotonicClock\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.backend.AnimationBackendDelegateWithInactivityCheck\nimport com.facebook.fresco.animation.bitmap.BitmapAnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\nimport com.facebook.fresco.animation.bitmap.BitmapFrameRenderer\nimport com.facebook.fresco.animation.bitmap.cache.AnimationFrameCacheKey\nimport com.facebook.fresco.animation.bitmap.cache.FrescoFrameCache\nimport com.facebook.fresco.animation.bitmap.cache.KeepLastFrameCache\nimport com.facebook.fresco.animation.bitmap.cache.NoOpCache\nimport com.facebook.fresco.animation.bitmap.preparation.BitmapFramePreparationStrategy\nimport com.facebook.fresco.animation.bitmap.preparation.BitmapFramePreparer\nimport com.facebook.fresco.animation.bitmap.preparation.DefaultBitmapFramePreparer\nimport com.facebook.fresco.animation.bitmap.preparation.FixedNumberBitmapFramePreparationStrategy\nimport com.facebook.fresco.animation.bitmap.preparation.FrameLoaderStrategy\nimport com.facebook.fresco.animation.bitmap.preparation.ondemandanimation.FrameLoaderFactory\nimport com.facebook.fresco.animation.bitmap.preparation.ondemandanimation.FrameLoaderListener\nimport com.facebook.fresco.animation.bitmap.wrapper.AnimatedDrawableBackendAnimationInformation\nimport com.facebook.fresco.animation.bitmap.wrapper.AnimatedDrawableBackendFrameRenderer\nimport com.facebook.fresco.animation.drawable.AnimatedDrawable2\nimport com.facebook.fresco.animation.drawable.KAnimatedDrawable2\nimport com.facebook.fresco.middleware.HasExtraData\nimport com.facebook.fresco.vito.core.AnimatedImagePerfLoggingListener\nimport com.facebook.fresco.vito.options.ImageOptions\nimport com.facebook.fresco.vito.options.ImageOptionsDrawableFactory\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult\nimport com.facebook.imagepipeline.animated.impl.AnimatedDrawableBackendProvider\nimport com.facebook.imagepipeline.animated.impl.AnimatedFrameCache\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.cache.CountingMemoryCache\nimport com.facebook.imagepipeline.drawable.DrawableFactory\nimport com.facebook.imagepipeline.image.CloseableAnimatedImage\nimport com.facebook.imagepipeline.image.CloseableImage\nimport java.util.concurrent.ExecutorService\nimport java.util.concurrent.ScheduledExecutorService\n\n/** Animation factory for [AnimatedDrawable2]. */\nclass DefaultBitmapAnimationDrawableFactory(\n private val animatedDrawableBackendProvider: AnimatedDrawableBackendProvider,\n private val scheduledExecutorServiceForUiThread: ScheduledExecutorService,\n private val executorServiceForFramePreparing: ExecutorService,\n private val monotonicClock: MonotonicClock,\n private val platformBitmapFactory: PlatformBitmapFactory,\n private val backingCache: CountingMemoryCache?,\n private val cachingStrategySupplier: Supplier,\n private val numberOfFramesToPrepareSupplier: Supplier,\n private val useDeepEqualsForCacheKey: Supplier,\n private val useNewBitmapRender: Supplier,\n private val downscaleFrameToDrawableDimensions: Supplier,\n private val animationFpsLimit: Supplier,\n private val bufferLengthMilliseconds: Supplier,\n private val animatedImagePerfLoggingListener: AnimatedImagePerfLoggingListener? = null,\n private val enableBufferFrameLoaderFix: Boolean = false,\n private val frameLoaderListener: FrameLoaderListener? = null,\n private val enableSingleFrameRendering: Boolean = false,\n) : DrawableFactory, ImageOptionsDrawableFactory {\n\n // Change the value to true to use KAnimatedDrawable2.kt\n private val useRendererAnimatedDrawable: Supplier = Suppliers.BOOLEAN_FALSE\n\n override fun supportsImageType(image: CloseableImage): Boolean {\n return image is CloseableAnimatedImage\n }\n\n override fun createDrawable(image: CloseableImage): Drawable? {\n if (!supportsImageType(image)) {\n return null\n }\n val closeable = image as CloseableAnimatedImage\n val animatedImage = closeable.image\n\n val animationBackend =\n createAnimationBackend(\n Preconditions.checkNotNull(closeable.imageResult),\n animatedImage?.animatedBitmapConfig,\n null,\n )\n return if (useRendererAnimatedDrawable.get()) {\n KAnimatedDrawable2(animationBackend)\n } else {\n AnimatedDrawable2(animationBackend)\n }\n }\n\n override fun createDrawable(\n resources: Resources,\n closeableImage: CloseableImage,\n imageOptions: ImageOptions,\n ): Drawable? {\n if (!supportsImageType(closeableImage)) {\n return null\n }\n val closeable = closeableImage as CloseableAnimatedImage\n val animatedImage = closeable.image\n\n // Log drawable creation start\n val imageId =\n closeable.imageResult?.source ?: \"unknown_${System.identityHashCode(closeableImage)}\"\n val startTime = System.nanoTime()\n animatedImagePerfLoggingListener?.onDrawableCreationStart(imageId, startTime)\n\n val animationBackend: AnimationBackend =\n runCatching {\n createAnimationBackend(\n Preconditions.checkNotNull(closeable.imageResult),\n animatedImage?.animatedBitmapConfig,\n imageOptions,\n )\n }\n .getOrElse { e ->\n when (e) {\n is NullPointerException -> {\n val uri = closeableImage.getExtra(HasExtraData.KEY_URI_SOURCE)\n if (uri != null) {\n throw NullPointerException(\"${e.message} uri=${uri}\")\n } else {\n throw e\n }\n }\n else -> throw e\n }\n }\n\n val drawable =\n if (useRendererAnimatedDrawable.get()) {\n KAnimatedDrawable2(animationBackend)\n } else {\n AnimatedDrawable2(animationBackend)\n }\n\n // Log drawable creation success\n val endTime = System.nanoTime()\n animatedImagePerfLoggingListener?.onDrawableCreationEnd(imageId, endTime, true)\n\n return drawable\n }\n\n /**\n * Creates an animation backend for the given animated image result. * * @param\n * animatedImageResult The animated image result to create a backend for\n *\n * @param animatedBitmapConfig Optional bitmap configuration for the animation\n * @param imageOptions Optional image options for customizing the animation\n * @return An animation backend for the given parameters\n */\n private fun createAnimationBackend(\n animatedImageResult: AnimatedImageResult,\n animatedBitmapConfig: Bitmap.Config?,\n imageOptions: ImageOptions?,\n ): AnimationBackend {\n val animatedDrawableBackend = createAnimatedDrawableBackend(animatedImageResult)\n val animationInfo = AnimatedDrawableBackendAnimationInformation(animatedDrawableBackend)\n\n val bitmapFrameCache = createBitmapFrameCache(animatedImageResult)\n val bitmapFrameRenderer =\n AnimatedDrawableBackendFrameRenderer(\n bitmapFrameCache,\n animatedDrawableBackend,\n useNewBitmapRender.get(),\n )\n\n val numberOfFramesToPrefetch = numberOfFramesToPrepareSupplier.get()\n var bitmapFramePreparationStrategy: BitmapFramePreparationStrategy? = null\n var bitmapFramePreparer: BitmapFramePreparer? = null\n if (numberOfFramesToPrefetch > 0) {\n bitmapFramePreparationStrategy =\n FixedNumberBitmapFramePreparationStrategy(numberOfFramesToPrefetch)\n bitmapFramePreparer = createBitmapFramePreparer(bitmapFrameRenderer, animatedBitmapConfig)\n }\n\n val roundingOptions = imageOptions?.roundingOptions\n\n val animatedOptions = imageOptions?.animatedOptions\n\n if (useNewBitmapRender.get()) {\n bitmapFramePreparationStrategy =\n FrameLoaderStrategy(\n animatedImageResult.source,\n animationInfo,\n bitmapFrameRenderer,\n FrameLoaderFactory(\n platformBitmapFactory,\n animationFpsLimit.get(),\n bufferLengthMilliseconds.get(),\n enableBufferFrameLoaderFix,\n frameLoaderListener,\n enableSingleFrameRendering,\n ),\n downscaleFrameToDrawableDimensions.get(),\n )\n }\n\n val bitmapAnimationBackend =\n BitmapAnimationBackend(\n platformBitmapFactory,\n bitmapFrameCache,\n animationInfo,\n bitmapFrameRenderer,\n useNewBitmapRender.get(),\n bitmapFramePreparationStrategy,\n bitmapFramePreparer,\n roundingOptions,\n animatedOptions,\n )\n\n // Set the animated image performance logging listener\n bitmapAnimationBackend.setAnimatedImagePerfLoggingListener(animatedImagePerfLoggingListener)\n\n return AnimationBackendDelegateWithInactivityCheck.createForBackend(\n bitmapAnimationBackend,\n monotonicClock,\n scheduledExecutorServiceForUiThread,\n )\n }\n\n private fun createBitmapFramePreparer(\n bitmapFrameRenderer: BitmapFrameRenderer,\n animatedBitmapConfig: Bitmap.Config?,\n ): BitmapFramePreparer {\n return DefaultBitmapFramePreparer(\n platformBitmapFactory,\n bitmapFrameRenderer,\n animatedBitmapConfig ?: Bitmap.Config.ARGB_8888,\n executorServiceForFramePreparing,\n )\n }\n\n private fun createAnimatedDrawableBackend(\n animatedImageResult: AnimatedImageResult\n ): AnimatedDrawableBackend {\n val animatedImage = animatedImageResult.image\n val initialBounds = Rect(0, 0, animatedImage.width, animatedImage.height)\n return animatedDrawableBackendProvider.get(animatedImageResult, initialBounds)\n }\n\n private fun createBitmapFrameCache(animatedImageResult: AnimatedImageResult): BitmapFrameCache {\n return when (cachingStrategySupplier.get()) {\n CACHING_STRATEGY_FRESCO_CACHE ->\n FrescoFrameCache(createAnimatedFrameCache(animatedImageResult), true)\n CACHING_STRATEGY_FRESCO_CACHE_NO_REUSING ->\n FrescoFrameCache(createAnimatedFrameCache(animatedImageResult), false)\n CACHING_STRATEGY_KEEP_LAST_CACHE -> KeepLastFrameCache()\n CACHING_STRATEGY_NO_CACHE -> NoOpCache()\n else -> NoOpCache()\n }\n }\n\n private fun createAnimatedFrameCache(\n animatedImageResult: AnimatedImageResult\n ): AnimatedFrameCache {\n return AnimatedFrameCache(\n AnimationFrameCacheKey(animatedImageResult.hashCode(), useDeepEqualsForCacheKey.get()),\n backingCache ?: throw IllegalStateException(\"backingCache is null\"),\n )\n }\n\n companion object {\n const val CACHING_STRATEGY_NO_CACHE = 0\n const val CACHING_STRATEGY_FRESCO_CACHE = 1\n const val CACHING_STRATEGY_FRESCO_CACHE_NO_REUSING = 2\n const val CACHING_STRATEGY_KEEP_LAST_CACHE = 3\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/base/AnimatedDrawableBackend.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.base;\n\nimport android.graphics.Bitmap;\nimport android.graphics.Canvas;\nimport android.graphics.Rect;\nimport com.facebook.common.references.CloseableReference;\nimport com.facebook.infer.annotation.Nullsafe;\nimport javax.annotation.Nullable;\n\n/**\n * Interface that {@link com.facebook.fresco.animation.drawable.BaseAnimatedDrawable} uses that\n * abstracts out the image format.\n */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic interface AnimatedDrawableBackend {\n\n /**\n * Gets the original result of the decode.\n *\n * @return the original result of the code\n */\n AnimatedImageResult getAnimatedImageResult();\n\n /**\n * Gets the duration of the animation.\n *\n * @return the duration of the animation in milliseconds\n */\n int getDurationMs();\n\n /**\n * Gets the number of frames in the animation.\n *\n * @return the number of frames in the animation\n */\n int getFrameCount();\n\n /**\n * Gets the number of loops to run the animation for.\n *\n * @return the number of loops, or 0 to indicate infinite\n */\n int getLoopCount();\n\n /**\n * Gets the width of the image.\n *\n * @return the width of the image\n */\n int getWidth();\n\n /**\n * Gets the height of the image.\n *\n * @return the height of the image\n */\n int getHeight();\n\n /**\n * Gets the rendered width of the image. This may be smaller than the underlying image width if\n * the image is being rendered to a small bounds or to reduce memory requirements.\n *\n * @return the rendered width of the image\n */\n int getRenderedWidth();\n\n /**\n * Gets the rendered height of the image. This may be smaller than the underlying image height if\n * the image is being rendered to a small bounds or to reduce memory requirements.\n *\n * @return the rendered height of the image\n */\n int getRenderedHeight();\n\n /**\n * Gets info about the specified frame.\n *\n * @param frameNumber the frame number (0-based)\n * @return the frame info\n */\n AnimatedDrawableFrameInfo getFrameInfo(int frameNumber);\n\n /**\n * Renders the specified frame onto the canvas.\n *\n * @param frameNumber the frame number (0-based)\n * @param canvas the canvas to render onto\n */\n void renderFrame(int frameNumber, Canvas canvas);\n\n /**\n * Renders the specified frame onto the canvas. The idea is the same than renderFrame(...) with\n * this differences: 1) Creates a new bitmap on each call. This allows to not block threads. 2)\n * Blend is applied here\n *\n * @param frameNumber the frame number (0-based)\n * @param canvas the canvas to render onto\n */\n void renderDeltas(int frameNumber, Canvas canvas);\n\n /**\n * Gets the frame index for specified timestamp.\n *\n * @param timestampMs the timestamp\n * @return the frame index for the timestamp or the last frame number if the timestamp is outside\n * the duration of the entire animation\n */\n int getFrameForTimestampMs(int timestampMs);\n\n /**\n * Gets the timestamp relative to the first frame that this frame number starts at.\n *\n * @param frameNumber the frame number\n * @return the time in milliseconds\n */\n int getTimestampMsForFrame(int frameNumber);\n\n /**\n * Gets the duration of the specified frame.\n *\n * @param frameNumber the frame number\n * @return the time in milliseconds\n */\n int getDurationMsForFrame(int frameNumber);\n\n /**\n * Gets the frame number to use for the preview frame.\n *\n * @return the frame number to use for the preview frame\n */\n int getFrameForPreview();\n\n /**\n * Creates a new {@link AnimatedDrawableBackend} with the same parameters but with a new bounds.\n *\n * @param bounds the bounds\n * @return an {@link AnimatedDrawableBackend} with the new bounds (this may be the same instance\n * if the bounds don't require a new backend)\n */\n AnimatedDrawableBackend forNewBounds(@Nullable Rect bounds);\n\n /**\n * Gets the number of bytes currently used by the backend for caching (for debugging)\n *\n * @return the number of bytes currently used by the backend for caching\n */\n int getMemoryUsage();\n\n /**\n * Gets a pre-decoded frame. This will only return non-null if the {@code ImageDecodeOptions} were\n * configured to decode all frames at decode time.\n *\n * @param frameNumber the index of the frame to get\n * @return a reference to the preview bitmap which must be released by the caller when done or\n * null if there is no preview bitmap set\n */\n @Nullable\n CloseableReference getPreDecodedFrame(int frameNumber);\n\n /**\n * Gets whether it has the decoded frame. This will only return true if the {@code\n * ImageDecodeOptions} were configured to decode all frames at decode time.\n *\n * @param frameNumber the index of the frame to get\n * @return true if the result has the decoded frame\n */\n boolean hasPreDecodedFrame(int frameNumber);\n\n /** Instructs the backend to drop its caches. */\n void dropCaches();\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/base/AnimatedDrawableFrameInfo.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.base;\n\nimport com.facebook.infer.annotation.Nullsafe;\n\n/** Info per frame returned by {@link AnimatedDrawableBackend}. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class AnimatedDrawableFrameInfo {\n\n /** How to dispose of the current frame before rendering the next frame. */\n public enum DisposalMethod {\n\n /** Do not dipose the frame. Leave as-is. */\n DISPOSE_DO_NOT,\n\n /** Dispose to the background color */\n DISPOSE_TO_BACKGROUND,\n\n /** Dispose to the previous frame */\n DISPOSE_TO_PREVIOUS\n }\n\n /**\n * Indicates how transparent pixels of the current frame are blended with those of the previous\n * canvas.\n */\n public enum BlendOperation {\n /** Blend * */\n BLEND_WITH_PREVIOUS,\n /** Do not blend * */\n NO_BLEND,\n }\n\n public final int frameNumber;\n public final int xOffset;\n public final int yOffset;\n public final int width;\n public final int height;\n public final BlendOperation blendOperation;\n public final DisposalMethod disposalMethod;\n\n public AnimatedDrawableFrameInfo(\n int frameNumber,\n int xOffset,\n int yOffset,\n int width,\n int height,\n BlendOperation blendOperation,\n DisposalMethod disposalMethod) {\n this.frameNumber = frameNumber;\n this.xOffset = xOffset;\n this.yOffset = yOffset;\n this.width = width;\n this.height = height;\n this.blendOperation = blendOperation;\n this.disposalMethod = disposalMethod;\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/base/AnimatedDrawableOptions.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.base;\n\nimport com.facebook.infer.annotation.Nullsafe;\nimport javax.annotation.concurrent.Immutable;\n\n/** Options for creating {@link com.facebook.fresco.animation.drawable.AnimatedDrawable2}. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\n@Immutable\npublic class AnimatedDrawableOptions {\n\n /** Default options. */\n public static AnimatedDrawableOptions DEFAULTS = AnimatedDrawableOptions.newBuilder().build();\n\n /** Whether all the rendered frames should be held in memory disregarding other constraints. */\n public final boolean forceKeepAllFramesInMemory;\n\n /** Whether the drawable can use worker threads to optimistically prefetch frames. */\n public final boolean allowPrefetching;\n\n /**\n * The maximum bytes that the backend can use to cache image frames in memory or -1 to use the\n * default\n */\n public final int maximumBytes;\n\n /** Whether to enable additional verbose debugging diagnostics. */\n public final boolean enableDebugging;\n\n /** Creates {@link AnimatedDrawableOptions} with default options. */\n public AnimatedDrawableOptions(AnimatedDrawableOptionsBuilder builder) {\n this.forceKeepAllFramesInMemory = builder.getForceKeepAllFramesInMemory();\n this.allowPrefetching = builder.getAllowPrefetching();\n this.maximumBytes = builder.getMaximumBytes();\n this.enableDebugging = builder.getEnableDebugging();\n }\n\n /**\n * Creates a new builder.\n *\n * @return the builder\n */\n public static AnimatedDrawableOptionsBuilder newBuilder() {\n return new AnimatedDrawableOptionsBuilder();\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/base/AnimatedDrawableOptionsBuilder.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.base;\n\nimport com.facebook.infer.annotation.Nullsafe;\n\n/** Builder for {@link AnimatedDrawableOptions}. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class AnimatedDrawableOptionsBuilder {\n\n private boolean mForceKeepAllFramesInMemory;\n private boolean mAllowPrefetching = true;\n private int mMaximumBytes = -1;\n private boolean mEnableDebugging;\n\n /**\n * Gets whether all the rendered frames should be held in memory disregarding other constraints.\n *\n * @return whether all the rendered frames should be held in memory\n */\n public boolean getForceKeepAllFramesInMemory() {\n return mForceKeepAllFramesInMemory;\n }\n\n /**\n * Sets whether all the rendered frames should be held in memory disregarding other constraints.\n *\n * @param forceKeepAllFramesInMemory whether to force the frames to be held in memory\n * @return this builder\n */\n public AnimatedDrawableOptionsBuilder setForceKeepAllFramesInMemory(\n boolean forceKeepAllFramesInMemory) {\n mForceKeepAllFramesInMemory = forceKeepAllFramesInMemory;\n return this;\n }\n\n /**\n * Gets whether the drawable can use worker threads to optimistically prefetch frames.\n *\n * @return whether the backend can use worker threads to prefetch frames\n */\n public boolean getAllowPrefetching() {\n return mAllowPrefetching;\n }\n\n /**\n * Sets whether the drawable can use worker threads to optimistically prefetch frames.\n *\n * @param allowPrefetching whether the backend can use worker threads to prefetch frames\n * @return this builder\n */\n public AnimatedDrawableOptionsBuilder setAllowPrefetching(boolean allowPrefetching) {\n mAllowPrefetching = allowPrefetching;\n return this;\n }\n\n /**\n * Gets the maximum bytes that the backend can use to cache image frames in memory.\n *\n * @return maximumBytes maximum bytes that the backend can use to cache image frames in memory or\n * -1 to use the default\n */\n public int getMaximumBytes() {\n return mMaximumBytes;\n }\n\n /**\n * Sets the maximum bytes that the backend can use to cache image frames in memory.\n *\n * @param maximumBytes maximum bytes that the backend can use to cache image frames in memory or\n * -1 to use the default\n * @return this builder\n */\n public AnimatedDrawableOptionsBuilder setMaximumBytes(int maximumBytes) {\n mMaximumBytes = maximumBytes;\n return this;\n }\n\n /**\n * Gets whether to enable additional verbose debugging diagnostics.\n *\n * @return whether to enable additional verbose debugging diagnostics\n */\n public boolean getEnableDebugging() {\n return mEnableDebugging;\n }\n\n /**\n * Sets whether to enable additional verbose debugging diagnostics.\n *\n * @param enableDebugging whether to enable additional verbose debugging diagnostics\n * @return this builder\n */\n public AnimatedDrawableOptionsBuilder setEnableDebugging(boolean enableDebugging) {\n mEnableDebugging = enableDebugging;\n return this;\n }\n\n /**\n * Builds the immutable options instance.\n *\n * @return the options instance\n */\n public AnimatedDrawableOptions build() {\n return new AnimatedDrawableOptions(this);\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/base/AnimatedImage.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.base;\n\nimport android.graphics.Bitmap;\nimport com.facebook.infer.annotation.Nullsafe;\nimport javax.annotation.Nullable;\n\n/** Common interface for an animated image. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic interface AnimatedImage {\n\n int LOOP_COUNT_INFINITE = 0;\n\n /**\n * Disposes the instance. This will free native resources held by this instance. Once called,\n * other methods on this instance may throw. Note, the underlying native resources may not\n * actually be freed until all associated instances of {@link AnimatedImageFrame} are disposed or\n * finalized as well.\n */\n void dispose();\n\n /**\n * Gets the width of the image (also known as the canvas in WebP nomenclature).\n *\n * @return the width of the image\n */\n int getWidth();\n\n /**\n * Gets the height of the image (also known as the canvas in WebP nomenclature).\n *\n * @return the height of the image\n */\n int getHeight();\n\n /**\n * Gets the number of frames in the image.\n *\n * @return the number of frames in the image\n */\n int getFrameCount();\n\n /**\n * Gets the duration of the animated image.\n *\n * @return the duration of the animated image in milliseconds\n */\n int getDuration();\n\n /**\n * Gets the duration of each frame of the animated image.\n *\n * @return an array that is the size of the number of frames containing the duration of each frame\n * in milliseconds\n */\n int[] getFrameDurations();\n\n /**\n * Gets the number of loops to run the animation for.\n *\n * @return the number of loops, or 0 to indicate infinite\n */\n int getLoopCount();\n\n /**\n * Creates an {@link AnimatedImageFrame} at the specified index.\n *\n * @param frameNumber the index of the frame\n * @return a newly created {@link AnimatedImageFrame}\n */\n AnimatedImageFrame getFrame(int frameNumber);\n\n /**\n * Returns whether {@link AnimatedImageFrame#renderFrame} supports scaling to arbitrary sizes or\n * whether scaling must be done externally.\n *\n * @return whether rendering supports scaling\n */\n boolean doesRenderSupportScaling();\n\n /**\n * Gets the size of bytes of the encoded image data (which is the data kept in memory for the\n * image).\n *\n * @return the size in bytes of the encoded image data\n */\n int getSizeInBytes();\n\n /**\n * Gets the frame info for the specified frame.\n *\n * @param frameNumber the frame to get the info for\n * @return the frame info\n */\n AnimatedDrawableFrameInfo getFrameInfo(int frameNumber);\n\n /**\n * Gets the Bitmap.Config to decode the Bitmap of Animated Frames.\n *\n * @return Bitmap.Config for Animated Image\n */\n @Nullable\n Bitmap.Config getAnimatedBitmapConfig();\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/base/AnimatedImageFrame.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.base;\n\nimport android.graphics.Bitmap;\nimport com.facebook.infer.annotation.Nullsafe;\n\n/** Common interface for a frame of an animated image. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic interface AnimatedImageFrame {\n\n /**\n * Disposes the instance. This will free native resources held by this instance. Once called,\n * other methods on this instance may throw. Note, the underlying native resources may not\n * actually be freed until all associated instances {@link AnimatedImage} are disposed or\n * finalized as well.\n */\n void dispose();\n\n /**\n * Renders the frame to the specified bitmap. The bitmap must have a width and height that is at\n * least as big as the specified width and height and it must be in RGBA_8888 color format.\n *\n * @param width the width to render to (the image is scaled to this width)\n * @param height the height to render to (the image is scaled to this height)\n * @param bitmap the bitmap to render into\n */\n void renderFrame(int width, int height, Bitmap bitmap);\n\n /**\n * Gets the duration of the frame.\n *\n * @return the duration of the frame in milliseconds\n */\n int getDurationMs();\n\n /**\n * Gets the width of the frame.\n *\n * @return the width of the frame\n */\n int getWidth();\n\n /**\n * Gets the height of the frame.\n *\n * @return the height of the frame\n */\n int getHeight();\n\n /**\n * Gets the x-offset of the frame relative to the image canvas.\n *\n * @return the x-offset of the frame\n */\n int getXOffset();\n\n /**\n * Gets the y-offset of the frame relative to the image canvas.\n *\n * @return the y-offset of the frame\n */\n int getYOffset();\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/base/AnimatedImageResult.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.base;\n\nimport android.graphics.Bitmap;\nimport com.facebook.common.internal.Preconditions;\nimport com.facebook.common.references.CloseableReference;\nimport com.facebook.imagepipeline.transformation.BitmapTransformation;\nimport com.facebook.infer.annotation.Nullsafe;\nimport java.util.List;\nimport javax.annotation.Nullable;\n\n/**\n * The result of decoding an animated image. Contains the {@link AnimatedImage} as well as\n * additional data.\n */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class AnimatedImageResult {\n\n private final AnimatedImage mImage;\n private final int mFrameForPreview;\n private @Nullable String mSource;\n private @Nullable CloseableReference mPreviewBitmap;\n private @Nullable List> mDecodedFrames;\n private @Nullable BitmapTransformation mBitmapTransformation;\n\n AnimatedImageResult(AnimatedImageResultBuilder builder) {\n mImage = Preconditions.checkNotNull(builder.getImage(), \"AnimatedImage cannot be null\");\n mFrameForPreview = builder.getFrameForPreview();\n mPreviewBitmap = builder.getPreviewBitmap();\n mDecodedFrames = builder.getDecodedFrames();\n mBitmapTransformation = builder.getBitmapTransformation();\n mSource = builder.getSource();\n }\n\n private AnimatedImageResult(AnimatedImage image) {\n mImage = Preconditions.checkNotNull(image, \"AnimatedImage cannot be null\");\n mFrameForPreview = 0;\n }\n\n /**\n * Creates an {@link AnimatedImageResult} with no additional options.\n *\n * @param image the image\n * @return the result\n */\n public static AnimatedImageResult forAnimatedImage(AnimatedImage image) {\n return new AnimatedImageResult(image);\n }\n\n /**\n * Creates an {@link AnimatedImageResultBuilder} for creating an {@link AnimatedImageResult}.\n *\n * @param image the image\n * @return the builder\n */\n public static AnimatedImageResultBuilder newBuilder(AnimatedImage image) {\n return new AnimatedImageResultBuilder(image);\n }\n\n /**\n * Gets the underlying image.\n *\n * @return the underlying image\n */\n public AnimatedImage getImage() {\n return mImage;\n }\n\n /**\n * Gets the animated result source uri\n *\n * @return source uri\n */\n @Nullable\n public String getSource() {\n return mSource;\n }\n\n /**\n * Gets the frame that should be used for the preview image. If the preview bitmap was fetched,\n * this is the frame that it's for.\n *\n * @return the frame that should be used for the preview image\n */\n public int getFrameForPreview() {\n return mFrameForPreview;\n }\n\n /**\n * Gets a decoded frame. This will only return non-null if the {@code ImageDecodeOptions} were\n * configured to decode all frames at decode time.\n *\n * @param index the index of the frame to get\n * @return a reference to the preview bitmap which must be released by the caller when done or\n * null if there is no preview bitmap set\n */\n public synchronized @Nullable CloseableReference getDecodedFrame(int index) {\n if (mDecodedFrames != null) {\n return CloseableReference.cloneOrNull(mDecodedFrames.get(index));\n }\n return null;\n }\n\n /**\n * Gets whether it has the decoded frame. This will only return true if the {@code\n * ImageDecodeOptions} were configured to decode all frames at decode time.\n *\n * @param index the index of the frame to get\n * @return true if the result has the decoded frame\n */\n public synchronized boolean hasDecodedFrame(int index) {\n return mDecodedFrames != null && mDecodedFrames.get(index) != null;\n }\n\n /**\n * Gets the transformation that is to be applied to the image, or null if none.\n *\n * @return the transformation that is to be applied to the image, or null if none\n */\n public @Nullable BitmapTransformation getBitmapTransformation() {\n return mBitmapTransformation;\n }\n\n /**\n * Gets the bitmap for the preview frame. This will only return non-null if the {@code\n * ImageDecodeOptions} were configured to decode the preview frame.\n *\n * @return a reference to the preview bitmap which must be released by the caller when done or\n * null if there is no preview bitmap set\n */\n @Nullable\n public synchronized CloseableReference getPreviewBitmap() {\n return CloseableReference.cloneOrNull(mPreviewBitmap);\n }\n\n /** Disposes the result, which releases the reference to any bitmaps. */\n public synchronized void dispose() {\n CloseableReference.closeSafely(mPreviewBitmap);\n mPreviewBitmap = null;\n CloseableReference.closeSafely(mDecodedFrames);\n mDecodedFrames = null;\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/base/AnimatedImageResultBuilder.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.base;\n\nimport android.graphics.Bitmap;\nimport com.facebook.common.references.CloseableReference;\nimport com.facebook.imagepipeline.transformation.BitmapTransformation;\nimport com.facebook.infer.annotation.Nullsafe;\nimport java.util.List;\nimport javax.annotation.Nullable;\n\n/** Builder for {@link AnimatedImageResult}. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class AnimatedImageResultBuilder {\n\n private final AnimatedImage mImage;\n private @Nullable CloseableReference mPreviewBitmap;\n private @Nullable List> mDecodedFrames;\n private int mFrameForPreview;\n private @Nullable BitmapTransformation mBitmapTransformation;\n private @Nullable String mSource;\n\n AnimatedImageResultBuilder(AnimatedImage image) {\n mImage = image;\n }\n\n /**\n * Gets the image for the result.\n *\n * @return the image\n */\n public AnimatedImage getImage() {\n return mImage;\n }\n\n /**\n * Gets the preview bitmap. This method returns a new reference. The caller must close it.\n *\n * @return the reference to the preview bitmap or null if none was set. This returns a reference\n * that must be released by the caller\n */\n public @Nullable CloseableReference getPreviewBitmap() {\n return CloseableReference.cloneOrNull(mPreviewBitmap);\n }\n\n /**\n * Sets a preview bitmap.\n *\n * @param previewBitmap the preview. The method clones the reference.\n * @return this builder\n */\n public AnimatedImageResultBuilder setPreviewBitmap(\n @Nullable CloseableReference previewBitmap) {\n mPreviewBitmap = CloseableReference.cloneOrNull(previewBitmap);\n return this;\n }\n\n /**\n * Gets the frame that should be used for the preview image. If the preview bitmap was fetched,\n * this is the frame that it's for.\n *\n * @return the frame that should be used for the preview image\n */\n public int getFrameForPreview() {\n return mFrameForPreview;\n }\n\n /**\n * Sets the frame that should be used for the preview image. If the preview bitmap was fetched,\n * this is the frame that it's for.\n *\n * @return the frame that should be used for the preview image\n */\n public AnimatedImageResultBuilder setFrameForPreview(int frameForPreview) {\n mFrameForPreview = frameForPreview;\n return this;\n }\n\n /**\n * Gets the decoded frames. Only used if the {@code ImageDecodeOptions} were configured to decode\n * all frames at decode time.\n *\n * @return the references to the decoded frames or null if none was set. This returns references\n * that must be released by the caller\n */\n public @Nullable List> getDecodedFrames() {\n return CloseableReference.cloneOrNull(mDecodedFrames);\n }\n\n /**\n * @return animated image uri path\n */\n @Nullable\n public String getSource() {\n return mSource;\n }\n\n /**\n * Sets the decoded frames. Only used if the {@code ImageDecodeOptions} were configured to decode\n * all frames at decode time.\n *\n * @param decodedFrames the decoded frames. The method clones the references.\n */\n public AnimatedImageResultBuilder setDecodedFrames(\n @Nullable List> decodedFrames) {\n mDecodedFrames = CloseableReference.cloneOrNull(decodedFrames);\n return this;\n }\n\n /**\n * Gets the transformation that is to be applied to the image, or null if none.\n *\n * @return the transformation that is to be applied to the image, or null if none\n */\n @Nullable\n public BitmapTransformation getBitmapTransformation() {\n return mBitmapTransformation;\n }\n\n /**\n * Sets the transformation that is to be applied to the image.\n *\n * @param bitmapTransformation the transformation that is to be applied to the image\n */\n public AnimatedImageResultBuilder setBitmapTransformation(\n @Nullable BitmapTransformation bitmapTransformation) {\n mBitmapTransformation = bitmapTransformation;\n return this;\n }\n\n /**\n * Sets the source of the animated image\n *\n * @param source uri path\n * @return bitmapTransformation the transformation that is to be applied to the image\n */\n public AnimatedImageResultBuilder setSource(@Nullable String source) {\n mSource = source;\n return this;\n }\n\n /**\n * Builds the {@link AnimatedImageResult}. The preview bitmap and the decoded frames are closed\n * after build is called, so this should not be called more than once or those fields will be lost\n * after the first call.\n *\n * @return the result\n */\n public AnimatedImageResult build() {\n try {\n return new AnimatedImageResult(this);\n } finally {\n CloseableReference.closeSafely(mPreviewBitmap);\n mPreviewBitmap = null;\n CloseableReference.closeSafely(mDecodedFrames);\n mDecodedFrames = null;\n }\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/base/AnimatedImageValidator.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.base\n\nimport com.facebook.imagepipeline.image.EncodedImage\n\ninterface AnimatedImageValidator {\n fun validateImage(encodedImage: EncodedImage): ValidationResult\n}\n\nsealed class ValidationResult(val isValid: Boolean, val message: String? = null) {\n\n object Success : ValidationResult(true)\n\n class Failure(message: String) : ValidationResult(false, message)\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/base/package-info.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\n/** Base classes and abstractions for the animation framework. */\npackage com.facebook.imagepipeline.animated.base;\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/factory/AnimatedImageDecoder.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.factory\n\nimport com.facebook.imagepipeline.animated.base.AnimatedImage\nimport com.facebook.imagepipeline.common.ImageDecodeOptions\nimport java.nio.ByteBuffer\n\ninterface AnimatedImageDecoder {\n\n /**\n * Factory method to create the AnimatedImage from a native pointer\n *\n * @param nativePtr The native pointer\n * @param sizeInBytes The size in byte to allocate\n * @param options The options for decoding\n * @return The AnimatedImage allocation\n */\n fun decodeFromNativeMemory(\n nativePtr: Long,\n sizeInBytes: Int,\n options: ImageDecodeOptions,\n ): AnimatedImage?\n\n /**\n * Factory method to create the AnimatedImage from a ByteBuffer\n *\n * @param byteBuffer The ByteBuffer containing the image\n * @param options The options for decoding\n * @return The AnimatedImage allocation\n */\n fun decodeFromByteBuffer(byteBuffer: ByteBuffer, options: ImageDecodeOptions): AnimatedImage?\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/factory/AnimatedImageDecoderBase.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.factory\n\nimport android.annotation.SuppressLint\nimport android.graphics.Bitmap\nimport android.graphics.Color\nimport android.graphics.Rect\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.vito.core.AnimatedImagePerfLoggingListener\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend\nimport com.facebook.imagepipeline.animated.base.AnimatedImage\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult\nimport com.facebook.imagepipeline.animated.impl.AnimatedDrawableBackendImpl\nimport com.facebook.imagepipeline.animated.impl.AnimatedDrawableBackendProvider\nimport com.facebook.imagepipeline.animated.impl.AnimatedImageCompositor\nimport com.facebook.imagepipeline.animated.util.AnimatedDrawableUtil\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.common.ImageDecodeOptions\nimport com.facebook.imagepipeline.image.CloseableAnimatedImage\nimport com.facebook.imagepipeline.image.CloseableImage\nimport com.facebook.imagepipeline.image.CloseableStaticBitmap\nimport com.facebook.imagepipeline.image.ImmutableQualityInfo\n\n/**\n * Base class for animated image decoders that provides common functionality for decoding animated\n * images. This class contains the shared logic for creating preview bitmaps, decoding all frames,\n * and creating closeable images.\n */\nabstract class AnimatedImageDecoderBase(\n protected val platformBitmapFactory: PlatformBitmapFactory,\n protected val downscaleFrameToDrawableDimensions: Boolean,\n protected val isNewRenderImplementation: Boolean,\n protected val treatAnimatedImagesAsStateful: Boolean = true,\n) {\n\n protected val animatedDrawableBackendProvider: AnimatedDrawableBackendProvider =\n createAnimatedDrawableBackendProvider(downscaleFrameToDrawableDimensions)\n\n private var animatedImagePerfLoggingListener: AnimatedImagePerfLoggingListener? = null\n\n fun setAnimatedImagePerfLoggingListener(listener: AnimatedImagePerfLoggingListener?) {\n this.animatedImagePerfLoggingListener = listener\n }\n\n companion object {\n /** Creates an AnimatedDrawableBackendProvider for animated image decoding. */\n fun createAnimatedDrawableBackendProvider(\n downscaleFrameToDrawableDimensions: Boolean\n ): AnimatedDrawableBackendProvider {\n return object : AnimatedDrawableBackendProvider {\n override fun get(\n animatedImageResult: AnimatedImageResult,\n bounds: Rect?,\n ): AnimatedDrawableBackend {\n return AnimatedDrawableBackendImpl(\n AnimatedDrawableUtil(),\n animatedImageResult,\n bounds,\n downscaleFrameToDrawableDimensions,\n )\n }\n }\n }\n }\n\n protected fun getCloseableImage(\n sourceUri: String?,\n options: ImageDecodeOptions,\n image: AnimatedImage,\n bitmapConfig: Bitmap.Config,\n ): CloseableImage {\n var decodedFrames: List?>? = null\n var previewBitmap: CloseableReference? = null\n try {\n val frameForPreview = if (options.useLastFrameForPreview) (image.frameCount - 1) else 0\n if (options.forceStaticImage) {\n return CloseableStaticBitmap.of(\n createPreviewBitmap(image, bitmapConfig, frameForPreview),\n ImmutableQualityInfo.FULL_QUALITY,\n 0,\n )\n }\n\n if (options.decodeAllFrames) {\n decodedFrames = decodeAllFrames(image, bitmapConfig)\n previewBitmap = CloseableReference.cloneOrNull(decodedFrames[frameForPreview])\n }\n\n if (options.decodePreviewFrame && previewBitmap == null) {\n previewBitmap = createPreviewBitmap(image, bitmapConfig, frameForPreview)\n }\n\n // Log CloseableAnimatedImage creation start\n val imageId = sourceUri ?: \"unknown_${System.identityHashCode(image)}\"\n val startTime = System.nanoTime()\n animatedImagePerfLoggingListener?.onCloseableAnimatedImageCreationStart(imageId, startTime)\n\n val animatedImageResult =\n AnimatedImageResult.newBuilder(image)\n .setPreviewBitmap(previewBitmap)\n .setFrameForPreview(frameForPreview)\n .setDecodedFrames(decodedFrames)\n .setBitmapTransformation(options.bitmapTransformation)\n .setSource(sourceUri)\n .build()\n val closeableAnimatedImage =\n CloseableAnimatedImage(animatedImageResult, treatAnimatedImagesAsStateful)\n\n // Log CloseableAnimatedImage creation success\n val endTime = System.nanoTime()\n animatedImagePerfLoggingListener?.onCloseableAnimatedImageCreationEnd(\n imageId,\n endTime,\n true,\n )\n\n return closeableAnimatedImage\n } finally {\n CloseableReference.closeSafely(previewBitmap)\n CloseableReference.closeSafely(decodedFrames)\n }\n }\n\n protected fun createPreviewBitmap(\n image: AnimatedImage,\n bitmapConfig: Bitmap.Config,\n frameForPreview: Int,\n ): CloseableReference {\n val bitmap = createBitmap(image.width, image.height, bitmapConfig)\n val tempResult = AnimatedImageResult.forAnimatedImage(image)\n val drawableBackend = animatedDrawableBackendProvider.get(tempResult, null)\n val animatedImageCompositor =\n AnimatedImageCompositor(\n drawableBackend,\n isNewRenderImplementation,\n object : AnimatedImageCompositor.Callback {\n override fun onIntermediateResult(frameNumber: Int, bitmap: Bitmap) {\n // Don't care.\n }\n\n override fun getCachedBitmap(frameNumber: Int): CloseableReference? = null\n },\n )\n animatedImageCompositor.renderFrame(frameForPreview, bitmap.get())\n return bitmap\n }\n\n protected fun decodeAllFrames(\n image: AnimatedImage,\n bitmapConfig: Bitmap.Config,\n ): List?> {\n val tempResult = AnimatedImageResult.forAnimatedImage(image)\n val drawableBackend = animatedDrawableBackendProvider.get(tempResult, null)\n val bitmaps: MutableList?> = ArrayList(drawableBackend.frameCount)\n val animatedImageCompositor =\n AnimatedImageCompositor(\n drawableBackend,\n isNewRenderImplementation,\n object : AnimatedImageCompositor.Callback {\n override fun onIntermediateResult(frameNumber: Int, bitmap: Bitmap) {\n // Don't care.\n }\n\n override fun getCachedBitmap(frameNumber: Int): CloseableReference? =\n CloseableReference.cloneOrNull(bitmaps[frameNumber])\n },\n )\n for (i in 0.. {\n val bitmap = platformBitmapFactory.createBitmapInternal(width, height, bitmapConfig)\n bitmap.get().eraseColor(Color.TRANSPARENT)\n bitmap.get().setHasAlpha(true)\n return bitmap\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/factory/AnimatedImageFactory.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.factory\n\nimport android.graphics.Bitmap\nimport com.facebook.imagepipeline.common.ImageDecodeOptions\nimport com.facebook.imagepipeline.image.CloseableImage\nimport com.facebook.imagepipeline.image.EncodedImage\n\n/** Decoder for animated images. */\ninterface AnimatedImageFactory {\n\n /**\n * Decodes a GIF into a CloseableImage.\n *\n * @param encodedImage encoded image (native byte array holding the encoded bytes and meta data)\n * @param options the options for the decode\n * @param bitmapConfig the Bitmap.Config used to generate the output bitmaps\n * @return a [CloseableImage] for the GIF image\n */\n fun decodeGif(\n encodedImage: EncodedImage,\n options: ImageDecodeOptions,\n bitmapConfig: Bitmap.Config,\n ): CloseableImage\n\n /**\n * Decode a WebP into a CloseableImage.\n *\n * @param encodedImage encoded image (native byte array holding the encoded bytes and meta data)\n * @param options the options for the decode\n * @param bitmapConfig the Bitmap.Config used to generate the output bitmaps\n * @return a [CloseableImage] for the WebP image\n */\n fun decodeWebP(\n encodedImage: EncodedImage,\n options: ImageDecodeOptions,\n bitmapConfig: Bitmap.Config,\n ): CloseableImage\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/impl/AnimatedDrawableBackendImpl.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.impl;\n\nimport android.graphics.Bitmap;\nimport android.graphics.Canvas;\nimport android.graphics.Color;\nimport android.graphics.Paint;\nimport android.graphics.PorterDuff;\nimport android.graphics.PorterDuffXfermode;\nimport android.graphics.Rect;\nimport com.facebook.common.internal.Preconditions;\nimport com.facebook.common.references.CloseableReference;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo.BlendOperation;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo.DisposalMethod;\nimport com.facebook.imagepipeline.animated.base.AnimatedImage;\nimport com.facebook.imagepipeline.animated.base.AnimatedImageFrame;\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult;\nimport com.facebook.imagepipeline.animated.util.AnimatedDrawableUtil;\nimport com.facebook.infer.annotation.Nullsafe;\nimport javax.annotation.Nullable;\nimport javax.annotation.concurrent.GuardedBy;\n\n/** An {@link AnimatedDrawableBackend} that renders {@link AnimatedImage}. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class AnimatedDrawableBackendImpl implements AnimatedDrawableBackend {\n\n private final AnimatedDrawableUtil mAnimatedDrawableUtil;\n\n private final AnimatedImageResult mAnimatedImageResult;\n private final AnimatedImage mAnimatedImage;\n private final Rect mRenderedBounds;\n private final int[] mFrameDurationsMs;\n private final int[] mFrameTimestampsMs;\n private final int mDurationMs;\n private final AnimatedDrawableFrameInfo[] mFrameInfos;\n private final Rect mRenderSrcRect = new Rect();\n private final Rect mRenderDstRect = new Rect();\n private final boolean mDownscaleFrameToDrawableDimensions;\n private final Paint mTransparentPaint;\n\n @GuardedBy(\"this\")\n private @Nullable Bitmap mTempBitmap;\n\n public AnimatedDrawableBackendImpl(\n AnimatedDrawableUtil animatedDrawableUtil,\n AnimatedImageResult animatedImageResult,\n @Nullable Rect bounds,\n boolean downscaleFrameToDrawableDimensions) {\n mAnimatedDrawableUtil = animatedDrawableUtil;\n mAnimatedImageResult = animatedImageResult;\n mAnimatedImage = animatedImageResult.getImage();\n mFrameDurationsMs = mAnimatedImage.getFrameDurations();\n mAnimatedDrawableUtil.fixFrameDurations(mFrameDurationsMs);\n mDurationMs = mAnimatedDrawableUtil.getTotalDurationFromFrameDurations(mFrameDurationsMs);\n mFrameTimestampsMs = mAnimatedDrawableUtil.getFrameTimeStampsFromDurations(mFrameDurationsMs);\n mRenderedBounds = getBoundsToUse(mAnimatedImage, bounds);\n mDownscaleFrameToDrawableDimensions = downscaleFrameToDrawableDimensions;\n mFrameInfos = new AnimatedDrawableFrameInfo[mAnimatedImage.getFrameCount()];\n for (int i = 0; i < mAnimatedImage.getFrameCount(); i++) {\n mFrameInfos[i] = mAnimatedImage.getFrameInfo(i);\n }\n mTransparentPaint = new Paint();\n mTransparentPaint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.CLEAR));\n }\n\n private static Rect getBoundsToUse(AnimatedImage image, @Nullable Rect targetBounds) {\n if (targetBounds == null) {\n return new Rect(0, 0, image.getWidth(), image.getHeight());\n }\n return new Rect(\n 0,\n 0,\n Math.min(targetBounds.width(), image.getWidth()),\n Math.min(targetBounds.height(), image.getHeight()));\n }\n\n @Override\n public AnimatedImageResult getAnimatedImageResult() {\n return mAnimatedImageResult;\n }\n\n @Override\n public int getDurationMs() {\n return mDurationMs;\n }\n\n @Override\n public int getFrameCount() {\n return mAnimatedImage.getFrameCount();\n }\n\n @Override\n public int getLoopCount() {\n return mAnimatedImage.getLoopCount();\n }\n\n @Override\n public int getWidth() {\n return mAnimatedImage.getWidth();\n }\n\n @Override\n public int getHeight() {\n return mAnimatedImage.getHeight();\n }\n\n @Override\n public int getRenderedWidth() {\n return mRenderedBounds.width();\n }\n\n @Override\n public int getRenderedHeight() {\n return mRenderedBounds.height();\n }\n\n @Override\n public AnimatedDrawableFrameInfo getFrameInfo(int frameNumber) {\n return mFrameInfos[frameNumber];\n }\n\n @Override\n public int getFrameForTimestampMs(int timestampMs) {\n return mAnimatedDrawableUtil.getFrameForTimestampMs(mFrameTimestampsMs, timestampMs);\n }\n\n @Override\n public int getTimestampMsForFrame(int frameNumber) {\n Preconditions.checkElementIndex(frameNumber, mFrameTimestampsMs.length);\n return mFrameTimestampsMs[frameNumber];\n }\n\n @Override\n public int getDurationMsForFrame(int frameNumber) {\n return mFrameDurationsMs[frameNumber];\n }\n\n @Override\n public int getFrameForPreview() {\n return mAnimatedImageResult.getFrameForPreview();\n }\n\n @Override\n public AnimatedDrawableBackend forNewBounds(@Nullable Rect bounds) {\n Rect boundsToUse = getBoundsToUse(mAnimatedImage, bounds);\n if (boundsToUse.equals(mRenderedBounds)) {\n // Actual bounds aren't changed.\n return this;\n }\n return new AnimatedDrawableBackendImpl(\n mAnimatedDrawableUtil, mAnimatedImageResult, bounds, mDownscaleFrameToDrawableDimensions);\n }\n\n @Override\n public synchronized int getMemoryUsage() {\n int bytes = 0;\n if (mTempBitmap != null) {\n bytes += mAnimatedDrawableUtil.getSizeOfBitmap(mTempBitmap);\n }\n bytes += mAnimatedImage.getSizeInBytes();\n return bytes;\n }\n\n @Override\n public @Nullable CloseableReference getPreDecodedFrame(int frameNumber) {\n return mAnimatedImageResult.getDecodedFrame(frameNumber);\n }\n\n @Override\n public boolean hasPreDecodedFrame(int index) {\n return mAnimatedImageResult.hasDecodedFrame(index);\n }\n\n @Override\n public void renderFrame(int frameNumber, Canvas canvas) {\n AnimatedImageFrame frame = mAnimatedImage.getFrame(frameNumber);\n try {\n if (frame.getWidth() <= 0 || frame.getHeight() <= 0) {\n return; // Frame not visible -> skipping\n }\n\n if (mAnimatedImage.doesRenderSupportScaling()) {\n renderImageSupportsScaling(canvas, frame);\n } else {\n renderImageDoesNotSupportScaling(canvas, frame);\n }\n } finally {\n frame.dispose();\n }\n }\n\n @Override\n public void renderDeltas(int frameNumber, Canvas canvas) {\n AnimatedImageFrame frame = mAnimatedImage.getFrame(frameNumber);\n AnimatedDrawableFrameInfo frameInfo = mAnimatedImage.getFrameInfo(frameNumber);\n AnimatedDrawableFrameInfo previousFrameInfo =\n frameNumber == 0 ? null : mAnimatedImage.getFrameInfo(frameNumber - 1);\n try {\n if (frame.getWidth() <= 0 || frame.getHeight() <= 0) {\n return; // Frame not visible -> skipping\n }\n\n if (mAnimatedImage.doesRenderSupportScaling()) {\n renderScalingFrames(canvas, frame, frameInfo, previousFrameInfo);\n } else {\n renderNonScalingFrames(canvas, frame, frameInfo, previousFrameInfo);\n }\n\n } finally {\n frame.dispose();\n }\n }\n\n private synchronized Bitmap prepareTempBitmapForThisSize(int width, int height) {\n // Different gif frames can be different size,\n // So we need to ensure we can fit next frame to temporary bitmap\n if (mTempBitmap != null\n && (mTempBitmap.getWidth() < width || mTempBitmap.getHeight() < height)) {\n clearTempBitmap();\n }\n if (mTempBitmap == null) {\n mTempBitmap = Bitmap.createBitmap(width, height, Bitmap.Config.ARGB_8888);\n }\n mTempBitmap.eraseColor(Color.TRANSPARENT);\n return mTempBitmap;\n }\n\n private void renderImageSupportsScaling(Canvas canvas, AnimatedImageFrame frame) {\n double xScale = (double) mRenderedBounds.width() / (double) mAnimatedImage.getWidth();\n double yScale = (double) mRenderedBounds.height() / (double) mAnimatedImage.getHeight();\n\n int frameWidth = (int) Math.round(frame.getWidth() * xScale);\n int frameHeight = (int) Math.round(frame.getHeight() * yScale);\n int xOffset = (int) (frame.getXOffset() * xScale);\n int yOffset = (int) (frame.getYOffset() * yScale);\n\n synchronized (this) {\n int renderedWidth = mRenderedBounds.width();\n int renderedHeight = mRenderedBounds.height();\n // Update the temp bitmap to be >= rendered dimensions\n prepareTempBitmapForThisSize(renderedWidth, renderedHeight);\n if (mTempBitmap != null) {\n frame.renderFrame(frameWidth, frameHeight, mTempBitmap);\n }\n // Temporary bitmap can be bigger than frame, so we should draw only rendered area of bitmap\n mRenderSrcRect.set(0, 0, renderedWidth, renderedHeight);\n mRenderDstRect.set(xOffset, yOffset, xOffset + renderedWidth, yOffset + renderedHeight);\n\n if (mTempBitmap != null) {\n canvas.drawBitmap(mTempBitmap, mRenderSrcRect, mRenderDstRect, null);\n }\n }\n }\n\n private void renderScalingFrames(\n Canvas canvas,\n AnimatedImageFrame frame,\n AnimatedDrawableFrameInfo frameInfo,\n @Nullable AnimatedDrawableFrameInfo previousFrameInfo) {\n int assetWidth = mAnimatedImage.getWidth();\n int assetHeight = mAnimatedImage.getHeight();\n\n // Find the best scale asset size. Maximum scaleSize would be the assetSize.\n float scaledWidth = assetWidth;\n float scaledHeight = assetHeight;\n\n // Apply the scale to the frame\n float xScale = 1f;\n float yScale = 1f;\n\n int frameWidth = frame.getWidth();\n int frameHeight = frame.getHeight();\n int xOffset = frame.getXOffset();\n int yOffset = frame.getYOffset();\n\n // Check if we need to down scale the asset to the canvas size\n if (scaledWidth > canvas.getWidth() || scaledHeight > canvas.getHeight()) {\n // Canvas could have wrong sizes as 314573336x200. Then we limit the frame sizes\n int maxCanvasWidth = Math.min(canvas.getWidth(), assetWidth);\n int maxCanvasHeight = Math.min(canvas.getHeight(), assetHeight);\n\n float assetRatio = assetWidth / (float) assetHeight;\n if (maxCanvasWidth > maxCanvasHeight) {\n scaledWidth = maxCanvasWidth;\n scaledHeight = maxCanvasWidth / assetRatio;\n } else {\n scaledWidth = maxCanvasHeight * assetRatio;\n scaledHeight = maxCanvasHeight;\n }\n\n xScale = scaledWidth / (float) assetWidth;\n yScale = scaledHeight / (float) assetHeight;\n\n frameWidth = (int) Math.ceil(frame.getWidth() * xScale);\n frameHeight = (int) Math.ceil(frame.getHeight() * yScale);\n xOffset = (int) Math.ceil(frame.getXOffset() * xScale);\n yOffset = (int) Math.ceil(frame.getYOffset() * yScale);\n }\n\n Rect renderSrcRect = new Rect(0, 0, frameWidth, frameHeight);\n Rect renderDstRect = new Rect(xOffset, yOffset, xOffset + frameWidth, yOffset + frameHeight);\n\n // Clean previous frame surface if that frame was disposable\n if (previousFrameInfo != null) {\n maybeDisposeBackground(canvas, xScale, yScale, previousFrameInfo);\n }\n\n // If current frame is no_blend, then we have to clean their surface before rendering\n if (frameInfo.blendOperation == BlendOperation.NO_BLEND) {\n canvas.drawRect(renderDstRect, mTransparentPaint);\n }\n\n synchronized (this) {\n // Impress the frame in the bitmap\n Bitmap frameBitmap = prepareTempBitmapForThisSize(frameWidth, frameHeight);\n frame.renderFrame(frameWidth, frameHeight, frameBitmap);\n canvas.drawBitmap(frameBitmap, renderSrcRect, renderDstRect, null);\n }\n }\n\n private void maybeDisposeBackground(\n Canvas canvas, float xScale, float yScale, AnimatedDrawableFrameInfo previousFrameInfo) {\n if (previousFrameInfo.disposalMethod == DisposalMethod.DISPOSE_TO_BACKGROUND) {\n int prevFrameWidth = (int) Math.ceil(previousFrameInfo.width * xScale);\n int prevFrameHeight = (int) Math.ceil(previousFrameInfo.height * yScale);\n int prevXOffset = (int) Math.ceil(previousFrameInfo.xOffset * xScale);\n int prevYOffset = (int) Math.ceil(previousFrameInfo.yOffset * yScale);\n Rect prevFrameSurface =\n new Rect(\n prevXOffset,\n prevYOffset,\n prevXOffset + prevFrameWidth,\n prevYOffset + prevFrameHeight);\n canvas.drawRect(prevFrameSurface, mTransparentPaint);\n }\n }\n\n private void renderImageDoesNotSupportScaling(Canvas canvas, AnimatedImageFrame frame) {\n int frameWidth, frameHeight, xOffset, yOffset;\n if (mDownscaleFrameToDrawableDimensions) {\n final int fittedWidth = Math.min(frame.getWidth(), canvas.getWidth());\n final int fittedHeight = Math.min(frame.getHeight(), canvas.getHeight());\n\n final float scaleX = (float) frame.getWidth() / (float) fittedWidth;\n final float scaleY = (float) frame.getHeight() / (float) fittedHeight;\n final float scale = Math.max(scaleX, scaleY);\n\n frameWidth = (int) (frame.getWidth() / scale);\n frameHeight = (int) (frame.getHeight() / scale);\n xOffset = (int) (frame.getXOffset() / scale);\n yOffset = (int) (frame.getYOffset() / scale);\n } else {\n frameWidth = frame.getWidth();\n frameHeight = frame.getHeight();\n xOffset = frame.getXOffset();\n yOffset = frame.getYOffset();\n }\n\n synchronized (this) {\n mTempBitmap = prepareTempBitmapForThisSize(frameWidth, frameHeight);\n frame.renderFrame(frameWidth, frameHeight, mTempBitmap);\n\n canvas.save();\n canvas.translate(xOffset, yOffset);\n canvas.drawBitmap(mTempBitmap, 0, 0, null);\n canvas.restore();\n }\n }\n\n private void renderNonScalingFrames(\n Canvas canvas,\n AnimatedImageFrame frame,\n AnimatedDrawableFrameInfo frameInfo,\n @Nullable AnimatedDrawableFrameInfo previousFrameInfo) {\n if (mRenderedBounds == null || mRenderedBounds.width() <= 0 || mRenderedBounds.height() <= 0) {\n return;\n }\n\n float scale = (float) canvas.getWidth() / mRenderedBounds.width();\n\n // Clean previous frame surface if that frame was disposable\n if (previousFrameInfo != null) {\n maybeDisposeBackground(canvas, scale, scale, previousFrameInfo);\n }\n\n // Prepare the new frame\n int frameWidth = frame.getWidth();\n int frameHeight = frame.getHeight();\n Rect src = new Rect(0, 0, frameWidth, frameHeight);\n\n int resizedWidth = (int) (frameWidth * scale);\n int resizedHeight = (int) (frameHeight * scale);\n\n int xOffset = (int) (frame.getXOffset() * scale);\n int yOffset = (int) (frame.getYOffset() * scale);\n\n // Clear the canvas if this frame doesnt blend\n Rect renderDstRect =\n new Rect(xOffset, yOffset, xOffset + resizedWidth, yOffset + resizedHeight);\n if (frameInfo.blendOperation == BlendOperation.NO_BLEND) {\n canvas.drawRect(renderDstRect, mTransparentPaint);\n }\n synchronized (this) {\n // Draw canvas frame\n Bitmap bitmap = prepareTempBitmapForThisSize(frameWidth, frameHeight);\n frame.renderFrame(frameWidth, frameHeight, bitmap);\n canvas.drawBitmap(bitmap, src, renderDstRect, null);\n }\n }\n\n @Override\n public synchronized void dropCaches() {\n clearTempBitmap();\n }\n\n private synchronized void clearTempBitmap() {\n if (mTempBitmap != null) {\n mTempBitmap.recycle();\n mTempBitmap = null;\n }\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/impl/AnimatedDrawableBackendProvider.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.impl;\n\nimport android.graphics.Rect;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend;\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult;\nimport com.facebook.infer.annotation.Nullsafe;\nimport javax.annotation.Nullable;\n\n/** Assisted provider for {@link AnimatedDrawableBackend}. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic interface AnimatedDrawableBackendProvider {\n\n /**\n * Creates a new {@link AnimatedDrawableBackend}.\n *\n * @param animatedImageResult the image result.\n * @param bounds the initial bounds for the drawable\n * @return a new {@link AnimatedDrawableBackend}\n */\n AnimatedDrawableBackend get(AnimatedImageResult animatedImageResult, @Nullable Rect bounds);\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/impl/AnimatedFrameCache.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.impl;\n\nimport android.net.Uri;\nimport androidx.annotation.VisibleForTesting;\nimport com.facebook.cache.common.CacheKey;\nimport com.facebook.common.internal.Objects;\nimport com.facebook.common.references.CloseableReference;\nimport com.facebook.imagepipeline.cache.CountingMemoryCache;\nimport com.facebook.imagepipeline.image.CloseableImage;\nimport com.facebook.infer.annotation.Nullsafe;\nimport java.util.Iterator;\nimport java.util.LinkedHashSet;\nimport javax.annotation.Nullable;\nimport javax.annotation.concurrent.GuardedBy;\n\n/**\n * Facade to the image memory cache for frames of an animated image.\n *\n *

Each animated image should have its own instance of this class.\n */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class AnimatedFrameCache {\n\n @VisibleForTesting\n static class FrameKey implements CacheKey {\n\n private final CacheKey mImageCacheKey;\n private final int mFrameIndex;\n\n public FrameKey(CacheKey imageCacheKey, int frameIndex) {\n mImageCacheKey = imageCacheKey;\n mFrameIndex = frameIndex;\n }\n\n @Override\n public String toString() {\n return Objects.toStringHelper(this)\n .add(\"imageCacheKey\", mImageCacheKey)\n .add(\"frameIndex\", mFrameIndex)\n .toString();\n }\n\n @Override\n public boolean equals(@Nullable Object o) {\n if (o == this) {\n return true;\n }\n if (o instanceof FrameKey) {\n FrameKey that = (FrameKey) o;\n return this.mFrameIndex == that.mFrameIndex\n && this.mImageCacheKey.equals(that.mImageCacheKey);\n }\n return false;\n }\n\n @Override\n public int hashCode() {\n return mImageCacheKey.hashCode() * 1013 + mFrameIndex;\n }\n\n @Override\n public boolean containsUri(Uri uri) {\n return mImageCacheKey.containsUri(uri);\n }\n\n @Override\n // NULLSAFE_FIXME[Inconsistent Subclass Return Annotation]\n public @Nullable String getUriString() {\n return null;\n }\n\n @Override\n public boolean isResourceIdForDebugging() {\n return false;\n }\n }\n\n private final CacheKey mImageCacheKey;\n private final CountingMemoryCache mBackingCache;\n private final CountingMemoryCache.EntryStateObserver mEntryStateObserver;\n\n @GuardedBy(\"this\")\n private final LinkedHashSet mFreeItemsPool;\n\n public AnimatedFrameCache(\n CacheKey imageCacheKey, final CountingMemoryCache backingCache) {\n mImageCacheKey = imageCacheKey;\n mBackingCache = backingCache;\n mFreeItemsPool = new LinkedHashSet<>();\n mEntryStateObserver =\n new CountingMemoryCache.EntryStateObserver() {\n @Override\n public void onExclusivityChanged(CacheKey key, boolean isExclusive) {\n AnimatedFrameCache.this.onReusabilityChange(key, isExclusive);\n }\n };\n }\n\n public synchronized void onReusabilityChange(CacheKey key, boolean isReusable) {\n if (isReusable) {\n mFreeItemsPool.add(key);\n } else {\n mFreeItemsPool.remove(key);\n }\n }\n\n /**\n * Caches the image for the given frame index.\n *\n *

Important: the client should use the returned reference instead of the original one. It is\n * the caller's responsibility to close the returned reference once not needed anymore.\n *\n * @return the new reference to be used, null if the value cannot be cached\n */\n @Nullable\n public CloseableReference cache(\n int frameIndex, CloseableReference imageRef) {\n return mBackingCache.cache(keyFor(frameIndex), imageRef, mEntryStateObserver);\n }\n\n /**\n * Gets the image for the given frame index.\n *\n *

It is the caller's responsibility to close the returned reference once not needed anymore.\n */\n @Nullable\n public CloseableReference get(int frameIndex) {\n return mBackingCache.get(keyFor(frameIndex));\n }\n\n /** Check whether the cache contains an image for the given frame index. */\n public boolean contains(int frameIndex) {\n return mBackingCache.contains(keyFor(frameIndex));\n }\n\n /**\n * Gets the image to be reused, or null if there is no such image.\n *\n *

The returned image is the least recently used image that has no more clients referencing it,\n * and it has not yet been evicted from the cache.\n *\n *

The client can freely modify the bitmap of the returned image and can cache it again without\n * any restrictions.\n */\n @Nullable\n public CloseableReference getForReuse() {\n while (true) {\n CacheKey key = popFirstFreeItemKey();\n if (key == null) {\n return null;\n }\n CloseableReference imageRef = mBackingCache.reuse(key);\n if (imageRef != null) {\n return imageRef;\n }\n }\n }\n\n @Nullable\n private synchronized CacheKey popFirstFreeItemKey() {\n CacheKey cacheKey = null;\n Iterator iterator = mFreeItemsPool.iterator();\n if (iterator.hasNext()) {\n cacheKey = iterator.next();\n iterator.remove();\n }\n return cacheKey;\n }\n\n private FrameKey keyFor(int frameIndex) {\n return new FrameKey(mImageCacheKey, frameIndex);\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/impl/AnimatedImageCompositor.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.impl;\n\nimport android.graphics.Bitmap;\nimport android.graphics.Canvas;\nimport android.graphics.Color;\nimport android.graphics.Paint;\nimport android.graphics.PorterDuff;\nimport android.graphics.PorterDuffXfermode;\nimport com.facebook.common.references.CloseableReference;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo.BlendOperation;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo.DisposalMethod;\nimport com.facebook.imagepipeline.animated.base.AnimatedImage;\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult;\nimport com.facebook.imagepipeline.transformation.BitmapTransformation;\nimport com.facebook.infer.annotation.Nullsafe;\nimport javax.annotation.Nullable;\n\n/**\n * Contains the logic for compositing the frames of an {@link AnimatedImage}. Animated image formats\n * like GIF and WebP support inter-frame compression where a subsequent frame may require being\n * blended on a previous frame in order to render the full frame. This class encapsulates the\n * behavior to be able to render any frame of the image. Designed to work with a cache via a\n * Callback.\n */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class AnimatedImageCompositor {\n\n /** Callback for caching. */\n public interface Callback {\n\n /**\n * Called from within {@link #renderFrame} to let the caller know that while trying generate the\n * requested frame, an earlier frame was generated. This allows the caller to optionally cache\n * the intermediate result. The caller must copy the Bitmap if it wishes to cache it as {@link\n * #renderFrame} will continue using it generate the requested frame.\n *\n * @param frameNumber the frame number of the intermediate result\n * @param bitmap the bitmap which must not be modified or directly cached\n */\n void onIntermediateResult(int frameNumber, Bitmap bitmap);\n\n /**\n * Called from within {@link #renderFrame} to ask the caller for a cached bitmap for the\n * specified frame number. If the caller has the bitmap cached, it can greatly reduce the work\n * required to render the requested frame.\n *\n * @param frameNumber the frame number to get\n * @return a reference to the bitmap. The ownership of the reference is passed to the caller who\n * must close it.\n */\n @Nullable\n CloseableReference getCachedBitmap(int frameNumber);\n }\n\n private final AnimatedDrawableBackend mAnimatedDrawableBackend;\n private final Callback mCallback;\n private final Paint mTransparentFillPaint;\n private final boolean mIsNewRenderImplementation;\n\n public AnimatedImageCompositor(\n AnimatedDrawableBackend animatedDrawableBackend,\n boolean isNewRenderImplementation,\n Callback callback) {\n mAnimatedDrawableBackend = animatedDrawableBackend;\n mCallback = callback;\n mIsNewRenderImplementation = isNewRenderImplementation;\n mTransparentFillPaint = new Paint();\n mTransparentFillPaint.setColor(Color.TRANSPARENT);\n mTransparentFillPaint.setStyle(Paint.Style.FILL);\n mTransparentFillPaint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.SRC));\n }\n\n public void renderDeltas(int frameNumber, Bitmap baseBitmap) {\n Canvas canvas = new Canvas(baseBitmap);\n mAnimatedDrawableBackend.renderDeltas(frameNumber, canvas);\n }\n\n /**\n * Renders the specified frame. Only should be called on the rendering thread.\n *\n * @param frameNumber the frame to render\n * @param bitmap the bitmap to render into\n */\n public void renderFrame(int frameNumber, Bitmap bitmap) {\n if (mIsNewRenderImplementation) {\n renderDeltas(frameNumber, bitmap);\n return;\n }\n\n Canvas canvas = new Canvas(bitmap);\n canvas.drawColor(Color.TRANSPARENT, PorterDuff.Mode.SRC);\n\n // If blending is required, prepare the canvas with the nearest cached frame.\n int nextIndex;\n if (!isKeyFrame(frameNumber)) {\n // Blending is required. nextIndex points to the next index to render onto the canvas.\n nextIndex = prepareCanvasWithClosestCachedFrame(frameNumber - 1, canvas);\n } else {\n // Blending isn't required. Start at the frame we're trying to render.\n nextIndex = frameNumber;\n }\n\n // Iterate from nextIndex to the frame number just preceding the one we're trying to render\n // and composite them in order according to the Disposal Method.\n for (int index = nextIndex; index < frameNumber; index++) {\n AnimatedDrawableFrameInfo frameInfo = mAnimatedDrawableBackend.getFrameInfo(index);\n DisposalMethod disposalMethod = frameInfo.disposalMethod;\n if (disposalMethod == DisposalMethod.DISPOSE_TO_PREVIOUS) {\n continue;\n }\n if (frameInfo.blendOperation == BlendOperation.NO_BLEND) {\n disposeToBackground(canvas, frameInfo);\n }\n mAnimatedDrawableBackend.renderFrame(index, canvas);\n mCallback.onIntermediateResult(index, bitmap);\n if (disposalMethod == DisposalMethod.DISPOSE_TO_BACKGROUND) {\n disposeToBackground(canvas, frameInfo);\n }\n }\n\n AnimatedDrawableFrameInfo frameInfo = mAnimatedDrawableBackend.getFrameInfo(frameNumber);\n if (frameInfo.blendOperation == BlendOperation.NO_BLEND) {\n disposeToBackground(canvas, frameInfo);\n }\n // Finally, we render the current frame. We don't dispose it.\n mAnimatedDrawableBackend.renderFrame(frameNumber, canvas);\n maybeApplyTransformation(bitmap);\n }\n\n /** Return value for {@link #isFrameNeededForRendering} used in the compositing logic. */\n private enum FrameNeededResult {\n /** The frame is required to render the next frame */\n REQUIRED,\n\n /** The frame is not required to render the next frame. */\n NOT_REQUIRED,\n\n /** Skip this frame and keep going. Used for GIF's DISPOSE_TO_PREVIOUS */\n SKIP,\n\n /** Stop processing at this frame. This means the image didn't specify the disposal method */\n ABORT\n }\n\n /**\n * Given a frame number, prepares the canvas to render based on the nearest cached frame at or\n * before the frame. On return the canvas will be prepared as if the nearest cached frame had been\n * rendered and disposed. The returned index is the next frame that needs to be composited onto\n * the canvas.\n *\n * @param previousFrameNumber the frame number that is ones less than the one we're rendering\n * @param canvas the canvas to prepare\n * @return the index of the the next frame to process\n */\n private int prepareCanvasWithClosestCachedFrame(int previousFrameNumber, Canvas canvas) {\n for (int index = previousFrameNumber; index >= 0; index--) {\n FrameNeededResult neededResult = isFrameNeededForRendering(index);\n switch (neededResult) {\n case REQUIRED:\n AnimatedDrawableFrameInfo frameInfo = mAnimatedDrawableBackend.getFrameInfo(index);\n CloseableReference startBitmap = mCallback.getCachedBitmap(index);\n if (startBitmap != null) {\n try {\n canvas.drawBitmap(startBitmap.get(), 0, 0, null);\n if (frameInfo.disposalMethod == DisposalMethod.DISPOSE_TO_BACKGROUND) {\n disposeToBackground(canvas, frameInfo);\n }\n return index + 1;\n } finally {\n if (!mIsNewRenderImplementation) {\n startBitmap.close();\n }\n }\n } else {\n if (isKeyFrame(index)) {\n return index;\n } else {\n // Keep going.\n break;\n }\n }\n case NOT_REQUIRED:\n return index + 1;\n case ABORT:\n return index;\n case SKIP:\n default:\n // Keep going.\n }\n }\n return 0;\n }\n\n private void disposeToBackground(Canvas canvas, AnimatedDrawableFrameInfo frameInfo) {\n canvas.drawRect(\n frameInfo.xOffset,\n frameInfo.yOffset,\n frameInfo.xOffset + frameInfo.width,\n frameInfo.yOffset + frameInfo.height,\n mTransparentFillPaint);\n }\n\n /**\n * Returns whether the specified frame is needed for rendering the next frame. This is part of the\n * compositing logic. See {@link FrameNeededResult} for more info about the results.\n *\n * @param index the frame to check\n * @return whether the frame is required taking into account special conditions\n */\n private FrameNeededResult isFrameNeededForRendering(int index) {\n AnimatedDrawableFrameInfo frameInfo = mAnimatedDrawableBackend.getFrameInfo(index);\n DisposalMethod disposalMethod = frameInfo.disposalMethod;\n if (disposalMethod == DisposalMethod.DISPOSE_DO_NOT) {\n // Need this frame so keep going.\n return FrameNeededResult.REQUIRED;\n } else if (disposalMethod == DisposalMethod.DISPOSE_TO_BACKGROUND) {\n if (isFullFrame(frameInfo)) {\n // The frame covered the whole image and we're disposing to background,\n // so we don't even need to draw this frame.\n return FrameNeededResult.NOT_REQUIRED;\n } else {\n // We need to draw the image. Then erase the part the previous frame covered.\n // So keep going.\n return FrameNeededResult.REQUIRED;\n }\n } else if (disposalMethod == DisposalMethod.DISPOSE_TO_PREVIOUS) {\n return FrameNeededResult.SKIP;\n } else {\n return FrameNeededResult.ABORT;\n }\n }\n\n private boolean isKeyFrame(int index) {\n if (index == 0) {\n return true;\n }\n AnimatedDrawableFrameInfo currFrameInfo = mAnimatedDrawableBackend.getFrameInfo(index);\n AnimatedDrawableFrameInfo prevFrameInfo = mAnimatedDrawableBackend.getFrameInfo(index - 1);\n if (currFrameInfo.blendOperation == BlendOperation.NO_BLEND && isFullFrame(currFrameInfo)) {\n return true;\n } else\n return prevFrameInfo.disposalMethod == DisposalMethod.DISPOSE_TO_BACKGROUND\n && isFullFrame(prevFrameInfo);\n }\n\n private boolean isFullFrame(AnimatedDrawableFrameInfo frameInfo) {\n return frameInfo.xOffset == 0\n && frameInfo.yOffset == 0\n && frameInfo.width == mAnimatedDrawableBackend.getRenderedWidth()\n && frameInfo.height == mAnimatedDrawableBackend.getRenderedHeight();\n }\n\n private void maybeApplyTransformation(Bitmap bitmap) {\n AnimatedImageResult animatedImageResult = mAnimatedDrawableBackend.getAnimatedImageResult();\n\n if (animatedImageResult == null) {\n return;\n }\n\n BitmapTransformation tr = animatedImageResult.getBitmapTransformation();\n\n if (tr == null) {\n return;\n }\n\n tr.transform(bitmap);\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/impl/package-info.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\n/** Base implementations for the animation framework abstractions. */\npackage com.facebook.imagepipeline.animated.impl;\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/util/AnimatedDrawableUtil.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.util\n\nimport android.graphics.Bitmap\nimport java.util.Arrays\n\n/** Utility methods for AnimatedDrawable. */\nclass AnimatedDrawableUtil {\n\n /**\n * Adjusts the frame duration array to respect logic for minimum frame duration time.\n *\n * @param frameDurationMs the frame duration array\n */\n fun fixFrameDurations(frameDurationMs: IntArray) {\n // We follow Chrome's behavior which comes from Firefox.\n // Comment from Chrome's ImageSource.cpp follows:\n // We follow Firefox's behavior and use a duration of 100 ms for any frames that specify\n // a duration of <= 10 ms. See and \n // for more information.\n for (i in frameDurationMs.indices) {\n if (frameDurationMs[i] < MIN_FRAME_DURATION_MS) {\n frameDurationMs[i] = FRAME_DURATION_MS_FOR_MIN\n }\n }\n }\n\n /**\n * Gets the total duration of an image by summing up the duration of the frames.\n *\n * @param frameDurationMs the frame duration array\n * @return the total duration in milliseconds\n */\n fun getTotalDurationFromFrameDurations(frameDurationMs: IntArray): Int {\n var totalMs = 0\n for (i in frameDurationMs.indices) {\n totalMs += frameDurationMs[i]\n }\n return totalMs\n }\n\n /**\n * Given an array of frame durations, generate an array of timestamps corresponding to when each\n * frame beings.\n *\n * @param frameDurationsMs an array of frame durations\n * @return an array of timestamps\n */\n fun getFrameTimeStampsFromDurations(frameDurationsMs: IntArray): IntArray {\n val frameTimestampsMs = IntArray(frameDurationsMs.size)\n var accumulatedDurationMs = 0\n for (i in frameDurationsMs.indices) {\n frameTimestampsMs[i] = accumulatedDurationMs\n accumulatedDurationMs += frameDurationsMs[i]\n }\n return frameTimestampsMs\n }\n\n /**\n * Gets the frame index for specified timestamp.\n *\n * @param frameTimestampsMs an array of timestamps generated by [getFrameForTimestampMs)]\n * @param timestampMs the timestamp\n * @return the frame index for the timestamp or the last frame number if the timestamp is outside\n * the duration of the entire animation\n */\n fun getFrameForTimestampMs(frameTimestampsMs: IntArray?, timestampMs: Int): Int {\n val index = Arrays.binarySearch(frameTimestampsMs, timestampMs)\n return if (index < 0) {\n -index - 1 - 1\n } else {\n index\n }\n }\n\n fun getSizeOfBitmap(bitmap: Bitmap): Int = bitmap.allocationByteCount\n\n companion object {\n // See comment in fixFrameDurations below.\n private const val MIN_FRAME_DURATION_MS = 11\n private const val FRAME_DURATION_MS_FOR_MIN = 100\n\n /**\n * Checks whether the specified frame number is outside the range inclusive of both start and\n * end. If start <= end, start is within, end is within, and everything in between is within. If\n * start\n * > end, start is within, end is within, everything less than start is within and everything\n * > greater than end is within. This behavior is useful for handling the wrapping case.\n *\n * @param startFrame the start frame\n * @param endFrame the end frame\n * @param frameNumber the frame number\n * @return whether the frame is outside the range of [start, end]\n */\n @JvmStatic\n fun isOutsideRange(startFrame: Int, endFrame: Int, frameNumber: Int): Boolean {\n if (startFrame == -1 || endFrame == -1) {\n // This means nothing should pass.\n return true\n }\n val outsideRange =\n if (startFrame <= endFrame) {\n frameNumber < startFrame || frameNumber > endFrame\n } else {\n // Wrapping\n frameNumber < startFrame && frameNumber > endFrame\n }\n return outsideRange\n }\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/animated/util/package-info.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\n/** Utility classes for the animation framework */\npackage com.facebook.imagepipeline.animated.util\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/image/CloseableAnimatedImage.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.image;\n\nimport com.facebook.imagepipeline.animated.base.AnimatedImage;\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult;\nimport com.facebook.infer.annotation.Nullsafe;\nimport javax.annotation.Nullable;\n\n/**\n * Encapsulates the data needed in order for {@code AnimatedDrawable} to render a {@code\n * AnimatedImage}.\n */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class CloseableAnimatedImage extends DefaultCloseableImage {\n\n private @Nullable AnimatedImageResult mImageResult;\n\n private boolean mIsStateful;\n\n public CloseableAnimatedImage(AnimatedImageResult imageResult) {\n this(imageResult, true);\n }\n\n public CloseableAnimatedImage(AnimatedImageResult imageResult, boolean isStateful) {\n mImageResult = imageResult;\n mIsStateful = isStateful;\n }\n\n @Override\n public synchronized int getWidth() {\n return mImageResult == null ? 0 : mImageResult.getImage().getWidth();\n }\n\n @Override\n public synchronized int getHeight() {\n return mImageResult == null ? 0 : mImageResult.getImage().getHeight();\n }\n\n @Override\n public void close() {\n AnimatedImageResult imageResult;\n synchronized (this) {\n if (mImageResult == null) {\n return;\n }\n imageResult = mImageResult;\n mImageResult = null;\n }\n imageResult.dispose();\n }\n\n @Override\n public synchronized boolean isClosed() {\n return mImageResult == null;\n }\n\n @Override\n public synchronized int getSizeInBytes() {\n return mImageResult == null ? 0 : mImageResult.getImage().getSizeInBytes();\n }\n\n @Override\n public boolean isStateful() {\n return mIsStateful;\n }\n\n public synchronized @Nullable AnimatedImageResult getImageResult() {\n return mImageResult;\n }\n\n public synchronized @Nullable AnimatedImage getImage() {\n return mImageResult == null ? null : mImageResult.getImage();\n }\n}\n" }, { "path": "animated-base/src/main/java/com/facebook/imagepipeline/image/package-info.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\n/** CloseableReference implementation for objects used into the animation framework. */\npackage com.facebook.imagepipeline.image;\n" }, { "path": "animated-base/src/test/java/android/net/http/AndroidHttpClient.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage android.net.http;\n\npublic class AndroidHttpClient {}\n" }, { "path": "animated-base/src/test/java/com/facebook/fresco/animation/bitmap/cache/FrescoFrameCacheTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.cache\n\nimport android.graphics.Bitmap\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.imagepipeline.image.CloseableImage\nimport com.facebook.imagepipeline.image.CloseableStaticBitmap\nimport org.assertj.core.api.Assertions\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.verifyNoMoreInteractions\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\n\n/** Tests [FrescoFrameCache]. */\n@RunWith(RobolectricTestRunner::class)\nclass FrescoFrameCacheTest {\n private lateinit var imageReference: CloseableReference\n private lateinit var closeableStaticBitmap: CloseableStaticBitmap\n private lateinit var bitmapReference: CloseableReference\n private lateinit var bitmapReferenceClone: CloseableReference\n private lateinit var underlyingBitmap: Bitmap\n\n @Before\n fun setup() {\n imageReference = mock()\n closeableStaticBitmap = mock()\n bitmapReference = mock()\n bitmapReferenceClone = mock()\n underlyingBitmap = mock()\n\n whenever(bitmapReference.isValid).thenReturn(true)\n whenever(bitmapReference.get()).thenReturn(underlyingBitmap)\n\n whenever(bitmapReferenceClone.isValid).thenReturn(true)\n whenever(bitmapReferenceClone.get()).thenReturn(underlyingBitmap)\n\n whenever(closeableStaticBitmap.isClosed()).thenReturn(false)\n whenever(closeableStaticBitmap.getUnderlyingBitmap()).thenReturn(underlyingBitmap)\n whenever(closeableStaticBitmap.convertToBitmapReference()).thenReturn(bitmapReference)\n whenever(closeableStaticBitmap.cloneUnderlyingBitmapReference())\n .thenReturn(bitmapReferenceClone)\n\n whenever(imageReference.isValid).thenReturn(true)\n whenever(imageReference.get()).thenReturn(closeableStaticBitmap)\n }\n\n @Test\n @Throws(Exception::class)\n fun testExtractAndClose() {\n val extractedReference: CloseableReference? =\n FrescoFrameCache.convertToBitmapReferenceAndClose(imageReference)\n\n Assertions.assertThat(extractedReference).isNotNull()\n extractedReference?.let { ref ->\n Assertions.assertThat(ref.get()).isEqualTo(underlyingBitmap)\n ref.close()\n }\n verify(imageReference).close()\n }\n\n @Test\n @Throws(Exception::class)\n fun testExtractAndClose_whenBitmapRecycled_thenReturnReference() {\n whenever(underlyingBitmap.isRecycled).thenReturn(true)\n\n val extractedReference: CloseableReference? =\n FrescoFrameCache.convertToBitmapReferenceAndClose(imageReference)\n\n // We only detach the reference and do not care if the bitmap is valid\n Assertions.assertThat(extractedReference).isNotNull()\n extractedReference?.let { ref ->\n Assertions.assertThat(ref.get()).isEqualTo(underlyingBitmap)\n ref.close()\n }\n verify(imageReference).close()\n }\n\n @Test\n @Throws(Exception::class)\n fun testExtractAndClose_whenBitmapReferenceInvalid_thenReturnReference() {\n whenever(bitmapReference.isValid).thenReturn(false)\n\n val extractedReference: CloseableReference? =\n FrescoFrameCache.convertToBitmapReferenceAndClose(imageReference)\n\n // We only detach the reference and do not care if the bitmap reference is valid\n Assertions.assertThat(extractedReference).isNotNull()\n extractedReference?.let { ref ->\n Assertions.assertThat(ref.get()).isEqualTo(underlyingBitmap)\n ref.close()\n }\n verify(imageReference).close()\n }\n\n @Test\n @Throws(Exception::class)\n fun testExtractAndClose_whenCloseableStaticBitmapClosed_thenReturnNull() {\n whenever(closeableStaticBitmap.isClosed()).thenReturn(true)\n whenever(closeableStaticBitmap.cloneUnderlyingBitmapReference()).thenReturn(null)\n\n val extractedReference: CloseableReference? =\n FrescoFrameCache.convertToBitmapReferenceAndClose(imageReference)\n\n // We only detach the reference and do not care if the bitmap is valid\n Assertions.assertThat(extractedReference).isNull()\n verify(imageReference).close()\n }\n\n @Test\n @Throws(Exception::class)\n fun testExtractAndClose_whenImageReferenceInvalid_thenReturnNull() {\n whenever(imageReference.isValid).thenReturn(false)\n\n val extractedReference: CloseableReference? =\n FrescoFrameCache.convertToBitmapReferenceAndClose(imageReference)\n\n // We only detach the reference and do not care if the bitmap is valid\n Assertions.assertThat(extractedReference).isNull()\n verify(imageReference).close()\n }\n\n @Test\n @Throws(Exception::class)\n fun testExtractAndClose_whenInputNull_thenReturnNull() {\n val extractedReference: CloseableReference? =\n FrescoFrameCache.convertToBitmapReferenceAndClose(null)\n\n Assertions.assertThat(extractedReference).isNull()\n verifyNoMoreInteractions(imageReference)\n }\n\n @Test\n @Throws(Exception::class)\n fun testExtractAndClose_whenCloseableStaticBitmapNull_thenReturnNull() {\n whenever(imageReference.get()).thenReturn(null)\n\n val extractedReference: CloseableReference? =\n FrescoFrameCache.convertToBitmapReferenceAndClose(imageReference)\n\n Assertions.assertThat(extractedReference).isNull()\n verify(imageReference).close()\n }\n}\n" }, { "path": "animated-base/src/test/java/com/facebook/fresco/animation/bitmap/wrapper/AnimatedDrawableBackendAnimationInformationTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.wrapper\n\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend\nimport org.assertj.core.api.Assertions\nimport org.junit.Before\nimport org.junit.Test\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.whenever\n\n/** Tests [AnimatedDrawableBackendAnimationInformation]. */\nclass AnimatedDrawableBackendAnimationInformationTest {\n private lateinit var animatedDrawableBackend: AnimatedDrawableBackend\n private lateinit var animatedDrawableBackendAnimationInformation:\n AnimatedDrawableBackendAnimationInformation\n\n @Before\n fun setup() {\n animatedDrawableBackend = mock()\n animatedDrawableBackendAnimationInformation =\n AnimatedDrawableBackendAnimationInformation(animatedDrawableBackend)\n }\n\n @Test\n @Throws(Exception::class)\n fun testGetFrameCount() {\n whenever(animatedDrawableBackend.getFrameCount()).thenReturn(123)\n\n Assertions.assertThat(animatedDrawableBackendAnimationInformation.getFrameCount())\n .isEqualTo(123)\n }\n\n @Test\n @Throws(Exception::class)\n fun testGetFrameDurationMs() {\n whenever(animatedDrawableBackend.getDurationMsForFrame(1)).thenReturn(123)\n whenever(animatedDrawableBackend.getDurationMsForFrame(2)).thenReturn(200)\n\n Assertions.assertThat(animatedDrawableBackendAnimationInformation.getFrameDurationMs(1))\n .isEqualTo(123)\n Assertions.assertThat(animatedDrawableBackendAnimationInformation.getFrameDurationMs(2))\n .isEqualTo(200)\n }\n\n @Test\n @Throws(Exception::class)\n fun testGetLoopCount() {\n whenever(animatedDrawableBackend.getLoopCount()).thenReturn(123)\n Assertions.assertThat(animatedDrawableBackendAnimationInformation.getLoopCount()).isEqualTo(123)\n }\n\n @Test\n @Throws(Exception::class)\n fun testGetLoopCountInfinite() {\n whenever(animatedDrawableBackend.getLoopCount())\n .thenReturn(AnimationBackend.LOOP_COUNT_INFINITE)\n\n Assertions.assertThat(animatedDrawableBackendAnimationInformation.getLoopCount())\n .isEqualTo(AnimationBackend.LOOP_COUNT_INFINITE)\n }\n}\n" }, { "path": "animated-base/src/test/java/com/facebook/fresco/animation/bitmap/wrapper/AnimatedDrawableBackendFrameRendererTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.wrapper\n\nimport android.graphics.Bitmap\nimport android.graphics.Canvas\nimport android.graphics.Rect\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo\nimport org.assertj.core.api.Assertions\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.kotlin.any\nimport org.mockito.kotlin.doThrow\nimport org.mockito.kotlin.eq\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\n\n/** Tests [AnimatedDrawableBackendFrameRenderer] */\n@RunWith(RobolectricTestRunner::class)\nclass AnimatedDrawableBackendFrameRendererTest {\n private lateinit var animatedDrawableBackendFrameRenderer: AnimatedDrawableBackendFrameRenderer\n private lateinit var animatedDrawableBackend: AnimatedDrawableBackend\n private lateinit var bitmapFrameCache: BitmapFrameCache\n\n @Before\n fun setup() {\n animatedDrawableBackend = mock()\n bitmapFrameCache = mock()\n animatedDrawableBackendFrameRenderer =\n AnimatedDrawableBackendFrameRenderer(bitmapFrameCache, animatedDrawableBackend, false)\n }\n\n @Test\n fun testSetBounds() {\n whenever(animatedDrawableBackend.forNewBounds(any())).thenReturn(animatedDrawableBackend)\n\n val bounds: Rect = mock()\n animatedDrawableBackendFrameRenderer.setBounds(bounds)\n\n verify(animatedDrawableBackend).forNewBounds(bounds)\n }\n\n @Test\n fun testGetIntrinsicWidth() {\n whenever(animatedDrawableBackend.getWidth()).thenReturn(123)\n\n Assertions.assertThat(animatedDrawableBackendFrameRenderer.intrinsicWidth).isEqualTo(123)\n Assertions.assertThat(animatedDrawableBackendFrameRenderer.intrinsicHeight).isNotEqualTo(123)\n }\n\n @Test\n fun testGetIntrinsicHeight() {\n whenever(animatedDrawableBackend.getHeight()).thenReturn(1200)\n\n Assertions.assertThat(animatedDrawableBackendFrameRenderer.intrinsicHeight).isEqualTo(1200)\n Assertions.assertThat(animatedDrawableBackendFrameRenderer.intrinsicWidth).isNotEqualTo(1200)\n }\n\n @Test\n fun testRenderFrame() {\n whenever(animatedDrawableBackend.getHeight()).thenReturn(1200)\n val bitmap: Bitmap = mockBitmap()\n val animatedDrawableFrameInfo: AnimatedDrawableFrameInfo = mock()\n whenever(animatedDrawableBackend.getFrameInfo(any())).thenReturn(animatedDrawableFrameInfo)\n\n val rendered = animatedDrawableBackendFrameRenderer.renderFrame(0, bitmap)\n\n Assertions.assertThat(rendered).isTrue()\n }\n\n @Test\n fun testRenderFrameUnsuccessful() {\n val frameNumber = 0\n\n whenever(animatedDrawableBackend.getHeight()).thenReturn(1200)\n val bitmap: Bitmap = mockBitmap()\n val animatedDrawableFrameInfo: AnimatedDrawableFrameInfo = mock()\n whenever(animatedDrawableBackend.getFrameInfo(any())).thenReturn(animatedDrawableFrameInfo)\n doThrow(IllegalStateException())\n .whenever(animatedDrawableBackend)\n .renderFrame(eq(frameNumber), any())\n\n val rendered = animatedDrawableBackendFrameRenderer.renderFrame(frameNumber, bitmap)\n\n Assertions.assertThat(rendered).isFalse()\n }\n\n companion object {\n private fun mockBitmap(): Bitmap {\n val mock: Bitmap = mock()\n whenever(mock.isMutable).thenReturn(true)\n return mock\n }\n }\n}\n" }, { "path": "animated-base/src/test/java/com/facebook/imagepipeline/animated/impl/AnimatedDrawableBackendImplTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.impl\n\nimport android.graphics.Bitmap\nimport android.graphics.Canvas\nimport android.graphics.Rect\nimport com.facebook.imagepipeline.animated.base.AnimatedImage\nimport com.facebook.imagepipeline.animated.base.AnimatedImageFrame\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult\nimport com.facebook.imagepipeline.animated.util.AnimatedDrawableUtil\nimport org.junit.After\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.MockedStatic\nimport org.mockito.Mockito\nimport org.mockito.kotlin.any\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\n\n@RunWith(RobolectricTestRunner::class)\nclass AnimatedDrawableBackendImplTest {\n private lateinit var animatedDrawableUtil: AnimatedDrawableUtil\n private lateinit var animatedImageResult: AnimatedImageResult\n private lateinit var canvas: Canvas\n private lateinit var image: AnimatedImage\n private lateinit var frame: AnimatedImageFrame\n private lateinit var bitmap: Bitmap\n private lateinit var rect: Rect\n private lateinit var mockedBitmap: MockedStatic\n\n @Before\n @Throws(Exception::class)\n fun setUp() {\n animatedDrawableUtil = mock()\n animatedImageResult = mock()\n canvas = mock()\n image = mock()\n frame = mock()\n bitmap = mock()\n rect = mock()\n\n mockedBitmap = Mockito.mockStatic(Bitmap::class.java)\n\n whenever(animatedImageResult.image).thenReturn(image)\n whenever(image.doesRenderSupportScaling()).thenReturn(false)\n whenever(image.getFrame(any())).thenReturn(frame)\n\n mockedBitmap\n .`when` {\n Bitmap.createBitmap(\n Mockito.anyInt(),\n Mockito.anyInt(),\n Mockito.any(Bitmap.Config::class.java),\n )\n }\n .thenReturn(bitmap)\n }\n\n private fun verifyBasic(\n canvasWidth: Int,\n canvasHeight: Int,\n frameOriginalWidth: Int,\n frameOriginalHeight: Int,\n frameExpectedRenderedWidth: Int,\n frameExpectedRenderedHeight: Int,\n ) {\n whenever(canvas.width).thenReturn(canvasWidth)\n whenever(canvas.height).thenReturn(canvasHeight)\n whenever(frame.width).thenReturn(frameOriginalWidth)\n whenever(frame.height).thenReturn(frameOriginalHeight)\n\n val animatedDrawableBackendImpl =\n AnimatedDrawableBackendImpl(animatedDrawableUtil, animatedImageResult, rect, true)\n\n animatedDrawableBackendImpl.renderFrame(0, canvas)\n\n verify(frame).renderFrame(frameExpectedRenderedWidth, frameExpectedRenderedHeight, bitmap)\n }\n\n @After\n fun tearDownStaticMocks() {\n mockedBitmap.close()\n }\n\n @Test\n fun testSimple() {\n verifyBasic(128, 128, 512, 512, 128, 128)\n }\n\n @Test\n fun testNoUpscaling() {\n verifyBasic(128, 128, 16, 16, 16, 16)\n }\n\n @Test\n fun testNarrow() {\n verifyBasic(64, 128, 256, 256, 64, 64)\n }\n\n @Test\n fun testOffsets() {\n val frameSide = 1024\n val canvasSide = 256\n val scale = frameSide / canvasSide\n\n val frameOffset = 512\n whenever(frame.xOffset).thenReturn(frameOffset)\n whenever(frame.yOffset).thenReturn(frameOffset)\n\n verifyBasic(canvasSide, canvasSide, frameSide, frameSide, frameSide / scale, frameSide / scale)\n verify(canvas).translate((frameOffset / scale).toFloat(), (frameOffset / scale).toFloat())\n }\n}\n" }, { "path": "animated-base/src/test/java/com/facebook/imagepipeline/animated/impl/AnimatedFrameCacheTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.impl\n\nimport com.facebook.cache.common.CacheKey\nimport com.facebook.cache.common.SimpleCacheKey\nimport com.facebook.common.internal.Supplier\nimport com.facebook.common.memory.MemoryTrimmableRegistry\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.common.util.ByteConstants\nimport com.facebook.imagepipeline.cache.BitmapMemoryCacheTrimStrategy\nimport com.facebook.imagepipeline.cache.CountingLruBitmapMemoryCacheFactory\nimport com.facebook.imagepipeline.cache.CountingMemoryCache\nimport com.facebook.imagepipeline.cache.MemoryCacheParams\nimport com.facebook.imagepipeline.image.CloseableImage\nimport java.util.concurrent.TimeUnit\nimport org.assertj.core.api.Assertions.assertThat\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\n\n@RunWith(RobolectricTestRunner::class)\nclass AnimatedFrameCacheTest {\n private lateinit var memoryTrimmableRegistry: MemoryTrimmableRegistry\n private lateinit var memoryCacheParamsSupplier: Supplier\n\n private lateinit var cacheKey: CacheKey\n private lateinit var animatedFrameCache: AnimatedFrameCache\n private lateinit var frame1: CloseableReference\n private lateinit var frame2: CloseableReference\n\n @Before\n fun setUp() {\n memoryTrimmableRegistry = mock()\n memoryCacheParamsSupplier = mock()\n\n val params: MemoryCacheParams =\n MemoryCacheParams(\n 4 * ByteConstants.MB,\n 256,\n Int.Companion.MAX_VALUE,\n Int.Companion.MAX_VALUE,\n Int.Companion.MAX_VALUE,\n TimeUnit.MINUTES.toMillis(5),\n )\n whenever(memoryCacheParamsSupplier.get()).thenReturn(params)\n val countingMemoryCache: CountingMemoryCache =\n CountingLruBitmapMemoryCacheFactory()\n .create(\n memoryCacheParamsSupplier,\n memoryTrimmableRegistry,\n BitmapMemoryCacheTrimStrategy(),\n false,\n false,\n null,\n )\n cacheKey = SimpleCacheKey(\"key\")\n animatedFrameCache = AnimatedFrameCache(cacheKey, countingMemoryCache)\n frame1 = CloseableReference.of(mock())\n frame2 = CloseableReference.of(mock())\n }\n\n @Test\n fun testBasic() {\n val ret = animatedFrameCache.cache(1, frame1)\n assertThat(ret?.get()).isSameAs(frame1.get())\n }\n\n @Test\n fun testMultipleFrames() {\n animatedFrameCache.cache(1, frame1)\n animatedFrameCache.cache(2, frame2)\n assertThat(animatedFrameCache.get(1)?.get()).isSameAs(frame1.get())\n assertThat(animatedFrameCache.get(2)?.get()).isSameAs(frame2.get())\n }\n\n @Test\n fun testReplace() {\n animatedFrameCache.cache(1, frame1)\n animatedFrameCache.cache(1, frame2)\n assertThat(animatedFrameCache.get(1)?.get()).isNotSameAs(frame1.get())\n assertThat(animatedFrameCache.get(1)?.get()).isSameAs(frame2.get())\n }\n\n @Test\n fun testReuse() {\n val ret = animatedFrameCache.cache(1, frame1)\n ret?.close()\n val free = animatedFrameCache.getForReuse()\n assertThat(free).isNotNull()\n }\n\n @Test\n fun testCantReuseIfNotClosed() {\n val ret = animatedFrameCache.cache(1, frame1)\n val free = animatedFrameCache.getForReuse()\n assertThat(free).isNull()\n }\n\n @Test\n fun testStillThereIfClosed() {\n val ret = animatedFrameCache.cache(1, frame1)\n ret?.close()\n assertThat(animatedFrameCache.get(1)).isNotNull()\n }\n\n @Test\n fun testContains() {\n assertThat(animatedFrameCache.contains(1)).isFalse()\n\n val ret = animatedFrameCache.cache(1, frame1)\n\n assertThat(animatedFrameCache.contains(1)).isTrue()\n assertThat(animatedFrameCache.contains(2)).isFalse()\n\n ret?.close()\n\n assertThat(animatedFrameCache.contains(1)).isTrue()\n assertThat(animatedFrameCache.contains(2)).isFalse()\n }\n\n @Test\n fun testContainsWhenReused() {\n val ret = animatedFrameCache.cache(1, frame1)\n ret?.close()\n\n assertThat(animatedFrameCache.contains(1)).isTrue()\n assertThat(animatedFrameCache.contains(2)).isFalse()\n\n val free = animatedFrameCache.getForReuse()\n free?.close()\n\n assertThat(animatedFrameCache.contains(1)).isFalse()\n assertThat(animatedFrameCache.contains(2)).isFalse()\n }\n\n @Test\n fun testContainsFullReuseFlowWithMultipleItems() {\n assertThat(animatedFrameCache.contains(1)).isFalse()\n assertThat(animatedFrameCache.contains(2)).isFalse()\n\n val ret = animatedFrameCache.cache(1, frame1)\n val ret2 = animatedFrameCache.cache(2, frame2)\n\n assertThat(animatedFrameCache.contains(1)).isTrue()\n assertThat(animatedFrameCache.contains(2)).isTrue()\n\n ret?.close()\n ret2?.close()\n\n assertThat(animatedFrameCache.contains(1)).isTrue()\n assertThat(animatedFrameCache.contains(2)).isTrue()\n\n var free = animatedFrameCache.getForReuse()\n free?.close()\n\n assertThat(animatedFrameCache.contains(1)).isFalse()\n assertThat(animatedFrameCache.contains(2)).isTrue()\n\n free = animatedFrameCache.getForReuse()\n free?.close()\n\n assertThat(animatedFrameCache.contains(1)).isFalse()\n assertThat(animatedFrameCache.contains(2)).isFalse()\n }\n}\n" }, { "path": "animated-base/src/test/java/com/facebook/imagepipeline/animated/testing/TestAnimatedDrawableBackend.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.testing;\n\nimport android.graphics.Bitmap;\nimport android.graphics.Canvas;\nimport android.graphics.Rect;\nimport com.facebook.common.references.CloseableReference;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableBackend;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo;\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult;\nimport com.facebook.infer.annotation.Nullsafe;\nimport javax.annotation.Nullable;\n\n/** Implementation of {@link AnimatedDrawableBackend} for unit tests. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class TestAnimatedDrawableBackend implements AnimatedDrawableBackend {\n\n private final int mWidth;\n private final int mHeight;\n private final int[] mFrameDurations;\n private final int[] mAccumulatedDurationsMs;\n\n private int mDropCachesCallCount;\n\n public TestAnimatedDrawableBackend(int width, int height, int[] frameDurations) {\n mWidth = width;\n mHeight = height;\n mFrameDurations = frameDurations;\n mAccumulatedDurationsMs = new int[mFrameDurations.length];\n int accumulatedDurationMs = 0;\n for (int i = 0; i < mAccumulatedDurationsMs.length; i++) {\n mAccumulatedDurationsMs[i] = accumulatedDurationMs + mFrameDurations[i];\n accumulatedDurationMs = mAccumulatedDurationsMs[i];\n }\n }\n\n public static int pixelValue(int frameNumber, int x, int y) {\n return ((frameNumber & 0xff) << 16) | ((x & 0xff) << 8) | ((y & 0xff));\n }\n\n @Nullable\n @Override\n // NULLSAFE_FIXME[Inconsistent Subclass Return Annotation]\n public AnimatedImageResult getAnimatedImageResult() {\n return null;\n }\n\n @Override\n public int getDurationMs() {\n return mAccumulatedDurationsMs[mAccumulatedDurationsMs.length - 1];\n }\n\n @Override\n public int getFrameCount() {\n return mFrameDurations.length;\n }\n\n @Override\n public int getLoopCount() {\n return 0;\n }\n\n @Override\n public int getWidth() {\n return mWidth;\n }\n\n @Override\n public int getHeight() {\n return mHeight;\n }\n\n @Override\n public int getRenderedWidth() {\n return mWidth;\n }\n\n @Override\n public int getRenderedHeight() {\n return mHeight;\n }\n\n @Override\n public AnimatedDrawableFrameInfo getFrameInfo(int frameNumber) {\n return new AnimatedDrawableFrameInfo(\n frameNumber,\n 0,\n 0,\n mWidth,\n mHeight,\n AnimatedDrawableFrameInfo.BlendOperation.NO_BLEND,\n AnimatedDrawableFrameInfo.DisposalMethod.DISPOSE_DO_NOT);\n }\n\n @Override\n public void renderFrame(int frameNumber, Canvas canvas) {\n int[] pixels = new int[mWidth * mHeight];\n for (int i = 0; i < pixels.length; i++) {\n // We store the frame number in the R, the x in the G, and the y in the B.\n int x = i % mWidth;\n int y = i / mWidth;\n pixels[i] = pixelValue(frameNumber, x, y);\n }\n Bitmap bitmap = Bitmap.createBitmap(pixels, mWidth, mHeight, Bitmap.Config.ARGB_8888);\n canvas.drawBitmap(bitmap, 0, 0, null);\n }\n\n @Override\n public void renderDeltas(int frameNumber, Canvas canvas) {\n renderFrame(frameNumber, canvas);\n }\n\n @Override\n public int getFrameForTimestampMs(int timestampMs) {\n int accumulator = 0;\n for (int i = 0; i < mFrameDurations.length; i++) {\n if (timestampMs < accumulator + mFrameDurations[i]) {\n return i;\n }\n accumulator += mFrameDurations[i];\n }\n return mFrameDurations.length - 1;\n }\n\n @Override\n public int getTimestampMsForFrame(int frameNumber) {\n return frameNumber == 0 ? 0 : mAccumulatedDurationsMs[frameNumber - 1];\n }\n\n @Override\n public int getDurationMsForFrame(int frameNumber) {\n return mFrameDurations[frameNumber];\n }\n\n @Override\n public int getFrameForPreview() {\n return 0;\n }\n\n @Override\n public AnimatedDrawableBackend forNewBounds(@Nullable Rect bounds) {\n return this;\n }\n\n @Override\n public int getMemoryUsage() {\n return 0;\n }\n\n @Nullable\n @Override\n public CloseableReference getPreDecodedFrame(int frameNumber) {\n return null;\n }\n\n @Override\n public boolean hasPreDecodedFrame(int frameNumber) {\n return false;\n }\n\n public int getDropCachesCallCount() {\n return mDropCachesCallCount;\n }\n\n @Override\n public void dropCaches() {\n mDropCachesCallCount++;\n }\n}\n" }, { "path": "animated-base/src/test/java/com/facebook/imagepipeline/animated/util/AnimatedDrawableUtilTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.animated.util\n\nimport org.assertj.core.api.Assertions.assertThat\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.robolectric.RobolectricTestRunner\n\n/** Tests for [AnimatedDrawableUtil]. */\n@RunWith(RobolectricTestRunner::class)\nclass AnimatedDrawableUtilTest {\n @Test\n fun testGetFrameTimeStampsFromDurations() {\n val frameDurationsMs = intArrayOf(30, 30, 60, 30, 30)\n val util = AnimatedDrawableUtil()\n val frameTimestampsMs = util.getFrameTimeStampsFromDurations(frameDurationsMs)\n val expected = intArrayOf(0, 30, 60, 120, 150)\n assertThat(frameTimestampsMs).isEqualTo(expected)\n }\n\n @Test\n fun testGetFrameTimeStampsFromDurationsWithEmptyArray() {\n val frameDurationsMs = IntArray(0)\n val util = AnimatedDrawableUtil()\n val frameTimestampsMs = util.getFrameTimeStampsFromDurations(frameDurationsMs)\n assertThat(frameTimestampsMs.size.toLong()).isEqualTo(0)\n }\n\n @Test\n fun testGetFrameForTimestampMs() {\n val frameTimestampsMs = intArrayOf(0, 50, 75, 100, 200)\n val util = AnimatedDrawableUtil()\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 0).toLong()).isEqualTo(0)\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 1).toLong()).isEqualTo(0)\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 49).toLong()).isEqualTo(0)\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 50).toLong()).isEqualTo(1)\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 74).toLong()).isEqualTo(1)\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 75).toLong()).isEqualTo(2)\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 76).toLong()).isEqualTo(2)\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 99).toLong()).isEqualTo(2)\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 100).toLong()).isEqualTo(3)\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 101).toLong()).isEqualTo(3)\n assertThat(util.getFrameForTimestampMs(frameTimestampsMs, 200).toLong()).isEqualTo(4)\n }\n\n @Test\n fun testIsOutsideRange() {\n assertThat(AnimatedDrawableUtil.isOutsideRange(-1, -1, 1)).isTrue() // Always outside range\n\n // Test before, within, and after 2 through 5.\n var start = 2\n var end = 5\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 1)).isTrue()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 2)).isFalse()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 3)).isFalse()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 4)).isFalse()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 5)).isFalse()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 6)).isTrue()\n\n // Test wrapping case when start is greater than end\n // Test before, within, and after 4 through 1\n start = 4\n end = 1\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 0)).isFalse()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 1)).isFalse()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 2)).isTrue()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 3)).isTrue()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 4)).isFalse()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 5)).isFalse()\n\n // Test cases where start == end\n start = 2\n end = 2\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 1)).isTrue()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 2)).isFalse()\n assertThat(AnimatedDrawableUtil.isOutsideRange(start, end, 3)).isTrue()\n }\n}\n" }, { "path": "animated-base/src/test/java/com/facebook/imagepipeline/producers/AnimatedRepeatedPostprocessorProducerTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.producers\n\nimport android.graphics.Bitmap\nimport com.facebook.common.internal.ImmutableMap\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.common.references.ResourceReleaser\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.common.Priority\nimport com.facebook.imagepipeline.core.ImagePipelineConfig\nimport com.facebook.imagepipeline.image.CloseableAnimatedImage\nimport com.facebook.imagepipeline.image.CloseableImage\nimport com.facebook.imagepipeline.image.CloseableStaticBitmap\nimport com.facebook.imagepipeline.producers.PostprocessorProducer.RepeatedPostprocessorConsumer\nimport com.facebook.imagepipeline.request.ImageRequest\nimport com.facebook.imagepipeline.request.RepeatedPostprocessor\nimport com.facebook.imagepipeline.request.RepeatedPostprocessorRunner\nimport com.facebook.imagepipeline.testing.FakeClock\nimport com.facebook.imagepipeline.testing.TestExecutorService\nimport java.util.ArrayList\nimport org.assertj.core.api.Assertions.assertThat\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.InOrder\nimport org.mockito.Mock\nimport org.mockito.MockitoAnnotations\nimport org.mockito.kotlin.any\nimport org.mockito.kotlin.argumentCaptor\nimport org.mockito.kotlin.doAnswer\nimport org.mockito.kotlin.doReturn\nimport org.mockito.kotlin.doThrow\nimport org.mockito.kotlin.eq\nimport org.mockito.kotlin.inOrder\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.never\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\nimport org.robolectric.annotation.Config\n\n@RunWith(RobolectricTestRunner::class)\n@Config(manifest = Config.NONE)\nclass AnimatedRepeatedPostprocessorProducerTest {\n\n companion object {\n private const val POSTPROCESSOR_NAME = \"postprocessor_name\"\n private val extraMap = ImmutableMap.of(PostprocessorProducer.POSTPROCESSOR, POSTPROCESSOR_NAME)\n }\n\n @Mock lateinit var platformBitmapFactory: PlatformBitmapFactory\n @Mock lateinit var producerListener: ProducerListener2\n @Mock lateinit var inputProducer: Producer>\n @Mock lateinit var consumer: Consumer>\n @Mock lateinit var postprocessor: RepeatedPostprocessor\n @Mock lateinit var bitmapResourceReleaser: ResourceReleaser\n\n @Mock lateinit var imageRequest: ImageRequest\n\n @Mock lateinit var config: ImagePipelineConfig\n\n private lateinit var producerContext: SettableProducerContext\n private val requestId = \"requestId\"\n private lateinit var sourceBitmap: Bitmap\n private lateinit var sourceCloseableStaticBitmap: CloseableStaticBitmap\n private lateinit var sourceCloseableImageRef: CloseableReference\n private lateinit var destinationBitmap: Bitmap\n private lateinit var destinationCloseableBitmapRef: CloseableReference\n private lateinit var testExecutorService: TestExecutorService\n private lateinit var postprocessorProducer: PostprocessorProducer\n private lateinit var results: MutableList>\n\n private lateinit var inOrder: InOrder\n\n @Before\n fun setUp() {\n MockitoAnnotations.initMocks(this)\n testExecutorService = TestExecutorService(FakeClock())\n postprocessorProducer =\n PostprocessorProducer(inputProducer, platformBitmapFactory, testExecutorService)\n producerContext =\n SettableProducerContext(\n imageRequest,\n requestId,\n producerListener,\n mock(),\n ImageRequest.RequestLevel.FULL_FETCH,\n false /* isPrefetch */,\n false /* isIntermediateResultExpected */,\n Priority.MEDIUM,\n config,\n )\n whenever(imageRequest.postprocessor).thenReturn(postprocessor)\n results = ArrayList()\n whenever(postprocessor.name).thenReturn(POSTPROCESSOR_NAME)\n whenever(producerListener.requiresExtraMap(producerContext, POSTPROCESSOR_NAME))\n .thenReturn(true)\n doAnswer { invocation ->\n results.add((invocation.arguments[0] as CloseableReference).clone())\n null\n }\n .whenever(consumer)\n .onNewResult(any(), any())\n inOrder = inOrder(postprocessor, producerListener, consumer)\n }\n\n @Test\n fun testNonStaticBitmapIsPassedOn() {\n val postprocessorConsumer = produceResults()\n val repeatedPostprocessorRunner = getRunner()\n\n val sourceCloseableAnimatedImage = mock()\n val sourceCloseableImageRef =\n CloseableReference.of(sourceCloseableAnimatedImage)\n postprocessorConsumer.onNewResult(sourceCloseableImageRef, Consumer.IS_LAST)\n sourceCloseableImageRef.close()\n testExecutorService.runUntilIdle()\n\n inOrder\n .verify(consumer)\n .onNewResult(any>(), eq(Consumer.NO_FLAGS))\n inOrder.verifyNoMoreInteractions()\n\n assertThat(results).hasSize(1)\n val res0 = results[0]\n assertThat(CloseableReference.isValid(res0)).isTrue()\n assertThat(res0.get()).isSameAs(sourceCloseableAnimatedImage)\n res0.close()\n\n performCancelAndVerifyOnCancellation()\n verify(sourceCloseableAnimatedImage).close()\n }\n\n private fun setupNewSourceImage() {\n sourceBitmap = mock()\n sourceCloseableStaticBitmap = mock()\n whenever(sourceCloseableStaticBitmap.underlyingBitmap).thenReturn(sourceBitmap)\n sourceCloseableImageRef = CloseableReference.of(sourceCloseableStaticBitmap)\n }\n\n private fun setupNewDestinationImage() {\n destinationBitmap = mock()\n destinationCloseableBitmapRef = CloseableReference.of(destinationBitmap, bitmapResourceReleaser)\n doReturn(destinationCloseableBitmapRef)\n .whenever(postprocessor)\n .process(sourceBitmap, platformBitmapFactory)\n }\n\n private fun produceResults(): RepeatedPostprocessorConsumer {\n postprocessorProducer.produceResults(consumer, producerContext)\n\n // Use argumentCaptor from Mockito Kotlin\n val consumerCaptor = argumentCaptor>>()\n verify(inputProducer).produceResults(consumerCaptor.capture(), eq(producerContext))\n return consumerCaptor.firstValue as RepeatedPostprocessorConsumer\n }\n\n private fun getRunner(): RepeatedPostprocessorRunner {\n val captor = argumentCaptor()\n inOrder.verify(postprocessor).setCallback(captor.capture())\n return captor.firstValue\n }\n\n private fun performNewResult(postprocessorConsumer: RepeatedPostprocessorConsumer, run: Boolean) {\n setupNewSourceImage()\n setupNewDestinationImage()\n postprocessorConsumer.onNewResult(sourceCloseableImageRef, Consumer.IS_LAST)\n sourceCloseableImageRef.close()\n if (run) {\n testExecutorService.runUntilIdle()\n }\n }\n\n private fun performUpdate(\n repeatedPostprocessorRunner: RepeatedPostprocessorRunner,\n run: Boolean,\n ) {\n setupNewDestinationImage()\n repeatedPostprocessorRunner.update()\n if (run) {\n testExecutorService.runUntilIdle()\n }\n }\n\n private fun performUpdateDuringTheNextPostprocessing(\n repeatedPostprocessorRunner: RepeatedPostprocessorRunner\n ) {\n doAnswer {\n val destBitmapRef = destinationCloseableBitmapRef\n performUpdate(repeatedPostprocessorRunner, false)\n // the following call should be ignored\n performUpdate(repeatedPostprocessorRunner, false)\n destBitmapRef\n }\n .whenever(postprocessor)\n .process(sourceBitmap, platformBitmapFactory)\n }\n\n private fun performFailure(repeatedPostprocessorRunner: RepeatedPostprocessorRunner) {\n setupNewDestinationImage()\n doThrow(RuntimeException()).whenever(postprocessor).process(sourceBitmap, platformBitmapFactory)\n repeatedPostprocessorRunner.update()\n testExecutorService.runUntilIdle()\n }\n\n private fun performCancelAndVerifyOnCancellation() {\n performCancel()\n inOrder.verify(consumer).onCancellation()\n }\n\n private fun performCancelAfterFinished() {\n performCancel()\n inOrder.verify(consumer, never()).onCancellation()\n }\n\n private fun performCancel() {\n producerContext.cancel()\n testExecutorService.runUntilIdle()\n }\n\n private fun verifyNewResultProcessed(index: Int) {\n verifyNewResultProcessed(index, destinationBitmap)\n }\n\n private fun verifyNewResultProcessed(index: Int, destBitmap: Bitmap) {\n inOrder.verify(producerListener).onProducerStart(producerContext, PostprocessorProducer.NAME)\n inOrder.verify(postprocessor).process(sourceBitmap, platformBitmapFactory)\n inOrder.verify(producerListener).requiresExtraMap(producerContext, PostprocessorProducer.NAME)\n inOrder\n .verify(producerListener)\n .onProducerFinishWithSuccess(producerContext, PostprocessorProducer.NAME, extraMap)\n inOrder\n .verify(consumer)\n .onNewResult(any>(), eq(Consumer.NO_FLAGS))\n inOrder.verifyNoMoreInteractions()\n\n assertThat(results).hasSize(index + 1)\n val res0 = results[index]\n assertThat(CloseableReference.isValid(res0)).isTrue()\n assertThat((res0.get() as CloseableStaticBitmap).underlyingBitmap).isSameAs(destBitmap)\n res0.close()\n verify(bitmapResourceReleaser).release(destBitmap)\n }\n}\n" }, { "path": "animated-base/src/test/java/com/facebook/imagepipeline/producers/AnimatedSingleUsePostprocessorProducerTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.imagepipeline.producers\n\nimport android.graphics.Bitmap\nimport com.facebook.common.internal.ImmutableMap\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.common.references.ResourceReleaser\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.image.CloseableAnimatedImage\nimport com.facebook.imagepipeline.image.CloseableImage\nimport com.facebook.imagepipeline.image.CloseableStaticBitmap\nimport com.facebook.imagepipeline.producers.PostprocessorProducer.SingleUsePostprocessorConsumer\nimport com.facebook.imagepipeline.request.ImageRequest\nimport com.facebook.imagepipeline.request.Postprocessor\nimport com.facebook.imagepipeline.testing.FakeClock\nimport com.facebook.imagepipeline.testing.TestExecutorService\nimport java.util.ArrayList\nimport org.assertj.core.api.Assertions.assertThat\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.InOrder\nimport org.mockito.Mock\nimport org.mockito.MockitoAnnotations\nimport org.mockito.kotlin.any\nimport org.mockito.kotlin.argumentCaptor\nimport org.mockito.kotlin.doAnswer\nimport org.mockito.kotlin.eq\nimport org.mockito.kotlin.inOrder\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\nimport org.robolectric.annotation.Config\n\n@RunWith(RobolectricTestRunner::class)\n@Config(manifest = Config.NONE)\nclass AnimatedSingleUsePostprocessorProducerTest {\n\n companion object {\n private const val POSTPROCESSOR_NAME = \"postprocessor_name\"\n private val extraMap = ImmutableMap.of(PostprocessorProducer.POSTPROCESSOR, POSTPROCESSOR_NAME)\n }\n\n @Mock lateinit var platformBitmapFactory: PlatformBitmapFactory\n @Mock lateinit var producerContext: ProducerContext\n @Mock lateinit var producerListener: ProducerListener2\n @Mock lateinit var inputProducer: Producer>\n @Mock lateinit var consumer: Consumer>\n @Mock lateinit var postprocessor: Postprocessor\n @Mock lateinit var bitmapResourceReleaser: ResourceReleaser\n\n @Mock lateinit var imageRequest: ImageRequest\n\n private val requestId = \"mRequestId\"\n private lateinit var sourceBitmap: Bitmap\n private lateinit var sourceCloseableStaticBitmap: CloseableStaticBitmap\n private lateinit var sourceCloseableImageRef: CloseableReference\n private lateinit var destinationBitmap: Bitmap\n private lateinit var destinationCloseableBitmapRef: CloseableReference\n private lateinit var testExecutorService: TestExecutorService\n private lateinit var postprocessorProducer: PostprocessorProducer\n private lateinit var results: MutableList>\n\n private lateinit var inOrder: InOrder\n\n @Before\n fun setUp() {\n MockitoAnnotations.initMocks(this)\n testExecutorService = TestExecutorService(FakeClock())\n postprocessorProducer =\n PostprocessorProducer(inputProducer, platformBitmapFactory, testExecutorService)\n\n whenever(imageRequest.postprocessor).thenReturn(postprocessor)\n whenever(producerContext.id).thenReturn(requestId)\n whenever(producerContext.producerListener).thenReturn(producerListener)\n whenever(producerContext.imageRequest).thenReturn(imageRequest)\n\n results = ArrayList()\n whenever(postprocessor.name).thenReturn(POSTPROCESSOR_NAME)\n whenever(producerListener.requiresExtraMap(eq(producerContext), eq(POSTPROCESSOR_NAME)))\n .thenReturn(true)\n doAnswer { invocation ->\n results.add((invocation.arguments[0] as CloseableReference).clone())\n null\n }\n .whenever(consumer)\n .onNewResult(any(), any())\n inOrder = inOrder(postprocessor, producerListener, consumer)\n\n sourceBitmap = mock()\n sourceCloseableStaticBitmap = mock()\n whenever(sourceCloseableStaticBitmap.underlyingBitmap).thenReturn(sourceBitmap)\n sourceCloseableImageRef = CloseableReference.of(sourceCloseableStaticBitmap)\n destinationBitmap = mock()\n destinationCloseableBitmapRef = CloseableReference.of(destinationBitmap, bitmapResourceReleaser)\n }\n\n @Test\n fun testNonStaticBitmapIsPassedOn() {\n val postprocessorConsumer = produceResults()\n val sourceCloseableAnimatedImage = mock()\n val sourceCloseableImageRef =\n CloseableReference.of(sourceCloseableAnimatedImage)\n postprocessorConsumer.onNewResult(sourceCloseableImageRef, Consumer.IS_LAST)\n sourceCloseableImageRef.close()\n testExecutorService.runUntilIdle()\n\n inOrder\n .verify(consumer)\n .onNewResult(any>(), eq(Consumer.IS_LAST))\n inOrder.verifyNoMoreInteractions()\n\n assertThat(results).hasSize(1)\n val res0 = results[0]\n assertThat(CloseableReference.isValid(res0)).isTrue()\n assertThat(res0.get()).isSameAs(sourceCloseableAnimatedImage)\n res0.close()\n\n verify(sourceCloseableAnimatedImage).close()\n }\n\n private fun produceResults(): SingleUsePostprocessorConsumer {\n postprocessorProducer.produceResults(consumer, producerContext)\n\n val consumerCaptor = argumentCaptor>>()\n verify(inputProducer).produceResults(consumerCaptor.capture(), eq(producerContext))\n return consumerCaptor.firstValue as SingleUsePostprocessorConsumer\n }\n}\n" }, { "path": "animated-drawable/.gitignore", "content": "/build\nnativedeps/\n" }, { "path": "animated-drawable/README.md", "content": "# Experimental Implementation for Animated Images\n\nThis is an experimental new animation implementation that is still work in progress.\nThe APIs & design might change significantly in the future.\n" }, { "path": "animated-drawable/build.gradle", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nimport com.facebook.fresco.buildsrc.Deps\nimport com.facebook.fresco.buildsrc.GradleDeps\nimport com.facebook.fresco.buildsrc.TestDeps\n\napply plugin: 'com.android.library'\napply plugin: 'kotlin-android'\n\nkotlin {\n jvmToolchain(11)\n}\n\nandroid {\n ndkVersion GradleDeps.Native.version\n\n buildToolsVersion FrescoConfig.buildToolsVersion\n compileSdkVersion FrescoConfig.compileSdkVersion\n\n namespace \"com.facebook.animated.drawable\"\n\n defaultConfig {\n minSdkVersion FrescoConfig.minSdkVersion\n targetSdkVersion FrescoConfig.targetSdkVersion\n }\n\n lintOptions {\n abortOnError false\n }\n testOptions {\n unitTests.returnDefaultValues = true\n }\n}\n\ndependencies {\n compileOnly Deps.AndroidX.androidxAnnotation\n compileOnly Deps.inferAnnotation\n compileOnly Deps.jsr305\n compileOnly Deps.javaxAnnotation\n\n testCompileOnly Deps.inferAnnotation\n testImplementation Deps.AndroidX.androidxAnnotation\n testImplementation Deps.jsr305\n testImplementation TestDeps.assertjCore\n testImplementation TestDeps.junit\n testImplementation TestDeps.festAssertCore\n testImplementation TestDeps.mockitoCore3\n testImplementation TestDeps.mockitoInline3\n testImplementation TestDeps.mockitoKotlin3\n testImplementation(TestDeps.robolectric) {\n exclude group: 'commons-logging', module: 'commons-logging'\n exclude group: 'org.apache.httpcomponents', module: 'httpclient'\n }\n testImplementation project(':imagepipeline-test')\n testImplementation project(':imagepipeline-base-test')\n\n\n implementation project(':imagepipeline-base')\n implementation project(':drawee')\n implementation project(':fbcore')\n implementation project(':urimod')\n implementation project(':vito:core')\n implementation project(':vito:options')\n implementation project(':vito:provider')\n implementation project(':vito:renderer')\n implementation project(':vito:source')\n}\n\napply plugin: \"com.vanniktech.maven.publish\"\n" }, { "path": "animated-drawable/gradle.properties", "content": "POM_NAME=AnimatedDrawable\nPOM_DESCRIPTION=Animated drawable that renders GIFs, WebPs and other Animations\nPOM_ARTIFACT_ID=animated-drawable\nPOM_PACKAGING=aar\n\n" }, { "path": "animated-drawable/src/main/AndroidManifest.xml", "content": "\n\n\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/backend/AnimationBackend.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.backend;\n\nimport android.graphics.Canvas;\nimport android.graphics.ColorFilter;\nimport android.graphics.Rect;\nimport android.graphics.drawable.Drawable;\nimport androidx.annotation.IntRange;\nimport javax.annotation.Nullable;\n\n/** Animation backend interface that is used to draw frames. */\npublic interface AnimationBackend extends AnimationInformation {\n\n interface Listener {\n\n /** Trigger when full animation is loaded and ready to play */\n void onAnimationLoaded();\n }\n\n /**\n * Default value if the intrinsic dimensions are not set.\n *\n * @see #getIntrinsicWidth()\n * @see #getIntrinsicHeight()\n */\n int INTRINSIC_DIMENSION_UNSET = -1;\n\n /**\n * Draw the frame for the given frame number on the canvas.\n *\n * @param parent the parent that draws the frame\n * @param canvas the canvas to draw an\n * @param frameNumber the frame number of the frame to draw\n * @return true if successful, false if the frame could not be rendered\n */\n boolean drawFrame(Drawable parent, Canvas canvas, int frameNumber);\n\n /**\n * Set the alpha value to be used for drawing frames in {@link #drawFrame(Drawable, Canvas, int)}\n * if supported.\n *\n * @param alpha the alpha value between 0 and 255\n */\n void setAlpha(@IntRange(from = 0, to = 255) int alpha);\n\n /**\n * The color filter to be used for drawing frames in {@link #drawFrame(Drawable, Canvas, int)} if\n * supported.\n *\n * @param colorFilter the color filter to use\n */\n void setColorFilter(@Nullable ColorFilter colorFilter);\n\n /**\n * Called when the bounds of the parent drawable are updated. This can be used to perform some\n * ahead-of-time computations if needed.\n *\n *

The supplied bounds do not have to be stored. It is possible to just use {@link\n * Drawable#getBounds()} of the parent drawable of {@link #drawFrame(Drawable, Canvas, int)}\n * instead.\n *\n * @param bounds the bounds to be used for drawing frames\n */\n void setBounds(Rect bounds);\n\n /**\n * Get the intrinsic width of the underlying animation or {@link #INTRINSIC_DIMENSION_UNSET} if\n * not available.\n *\n *

This value is used by the underlying drawable for aspect ratio computations, similar to\n * {@link Drawable#getIntrinsicWidth()}.\n *\n * @return the width or {@link #INTRINSIC_DIMENSION_UNSET} if unset\n */\n int getIntrinsicWidth();\n\n /**\n * Get the intrinsic height of the underlying animation or {@link #INTRINSIC_DIMENSION_UNSET} if\n * not available.\n *\n *

This value is used by the underlying drawable for aspect ratio computations, similar to\n * {@link Drawable#getIntrinsicHeight()}.\n *\n * @return the height or {@link #INTRINSIC_DIMENSION_UNSET} if unset\n */\n int getIntrinsicHeight();\n\n /**\n * Get the size of the animation backend.\n *\n * @return the size in bytes\n */\n int getSizeInBytes();\n\n /**\n * Clean up animation data. This will be called when the backing drawable is cleared as well. For\n * example, drop all cached frames.\n */\n void clear();\n\n /** Load animation bitmaps using the animation frame as canvas size. */\n void preloadAnimation();\n\n /** Set listener for animation events */\n void setAnimationListener(@Nullable Listener listener);\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/backend/AnimationBackendDelegate.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.backend\n\nimport android.annotation.SuppressLint\nimport android.graphics.Canvas\nimport android.graphics.ColorFilter\nimport android.graphics.Rect\nimport android.graphics.drawable.Drawable\nimport androidx.annotation.IntRange\n\n/** Animation backend delegate that forwards all calls to a given [AnimationBackend] */\nopen class AnimationBackendDelegate(\n /** Current animation backend in use */\n private var _animationBackend: T?\n) : AnimationBackend {\n\n // Animation backend parameters\n @IntRange(from = -1, to = 255) private var alpha = ALPHA_UNSET\n\n private var colorFilter: ColorFilter? = null\n private var bounds: Rect? = null\n\n override fun getFrameCount(): Int =\n if (_animationBackend == null) 0 else _animationBackend!!.frameCount\n\n override fun getFrameDurationMs(frameNumber: Int): Int =\n if (_animationBackend == null) 0 else _animationBackend!!.getFrameDurationMs(frameNumber)\n\n override fun getLoopDurationMs(): Int =\n if (_animationBackend == null) 0 else _animationBackend!!.loopDurationMs\n\n override fun width(): Int = if (_animationBackend == null) 0 else _animationBackend!!.width()\n\n override fun height(): Int = if (_animationBackend == null) 0 else _animationBackend!!.height()\n\n override fun getLoopCount(): Int =\n if (_animationBackend == null) AnimationInformation.LOOP_COUNT_INFINITE\n else _animationBackend!!.loopCount\n\n override fun drawFrame(parent: Drawable, canvas: Canvas, frameNumber: Int): Boolean =\n _animationBackend?.drawFrame(parent, canvas, frameNumber) == true\n\n override fun setAlpha(@IntRange(from = 0, to = 255) alpha: Int) {\n _animationBackend?.setAlpha(alpha)\n this.alpha = alpha\n }\n\n override fun setColorFilter(colorFilter: ColorFilter?) {\n _animationBackend?.setColorFilter(colorFilter)\n this.colorFilter = colorFilter\n }\n\n override fun setBounds(bounds: Rect) {\n _animationBackend?.setBounds(bounds)\n this.bounds = bounds\n }\n\n override fun getSizeInBytes(): Int =\n if (_animationBackend == null) 0 else _animationBackend!!.sizeInBytes\n\n override fun clear() {\n _animationBackend?.clear()\n }\n\n override fun preloadAnimation() {\n _animationBackend?.preloadAnimation()\n }\n\n override fun setAnimationListener(listener: AnimationBackend.Listener?) {\n _animationBackend?.setAnimationListener(listener)\n }\n\n override fun getIntrinsicWidth(): Int =\n if (_animationBackend == null) AnimationBackend.INTRINSIC_DIMENSION_UNSET\n else _animationBackend!!.intrinsicWidth\n\n override fun getIntrinsicHeight(): Int =\n if (_animationBackend == null) AnimationBackend.INTRINSIC_DIMENSION_UNSET\n else _animationBackend!!.intrinsicHeight\n\n var animationBackend: T?\n /**\n * Get the current animation backend.\n *\n * @return the current animation backend in use or null if not set\n */\n get() = _animationBackend\n /**\n * Set the animation backend to forward calls to. If called with null, the current backend will\n * be removed.\n *\n * @param animationBackend the backend to use or null to remove the current backend\n */\n set(animationBackend) {\n this._animationBackend = animationBackend\n if (this._animationBackend != null) {\n applyBackendProperties(_animationBackend!!)\n }\n }\n\n @SuppressLint(\"Range\")\n private fun applyBackendProperties(backend: AnimationBackend) {\n if (bounds != null) {\n backend.setBounds(bounds)\n }\n if (alpha >= 0 && alpha <= 255) {\n backend.setAlpha(alpha)\n }\n if (colorFilter != null) {\n backend.setColorFilter(colorFilter)\n }\n }\n\n companion object {\n private const val ALPHA_UNSET = -1\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/backend/AnimationBackendDelegateWithInactivityCheck.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.backend;\n\nimport android.graphics.Canvas;\nimport android.graphics.drawable.Drawable;\nimport androidx.annotation.VisibleForTesting;\nimport com.facebook.common.time.MonotonicClock;\nimport com.facebook.infer.annotation.Nullsafe;\nimport java.util.concurrent.ScheduledExecutorService;\nimport java.util.concurrent.TimeUnit;\nimport javax.annotation.Nullable;\n\n/**\n * Animation backend delegate for animation backends that implement {@link InactivityListener}.\n * After a certain inactivity period (default = {@link #INACTIVITY_THRESHOLD_MS}, {@link\n * InactivityListener#onInactive()} will be called.\n *\n *

This can for example be used to drop caches if needed.\n *\n *

New instances can be created with {@link #createForBackend(AnimationBackend, MonotonicClock,\n * ScheduledExecutorService)}.\n */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class AnimationBackendDelegateWithInactivityCheck\n extends AnimationBackendDelegate {\n\n public interface InactivityListener {\n\n /**\n * Called when the animation backend has not been used to draw frames within the given\n * threshold.\n */\n void onInactive();\n }\n\n public static <\n T extends\n AnimationBackend & AnimationBackendDelegateWithInactivityCheck.InactivityListener>\n AnimationBackendDelegate createForBackend(\n T backend,\n MonotonicClock monotonicClock,\n ScheduledExecutorService scheduledExecutorServiceForUiThread) {\n return createForBackend(backend, backend, monotonicClock, scheduledExecutorServiceForUiThread);\n }\n\n public static AnimationBackendDelegate createForBackend(\n T backend,\n InactivityListener inactivityListener,\n MonotonicClock monotonicClock,\n ScheduledExecutorService scheduledExecutorServiceForUiThread) {\n return new AnimationBackendDelegateWithInactivityCheck<>(\n backend, inactivityListener, monotonicClock, scheduledExecutorServiceForUiThread);\n }\n\n @VisibleForTesting static final long INACTIVITY_THRESHOLD_MS = 2000;\n @VisibleForTesting static final long INACTIVITY_CHECK_POLLING_TIME_MS = 1000;\n\n private final MonotonicClock mMonotonicClock;\n private final ScheduledExecutorService mScheduledExecutorServiceForUiThread;\n private boolean mInactivityCheckScheduled = false;\n private long mLastDrawnTimeMs;\n private long mInactivityThresholdMs = INACTIVITY_THRESHOLD_MS;\n private long mInactivityCheckPollingTimeMs = INACTIVITY_CHECK_POLLING_TIME_MS;\n @Nullable private InactivityListener mInactivityListener;\n\n /**\n * Watchdog runnable that calls {@link InactivityListener#onInactive()} if necessary or schedules\n * a new watchdog task otherwise.\n */\n private final Runnable mIsInactiveCheck =\n new Runnable() {\n @Override\n public void run() {\n synchronized (AnimationBackendDelegateWithInactivityCheck.this) {\n mInactivityCheckScheduled = false;\n if (isInactive()) {\n if (mInactivityListener != null) {\n mInactivityListener.onInactive();\n }\n } else {\n maybeScheduleInactivityCheck();\n }\n }\n }\n };\n\n private AnimationBackendDelegateWithInactivityCheck(\n @Nullable T animationBackend,\n @Nullable InactivityListener inactivityListener,\n MonotonicClock monotonicClock,\n ScheduledExecutorService scheduledExecutorServiceForUiThread) {\n super(animationBackend);\n mInactivityListener = inactivityListener;\n mMonotonicClock = monotonicClock;\n mScheduledExecutorServiceForUiThread = scheduledExecutorServiceForUiThread;\n }\n\n @Override\n public boolean drawFrame(Drawable parent, Canvas canvas, int frameNumber) {\n mLastDrawnTimeMs = mMonotonicClock.now();\n boolean result = super.drawFrame(parent, canvas, frameNumber);\n maybeScheduleInactivityCheck();\n return result;\n }\n\n public void setInactivityListener(@Nullable InactivityListener inactivityListener) {\n mInactivityListener = inactivityListener;\n }\n\n public long getInactivityCheckPollingTimeMs() {\n return mInactivityCheckPollingTimeMs;\n }\n\n public void setInactivityCheckPollingTimeMs(long inactivityCheckPollingTimeMs) {\n mInactivityCheckPollingTimeMs = inactivityCheckPollingTimeMs;\n }\n\n public long getInactivityThresholdMs() {\n return mInactivityThresholdMs;\n }\n\n public void setInactivityThresholdMs(long inactivityThresholdMs) {\n mInactivityThresholdMs = inactivityThresholdMs;\n }\n\n private boolean isInactive() {\n return mMonotonicClock.now() - mLastDrawnTimeMs > mInactivityThresholdMs;\n }\n\n private synchronized void maybeScheduleInactivityCheck() {\n if (!mInactivityCheckScheduled) {\n mInactivityCheckScheduled = true;\n mScheduledExecutorServiceForUiThread.schedule(\n mIsInactiveCheck, mInactivityCheckPollingTimeMs, TimeUnit.MILLISECONDS);\n }\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/backend/AnimationInformation.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.backend;\n\nimport com.facebook.infer.annotation.Nullsafe;\n\n/** Basic animation metadata: Frame and loop count & duration */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic interface AnimationInformation {\n\n /**\n * Loop count to be returned by {@link #getLoopCount()} when the animation should be repeated\n * indefinitely.\n */\n int LOOP_COUNT_INFINITE = 0;\n\n /**\n * Get the number of frames for the animation\n *\n * @return the number of frames\n */\n int getFrameCount();\n\n /**\n * Get the frame duration for a given frame number in milliseconds.\n *\n * @param frameNumber the frame to get the duration for\n * @return the duration in ms\n */\n int getFrameDurationMs(int frameNumber);\n\n /**\n * Loop duration in ms\n *\n * @return duration in ms\n */\n int getLoopDurationMs();\n\n /**\n * @return Animation asset width\n */\n int width();\n\n /**\n * @return Animation asset height\n */\n int height();\n\n /**\n * Get the number of loops the animation has or {@link #LOOP_COUNT_INFINITE} for infinite looping.\n *\n * @return the loop count or {@link #LOOP_COUNT_INFINITE}\n */\n int getLoopCount();\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/BitmapAnimationBackend.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap\n\nimport android.content.res.Resources\nimport android.graphics.Bitmap\nimport android.graphics.BitmapShader\nimport android.graphics.Canvas\nimport android.graphics.ColorFilter\nimport android.graphics.Matrix\nimport android.graphics.Paint\nimport android.graphics.Path\nimport android.graphics.Rect\nimport android.graphics.RectF\nimport android.graphics.Shader\nimport android.graphics.drawable.Drawable\nimport androidx.annotation.IntDef\nimport androidx.annotation.IntRange\nimport com.facebook.common.logging.FLog\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.backend.AnimationBackendDelegateWithInactivityCheck.InactivityListener\nimport com.facebook.fresco.animation.backend.AnimationInformation\nimport com.facebook.fresco.animation.bitmap.preparation.BitmapFramePreparationStrategy\nimport com.facebook.fresco.animation.bitmap.preparation.BitmapFramePreparer\nimport com.facebook.fresco.ui.common.DimensionsInfo\nimport com.facebook.fresco.vito.core.AnimatedImagePerfLoggingListener\nimport com.facebook.fresco.vito.core.FrescoDrawableInterface\nimport com.facebook.fresco.vito.listener.ImageListener\nimport com.facebook.fresco.vito.options.AnimatedOptions\nimport com.facebook.fresco.vito.options.ImageOptions\nimport com.facebook.fresco.vito.options.RoundingOptions\nimport com.facebook.fresco.vito.provider.FrescoVitoProvider\nimport com.facebook.fresco.vito.source.ImageSourceProvider\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.image.ImageInfo\n\n/**\n * Bitmap animation backend that renders bitmap frames.\n *\n * The given [BitmapFrameCache] is used to cache frames and create new bitmaps.\n * [AnimationInformation] defines the main animation parameters, like frame and loop count.\n * [BitmapFrameRenderer] is used to render frames to the bitmaps acquired from the\n * [BitmapFrameCache].\n */\nclass BitmapAnimationBackend\n@JvmOverloads\nconstructor(\n private val platformBitmapFactory: PlatformBitmapFactory,\n private val bitmapFrameCache: BitmapFrameCache,\n private val animationInformation: AnimationInformation,\n private val bitmapFrameRenderer: BitmapFrameRenderer,\n private val isNewRenderImplementation: Boolean,\n private val bitmapFramePreparationStrategy: BitmapFramePreparationStrategy?,\n private val bitmapFramePreparer: BitmapFramePreparer?,\n val roundingOptions: RoundingOptions? = null,\n val animatedOptions: AnimatedOptions? = null,\n) : AnimationBackend, InactivityListener {\n\n private val isCircular: Boolean = roundingOptions?.isCircular == true\n private val isAntiAliased: Boolean = roundingOptions?.isAntiAliased == true\n\n val cornerRadii: FloatArray? =\n roundingOptions?.let { roundingOptions ->\n if (isCircular) {\n null\n } else if (roundingOptions.cornerRadius != RoundingOptions.CORNER_RADIUS_UNSET) {\n val corners = FloatArray(8)\n corners.fill(roundingOptions.cornerRadius)\n corners\n } else {\n roundingOptions.cornerRadii\n }\n }\n\n interface FrameListener {\n /**\n * Called when the backend started drawing the given frame.\n *\n * @param backend the backend\n * @param frameNumber the frame number to be drawn\n */\n fun onDrawFrameStart(backend: BitmapAnimationBackend, frameNumber: Int)\n\n /**\n * Called when the given frame has been drawn.\n *\n * @param backend the backend\n * @param frameNumber the frame number that has been drawn\n * @param frameType the [FrameType] that has been drawn\n */\n fun onFrameDrawn(backend: BitmapAnimationBackend, frameNumber: Int, @FrameType frameType: Int)\n\n /**\n * Called when no bitmap could be drawn by the backend for the given frame number.\n *\n * @param backend the backend\n * @param frameNumber the frame number that could not be drawn\n */\n fun onFrameDropped(backend: BitmapAnimationBackend, frameNumber: Int)\n }\n\n /** Frame type that has been drawn. Can be used for logging. */\n @Retention(AnnotationRetention.SOURCE)\n @IntDef(\n FRAME_TYPE_UNKNOWN,\n FRAME_TYPE_CACHED,\n FRAME_TYPE_REUSED,\n FRAME_TYPE_CREATED,\n FRAME_TYPE_FALLBACK,\n )\n annotation class FrameType\n\n private val bitmapConfig = Bitmap.Config.ARGB_8888\n\n private val paint: Paint = Paint(Paint.FILTER_BITMAP_FLAG or Paint.DITHER_FLAG)\n private var bounds: Rect? = null\n private var bitmapWidth = 0\n private var bitmapHeight = 0\n\n private val path: Path = Path()\n private val matrix: Matrix = Matrix()\n private var pathFrameNumber: Int = -1\n\n private var frameListener: FrameListener? = null\n private var animationListener: AnimationBackend.Listener? = null\n private var animatedImagePerfLoggingListener: AnimatedImagePerfLoggingListener? = null\n\n // Thumbnail fallback functionality\n private var thumbnailDrawable: FrescoDrawableInterface? = null\n private var animationCompleted: Boolean = false\n private var totalFramesProcessed: Int = 0\n private var lastFrameNumber: Int = -1\n\n init {\n initializeThumbnailDrawable()\n updateBitmapDimensions()\n }\n\n fun setFrameListener(frameListener: FrameListener?) {\n this.frameListener = frameListener\n }\n\n fun setAnimatedImagePerfLoggingListener(listener: AnimatedImagePerfLoggingListener?) {\n this.animatedImagePerfLoggingListener = listener\n }\n\n override fun getFrameCount(): Int = animationInformation.frameCount\n\n override fun getFrameDurationMs(frameNumber: Int): Int =\n animationInformation.getFrameDurationMs(frameNumber)\n\n override fun width(): Int = animationInformation.width()\n\n override fun height(): Int = animationInformation.height()\n\n override fun getLoopDurationMs(): Int = animationInformation.loopDurationMs\n\n override fun getLoopCount(): Int {\n // If no animated options are set, use the default loop count\n if (animatedOptions == null) {\n return animationInformation.loopCount\n }\n\n return when (animatedOptions.loopCount) {\n AnimatedOptions.LOOP_COUNT_INFINITE -> AnimationInformation.LOOP_COUNT_INFINITE\n else -> animatedOptions.loopCount\n }\n }\n\n override fun drawFrame(parent: Drawable, canvas: Canvas, frameNumber: Int): Boolean {\n frameListener?.onDrawFrameStart(this, frameNumber)\n\n // Check if we should show thumbnail instead of animation frame\n if (showThumbnail()) {\n val thumbnailDrawn = drawThumbnail(canvas)\n if (thumbnailDrawn) {\n return true\n }\n }\n\n val drawn = drawFrameOrFallback(canvas, frameNumber, FRAME_TYPE_CACHED)\n\n // Track animation progress for thumbnail fallback\n trackAnimationProgress(frameNumber)\n\n // We could not draw anything\n if (!drawn) {\n frameListener?.onFrameDropped(this, frameNumber)\n\n // Log frame drop for performance monitoring\n val imageId = animationInformation.toString() // Use animation info as identifier\n val timestamp = System.currentTimeMillis()\n animatedImagePerfLoggingListener?.onFrameDropped(imageId, frameNumber, timestamp)\n }\n\n // Prepare next frames\n if (!isNewRenderImplementation && bitmapFramePreparer != null) {\n bitmapFramePreparationStrategy?.prepareFrames(\n bitmapFramePreparer,\n bitmapFrameCache,\n this,\n frameNumber,\n )\n }\n return drawn\n }\n\n private fun drawFrameOrFallback(\n canvas: Canvas,\n frameNumber: Int,\n @FrameType frameType: Int,\n ): Boolean {\n var bitmapReference: CloseableReference? = null\n val drawn: Boolean\n var nextFrameType = FRAME_TYPE_UNKNOWN\n\n try {\n if (isNewRenderImplementation) {\n bitmapReference =\n bitmapFramePreparationStrategy?.getBitmapFrame(frameNumber, canvas.width, canvas.height)\n\n if (bitmapReference != null && bitmapReference.isValid) {\n drawBitmap(frameNumber, bitmapReference.get(), canvas)\n return true\n }\n\n // If bitmap could not be drawn, then fetch frames\n bitmapFramePreparationStrategy?.prepareFrames(canvas.width, canvas.height, null)\n return false\n }\n\n when (frameType) {\n FRAME_TYPE_CACHED -> {\n bitmapReference = bitmapFrameCache.getCachedFrame(frameNumber)\n drawn = drawBitmapAndCache(frameNumber, bitmapReference, canvas, FRAME_TYPE_CACHED)\n nextFrameType = FRAME_TYPE_REUSED\n }\n FRAME_TYPE_REUSED -> {\n bitmapReference =\n bitmapFrameCache.getBitmapToReuseForFrame(frameNumber, bitmapWidth, bitmapHeight)\n // Try to render the frame and draw on the canvas immediately after\n drawn =\n (renderFrameInBitmap(frameNumber, bitmapReference) &&\n drawBitmapAndCache(frameNumber, bitmapReference, canvas, FRAME_TYPE_REUSED))\n nextFrameType = FRAME_TYPE_CREATED\n }\n FRAME_TYPE_CREATED -> {\n bitmapReference =\n try {\n platformBitmapFactory.createBitmap(bitmapWidth, bitmapHeight, bitmapConfig)\n } catch (e: RuntimeException) {\n // Failed to create the bitmap for the frame, return and report that we could not\n // draw the frame.\n FLog.w(TAG, \"Failed to create frame bitmap\", e)\n return false\n }\n // Try to render the frame and draw on the canvas immediately after\n drawn =\n (renderFrameInBitmap(frameNumber, bitmapReference) &&\n drawBitmapAndCache(frameNumber, bitmapReference, canvas, FRAME_TYPE_CREATED))\n nextFrameType = FRAME_TYPE_FALLBACK\n }\n FRAME_TYPE_FALLBACK -> {\n bitmapReference = bitmapFrameCache.getFallbackFrame(frameNumber)\n drawn = drawBitmapAndCache(frameNumber, bitmapReference, canvas, FRAME_TYPE_FALLBACK)\n }\n else -> return false\n }\n } finally {\n CloseableReference.closeSafely(bitmapReference)\n }\n return if (drawn || nextFrameType == FRAME_TYPE_UNKNOWN) {\n drawn\n } else {\n drawFrameOrFallback(canvas, frameNumber, nextFrameType)\n }\n }\n\n override fun setAlpha(@IntRange(from = 0, to = 255) alpha: Int) {\n paint.alpha = alpha\n }\n\n override fun setColorFilter(colorFilter: ColorFilter?) {\n paint.colorFilter = colorFilter\n }\n\n override fun setBounds(bounds: Rect?) {\n this.bounds = bounds\n bitmapFrameRenderer.setBounds(bounds)\n updateBitmapDimensions()\n\n // Set bounds on thumbnail drawable when backend bounds change\n thumbnailDrawable?.let { drawable ->\n val thumbnailBounds = bounds ?: Rect(0, 0, width(), height())\n (drawable as Drawable).setBounds(thumbnailBounds)\n }\n }\n\n override fun getIntrinsicWidth(): Int = bitmapWidth\n\n override fun getIntrinsicHeight(): Int = bitmapHeight\n\n override fun getSizeInBytes(): Int = bitmapFrameCache.sizeInBytes\n\n override fun clear() {\n if (isNewRenderImplementation) {\n bitmapFramePreparationStrategy?.clearFrames()\n } else {\n bitmapFrameCache.clear()\n }\n }\n\n override fun preloadAnimation() {\n if (!isNewRenderImplementation && bitmapFramePreparer != null) {\n bitmapFramePreparationStrategy?.prepareFrames(\n bitmapFramePreparer,\n bitmapFrameCache,\n this,\n 0,\n ) {\n animationListener?.onAnimationLoaded()\n }\n } else {\n bitmapFramePreparationStrategy?.prepareFrames(\n animationInformation.width(),\n animationInformation.height(),\n ) {\n animationListener?.onAnimationLoaded()\n }\n }\n }\n\n override fun onInactive() {\n if (isNewRenderImplementation) {\n bitmapFramePreparationStrategy?.onStop()\n } else {\n clear()\n }\n thumbnailDrawable?.let { FrescoVitoProvider.getController().releaseImmediately(it) }\n thumbnailDrawable = null\n }\n\n override fun setAnimationListener(listener: AnimationBackend.Listener?) {\n animationListener = listener\n }\n\n private fun updateBitmapDimensions() {\n // Calculate the correct bitmap dimensions\n bitmapWidth = bitmapFrameRenderer.intrinsicWidth\n if (bitmapWidth == AnimationBackend.INTRINSIC_DIMENSION_UNSET) {\n bitmapWidth = bounds?.width() ?: AnimationBackend.INTRINSIC_DIMENSION_UNSET\n }\n bitmapHeight = bitmapFrameRenderer.intrinsicHeight\n if (bitmapHeight == AnimationBackend.INTRINSIC_DIMENSION_UNSET) {\n bitmapHeight = bounds?.height() ?: AnimationBackend.INTRINSIC_DIMENSION_UNSET\n }\n }\n\n /**\n * Try to render the frame to the given target bitmap. If the rendering fails, the target bitmap\n * reference will be closed and false is returned. If rendering succeeds, the target bitmap\n * reference can be drawn and has to be manually closed after drawing has been completed.\n *\n * @param frameNumber the frame number to render\n * @param targetBitmap the target bitmap\n * @return true if rendering successful\n */\n private fun renderFrameInBitmap(\n frameNumber: Int,\n targetBitmap: CloseableReference?,\n ): Boolean {\n if (targetBitmap == null || !targetBitmap.isValid) {\n return false\n }\n // Render the image\n val frameRendered = bitmapFrameRenderer.renderFrame(frameNumber, targetBitmap.get())\n if (!frameRendered) {\n CloseableReference.closeSafely(targetBitmap)\n }\n return frameRendered\n }\n\n private fun updatePath(\n frameNumber: Int,\n bitmap: Bitmap,\n currentBoundsWidth: Float,\n currentBoundsHeight: Float,\n ): Boolean {\n if (!isCircular && cornerRadii == null) {\n return false\n }\n if (frameNumber == pathFrameNumber) {\n return true\n }\n\n val bitmapShader = BitmapShader(bitmap, Shader.TileMode.CLAMP, Shader.TileMode.CLAMP)\n val src = RectF(0f, 0f, bitmapWidth.toFloat(), bitmapHeight.toFloat())\n val dst = RectF(0f, 0f, currentBoundsWidth, currentBoundsHeight)\n matrix.setRectToRect(src, dst, Matrix.ScaleToFit.FILL)\n bitmapShader.setLocalMatrix(matrix)\n paint.shader = bitmapShader\n paint.isAntiAlias = isAntiAliased\n\n path.reset()\n\n if (isCircular) {\n val centerX = currentBoundsWidth / 2f\n val centerY = currentBoundsHeight / 2f\n val radius = minOf(centerX, centerY)\n path.addCircle(centerX, centerY, radius, Path.Direction.CW)\n } else {\n path.addRoundRect(\n RectF(0f, 0f, currentBoundsWidth, currentBoundsHeight),\n cornerRadii ?: floatArrayOf(),\n Path.Direction.CW,\n )\n }\n\n pathFrameNumber = frameNumber\n return true\n }\n\n private fun drawBitmap(frameNumber: Int, bitmap: Bitmap, canvas: Canvas) {\n val currentBounds = bounds\n\n if (currentBounds == null) {\n canvas.drawBitmap(bitmap, 0f, 0f, paint)\n } else {\n if (\n updatePath(\n frameNumber,\n bitmap,\n currentBounds.width().toFloat(),\n currentBounds.height().toFloat(),\n )\n ) {\n canvas.drawPath(path, paint)\n } else {\n canvas.drawBitmap(bitmap, null, currentBounds, paint)\n }\n }\n }\n\n /**\n * Helper method that draws the given bitmap on the canvas respecting the bounds (if set).\n *\n * If rendering was successful, it notifies the cache that the frame has been rendered with the\n * given bitmap. In addition, it will notify the [FrameListener] if set.\n *\n * @param frameNumber the current frame number passed to the cache\n * @param bitmapReference the bitmap to draw\n * @param canvas the canvas to draw an\n * @param frameType the [FrameType] to be rendered\n * @return true if the bitmap has been drawn\n */\n private fun drawBitmapAndCache(\n frameNumber: Int,\n bitmapReference: CloseableReference?,\n canvas: Canvas,\n @FrameType frameType: Int,\n ): Boolean {\n if (bitmapReference == null || !CloseableReference.isValid(bitmapReference)) {\n return false\n }\n\n this.drawBitmap(frameNumber, bitmapReference.get(), canvas)\n\n // Notify the cache that a frame has been rendered.\n // We should not cache fallback frames since they do not represent the actual frame.\n if (frameType != FRAME_TYPE_FALLBACK && !isNewRenderImplementation) {\n bitmapFrameCache.onFrameRendered(frameNumber, bitmapReference, frameType)\n }\n frameListener?.onFrameDrawn(this, frameNumber, frameType)\n\n return true\n }\n\n private fun initializeThumbnailDrawable() {\n val options = animatedOptions\n if (options?.useFallbackThumbnail() == true && !options.thumbnailUrl.isNullOrEmpty()) {\n try {\n thumbnailDrawable =\n FrescoVitoProvider.getController().createDrawable(\"bitmap-animation-thumbnail\")\n\n // Load the thumbnail through Fresco's pipeline\n options.thumbnailUrl?.let { url -> loadFrescoThumbnail(url) }\n } catch (e: Exception) {\n FLog.w(TAG, \"Failed to initialize thumbnail drawable\", e)\n thumbnailDrawable = null\n }\n }\n }\n\n private fun loadFrescoThumbnail(thumbnailUrl: String) {\n val drawable = thumbnailDrawable ?: return\n\n try {\n val imageOptions = ImageOptions.defaults().extend().round(roundingOptions).build()\n\n val imageRequest =\n FrescoVitoProvider.getImagePipeline()\n .createImageRequest(\n Resources.getSystem(),\n ImageSourceProvider.forUri(thumbnailUrl),\n imageOptions,\n callerContext = CALLER_CONTEXT,\n )\n\n val imageListener =\n object : ImageListener {\n override fun onFinalImageSet(\n id: Long,\n imageOrigin: Int,\n imageInfo: ImageInfo?,\n drawable: Drawable?,\n ) = Unit\n\n override fun onFailure(id: Long, error: Drawable?, throwable: Throwable?) {\n FLog.w(TAG, \"Failed to load thumbnail from URL: $thumbnailUrl\", throwable)\n thumbnailDrawable = null\n }\n\n override fun onImageDrawn(\n id: String,\n imageInfo: ImageInfo,\n dimensionsInfo: DimensionsInfo,\n ) {\n // Image drawn\n }\n }\n\n FrescoVitoProvider.getController()\n .fetch(\n drawable = drawable,\n imageRequest = imageRequest,\n callerContext = CALLER_CONTEXT,\n contextChain = null,\n listener = imageListener,\n onFadeListener = null,\n viewportDimensions = null,\n )\n } catch (e: Exception) {\n FLog.w(TAG, \"Failed to load thumbnail through Fresco: $thumbnailUrl\", e)\n // Release the image\n thumbnailDrawable?.let { FrescoVitoProvider.getController().releaseImmediately(it) }\n thumbnailDrawable = null\n }\n }\n\n private fun showThumbnail(): Boolean {\n val options = animatedOptions ?: return false\n\n // Only show thumbnail if we should use fallback thumbnail and we have a thumbnail drawable\n if (!options.useFallbackThumbnail() || thumbnailDrawable?.hasImage() != true) {\n return false\n }\n\n if (animationCompleted) {\n return true\n }\n return false\n }\n\n private fun drawThumbnail(canvas: Canvas): Boolean {\n val frescoDrawable = thumbnailDrawable ?: return false\n\n if (!frescoDrawable.hasImage()) {\n return false\n }\n\n try {\n val drawable = frescoDrawable as Drawable\n drawable.draw(canvas)\n return true\n } catch (e: Exception) {\n FLog.w(TAG, \"Failed to draw thumbnail drawable\", e)\n return false\n }\n }\n\n // Track animation progress for thumbnail fallback\n private fun trackAnimationProgress(frameNumber: Int) {\n val options = animatedOptions ?: return\n\n if (!options.useFallbackThumbnail()) {\n return\n }\n\n val totalLoops = getLoopCount()\n val framesPerLoop = getFrameCount()\n\n if (totalLoops == AnimationInformation.LOOP_COUNT_INFINITE) {\n return\n }\n\n if (frameNumber < lastFrameNumber) {\n totalFramesProcessed += framesPerLoop\n }\n lastFrameNumber = frameNumber\n\n // Calculate current loop and frame within loop\n val currentLoop = totalFramesProcessed / framesPerLoop\n val frameInLoop = frameNumber\n\n // Last loop reached, mark animation as completed\n if (currentLoop >= totalLoops - 1 && frameInLoop == framesPerLoop - 1) {\n animationCompleted = true\n }\n }\n\n companion object {\n const val FRAME_TYPE_UNKNOWN: Int = -1\n const val FRAME_TYPE_CACHED = 0\n const val FRAME_TYPE_REUSED = 1\n const val FRAME_TYPE_CREATED = 2\n const val FRAME_TYPE_FALLBACK = 3\n private val TAG = BitmapAnimationBackend::class.java\n private const val CALLER_CONTEXT = \"BitmapAnimationBackend\"\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/BitmapFrameCache.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap\n\nimport android.graphics.Bitmap\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.bitmap.BitmapAnimationBackend.FrameType\n\n/** Bitmap frame cache that is used for animated images. */\ninterface BitmapFrameCache {\n\n interface FrameCacheListener {\n /**\n * Called when the frame for the given frame number has been put in the frame cache.\n *\n * @param bitmapFrameCache the frame cache that holds the frame\n * @param frameNumber the cached frame number\n */\n fun onFrameCached(bitmapFrameCache: BitmapFrameCache, frameNumber: Int)\n\n /**\n * Called when the frame for the given frame number has been evicted from the frame cache.\n *\n * @param bitmapFrameCache the frame cache that evicted the frame\n * @param frameNumber the frame number of the evicted frame\n */\n fun onFrameEvicted(bitmapFrameCache: BitmapFrameCache, frameNumber: Int)\n }\n\n /**\n * Get the cached frame for the given frame number.\n *\n * @param frameNumber the frame number to get the cached frame for\n * @return the cached frame or null if not cached\n */\n fun getCachedFrame(frameNumber: Int): CloseableReference?\n\n /**\n * Get a fallback frame for the given frame number. This method is called if all other attempts to\n * draw a frame failed. The bitmap returned could for example be the last drawn frame (if any).\n *\n * @param frameNumber the frame number to get the fallback\n * @return the fallback frame or null if not cached\n */\n fun getFallbackFrame(frameNumber: Int): CloseableReference?\n\n /**\n * Return a reusable bitmap that should be used to render the given frame.\n *\n * @param frameNumber the frame number to be rendered\n * @param width the width of the target bitmap\n * @param height the height of the target bitmap\n * @return the reusable bitmap or null if no reusable bitmaps available\n */\n fun getBitmapToReuseForFrame(\n frameNumber: Int,\n width: Int,\n height: Int,\n ): CloseableReference?\n\n /**\n * Check whether the cache contains a certain frame.\n *\n * @param frameNumber the frame number to check\n * @return true if the frame is cached\n */\n operator fun contains(frameNumber: Int): Boolean\n\n /** @return the size in bytes of all cached data */\n val sizeInBytes: Int\n\n /** Send the list of frames when the animation frames are loaded */\n fun onAnimationPrepared(frameBitmaps: Map>): Boolean = true\n\n /** Clear the cache. */\n fun clear()\n\n /** Indicates if animation is loaded in cache and ready for usage */\n fun isAnimationReady(): Boolean = false\n\n /**\n * Callback when the given bitmap has been drawn to a canvas. This bitmap can either be a reused\n * bitmap returned by [getBitmapToReuseForFrame(int, int, int)] or a new bitmap.\n *\n * Note: the implementation of this interface must manually clone the given bitmap reference if it\n * wants to hold on to the bitmap. The original reference will be automatically closed after this\n * call.\n *\n * @param frameNumber the frame number that has been rendered\n * @param bitmapReference the bitmap reference that has been rendered\n * @param frameType the frame type that has been rendered\n */\n fun onFrameRendered(\n frameNumber: Int,\n bitmapReference: CloseableReference,\n @FrameType frameType: Int,\n )\n\n /**\n * Callback when a bitmap reference for a given frame has been prepared for future rendering.\n *\n * This method is called ahead of render time (i.e. when future frames have been prepared in the\n * background), whereas [onFrameRendered(int, CloseableReference, int)] is invoked when the actual\n * frame has been drawn on a Canvas.\n *\n * The supplied bitmap reference can either hold a reused bitmap returned by\n * [getBitmapToReuseForFrame(int, int, int)] or a new bitmap as indicated by the frame type\n * parameter.\n *\n * Note: the implementation of this interface must manually clone the given bitmap reference if it\n * wants to hold on to the bitmap. The original reference will be automatically closed after this\n * call.\n *\n * @param frameNumber the frame number of the passed bitmapReference\n * @param bitmapReference the bitmap reference that has been prepared for future rendering\n * @param frameType the frame type of the prepared frame\n * @return true if the frame has been successfully cached\n */\n fun onFramePrepared(\n frameNumber: Int,\n bitmapReference: CloseableReference,\n @FrameType frameType: Int,\n )\n\n /**\n * Set a frame cache listener that gets notified about caching events.\n *\n * @param frameCacheListener the listener to use\n */\n fun setFrameCacheListener(frameCacheListener: FrameCacheListener?)\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/BitmapFrameRenderer.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap\n\nimport android.graphics.Bitmap\nimport android.graphics.Rect\n\n/**\n * Bitmap frame renderer used by [BitmapAnimationBackend] to render animated images (e.g. GIFs or\n * animated WebPs).\n */\ninterface BitmapFrameRenderer {\n\n /**\n * Render the frame for the given frame number to the target bitmap.\n *\n * @param frameNumber the frame number to render\n * @param targetBitmap the bitmap to render the frame in\n * @return true if successful\n */\n fun renderFrame(frameNumber: Int, targetBitmap: Bitmap): Boolean\n\n /**\n * Set the parent drawable bounds to be used for frame rendering.\n *\n * @param bounds the bounds to use\n */\n fun setBounds(bounds: Rect?)\n\n /**\n * Return the intrinsic width of bitmap frames. Return\n * [AnimationBackend#INTRINSIC_DIMENSION_UNSET] if no specific width is set.\n *\n * @return the intrinsic width\n */\n val intrinsicWidth: Int\n\n /**\n * Return the intrinsic height of bitmap frames. Return\n * [AnimationBackend#INTRINSIC_DIMENSION_UNSET] if no specific height is set.\n *\n * @return the intrinsic height\n */\n val intrinsicHeight: Int\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/cache/KeepLastFrameCache.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.cache\n\nimport android.graphics.Bitmap\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.bitmap.BitmapAnimationBackend.FrameType\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache.FrameCacheListener\nimport com.facebook.imageutils.BitmapUtil\nimport javax.annotation.concurrent.GuardedBy\n\n/** Simple bitmap cache that keeps the last frame and reuses it if possible. */\nclass KeepLastFrameCache : BitmapFrameCache {\n\n private var lastFrameNumber = FRAME_NUMBER_UNSET\n private var frameCacheListener: FrameCacheListener? = null\n\n @GuardedBy(\"this\") private var lastBitmapReference: CloseableReference? = null\n\n @Synchronized\n override fun getCachedFrame(frameNumber: Int): CloseableReference? =\n if (lastFrameNumber == frameNumber) {\n CloseableReference.cloneOrNull(lastBitmapReference)\n } else {\n null\n }\n\n @Synchronized\n override fun getFallbackFrame(frameNumber: Int): CloseableReference? =\n CloseableReference.cloneOrNull(lastBitmapReference)\n\n @Synchronized\n override fun getBitmapToReuseForFrame(\n frameNumber: Int,\n width: Int,\n height: Int,\n ): CloseableReference? =\n try {\n CloseableReference.cloneOrNull(lastBitmapReference)\n } finally {\n closeAndResetLastBitmapReference()\n }\n\n @Synchronized\n override fun contains(frameNumber: Int): Boolean =\n frameNumber == lastFrameNumber && CloseableReference.isValid(lastBitmapReference)\n\n @get:Synchronized\n override val sizeInBytes: Int\n get() =\n if (lastBitmapReference == null) 0\n else BitmapUtil.getSizeInBytes(lastBitmapReference!!.get())\n\n @Synchronized\n override fun clear() {\n closeAndResetLastBitmapReference()\n }\n\n @Synchronized\n override fun onFrameRendered(\n frameNumber: Int,\n bitmapReference: CloseableReference,\n @FrameType frameType: Int,\n ) {\n if (lastBitmapReference != null && bitmapReference.get() == lastBitmapReference?.get()) {\n return\n }\n CloseableReference.closeSafely(lastBitmapReference)\n if (lastFrameNumber != FRAME_NUMBER_UNSET) {\n frameCacheListener?.onFrameEvicted(this, lastFrameNumber)\n }\n lastBitmapReference = CloseableReference.cloneOrNull(bitmapReference)\n frameCacheListener?.onFrameCached(this, frameNumber)\n lastFrameNumber = frameNumber\n }\n\n override fun onFramePrepared(\n frameNumber: Int,\n bitmapReference: CloseableReference,\n @FrameType frameType: Int,\n ) = Unit\n\n override fun setFrameCacheListener(frameCacheListener: FrameCacheListener?) {\n this.frameCacheListener = frameCacheListener\n }\n\n @Synchronized\n private fun closeAndResetLastBitmapReference() {\n if (lastFrameNumber != FRAME_NUMBER_UNSET) {\n frameCacheListener?.onFrameEvicted(this, lastFrameNumber)\n }\n CloseableReference.closeSafely(lastBitmapReference)\n lastBitmapReference = null\n lastFrameNumber = FRAME_NUMBER_UNSET\n }\n\n companion object {\n private const val FRAME_NUMBER_UNSET = -1\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/cache/NoOpCache.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.cache\n\nimport android.graphics.Bitmap\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.bitmap.BitmapAnimationBackend.FrameType\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache.FrameCacheListener\n\n/** No-op bitmap cache that doesn't do anything. */\nclass NoOpCache : BitmapFrameCache {\n\n override fun getCachedFrame(frameNumber: Int): CloseableReference? = null\n\n override fun getFallbackFrame(frameNumber: Int): CloseableReference? = null\n\n override fun getBitmapToReuseForFrame(\n frameNumber: Int,\n width: Int,\n height: Int,\n ): CloseableReference? = null\n\n override fun contains(frameNumber: Int): Boolean = false\n\n override val sizeInBytes: Int = 0\n\n override fun clear() {\n // no-op\n }\n\n override fun onFrameRendered(\n frameNumber: Int,\n bitmapReference: CloseableReference,\n @FrameType frameType: Int,\n ) {\n // no-op\n }\n\n override fun onFramePrepared(\n frameNumber: Int,\n bitmapReference: CloseableReference,\n @FrameType frameType: Int,\n ) {\n // Does not cache anything\n }\n\n override fun setFrameCacheListener(frameCacheListener: FrameCacheListener?) {\n // Does not cache anything\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/BitmapFramePreparationStrategy.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation\n\nimport android.graphics.Bitmap\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\n\n/** Frame preparation strategy to prepare next animation frames. */\ninterface BitmapFramePreparationStrategy {\n /**\n * Decide whether frames should be prepared ahead of time when a frame is drawn.\n *\n * @param bitmapFramePreparer the preparer to be used to create frames\n * @param bitmapFrameCache the cache to pass to the preparer\n * @param animationBackend the animation backend to prepare frames for\n * @param lastDrawnFrameNumber the last drawn frame number\n */\n fun prepareFrames(\n bitmapFramePreparer: BitmapFramePreparer,\n bitmapFrameCache: BitmapFrameCache,\n animationBackend: AnimationBackend,\n lastDrawnFrameNumber: Int,\n onAnimationLoaded: (() -> Unit)? = null,\n ) = Unit\n\n /**\n * Prepare the frames for the animation giving the size of the animation and the size of the\n * canvas\n *\n * @param onAnimationLoaded This callback is invoked every time that bitmaps are loaded in memory\n * successfully. This can be triggered several times because animation could be dropped from\n * memory and then loaded again\n */\n fun prepareFrames(canvasWidth: Int, canvasHeight: Int, onAnimationLoaded: (() -> Unit)?) = Unit\n\n /** Force stop any task running on the strategy */\n fun onStop() = Unit\n\n /** Clear the frames from cache */\n fun clearFrames() = Unit\n\n fun getBitmapFrame(\n frameNumber: Int,\n canvasWidth: Int,\n canvasHeight: Int,\n ): CloseableReference? = null\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/BitmapFramePreparer.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation\n\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\n\n/** Prepare frames for animated images ahead of time. */\ninterface BitmapFramePreparer {\n /**\n * Prepare the frame with the given frame number and notify the supplied bitmap frame cache once\n * the frame is ready by calling [BitmapFrameCache#onFramePrepared(int, CloseableReference, int)]\n *\n * @param bitmapFrameCache the cache to notify for prepared frames\n * @param animationBackend the backend to prepare frames for\n * @param frameNumber\n * @return\n */\n fun prepareFrame(\n bitmapFrameCache: BitmapFrameCache,\n animationBackend: AnimationBackend,\n frameNumber: Int,\n ): Boolean\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/DefaultBitmapFramePreparer.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation\n\nimport android.graphics.Bitmap\nimport android.util.SparseArray\nimport com.facebook.common.logging.FLog\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapAnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapAnimationBackend.FrameType\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\nimport com.facebook.fresco.animation.bitmap.BitmapFrameRenderer\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport java.lang.RuntimeException\nimport java.util.concurrent.ExecutorService\n\n/**\n * Default bitmap frame preparer that uses the given [ExecutorService] to schedule jobs. An instance\n * of this class can be shared between multiple animated images.\n */\nclass DefaultBitmapFramePreparer(\n private val platformBitmapFactory: PlatformBitmapFactory,\n private val bitmapFrameRenderer: BitmapFrameRenderer,\n private val bitmapConfig: Bitmap.Config,\n private val executorService: ExecutorService,\n) : BitmapFramePreparer {\n\n private val TAG = DefaultBitmapFramePreparer::class.java\n\n private val pendingFrameDecodeJobs: SparseArray = SparseArray()\n\n override fun prepareFrame(\n bitmapFrameCache: BitmapFrameCache,\n animationBackend: AnimationBackend,\n frameNumber: Int,\n ): Boolean {\n // Create a unique ID to identify the frame for the given backend.\n val frameId = getUniqueId(animationBackend, frameNumber)\n synchronized(pendingFrameDecodeJobs) {\n\n // Check if already scheduled.\n if (pendingFrameDecodeJobs[frameId] != null) {\n FLog.v(TAG, \"Already scheduled decode job for frame %d\", frameNumber)\n return true\n }\n\n // Check if already cached.\n if (bitmapFrameCache.contains(frameNumber)) {\n FLog.v(TAG, \"Frame %d is cached already.\", frameNumber)\n return true\n }\n\n val frameDecodeRunnable =\n FrameDecodeRunnable(animationBackend, bitmapFrameCache, frameNumber, frameId)\n pendingFrameDecodeJobs.put(frameId, frameDecodeRunnable)\n executorService.execute(frameDecodeRunnable)\n }\n return true\n }\n\n private inner class FrameDecodeRunnable(\n private val animationBackend: AnimationBackend,\n private val bitmapFrameCache: BitmapFrameCache,\n private val frameNumber: Int,\n private val frameId: Int,\n ) : Runnable {\n override fun run() {\n try {\n // If we have a cached frame already, we don't need to do anything.\n if (bitmapFrameCache.contains(frameNumber)) {\n FLog.v(TAG, \"Frame %d is cached already.\", frameNumber)\n return\n }\n\n // Prepare the frame.\n if (prepareFrameAndCache(frameNumber, BitmapAnimationBackend.FRAME_TYPE_REUSED)) {\n FLog.v(TAG, \"Prepared frame %d.\", frameNumber)\n } else {\n FLog.e(TAG, \"Could not prepare frame %d.\", frameNumber)\n }\n } finally {\n synchronized(pendingFrameDecodeJobs) { pendingFrameDecodeJobs.remove(frameId) }\n }\n }\n\n private fun prepareFrameAndCache(frameNumber: Int, @FrameType frameType: Int): Boolean {\n var bitmapReference: CloseableReference? = null\n val created: Boolean\n val nextFrameType: Int\n try {\n when (frameType) {\n BitmapAnimationBackend.FRAME_TYPE_REUSED -> {\n bitmapReference =\n bitmapFrameCache.getBitmapToReuseForFrame(\n frameNumber,\n animationBackend.intrinsicWidth,\n animationBackend.intrinsicHeight,\n )\n nextFrameType = BitmapAnimationBackend.FRAME_TYPE_CREATED\n }\n BitmapAnimationBackend.FRAME_TYPE_CREATED -> {\n bitmapReference =\n try {\n platformBitmapFactory.createBitmap(\n animationBackend.intrinsicWidth,\n animationBackend.intrinsicHeight,\n bitmapConfig,\n )\n } catch (e: RuntimeException) {\n // Failed to create the bitmap for the frame, return and report that we could not\n // prepare the frame.\n FLog.w(TAG, \"Failed to create frame bitmap\", e)\n return false\n }\n nextFrameType = BitmapAnimationBackend.FRAME_TYPE_UNKNOWN\n }\n else -> return false\n }\n // Try to render and cache the frame\n created = renderFrameAndCache(frameNumber, bitmapReference, frameType)\n } finally {\n CloseableReference.closeSafely(bitmapReference)\n }\n return if (created || nextFrameType == BitmapAnimationBackend.FRAME_TYPE_UNKNOWN) {\n created\n } else {\n prepareFrameAndCache(frameNumber, nextFrameType)\n }\n }\n\n private fun renderFrameAndCache(\n frameNumber: Int,\n bitmapReference: CloseableReference?,\n @FrameType frameType: Int,\n ): Boolean {\n // Check if the bitmap is valid\n if (!CloseableReference.isValid(bitmapReference)) {\n return false\n }\n // Try to render the frame\n if (\n bitmapReference == null ||\n !bitmapFrameRenderer.renderFrame(frameNumber, bitmapReference.get())\n ) {\n return false\n }\n FLog.v(TAG, \"Frame %d ready.\", frameNumber)\n // Cache the frame\n synchronized(pendingFrameDecodeJobs) {\n bitmapFrameCache.onFramePrepared(frameNumber, bitmapReference, frameType)\n }\n return true\n }\n }\n\n private fun getUniqueId(backend: AnimationBackend, frameNumber: Int): Int =\n 31 * backend.hashCode() + frameNumber\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/FixedNumberBitmapFramePreparationStrategy.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation\n\nimport com.facebook.common.logging.FLog\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\n\n/** Frame preparation strategy to prepare the next n frames */\nclass FixedNumberBitmapFramePreparationStrategy\n@JvmOverloads\nconstructor(private val framesToPrepare: Int = 3) : BitmapFramePreparationStrategy {\n\n private val TAG = FixedNumberBitmapFramePreparationStrategy::class.java\n\n override fun prepareFrames(\n bitmapFramePreparer: BitmapFramePreparer,\n bitmapFrameCache: BitmapFrameCache,\n animationBackend: AnimationBackend,\n lastDrawnFrameNumber: Int,\n onAnimationLoaded: (() -> Unit)?,\n ) {\n for (i in 1..framesToPrepare) {\n val nextFrameNumber = (lastDrawnFrameNumber + i) % animationBackend.frameCount\n if (FLog.isLoggable(FLog.VERBOSE)) {\n FLog.v(TAG, \"Preparing frame %d, last drawn: %d\", nextFrameNumber, lastDrawnFrameNumber)\n }\n if (!bitmapFramePreparer.prepareFrame(bitmapFrameCache, animationBackend, nextFrameNumber)) {\n // We cannot prepare more frames, so we return early\n return\n }\n }\n\n onAnimationLoaded?.invoke()\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/FrameLoaderStrategy.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation\n\nimport android.graphics.Bitmap\nimport androidx.annotation.UiThread\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.backend.AnimationInformation\nimport com.facebook.fresco.animation.bitmap.BitmapFrameRenderer\nimport com.facebook.fresco.animation.bitmap.preparation.ondemandanimation.AnimationCoordinator\nimport com.facebook.fresco.animation.bitmap.preparation.ondemandanimation.DynamicRenderingFps\nimport com.facebook.fresco.animation.bitmap.preparation.ondemandanimation.FrameLoader\nimport com.facebook.fresco.animation.bitmap.preparation.ondemandanimation.FrameLoaderFactory\nimport java.util.concurrent.TimeUnit\n\n/** Use a [FrameLoader] strategy to render the animaion */\nclass FrameLoaderStrategy(\n source: String?,\n private val animationInformation: AnimationInformation,\n private val bitmapFrameRenderer: BitmapFrameRenderer,\n private val frameLoaderFactory: FrameLoaderFactory,\n private val downscaleFrameToDrawableDimensions: Boolean,\n) : BitmapFramePreparationStrategy {\n\n private val cacheKey = source ?: this.hashCode().toString()\n private val animationWidth: Int = animationInformation.width()\n private val animationHeight: Int = animationInformation.height()\n private var frameLoader: FrameLoader? = null\n get() {\n if (field == null) {\n field =\n frameLoaderFactory.createBufferLoader(\n cacheKey,\n bitmapFrameRenderer,\n animationInformation,\n )\n }\n return field\n }\n\n private val maxAnimationFps = animationInformation.fps()\n private var currentFps = maxAnimationFps\n private var isRunning = true\n\n private val dynamicFpsRender =\n object : DynamicRenderingFps {\n override val animationFps: Int = maxAnimationFps\n\n override val renderingFps: Int\n get() = currentFps\n\n override fun setRenderingFps(renderingFps: Int) {\n if (renderingFps != currentFps && isRunning) {\n currentFps = renderingFps.coerceIn(1, maxAnimationFps)\n frameLoader?.compressToFps(currentFps)\n }\n }\n }\n\n @UiThread\n override fun prepareFrames(\n canvasWidth: Int,\n canvasHeight: Int,\n onAnimationLoaded: (() -> Unit)?,\n ) {\n // Validate inputs\n if (canvasWidth <= 0 || canvasHeight <= 0 || animationWidth <= 0 || animationHeight <= 0) {\n return\n }\n isRunning = true\n\n val frameSize = calculateFrameSize(canvasWidth, canvasHeight)\n frameLoader?.prepareFrames(frameSize.width, frameSize.height, onAnimationLoaded ?: {})\n }\n\n @UiThread\n override fun getBitmapFrame(\n frameNumber: Int,\n canvasWidth: Int,\n canvasHeight: Int,\n ): CloseableReference? {\n val frameSize = calculateFrameSize(canvasWidth, canvasHeight)\n val frame = frameLoader?.getFrame(frameNumber, frameSize.width, frameSize.height)\n frame?.let { AnimationCoordinator.onRenderFrame(dynamicFpsRender, it) }\n isRunning = true\n return frame?.bitmapRef\n }\n\n override fun onStop() {\n frameLoader?.onStop()\n clearFrames()\n }\n\n override fun clearFrames() {\n frameLoader?.let { FrameLoaderFactory.saveUnusedFrame(cacheKey, it) }\n frameLoader = null\n isRunning = false\n }\n\n private fun calculateFrameSize(canvasWidth: Int, canvasHeight: Int): FrameSize {\n if (!downscaleFrameToDrawableDimensions) {\n return FrameSize(animationWidth, animationHeight)\n }\n\n var bitmapWidth: Int = animationWidth\n var bitmapHeight: Int = animationHeight\n\n // The maximum size for the bitmap is the size of the animation if the canvas is bigger\n if (canvasWidth < animationWidth || canvasHeight < animationHeight) {\n val ratioW = animationWidth.toDouble().div(animationHeight)\n if (canvasHeight > canvasWidth) {\n bitmapHeight = canvasHeight.coerceAtMost(animationHeight)\n bitmapWidth = bitmapHeight.times(ratioW).toInt()\n } else {\n bitmapWidth = canvasWidth.coerceAtMost(animationWidth)\n bitmapHeight = bitmapWidth.div(ratioW).toInt()\n }\n }\n\n return FrameSize(bitmapWidth, bitmapHeight)\n }\n\n private fun AnimationInformation.fps(): Int =\n TimeUnit.SECONDS.toMillis(1).div(loopDurationMs.div(frameCount)).coerceAtLeast(1).toInt()\n}\n\nprivate class FrameSize(val width: Int, val height: Int)\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/loadframe/AnimationLoaderExecutor.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation.loadframe\n\nimport java.util.concurrent.Executors\nimport java.util.concurrent.ThreadFactory\n\nobject AnimationLoaderExecutor {\n\n private val frameThreadFactory = ThreadFactory { runnable: Runnable? ->\n val thread = Thread(runnable)\n thread.priority = Thread.MIN_PRIORITY\n thread\n }\n\n private val executor = Executors.newCachedThreadPool(frameThreadFactory)\n\n fun execute(task: Runnable) {\n executor.execute(task)\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/loadframe/FpsCompressorInfo.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation.loadframe\n\nimport android.graphics.Bitmap\nimport com.facebook.common.references.CloseableReference\n\nclass FpsCompressorInfo(private val maxFpsLimit: Int) {\n\n /**\n * @param frameBitmaps has the bitmaps of the animation. FrameNumber -> Bitmap\n * @param targetFps compressed animation fps\n * @return AnimationFrame reference if the animation was saved in memory. Returns null if\n * animation couldn't be allocated\n */\n fun compress(\n durationMs: Int,\n frameBitmaps: Map>,\n targetFps: Int,\n ): CompressionResult {\n val realToCompressIndex = calculateReducedIndexes(durationMs, frameBitmaps.size, targetFps)\n return compressAnimation(frameBitmaps, realToCompressIndex)\n }\n\n /**\n * Create a Map calculated based on the maximum FPS allowed\n *\n * @param durationMs duration of the animation in ms\n * @param frameCount Number of frames extracted from the animation asset\n * @param targetFps\n * @return Map of equivalences between the original frame number and compress frame number\n */\n fun calculateReducedIndexes(durationMs: Int, frameCount: Int, targetFps: Int): Map {\n val sanitiseFps = targetFps.coerceAtLeast(1).coerceAtMost(maxFpsLimit)\n val maxAllowedFrames = sanitiseFps.times(durationMs.millisecondsToSeconds()).coerceAtLeast(0f)\n\n val skipRatio = frameCount.div(maxAllowedFrames.coerceAtMost(frameCount.toFloat()))\n var prevFrame = 0\n return (0 until frameCount).associateWith { frameIndex ->\n if ((frameIndex % skipRatio).toInt() == 0) {\n prevFrame = frameIndex\n }\n\n prevFrame\n }\n }\n\n /**\n * Compress animation releasing those bitmaps which wont be in the final animation\n *\n * @param frameBitmaps relation frameNumber->bitmap of the original animation\n * @param realToReducedIndex map of equivalences between originalFrameNumber->compressFrameNumber\n * @return map associating compressFrameNumber->bitmap\n */\n private fun compressAnimation(\n frameBitmaps: Map>,\n realToReducedIndex: Map,\n ): CompressionResult {\n val compressedAnim = mutableMapOf>()\n val removedFrames = mutableListOf>()\n\n frameBitmaps.forEach { (i, bitmapRef) ->\n val reducedIndex = realToReducedIndex[i] ?: return@forEach\n\n if (compressedAnim.contains(reducedIndex)) {\n removedFrames.add(bitmapRef)\n } else {\n compressedAnim[reducedIndex] = bitmapRef\n }\n }\n\n return CompressionResult(compressedAnim, realToReducedIndex, removedFrames)\n }\n\n /**\n * Contain the result of the compression\n *\n * @param compressedAnim Contains the bitmaps associated with frame number\n *\n * ```\n * ________________________\n * | Frame 1 ----> Bitmap1 | ________________________\n * | Frame 2 ----> Bitmap2 | ====> | Compress 1 ----> Bitmap1 |\n * ------------------------- -------------------------\n * ```\n *\n * @param realToReducedIndex contains the association between old frame numbers to new frame\n * numbers\n *\n * ```\n * ________________________________\n * | Frame 1 ----> Compress Frame 1 |\n * | Frame 2 ----> Compress Frame 1 |\n * ---------------------------------\n *\n * ```\n *\n * @param removedFrames contains the bitmap that are not useful. \"Bitmap2\"\n */\n class CompressionResult(\n val compressedAnim: Map>,\n val realToReducedIndex: Map,\n val removedFrames: List>,\n )\n\n fun Int.millisecondsToSeconds(): Float = this.div(1000f)\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/ondemandanimation/AnimationBitmapFrame.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation.ondemandanimation\n\nimport android.graphics.Bitmap\nimport com.facebook.common.references.CloseableReference\nimport java.io.Closeable\n\nclass AnimationBitmapFrame(var frameNumber: Int, val bitmap: CloseableReference) :\n Closeable {\n fun isValidFor(frameNumber: Int): Boolean = this.frameNumber == frameNumber && bitmap.isValid\n\n fun isValid(): Boolean = bitmap.isValid\n\n override fun close() {\n bitmap.close()\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/ondemandanimation/AnimationCoordinator.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation.ondemandanimation\n\nimport android.os.Handler\nimport android.os.HandlerThread\nimport com.facebook.fresco.animation.bitmap.preparation.ondemandanimation.FrameResult.FrameType\nimport java.util.Date\nimport java.util.concurrent.ConcurrentHashMap\nimport java.util.concurrent.atomic.AtomicInteger\n\nobject AnimationCoordinator {\n\n /** Frequency in ms to adjust the rendering fps based con device performance */\n private const val FREQUENCY_PERFORMANCE_MS = 2000L\n private const val FREQUENCY_LOADERS_MS = 10000L\n\n /** This is the % of fps that animation will increase or decrease based on device performance */\n private const val FPS_STEP_PERCENTAGE = 0.20f\n\n /** Minimum rendering fps percentage */\n private const val MIN_RENDERING_FPS_PERCENTAGE = 0.50f\n\n private val successCounter = AtomicInteger(0)\n private val failuresCounter = AtomicInteger(0)\n private val criticalCounter = AtomicInteger(0)\n private val runningAnimations = ConcurrentHashMap()\n private val handler: Handler by lazy {\n val handlerThread = HandlerThread(\"FrescoAnimationWorker\")\n handlerThread.start()\n Handler(handlerThread.looper)\n }\n\n private val calculatePerformance: Runnable = Runnable {\n val success = successCounter.getAndSet(0).toFloat()\n val failures = failuresCounter.getAndSet(0).toFloat()\n val critical = criticalCounter.getAndSet(0).toFloat()\n val totalFrames = success + failures + critical\n\n if (totalFrames > 0) {\n val successRatio = success.div(totalFrames)\n val failuresRatio = failures.div(totalFrames)\n val criticalRatio = critical.div(totalFrames)\n\n // Verify that device performance can render all needed frames\n if (failuresRatio > 0.25f || criticalRatio > 0.1f) {\n // If animation performance is not enough, then decrease the rendering fps\n runningAnimations.forEach { (animation, fpsStep) ->\n updateRenderingFps(animation, -fpsStep)\n }\n } else if (successRatio > 0.98f) {\n // Animation performance is good, then we can increase the rendering fps\n runningAnimations.forEach { (animation, fpsStep) -> updateRenderingFps(animation, fpsStep) }\n } else {\n // Performance is good enough, but to increase rendering fps could be risky\n }\n runningAnimations.clear()\n }\n\n schedulePerformance()\n }\n\n private val clearUnusedFrameLoaders: Runnable = Runnable {\n val maxUnusedTime = System.currentTimeMillis() - FREQUENCY_LOADERS_MS\n FrameLoaderFactory.clearUnusedUntil(Date(maxUnusedTime))\n scheduleLoaders()\n }\n\n init {\n handler.post(calculatePerformance)\n handler.post(clearUnusedFrameLoaders)\n }\n\n private fun schedulePerformance() =\n handler.postDelayed(calculatePerformance, FREQUENCY_PERFORMANCE_MS)\n\n private fun scheduleLoaders() = handler.postDelayed(clearUnusedFrameLoaders, FREQUENCY_LOADERS_MS)\n\n private fun updateRenderingFps(animation: DynamicRenderingFps, delta: Int) {\n val minRenderingFps =\n animation.animationFps.times(MIN_RENDERING_FPS_PERCENTAGE).coerceAtLeast(1f).toInt()\n val renderingFps =\n (animation.renderingFps + delta).coerceIn(minRenderingFps, animation.animationFps)\n\n if (renderingFps != animation.renderingFps) {\n animation.setRenderingFps(renderingFps)\n }\n }\n\n /**\n * This method is executed everytime that a frame is render in one animation. This allow to\n * collect what is the running animation performance per [FREQUENCY_PERFORMANCE_MS] We will adjust\n * the animation performance based on this data.\n */\n fun onRenderFrame(animation: DynamicRenderingFps, frameResult: FrameResult) {\n if (!runningAnimations.contains(animation)) {\n val fps = animation.animationFps\n val fpsStep = fps.times(FPS_STEP_PERCENTAGE).toInt()\n\n runningAnimations[animation] = fpsStep\n }\n\n when (frameResult.type) {\n FrameType.SUCCESS -> successCounter.incrementAndGet()\n FrameType.NEAREST -> failuresCounter.incrementAndGet()\n FrameType.MISSING -> criticalCounter.incrementAndGet()\n }\n }\n}\n\n/** This interface allow animations to adjust their fps according with the device performance. */\ninterface DynamicRenderingFps {\n /** Animation FPS provided by the original asset */\n val animationFps: Int\n\n /** Render animation FPS. These are time-varying based on the performance of the device. */\n val renderingFps: Int\n\n /**\n * Update the render fps to [renderingFps]. This number is calculated based on the range from\n * [AnimationCoordinator.MIN_RENDERING_FPS_PERCENTAGE] to [animationFps]\n */\n fun setRenderingFps(renderingFps: Int)\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/ondemandanimation/AnimationLoaderFactory.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation.ondemandanimation\n\nimport com.facebook.fresco.animation.backend.AnimationInformation\nimport com.facebook.fresco.animation.bitmap.BitmapFrameRenderer\nimport com.facebook.fresco.animation.bitmap.preparation.loadframe.FpsCompressorInfo\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport java.util.Date\nimport java.util.concurrent.ConcurrentHashMap\n\nclass FrameLoaderFactory(\n private val platformBitmapFactory: PlatformBitmapFactory,\n private val maxFpsRender: Int,\n private val bufferLengthMilliseconds: Int,\n private val enableBufferFrameLoaderFix: Boolean = false,\n private val frameLoaderListener: FrameLoaderListener? = null,\n private val enableSingleFrameRendering: Boolean = false,\n) {\n\n fun createBufferLoader(\n cacheKey: String,\n bitmapFrameRenderer: BitmapFrameRenderer,\n animationInformation: AnimationInformation,\n ): FrameLoader {\n synchronized(UNUSED_FRAME_LOADERS) {\n val unusedFrameLoader = UNUSED_FRAME_LOADERS[cacheKey]\n if (unusedFrameLoader != null) {\n UNUSED_FRAME_LOADERS.remove(cacheKey)\n return unusedFrameLoader.frameLoader\n }\n }\n\n return BufferFrameLoader(\n platformBitmapFactory,\n bitmapFrameRenderer,\n FpsCompressorInfo(maxFpsRender),\n animationInformation,\n bufferLengthMilliseconds,\n enableBufferFrameLoaderFix,\n frameLoaderListener,\n enableSingleFrameRendering,\n )\n }\n\n companion object {\n private val UNUSED_FRAME_LOADERS = ConcurrentHashMap()\n\n fun saveUnusedFrame(cacheKey: String, frameLoader: FrameLoader) {\n UNUSED_FRAME_LOADERS[cacheKey] = UnusedFrameLoader(frameLoader, Date())\n }\n\n fun clearUnusedUntil(until: Date) {\n synchronized(UNUSED_FRAME_LOADERS) {\n val oldItems = UNUSED_FRAME_LOADERS.filter { it.value.insertedTime < until }\n\n oldItems.forEach { entry ->\n entry.value.frameLoader.clear()\n UNUSED_FRAME_LOADERS.remove(entry.key)\n }\n }\n }\n }\n}\n\nprivate class UnusedFrameLoader(val frameLoader: FrameLoader, val insertedTime: Date)\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/ondemandanimation/BufferFrameLoader.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation.ondemandanimation\n\nimport android.graphics.Bitmap\nimport android.graphics.Canvas\nimport android.graphics.Color\nimport android.graphics.PorterDuff\nimport androidx.annotation.UiThread\nimport androidx.annotation.WorkerThread\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.backend.AnimationInformation\nimport com.facebook.fresco.animation.bitmap.BitmapFrameRenderer\nimport com.facebook.fresco.animation.bitmap.preparation.loadframe.AnimationLoaderExecutor\nimport com.facebook.fresco.animation.bitmap.preparation.loadframe.FpsCompressorInfo\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport java.util.ArrayDeque\nimport java.util.concurrent.ConcurrentHashMap\nimport java.util.concurrent.TimeUnit\nimport kotlin.collections.set\n\n/**\n * This frame loader uses a fixed number of bitmap. The buffer loads the next bunch of frames when\n * the animation render an specific threshold frame\n */\nclass BufferFrameLoader(\n private val platformBitmapFactory: PlatformBitmapFactory,\n private val bitmapFrameRenderer: BitmapFrameRenderer,\n private val fpsCompressor: FpsCompressorInfo,\n override val animationInformation: AnimationInformation,\n private val bufferLengthMilliseconds: Int,\n private val enableBufferFrameLoaderFix: Boolean = false,\n private val frameLoaderListener: FrameLoaderListener? = null,\n private val enableSingleFrameRendering: Boolean = false,\n) : FrameLoader {\n\n private val bufferSize =\n ((animationInformation.fps() * bufferLengthMilliseconds) / 1000).coerceAtLeast(1)\n private val isSingleFrame = enableSingleFrameRendering && animationInformation.frameCount == 1\n @Volatile private var singleFrameRef: CloseableReference? = null\n\n private val bufferFramesHash = ConcurrentHashMap()\n @Volatile private var thresholdFrame: Int\n @Volatile private var isFetching = false\n\n private val frameSequence = CircularList(animationInformation.frameCount)\n private var lastRenderedFrameNumber: Int = -1\n private var compressionFrameMap: Map = emptyMap()\n private var renderableFrameIndexes: Set = emptySet()\n\n init {\n compressToFps(animationInformation.fps())\n thresholdFrame = bufferSize.times(THRESHOLD_PERCENTAGE).toInt()\n }\n\n @UiThread\n override fun getFrame(frameNumber: Int, width: Int, height: Int): FrameResult {\n if (isSingleFrame) {\n return getSingleFrame(width, height)\n }\n\n val cachedFrameIndex = compressionFrameMap[frameNumber]\n\n // Return the nearest frame if the frame is not in the buffer OR width or height is 0\n if (enableBufferFrameLoaderFix && (width == 0 || height == 0)) {\n frameLoaderListener?.onZeroFrameDimensions(\n origin = \"BufferFrameLoader.getFrame\",\n frameNumber,\n width,\n height,\n )\n\n return findNearestToRender(frameNumber)\n }\n\n if (cachedFrameIndex == null) {\n return findNearestToRender(frameNumber)\n }\n\n lastRenderedFrameNumber = cachedFrameIndex\n\n val cachedFrame = bufferFramesHash[cachedFrameIndex]?.takeIf { it.isFrameAvailable }\n\n if (cachedFrame != null) {\n val isTargetAhead = frameSequence.isTargetAhead(thresholdFrame, cachedFrameIndex, bufferSize)\n if (isTargetAhead) {\n loadNextFrames(width, height)\n }\n return FrameResult(cachedFrame.bitmapRef.clone(), FrameResult.FrameType.SUCCESS)\n }\n\n loadNextFrames(width, height)\n return findNearestToRender(cachedFrameIndex)\n }\n\n @UiThread\n private fun getSingleFrame(width: Int, height: Int): FrameResult {\n frameLoaderListener?.onSingleFrameRender(\n origin = \"BufferFrameLoader.getSingleFrame\",\n width,\n height,\n )\n\n singleFrameRef?.let { ref ->\n val clone = ref.cloneOrNull()\n if (clone != null) {\n return FrameResult(clone, FrameResult.FrameType.SUCCESS)\n }\n }\n\n if (width == 0 || height == 0) {\n return FrameResult(null, FrameResult.FrameType.MISSING)\n }\n\n val bitmapRef = platformBitmapFactory.createBitmap(width, height)\n bitmapFrameRenderer.renderFrame(0, bitmapRef.get())\n singleFrameRef = bitmapRef\n return FrameResult(bitmapRef.clone(), FrameResult.FrameType.SUCCESS)\n }\n\n @UiThread\n private fun findNearestToRender(targetFrame: Int): FrameResult {\n val nearestFrame = findNearestFrame(targetFrame)\n\n return if (nearestFrame != null) {\n val bitmapRef = nearestFrame.bitmap.clone()\n lastRenderedFrameNumber = nearestFrame.frameNumber\n FrameResult(bitmapRef, FrameResult.FrameType.NEAREST)\n } else {\n FrameResult(null, FrameResult.FrameType.MISSING)\n }\n }\n\n @UiThread\n override fun prepareFrames(width: Int, height: Int, onAnimationLoaded: () -> Unit) {\n if (isSingleFrame) {\n onAnimationLoaded()\n return\n }\n loadNextFrames(width, height)\n onAnimationLoaded()\n }\n\n override fun compressToFps(fps: Int) {\n val durationMs =\n animationInformation.loopDurationMs.times(animationInformation.loopCount.coerceAtLeast(1))\n compressionFrameMap =\n fpsCompressor.calculateReducedIndexes(\n durationMs = durationMs,\n frameCount = animationInformation.frameCount,\n targetFps = fps.coerceAtMost(animationInformation.fps()),\n )\n\n renderableFrameIndexes = compressionFrameMap.values.toSet()\n }\n\n /** Release all bitmaps */\n override fun clear() {\n CloseableReference.closeSafely(singleFrameRef)\n singleFrameRef = null\n bufferFramesHash.values.forEach { it.release() }\n bufferFramesHash.clear()\n lastRenderedFrameNumber = -1\n }\n\n private fun loadNextFrames(width: Int, height: Int) {\n // Skip frame if width or height is 0 OR if the buffer is already loading\n if ((enableBufferFrameLoaderFix && (width == 0 || height == 0)) || isFetching) {\n frameLoaderListener?.onZeroFrameDimensions(\n origin = \"BufferFrameLoader.loadNextFrames\",\n frameNumber = lastRenderedFrameNumber.coerceAtLeast(0),\n width,\n height,\n )\n\n return\n }\n\n isFetching = true\n AnimationLoaderExecutor.execute {\n do {\n val targetFrame = lastRenderedFrameNumber.coerceAtLeast(0)\n val success = extractDemandedFrame(targetFrame, width, height)\n } while (!success)\n isFetching = false\n }\n }\n\n @WorkerThread\n private fun extractDemandedFrame(\n targetFrame: Int,\n width: Int,\n height: Int,\n count: Int = 0,\n ): Boolean {\n val nextWindow =\n frameSequence.sublist(targetFrame, bufferSize).filter {\n renderableFrameIndexes.contains(it)\n }\n val nextWindowIndexes = nextWindow.toSet()\n val oldFramesNumbers = ArrayDeque(bufferFramesHash.keys.minus(nextWindowIndexes))\n\n // Load new frames\n nextWindow.forEach { newFrameNumber ->\n if (bufferFramesHash[newFrameNumber] != null) {\n return@forEach\n }\n\n if (lastRenderedFrameNumber != -1 && !nextWindowIndexes.contains(lastRenderedFrameNumber)) {\n return false\n }\n\n val deprecatedFrameNumber = oldFramesNumbers.pollFirst() ?: -1\n val cachedFrame = bufferFramesHash[deprecatedFrameNumber]\n val bufferFrame: BufferFrame\n val bitmapRef: CloseableReference\n val ref = cachedFrame?.bitmapRef?.cloneOrNull()\n\n if (ref != null) {\n bufferFrame = cachedFrame\n bitmapRef = ref\n } else {\n bufferFrame = BufferFrame(platformBitmapFactory.createBitmap(width, height))\n bitmapRef = bufferFrame.bitmapRef.clone()\n }\n bufferFrame.isUpdatingFrame = true\n bitmapRef.use { obtainFrame(it, newFrameNumber, width, height) }\n bufferFramesHash.remove(deprecatedFrameNumber)\n bufferFrame.isUpdatingFrame = false\n\n bufferFramesHash[newFrameNumber] = bufferFrame\n }\n\n thresholdFrame =\n if (nextWindow.isEmpty()) bufferSize.times(THRESHOLD_PERCENTAGE).toInt()\n else {\n val windowSize = nextWindow.size\n val middlePoint =\n windowSize.times(THRESHOLD_PERCENTAGE).toInt().coerceIn(0, windowSize - 1)\n nextWindow[middlePoint]\n }\n return true\n }\n\n private fun obtainFrame(\n targetBitmap: CloseableReference,\n targetFrame: Int,\n width: Int,\n height: Int,\n ) {\n val nearestFrame = findNearestFrame(targetFrame)\n\n nearestFrame?.bitmap?.cloneOrNull()?.use { nearestBitmap ->\n val from = nearestFrame.frameNumber\n\n if (from < targetFrame) {\n targetBitmap.set(nearestBitmap.get())\n (from + 1..targetFrame).forEach { bitmapFrameRenderer.renderFrame(it, targetBitmap.get()) }\n return\n }\n }\n\n targetBitmap.clear()\n (0..targetFrame).forEach { bitmapFrameRenderer.renderFrame(it, targetBitmap.get()) }\n }\n\n private fun findNearestFrame(targetFrame: Int): AnimationBitmapFrame? =\n (0..frameSequence.size).firstNotNullOfOrNull { delta ->\n val closestFrame = frameSequence.getPosition(targetFrame - delta)\n bufferFramesHash[closestFrame]\n ?.takeIf { it.isFrameAvailable }\n ?.let { AnimationBitmapFrame(closestFrame, it.bitmapRef) }\n }\n\n private fun CloseableReference.clear() {\n if (isValid) {\n Canvas(get()).drawColor(Color.TRANSPARENT, PorterDuff.Mode.CLEAR)\n }\n }\n\n private fun CloseableReference.set(src: Bitmap): CloseableReference {\n if (isValid && get() != src) {\n val canvas = Canvas(get())\n canvas.drawColor(Color.TRANSPARENT, PorterDuff.Mode.CLEAR)\n canvas.drawBitmap(src, 0f, 0f, null)\n }\n return this\n }\n\n private fun AnimationInformation.fps(): Int =\n TimeUnit.SECONDS.toMillis(1).div(loopDurationMs.div(frameCount)).coerceAtLeast(1).toInt()\n\n private class BufferFrame(val bitmapRef: CloseableReference) {\n var isUpdatingFrame: Boolean = false\n val isFrameAvailable: Boolean\n get(): Boolean = !isUpdatingFrame && bitmapRef.isValid\n\n fun release() {\n CloseableReference.closeSafely(bitmapRef)\n }\n }\n\n companion object {\n\n /**\n * Used to calculate the threshold frame for triggering the next buffer load from the last\n * render frame\n */\n private const val THRESHOLD_PERCENTAGE = 0.5f\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/ondemandanimation/CircularList.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation.ondemandanimation\n\nclass CircularList(val size: Int) {\n\n fun isTargetAhead(from: Int, target: Int, length: Int): Boolean {\n val endPosition = getPosition(from + length)\n\n return if (from < endPosition) {\n target in from..endPosition\n } else {\n target in from..size || target in 0..endPosition\n }\n }\n\n fun getPosition(target: Int): Int {\n val circularPosition = target % size\n\n return circularPosition.takeIf { it >= 0 } ?: (circularPosition + size)\n }\n\n fun sublist(from: Int, length: Int): List = (0 until length).map { getPosition(from + it) }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/bitmap/preparation/ondemandanimation/FrameLoader.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation.ondemandanimation\n\nimport android.graphics.Bitmap\nimport androidx.annotation.UiThread\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.backend.AnimationInformation\n\n/**\n * Callback interface for logging frame loading events. This allows app-specific error reporting\n * implementations to be injected for various frame loading scenarios.\n */\ninterface FrameLoaderListener {\n /**\n * Called when frame loading is skipped due to zero frame dimensions.\n *\n * @param origin the origin of the call (e.g., \"BufferFrameLoader.getFrame\")\n * @param frameNumber the frame number being loaded (-1 if not applicable)\n * @param width the frame width\n * @param height the frame height\n */\n fun onZeroFrameDimensions(origin: String, frameNumber: Int, width: Int, height: Int)\n\n /**\n * Called when a single frame render is performed.\n *\n * @param origin the origin of the call (e.g., \"BufferFrameLoader.getSingleFrame\")\n * @param width the frame width\n * @param height the frame height\n */\n fun onSingleFrameRender(origin: String, width: Int, height: Int)\n}\n\n/** This interface provides the basic O(1) methods to extract and prepare bitmap animations */\ninterface FrameLoader {\n\n /** Animation info */\n val animationInformation: AnimationInformation\n\n /**\n * Return the [frameNumber] bitmap to render, given the [width] and [height] of the view.\n *\n * This method is always executed by the main thread, so its performance needs to be O(1)\n */\n @UiThread fun getFrame(frameNumber: Int, width: Int, height: Int): FrameResult\n\n /**\n * Prepare the frames to be rendered. [onAnimationLoaded] is executed once the preparation is done\n *\n * This method is always executed by the main thread, so its performance needs to be O(1).\n */\n @UiThread fun prepareFrames(width: Int, height: Int, onAnimationLoaded: () -> Unit)\n\n /**\n * Force the animation to run to indicated fps\n *\n * @param fps fps that animation should run\n */\n fun compressToFps(fps: Int): Unit = Unit\n\n fun onStop() = Unit\n\n /** Release resources */\n fun clear()\n}\n\nclass FrameResult(val bitmapRef: CloseableReference?, val type: FrameType) {\n enum class FrameType {\n SUCCESS,\n NEAREST,\n MISSING,\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/drawable/AnimatedDrawable2.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.drawable\n\nimport android.graphics.Canvas\nimport android.graphics.ColorFilter\nimport android.graphics.PixelFormat\nimport android.graphics.Rect\nimport android.graphics.drawable.Animatable\nimport android.graphics.drawable.Drawable\nimport android.os.SystemClock\nimport com.facebook.common.logging.FLog\nimport com.facebook.drawable.base.DrawableWithCaches\nimport com.facebook.drawee.drawable.DrawableProperties\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapAnimationBackend\nimport com.facebook.fresco.animation.frame.DropFramesFrameScheduler\nimport com.facebook.fresco.animation.frame.FrameScheduler\nimport kotlin.concurrent.Volatile\nimport kotlin.math.max\n\n/**\n * Experimental new animated drawable that uses a supplied [AnimationBackend] for drawing frames.\n */\nopen class AnimatedDrawable2\n@JvmOverloads\nconstructor(private var _animationBackend: AnimationBackend? = null) :\n Drawable(), Animatable, DrawableWithCaches {\n\n /** [draw(Canvas)] listener that is notified for each draw call. Can be used for debugging. */\n fun interface DrawListener {\n fun onDraw(\n animatedDrawable: AnimatedDrawable2,\n frameScheduler: FrameScheduler,\n frameNumberToDraw: Int,\n frameDrawn: Boolean,\n isAnimationRunning: Boolean,\n animationStartTimeMs: Long,\n animationTimeMs: Long,\n lastFrameAnimationTimeMs: Long,\n actualRenderTimeStartMs: Long,\n actualRenderTimeEndMs: Long,\n startRenderTimeForNextFrameMs: Long,\n scheduledRenderTimeForNextFrameMs: Long,\n )\n }\n\n private var frameScheduler: FrameScheduler?\n\n // Animation parameters\n @Volatile private var _isRunning = false\n var startTimeMs: Long = 0\n private set\n\n private var lastFrameAnimationTimeMs: Long = 0\n private var expectedRenderTimeMs: Long = 0\n private var lastDrawnFrameNumber = 0\n\n private var pausedStartTimeMsDifference: Long = 0\n private var pausedLastFrameAnimationTimeMsDifference: Long = 0\n private var pausedLastDrawnFrameNumber = 0\n\n private var frameSchedulingDelayMs = DEFAULT_FRAME_SCHEDULING_DELAY_MS.toLong()\n private var frameSchedulingOffsetMs = DEFAULT_FRAME_SCHEDULING_OFFSET_MS.toLong()\n\n // Animation statistics\n private var _droppedFrames = 0\n\n // Listeners\n @Volatile private var animationListener = NO_OP_LISTENER\n\n @Volatile private var drawListener: DrawListener? = null\n private val animationBackendListener =\n AnimationBackend.Listener { animationListener.onAnimationLoaded() }\n\n // Holder for drawable properties like alpha to be able to re-apply if the backend changes.\n // The instance is created lazily only if needed.\n private var drawableProperties: DrawableProperties? = null\n\n /**\n * Runnable that invalidates the drawable that will be scheduled according to the next target\n * frame.\n */\n private val invalidateRunnable: Runnable =\n object : Runnable {\n override fun run() {\n // Remove all potential other scheduled runnables\n // (e.g. if the view has been invalidated a lot)\n unscheduleSelf(this)\n // Draw the next frame\n invalidateSelf()\n }\n }\n\n override fun getIntrinsicWidth(): Int {\n return _animationBackend?.intrinsicWidth ?: super.getIntrinsicWidth()\n }\n\n override fun getIntrinsicHeight(): Int {\n return _animationBackend?.intrinsicHeight ?: super.getIntrinsicHeight()\n }\n\n /** Start the animation. */\n override fun start() {\n if (_isRunning || _animationBackend == null || _animationBackend!!.frameCount <= 1) {\n return\n }\n _isRunning = true\n\n val now = now()\n startTimeMs = now - pausedStartTimeMsDifference\n expectedRenderTimeMs = startTimeMs\n lastFrameAnimationTimeMs = now - pausedLastFrameAnimationTimeMsDifference\n lastDrawnFrameNumber = pausedLastDrawnFrameNumber\n invalidateSelf()\n animationListener.onAnimationStart(this)\n }\n\n /** Stop the animation at the current frame. It can be resumed by calling [start()] again. */\n override fun stop() {\n if (!_isRunning) {\n return\n }\n val now = now()\n pausedStartTimeMsDifference = now - startTimeMs\n pausedLastFrameAnimationTimeMsDifference = now - lastFrameAnimationTimeMs\n pausedLastDrawnFrameNumber = lastDrawnFrameNumber\n\n _isRunning = false\n startTimeMs = 0\n expectedRenderTimeMs = startTimeMs\n lastFrameAnimationTimeMs = -1\n lastDrawnFrameNumber = -1\n _animationBackend?.clear()\n unscheduleSelf(invalidateRunnable)\n animationListener.onAnimationStop(this)\n }\n\n /**\n * Check whether the animation is running.\n *\n * @return true if the animation is currently running\n */\n override fun isRunning(): Boolean = _isRunning\n\n override fun onBoundsChange(bounds: Rect) {\n super.onBoundsChange(bounds)\n _animationBackend?.setBounds(bounds)\n }\n\n override fun draw(canvas: Canvas) {\n if (_animationBackend == null || frameScheduler == null) {\n return\n }\n\n val actualRenderTimeStartMs = now()\n val animationTimeMs =\n if (_isRunning) (actualRenderTimeStartMs - startTimeMs + frameSchedulingOffsetMs)\n else max(lastFrameAnimationTimeMs.toDouble(), 0.0).toLong()\n\n // What frame should be drawn?\n var frameNumberToDraw =\n frameScheduler!!.getFrameNumberToRender(animationTimeMs, lastFrameAnimationTimeMs)\n\n // Check if the animation is finished and draw last frame\n if (frameNumberToDraw == FrameScheduler.FRAME_NUMBER_DONE) {\n frameNumberToDraw = _animationBackend!!.frameCount - 1\n\n // Check if the animation is finished and draw the fallback thumbnail if\n // useFallbackThumbnail is true\n val bitmapBackend = _animationBackend as? BitmapAnimationBackend\n val animatedOptions = bitmapBackend?.animatedOptions\n val useFallbackThumbnail = animatedOptions?.useFallbackThumbnail() == true\n\n if (!useFallbackThumbnail) {\n animationListener.onAnimationStop(this)\n _isRunning = false\n }\n } else if (frameNumberToDraw == 0) {\n if (lastDrawnFrameNumber != -1 && actualRenderTimeStartMs >= expectedRenderTimeMs) {\n animationListener.onAnimationRepeat(this)\n }\n }\n\n // Draw the frame\n val frameDrawn = _animationBackend!!.drawFrame(this, canvas, frameNumberToDraw)\n if (frameDrawn) {\n // Notify listeners that we draw a new frame and\n // that the animation might be repeated\n animationListener.onAnimationFrame(this, frameNumberToDraw)\n lastDrawnFrameNumber = frameNumberToDraw\n }\n\n // Log potential dropped frames\n if (!frameDrawn) {\n onFrameDropped()\n }\n\n var targetRenderTimeForNextFrameMs = FrameScheduler.NO_NEXT_TARGET_RENDER_TIME.toLong()\n var scheduledRenderTimeForNextFrameMs: Long = -1\n val actualRenderTimeEnd = now()\n if (_isRunning) {\n // Schedule the next frame if needed.\n targetRenderTimeForNextFrameMs =\n frameScheduler!!.getTargetRenderTimeForNextFrameMs(actualRenderTimeEnd - startTimeMs)\n if (targetRenderTimeForNextFrameMs != FrameScheduler.NO_NEXT_TARGET_RENDER_TIME.toLong()) {\n scheduledRenderTimeForNextFrameMs = targetRenderTimeForNextFrameMs + frameSchedulingDelayMs\n scheduleNextFrame(scheduledRenderTimeForNextFrameMs)\n } else {\n animationListener.onAnimationStop(this)\n _isRunning = false\n }\n }\n\n val listener = drawListener\n listener?.onDraw(\n this,\n checkNotNull(frameScheduler),\n frameNumberToDraw,\n frameDrawn,\n _isRunning,\n startTimeMs,\n animationTimeMs,\n lastFrameAnimationTimeMs,\n actualRenderTimeStartMs,\n actualRenderTimeEnd,\n targetRenderTimeForNextFrameMs,\n scheduledRenderTimeForNextFrameMs,\n )\n lastFrameAnimationTimeMs = animationTimeMs\n }\n\n override fun setAlpha(alpha: Int) {\n if (drawableProperties == null) {\n drawableProperties = DrawableProperties()\n }\n drawableProperties!!.setAlpha(alpha)\n _animationBackend?.setAlpha(alpha)\n }\n\n override fun setColorFilter(colorFilter: ColorFilter?) {\n if (drawableProperties == null) {\n drawableProperties = DrawableProperties()\n }\n drawableProperties!!.setColorFilter(colorFilter)\n _animationBackend?.setColorFilter(colorFilter)\n }\n\n override fun getOpacity(): Int = PixelFormat.TRANSLUCENT\n\n fun preloadAnimation() {\n _animationBackend?.preloadAnimation()\n }\n\n var animationBackend: AnimationBackend?\n get() = _animationBackend\n /**\n * Update the animation backend to be used for the animation. This will also stop the animation.\n * In order to remove the current animation backend, call this method with null.\n *\n * @param animationBackend the animation backend to be used or null\n */\n set(animationBackend) {\n if (this._animationBackend != null) {\n _animationBackend!!.setAnimationListener(null)\n }\n\n this._animationBackend = animationBackend\n if (this._animationBackend != null) {\n frameScheduler = DropFramesFrameScheduler(_animationBackend!!)\n _animationBackend!!.setAnimationListener(animationBackendListener)\n _animationBackend!!.setBounds(bounds)\n drawableProperties?.applyTo(this)\n }\n frameScheduler = createSchedulerForBackendAndDelayMethod(this._animationBackend)\n stop()\n }\n\n val droppedFrames: Long\n get() = _droppedFrames.toLong()\n\n val isInfiniteAnimation: Boolean\n get() = frameScheduler?.isInfiniteAnimation == true\n\n /**\n * Jump immediately to the given frame number. The animation will not be paused if it is running.\n * If the animation is not running, the animation will not be started.\n *\n * @param targetFrameNumber the frame number to jump to\n */\n fun jumpToFrame(targetFrameNumber: Int) {\n if (_animationBackend == null || frameScheduler == null) {\n return\n }\n // In order to jump to a given frame, we have to compute the correct start time\n lastFrameAnimationTimeMs = frameScheduler!!.getTargetRenderTimeMs(targetFrameNumber)\n\n // Reset the paused timing as we broke the animation frame flow\n pausedLastDrawnFrameNumber = targetFrameNumber\n pausedStartTimeMsDifference = 0\n pausedLastFrameAnimationTimeMsDifference = 0\n\n startTimeMs = now() - lastFrameAnimationTimeMs\n expectedRenderTimeMs = startTimeMs\n invalidateSelf()\n }\n\n val loopDurationMs: Long\n /**\n * Get the animation duration for 1 loop by summing all frame durations.\n *\n * @return the duration of 1 animation loop in ms\n */\n get() {\n if (_animationBackend == null) {\n return 0L\n }\n if (frameScheduler != null) {\n return frameScheduler!!.loopDurationMs\n }\n var loopDurationMs = 0\n for (i in 0..<_animationBackend!!.frameCount) {\n loopDurationMs += _animationBackend!!.getFrameDurationMs(i)\n }\n return loopDurationMs.toLong()\n }\n\n val frameCount: Int\n /**\n * Get the number of frames for the animation. If no animation backend is set, 0 will be\n * returned.\n *\n * @return the number of frames of the animation\n */\n get() = if (_animationBackend == null) 0 else _animationBackend!!.frameCount\n\n /**\n * Get the duration of a specific frame. If not animation backend is set, 0 will be returned.\n *\n * @param frameNumber the requested frame\n * @return the duration of the frame\n */\n fun getFrameDurationMs(frameNumber: Int): Int =\n if (_animationBackend == null) 0 else _animationBackend!!.getFrameDurationMs(frameNumber)\n\n val loopCount: Int\n /**\n * Get the loop count of the animation. The returned value is either\n * [AnimationInformation#LOOP_COUNT_INFINITE] if the animation is repeated infinitely or a\n * positive integer that corresponds to the number of loops. If no animation backend is set,\n * [AnimationInformation#LOOP_COUNT_INFINITE] will be returned.\n *\n * @return the loop count of the animation or [AnimationInformation#LOOP_COUNT_INFINITE]\n */\n get() = if (_animationBackend == null) 0 else _animationBackend!!.loopCount\n\n init {\n frameScheduler = createSchedulerForBackendAndDelayMethod(this._animationBackend)\n\n _animationBackend?.setAnimationListener(animationBackendListener)\n }\n\n /**\n * Frame scheduling delay to shift the target render time for a frame within the frame's visible\n * window. If the value is set to 0, the frame will be scheduled right at the beginning of the\n * frame's visible window.\n *\n * @param frameSchedulingDelayMs the delay to use in ms\n */\n fun setFrameSchedulingDelayMs(frameSchedulingDelayMs: Long) {\n this.frameSchedulingDelayMs = frameSchedulingDelayMs\n }\n\n /**\n * Frame scheduling offset to shift the animation time by the given offset. This is similar to\n * [mFrameSchedulingDelayMs] but instead of delaying the invalidation, this offsets the animation\n * time by the given value.\n *\n * @param frameSchedulingOffsetMs the offset to use in ms\n */\n fun setFrameSchedulingOffsetMs(frameSchedulingOffsetMs: Long) {\n this.frameSchedulingOffsetMs = frameSchedulingOffsetMs\n }\n\n /**\n * Set an animation listener that is notified for various animation events.\n *\n * @param animationListener the listener to use\n */\n fun setAnimationListener(animationListener: AnimationListener?) {\n this.animationListener = animationListener ?: NO_OP_LISTENER\n }\n\n /**\n * Set a draw listener that is notified for each [draw(Canvas)] call.\n *\n * @param drawListener the listener to use\n */\n fun setDrawListener(drawListener: DrawListener?) {\n this.drawListener = drawListener\n }\n\n /**\n * Schedule the next frame to be rendered after the given delay.\n *\n * @param targetAnimationTimeMs the time in ms to update the frame\n */\n private fun scheduleNextFrame(targetAnimationTimeMs: Long) {\n expectedRenderTimeMs = startTimeMs + targetAnimationTimeMs\n scheduleSelf(invalidateRunnable, expectedRenderTimeMs)\n }\n\n private fun onFrameDropped() {\n _droppedFrames++\n // we need to drop frames\n if (FLog.isLoggable(FLog.VERBOSE)) {\n FLog.v(TAG, \"Dropped a frame. Count: %s\", _droppedFrames)\n }\n }\n\n /** @return the current uptime in ms */\n private fun now(): Long =\n // This call has to return [SystemClock#uptimeMillis()] in order to preserve correct\n // frame scheduling.\n SystemClock.uptimeMillis()\n\n /**\n * Set the animation to the given level. The level represents the animation time in ms. If the\n * animation time is greater than the last frame time for the last loop, the last frame will be\n * displayed.\n *\n * If the animation is running (e.g. if [start()] has been called, the level change will be\n * ignored. In this case, [stop()] the animation first.\n *\n * @param level the animation time in ms\n * @return true if the level change could be performed\n */\n override fun onLevelChange(level: Int): Boolean {\n if (_isRunning) {\n // If the client called start on us, they expect us to run the animation. In that case,\n // we ignore level changes.\n return false\n }\n if (lastFrameAnimationTimeMs != level.toLong()) {\n lastFrameAnimationTimeMs = level.toLong()\n invalidateSelf()\n return true\n }\n return false\n }\n\n override fun dropCaches() {\n _animationBackend?.clear()\n }\n\n companion object {\n private val TAG: Class<*> = AnimatedDrawable2::class.java\n\n private val NO_OP_LISTENER: AnimationListener = BaseAnimationListener()\n\n private const val DEFAULT_FRAME_SCHEDULING_DELAY_MS = 8\n private const val DEFAULT_FRAME_SCHEDULING_OFFSET_MS = 0\n\n private fun createSchedulerForBackendAndDelayMethod(\n animationBackend: AnimationBackend?\n ): FrameScheduler? {\n if (animationBackend == null) {\n return null\n }\n return DropFramesFrameScheduler(animationBackend)\n }\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/drawable/AnimatedDrawable2DebugDrawListener.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.drawable\n\nimport com.facebook.common.logging.FLog\nimport com.facebook.fresco.animation.frame.FrameScheduler\n\n/**\n * [com.facebook.fresco.animation.drawable.AnimatedDrawable2.DrawListener] for debugging\n * [AnimatedDrawable2].\n */\nclass AnimatedDrawable2DebugDrawListener : AnimatedDrawable2.DrawListener {\n\n private var lastFrameNumber = -1\n private var skippedFrames = 0\n private var duplicateFrames = 0\n private var drawCalls = 0\n\n override fun onDraw(\n animatedDrawable: AnimatedDrawable2,\n frameScheduler: FrameScheduler,\n frameNumberToDraw: Int,\n frameDrawn: Boolean,\n isAnimationRunning: Boolean,\n animationStartTimeMs: Long,\n animationTimeMs: Long,\n lastFrameAnimationTimeMs: Long,\n actualRenderTimeStartMs: Long,\n actualRenderTimeEndMs: Long,\n startRenderTimeForNextFrameMs: Long,\n scheduledRenderTimeForNextFrameMs: Long,\n ) {\n val frameCount = animatedDrawable.animationBackend?.getFrameCount() ?: return\n\n val animationTimeDifference = animationTimeMs - lastFrameAnimationTimeMs\n drawCalls++\n val expectedNextFrameNumber = (lastFrameNumber + 1) % frameCount\n if (expectedNextFrameNumber != frameNumberToDraw) {\n // something went wrong...\n if (lastFrameNumber == frameNumberToDraw) {\n duplicateFrames++\n } else {\n var skippedFrameCount = (frameNumberToDraw - expectedNextFrameNumber) % frameCount\n if (skippedFrameCount < 0) {\n skippedFrameCount += frameCount\n }\n skippedFrames += skippedFrameCount\n }\n }\n lastFrameNumber = frameNumberToDraw\n FLog.d(\n TAG,\n (\"draw: frame: %2d, drawn: %b, delay: %3d ms, rendering: %3d ms, prev: %3d ms ago, duplicates: %3d, skipped: %3d, draw calls: %4d, anim time: %6d ms, next start: %6d ms, next scheduled: %6d ms\"),\n frameNumberToDraw,\n frameDrawn,\n animationTimeMs % frameScheduler.loopDurationMs -\n frameScheduler.getTargetRenderTimeMs(frameNumberToDraw),\n actualRenderTimeEndMs - actualRenderTimeStartMs,\n animationTimeDifference,\n duplicateFrames,\n skippedFrames,\n drawCalls,\n animationTimeMs,\n startRenderTimeForNextFrameMs,\n scheduledRenderTimeForNextFrameMs,\n )\n }\n\n companion object {\n private val TAG: Class<*> = AnimatedDrawable2DebugDrawListener::class.java\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/drawable/AnimationFrameScheduler.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.drawable\n\nimport android.os.SystemClock\nimport com.facebook.fresco.animation.frame.FrameScheduler\nimport com.facebook.fresco.animation.frame.FrameScheduler.NO_NEXT_TARGET_RENDER_TIME\nimport kotlin.math.max\n\nconst val INVALID_FRAME_TIME = -1L\nprivate const val DEFAULT_FRAME_SCHEDULING_DELAY_MS = 8L\nprivate const val DEFAULT_FRAME_SCHEDULING_OFFSET_MS = 0L\n\nclass AnimationFrameScheduler(private val frameScheduler: FrameScheduler) {\n\n var running: Boolean = false\n\n // Frame scheduling timer in milliseconds\n var frameSchedulingDelayMs: Long = DEFAULT_FRAME_SCHEDULING_DELAY_MS\n var frameSchedulingOffsetMs: Long = DEFAULT_FRAME_SCHEDULING_OFFSET_MS\n private var pauseTimeMs = 0L\n private var startMs = 0L\n private var expectedRenderTimeMs = 0L\n private var lastFrameAnimationTimeMs = 0L\n private var lastFrameAnimationTimeDifferenceMs = 0L\n\n // Frame management\n var lastDrawnFrameNumber = -1\n private val pausedLastDrawnFrameNumber = -1\n\n // Stats\n private var framesDropped = 0\n\n private fun now() = SystemClock.uptimeMillis()\n\n fun start() {\n if (!running) {\n val now = now()\n startMs = now - pauseTimeMs\n expectedRenderTimeMs = startMs\n lastFrameAnimationTimeMs = now - lastFrameAnimationTimeDifferenceMs\n lastDrawnFrameNumber = pausedLastDrawnFrameNumber\n running = true\n }\n }\n\n fun stop() {\n if (running) {\n val now = now()\n pauseTimeMs = now - startMs\n lastFrameAnimationTimeDifferenceMs = now - lastFrameAnimationTimeMs\n startMs = 0L\n expectedRenderTimeMs = 0L\n lastFrameAnimationTimeMs = -1L\n lastDrawnFrameNumber = -1\n running = false\n }\n }\n\n fun frameToDraw(): Int {\n val renderTimeMillis = now()\n\n val animationTimeMillis =\n if (running) {\n renderTimeMillis - startMs + frameSchedulingOffsetMs\n } else {\n max(lastFrameAnimationTimeMs, 0)\n }\n\n // What frame should be drawn?\n val frameNumberToDraw =\n frameScheduler.getFrameNumberToRender(animationTimeMillis, lastFrameAnimationTimeMs)\n\n lastFrameAnimationTimeMs = animationTimeMillis\n\n return frameNumberToDraw\n }\n\n // Returns -1 if it's an valid next render time\n fun nextRenderTime(): Long {\n if (!running) {\n return INVALID_FRAME_TIME\n }\n\n val actualRenderTimeEnd = now()\n val targetRenderTimeForNextFrameMs =\n frameScheduler.getTargetRenderTimeForNextFrameMs(actualRenderTimeEnd - startMs)\n if (targetRenderTimeForNextFrameMs != NO_NEXT_TARGET_RENDER_TIME.toLong()) {\n val nextFrameTime = targetRenderTimeForNextFrameMs + frameSchedulingDelayMs\n expectedRenderTimeMs = startMs + nextFrameTime\n return nextFrameTime\n }\n running = false\n\n return INVALID_FRAME_TIME\n }\n\n fun shouldRepeatAnimation(): Boolean {\n return lastDrawnFrameNumber != -1 && now() >= expectedRenderTimeMs\n }\n\n fun onFrameDropped() {\n framesDropped++\n // TODO Add log info here\n }\n\n fun infinite(): Boolean = frameScheduler.isInfiniteAnimation\n\n fun loopDuration(): Long = frameScheduler.loopDurationMs\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/drawable/AnimationListener.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.drawable\n\nimport android.graphics.drawable.Drawable\n\n/**\n * Animation listener that can be used to get notified about [AnimatedDrawable2] events. Call\n * [AnimatedDrawable2#setAnimationListener(AnimationListener)] to set a listener.\n */\ninterface AnimationListener {\n /**\n * Called when the animation is started for the given drawable.\n *\n * @param drawable the affected drawable\n */\n fun onAnimationStart(drawable: Drawable)\n\n /**\n * Called when the animation is stopped for the given drawable.\n *\n * @param drawable the affected drawable\n */\n fun onAnimationStop(drawable: Drawable)\n\n /**\n * Called when the animation is reset for the given drawable.\n *\n * @param drawable the affected drawable\n */\n fun onAnimationReset(drawable: Drawable)\n\n /**\n * Called when the animation is repeated for the given drawable. Animations have a loop count, and\n * frame count, so this is called when the frame count is 0 and the loop count is increased.\n *\n * @param drawable the affected drawable\n */\n fun onAnimationRepeat(drawable: Drawable)\n\n /**\n * Called when a frame of the animation is about to be rendered.\n *\n * @param drawable the affected drawable\n * @param frameNumber the frame number to be rendered\n */\n fun onAnimationFrame(drawable: Drawable, frameNumber: Int)\n\n /** Triggered when animation is loaded in memory and ready to play */\n fun onAnimationLoaded() = Unit\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/drawable/BaseAnimationListener.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.drawable\n\nimport android.graphics.drawable.Drawable\n\n/**\n * Base animation listener. This convenience class can be used to simplify the code if the extending\n * class is not interested in all events. Just override the ones you need.\n *\n * See [AnimationListener] for more information.\n */\nopen class BaseAnimationListener : AnimationListener {\n override fun onAnimationStart(drawable: Drawable) = Unit\n\n override fun onAnimationStop(drawable: Drawable) = Unit\n\n override fun onAnimationReset(drawable: Drawable) = Unit\n\n override fun onAnimationRepeat(drawable: Drawable) = Unit\n\n override fun onAnimationFrame(drawable: Drawable, frameNumber: Int) = Unit\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/drawable/KAnimatedDrawable2.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.drawable\n\nimport android.graphics.Canvas\nimport android.graphics.ColorFilter\nimport android.graphics.PixelFormat\nimport android.graphics.Rect\nimport android.graphics.drawable.Animatable\nimport android.graphics.drawable.Drawable\nimport com.facebook.drawable.base.DrawableWithCaches\nimport com.facebook.drawee.drawable.DrawableProperties\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.frame.DropFramesFrameScheduler\nimport com.facebook.fresco.animation.frame.FrameScheduler\n\nopen class KAnimatedDrawable2(private var animationBackend: AnimationBackend) :\n Drawable(), Animatable, DrawableWithCaches {\n\n private val animatedFrameScheduler =\n AnimationFrameScheduler(DropFramesFrameScheduler(animationBackend))\n private var animationListener: AnimationListener = BaseAnimationListener()\n private var drawListener: DrawListener? = null\n private val drawableProperties = DrawableProperties().apply { applyTo(this@KAnimatedDrawable2) }\n\n @Volatile private var isRunning = false\n\n /**\n * Runnable that invalidates the drawable that will be scheduled according to the next target\n * frame.\n */\n private val invalidateRunnable =\n object : Runnable {\n override fun run() {\n // Remove all potential other scheduled runnables\n // (e.g. if the view has been invalidated a lot)\n unscheduleSelf(this)\n // Draw the next frame\n invalidateSelf()\n }\n }\n\n override fun setAlpha(alpha: Int) {\n drawableProperties.setAlpha(alpha)\n animationBackend.setAlpha(alpha)\n }\n\n override fun setColorFilter(colorFilter: ColorFilter?) {\n drawableProperties.setColorFilter(colorFilter)\n animationBackend.setColorFilter(colorFilter)\n }\n\n override fun getOpacity(): Int = PixelFormat.TRANSLUCENT\n\n /** Start the animation. */\n override fun start() {\n if (animationBackend.frameCount <= 0) {\n return\n }\n\n animatedFrameScheduler.start()\n animationListener.onAnimationStart(this)\n invalidateSelf()\n }\n\n /** Stop the animation at the current frame. It can be resumed by calling [start()] again. */\n override fun stop() {\n animatedFrameScheduler.stop()\n animationListener.onAnimationStop(this)\n unscheduleSelf(invalidateRunnable)\n }\n\n /**\n * Check whether the animation is running.\n *\n * @return true if the animation is currently running\n */\n override fun isRunning(): Boolean = animatedFrameScheduler.running\n\n override fun dropCaches() {\n animationBackend.clear()\n }\n\n override fun onBoundsChange(bounds: Rect) {\n animationBackend.setBounds(bounds)\n }\n\n override fun getIntrinsicWidth(): Int = animationBackend.intrinsicWidth\n\n override fun getIntrinsicHeight(): Int = animationBackend.intrinsicHeight\n\n /**\n * Get the animation duration for 1 loop by summing all frame durations.\n *\n * @return the duration of 1 animation loop in ms\n */\n fun loopDurationMs(): Int = animationBackend.loopDurationMs\n\n /**\n * Get the number of frames for the animation. If no animation backend is set, 0 will be returned.\n *\n * @return the number of frames of the animation\n */\n fun getFrameCount(): Int = animationBackend.frameCount\n\n /**\n * Get the loop count of the animation. The returned value is either\n * [AnimationInformation#LOOP_COUNT_INFINITE] if the animation is repeated infinitely or a\n * positive integer that corresponds to the number of loops. If no animation backend is set,\n * [AnimationInformation#LOOP_COUNT_INFINITE] will be returned.\n *\n * @return the loop count of the animation or [AnimationInformation#LOOP_COUNT_INFINITE]\n */\n fun loopCount(): Int = animationBackend.loopCount\n\n /**\n * Frame scheduling delay to shift the target render time for a frame within the frame's visible\n * window. If the value is set to 0, the frame will be scheduled right at the beginning of the\n * frame's visible window.\n *\n * @param delayMs the delay to use in ms\n */\n fun setFrameSchedulingDelayMs(delayMs: Long) {\n animatedFrameScheduler.frameSchedulingDelayMs = delayMs\n }\n\n /**\n * Frame scheduling offset to shift the animation time by the given offset. This is similar to\n * [frameSchedulingDelayMs] but instead of delaying the invalidation, this offsets the animation\n * time by the given value.\n *\n * @param offsetMs the offset to use in ms\n */\n fun setFrameSchedulingOffsetMs(offsetMs: Long) {\n animatedFrameScheduler.frameSchedulingOffsetMs = offsetMs\n }\n\n /**\n * Set an animation listener that is notified for various animation events.\n *\n * @param listener the listener to use\n */\n fun setAnimationListener(listener: AnimationListener?) {\n animationListener = listener ?: animationListener\n }\n\n /**\n * Set a draw listener that is notified for each [draw(Canvas)] call.\n *\n * @param listener the listener to use\n */\n fun setDrawListener(listener: DrawListener?) {\n drawListener = listener\n }\n\n /**\n * Update the animation backend to be used for the animation. This will also stop the animation.\n * In order to remove the current animation backend, call this method with null.\n *\n * @param animationBackend the animation backend to be used or null\n */\n fun setAnimationBackend(animationBackend: AnimationBackend?) {\n animationBackend ?: return\n stop()\n animationBackend.setBounds(bounds)\n drawableProperties.applyTo(this)\n this.animationBackend = animationBackend\n }\n\n override fun draw(canvas: Canvas) {\n var frameNumber = animatedFrameScheduler.frameToDraw()\n // Check if the animation is finished and draw last frame if so\n if (frameNumber == FrameScheduler.FRAME_NUMBER_DONE) {\n frameNumber = animationBackend.frameCount - 1\n animatedFrameScheduler.running = false\n animationListener.onAnimationStop(this)\n } else if (frameNumber == 0 && animatedFrameScheduler.shouldRepeatAnimation()) {\n animationListener.onAnimationRepeat(this)\n }\n\n val frameDrawn = animationBackend.drawFrame(this, canvas, frameNumber)\n if (frameDrawn) {\n // Notify listeners that we draw a new frame and\n // that the animation might be repeated\n animationListener.onAnimationFrame(this, frameNumber)\n animatedFrameScheduler.lastDrawnFrameNumber = frameNumber\n } else {\n animatedFrameScheduler.onFrameDropped()\n }\n\n val nextFrameTime = animatedFrameScheduler.nextRenderTime()\n if (nextFrameTime != INVALID_FRAME_TIME) {\n scheduleSelf(invalidateRunnable, nextFrameTime)\n } else {\n animationListener.onAnimationStop(this)\n animatedFrameScheduler.running = false\n }\n }\n\n interface DrawListener {\n fun onDraw(\n animatedDrawable: KAnimatedDrawable2,\n frameScheduler: FrameScheduler,\n frameNumberToDraw: Int,\n frameDrawn: Boolean,\n isAnimationRunning: Boolean,\n animationStartTimeMs: Long,\n animationTimeMs: Long,\n lastFrameAnimationTimeMs: Long,\n actualRenderTimeStartMs: Long,\n actualRenderTimeEndMs: Long,\n startRenderTimeForNextFrameMs: Long,\n scheduledRenderTimeForNextFrameMs: Long,\n )\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/drawable/animator/AnimatedDrawable2ValueAnimatorHelper.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.drawable.animator\n\nimport android.animation.ValueAnimator\nimport android.animation.ValueAnimator.AnimatorUpdateListener\nimport android.graphics.drawable.Drawable\nimport com.facebook.fresco.animation.backend.AnimationInformation\nimport com.facebook.fresco.animation.drawable.AnimatedDrawable2\n\n/** Helper class to create [ValueAnimator]s for [AnimatedDrawable2]. */\nobject AnimatedDrawable2ValueAnimatorHelper {\n\n @JvmStatic\n fun createValueAnimator(animatedDrawable: AnimatedDrawable2, maxDurationMs: Int): ValueAnimator? {\n val animator =\n createValueAnimator(\n animatedDrawable,\n animatedDrawable.loopCount,\n animatedDrawable.loopDurationMs,\n ) ?: return null\n val repeatCount = Math.max(maxDurationMs / animatedDrawable.loopDurationMs, 1).toInt()\n animator.repeatCount = repeatCount\n return animator\n }\n\n @JvmStatic\n fun createValueAnimator(\n animatedDrawable: Drawable,\n loopCount: Int,\n loopDurationMs: Long,\n ): ValueAnimator {\n val animator = ValueAnimator()\n animator.setIntValues(0, loopDurationMs.toInt())\n animator.duration = loopDurationMs\n animator.repeatCount =\n if (loopCount != AnimationInformation.LOOP_COUNT_INFINITE) loopCount\n else ValueAnimator.INFINITE\n animator.repeatMode = ValueAnimator.RESTART\n // Use a linear interpolator\n animator.interpolator = null\n val animatorUpdateListener = createAnimatorUpdateListener(animatedDrawable)\n animator.addUpdateListener(animatorUpdateListener)\n return animator\n }\n\n @JvmStatic\n fun createAnimatorUpdateListener(drawable: Drawable): AnimatorUpdateListener =\n AnimatorUpdateListener { animation: ValueAnimator ->\n drawable.level = (animation.animatedValue as Int)\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/frame/DropFramesFrameScheduler.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.frame\n\nimport androidx.annotation.VisibleForTesting\nimport com.facebook.fresco.animation.backend.AnimationInformation\n\n/** Frame scheduler that maps time values to frames. */\nclass DropFramesFrameScheduler(private val animationInformation: AnimationInformation) :\n FrameScheduler {\n\n private var _loopDurationMs = UNSET.toLong()\n\n override fun getFrameNumberToRender(animationTimeMs: Long, lastFrameTimeMs: Long): Int {\n val loopDurationMs = this.loopDurationMs\n if (loopDurationMs == 0L) {\n return getFrameNumberWithinLoop(0)\n }\n if (!isInfiniteAnimation) {\n val loopCount = animationTimeMs / loopDurationMs\n if (loopCount >= animationInformation.loopCount) {\n return FrameScheduler.FRAME_NUMBER_DONE\n }\n }\n val timeInCurrentLoopMs = animationTimeMs % loopDurationMs\n return getFrameNumberWithinLoop(timeInCurrentLoopMs)\n }\n\n override fun getLoopDurationMs(): Long {\n if (_loopDurationMs != UNSET.toLong()) {\n return _loopDurationMs\n }\n _loopDurationMs = 0\n val frameCount = animationInformation.frameCount\n for (i in 0 until frameCount) {\n _loopDurationMs += animationInformation.getFrameDurationMs(i).toLong()\n }\n return _loopDurationMs\n }\n\n override fun getTargetRenderTimeMs(frameNumber: Int): Long {\n var targetRenderTimeMs = 0L\n for (i in 0 until frameNumber) {\n targetRenderTimeMs += animationInformation.getFrameDurationMs(i).toLong()\n }\n return targetRenderTimeMs\n }\n\n override fun getTargetRenderTimeForNextFrameMs(animationTimeMs: Long): Long {\n val loopDurationMs = this.loopDurationMs\n // Sanity check.\n if (loopDurationMs == 0L) {\n return FrameScheduler.NO_NEXT_TARGET_RENDER_TIME.toLong()\n }\n if (!isInfiniteAnimation) {\n val loopCount = animationTimeMs / loopDurationMs\n if (loopCount >= animationInformation.loopCount) {\n return FrameScheduler.NO_NEXT_TARGET_RENDER_TIME.toLong()\n }\n }\n // The animation time in the current loop\n val timePassedInCurrentLoopMs = animationTimeMs % loopDurationMs\n // The animation time in the current loop for the next frame\n var timeOfNextFrameInLoopMs = 0L\n val frameCount = animationInformation.frameCount\n var i = 0\n while (i < frameCount && timeOfNextFrameInLoopMs <= timePassedInCurrentLoopMs) {\n timeOfNextFrameInLoopMs += animationInformation.getFrameDurationMs(i).toLong()\n i++\n }\n\n // Difference between current time in loop and next frame in loop\n val timeUntilNextFrameInLoopMs = timeOfNextFrameInLoopMs - timePassedInCurrentLoopMs\n // Add the difference to the current animation time\n return animationTimeMs + timeUntilNextFrameInLoopMs\n }\n\n override fun isInfiniteAnimation(): Boolean =\n animationInformation.loopCount == AnimationInformation.LOOP_COUNT_INFINITE\n\n @VisibleForTesting\n fun getFrameNumberWithinLoop(timeInCurrentLoopMs: Long): Int {\n var frame = 0\n var currentDuration = 0L\n do {\n currentDuration += animationInformation.getFrameDurationMs(frame).toLong()\n frame++\n } while (timeInCurrentLoopMs >= currentDuration)\n return frame - 1\n }\n\n companion object {\n private const val UNSET = -1\n }\n}\n" }, { "path": "animated-drawable/src/main/java/com/facebook/fresco/animation/frame/FrameScheduler.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.frame;\n\nimport com.facebook.infer.annotation.Nullsafe;\n\n/** Frame scheduler used to calculate which frame to display for given animation times. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic interface FrameScheduler {\n\n int FRAME_NUMBER_DONE = -1;\n\n int NO_NEXT_TARGET_RENDER_TIME = -1;\n\n /**\n * Get the frame number for the given animation time or {@link #FRAME_NUMBER_DONE} if the\n * animation is over.\n *\n * @param animationTimeMs the animation time to get the frame number for\n * @param lastFrameTimeMs the time of the last draw before\n * @return the frame number to render or {@link #FRAME_NUMBER_DONE}\n */\n int getFrameNumberToRender(long animationTimeMs, long lastFrameTimeMs);\n\n /**\n * Get the loop duration of 1 full loop.\n *\n * @return the loop duration in ms\n */\n long getLoopDurationMs();\n\n /**\n * Get the target render time for the given frame number in ms.\n *\n * @param frameNumber the frame number to use\n * @return the target render time\n */\n long getTargetRenderTimeMs(int frameNumber);\n\n /**\n * For a given animation time, calculate the target render time for the next frame in ms. If the\n * animation is over, this will return {@link #NO_NEXT_TARGET_RENDER_TIME}\n *\n * @param animationTimeMs the current animation time in ms\n * @return the target animation time in ms for the next frame after the given animation time or\n * {@link #NO_NEXT_TARGET_RENDER_TIME} if the animation is over\n */\n long getTargetRenderTimeForNextFrameMs(long animationTimeMs);\n\n /**\n * @return true if the animation is infinite\n */\n boolean isInfiniteAnimation();\n}\n" }, { "path": "animated-drawable/src/test/java/com/facebook/fresco/animation/backend/AnimationBackendDelegateTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.backend\n\nimport android.graphics.Canvas\nimport android.graphics.ColorFilter\nimport android.graphics.Rect\nimport android.graphics.drawable.Drawable\nimport org.assertj.core.api.Assertions.assertThat\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.kotlin.any\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.verifyNoMoreInteractions\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\n\n/** Tests [AnimationBackendDelegate] */\n@RunWith(RobolectricTestRunner::class)\nclass AnimationBackendDelegateTest {\n\n private lateinit var animationBackendDelegate: AnimationBackendDelegate\n private lateinit var animationBackend: AnimationBackend\n private lateinit var parent: Drawable\n private lateinit var canvas: Canvas\n\n @Before\n fun setup() {\n animationBackend = mock()\n parent = mock()\n canvas = mock()\n\n animationBackendDelegate = AnimationBackendDelegate(animationBackend)\n }\n\n @Test\n fun testForwardProperties() {\n val colorFilter = mock()\n val bounds = mock()\n val alphaValue = 123\n\n verifyNoMoreInteractions(animationBackend)\n\n // Set values to be persisted\n animationBackendDelegate.setAlpha(alphaValue)\n animationBackendDelegate.setColorFilter(colorFilter)\n animationBackendDelegate.setBounds(bounds)\n\n // Verify that values have been restored\n verify(animationBackend).setAlpha(alphaValue)\n verify(animationBackend).setColorFilter(colorFilter)\n verify(animationBackend).setBounds(bounds)\n }\n\n @Test\n fun testGetProperties() {\n val width = 123\n val height = 234\n val sizeInBytes = 2000\n val frameCount = 20\n val loopCount = 1000\n val frameDurationMs = 200\n\n whenever(animationBackend.intrinsicWidth).thenReturn(width)\n whenever(animationBackend.intrinsicHeight).thenReturn(height)\n whenever(animationBackend.sizeInBytes).thenReturn(sizeInBytes)\n whenever(animationBackend.frameCount).thenReturn(frameCount)\n whenever(animationBackend.loopCount).thenReturn(loopCount)\n whenever(animationBackend.getFrameDurationMs(any())).thenReturn(frameDurationMs)\n\n assertThat(animationBackendDelegate.intrinsicWidth).isEqualTo(width)\n assertThat(animationBackendDelegate.intrinsicHeight).isEqualTo(height)\n assertThat(animationBackendDelegate.sizeInBytes).isEqualTo(sizeInBytes)\n assertThat(animationBackendDelegate.frameCount).isEqualTo(frameCount)\n assertThat(animationBackendDelegate.loopCount).isEqualTo(loopCount)\n assertThat(animationBackendDelegate.getFrameDurationMs(1)).isEqualTo(frameDurationMs)\n }\n\n @Test\n fun testGetDefaultProperties() {\n // We don't set an animation backend\n animationBackendDelegate.animationBackend = null\n\n assertThat(animationBackendDelegate.intrinsicWidth)\n .isEqualTo(AnimationBackend.INTRINSIC_DIMENSION_UNSET)\n assertThat(animationBackendDelegate.intrinsicHeight)\n .isEqualTo(AnimationBackend.INTRINSIC_DIMENSION_UNSET)\n assertThat(animationBackendDelegate.sizeInBytes).isEqualTo(0)\n assertThat(animationBackendDelegate.frameCount).isEqualTo(0)\n assertThat(animationBackendDelegate.loopCount).isEqualTo(0)\n assertThat(animationBackendDelegate.getFrameDurationMs(1)).isEqualTo(0)\n }\n\n @Test\n fun testSetAnimationBackend() {\n val backend2 = mock()\n val colorFilter = mock()\n val bounds = mock()\n val alphaValue = 123\n\n verifyNoMoreInteractions(backend2)\n\n // Set values to be persisted\n animationBackendDelegate.setAlpha(alphaValue)\n animationBackendDelegate.setColorFilter(colorFilter)\n animationBackendDelegate.setBounds(bounds)\n\n animationBackendDelegate.animationBackend = backend2\n\n // Verify that values have been restored\n verify(backend2).setAlpha(alphaValue)\n verify(backend2).setColorFilter(colorFilter)\n verify(backend2).setBounds(bounds)\n }\n\n @Test\n fun testDrawFrame() {\n animationBackendDelegate.drawFrame(parent, canvas, 1)\n\n verify(animationBackend).drawFrame(parent, canvas, 1)\n }\n\n @Test\n fun testClear() {\n animationBackendDelegate.clear()\n\n verify(animationBackend).clear()\n }\n}\n" }, { "path": "animated-drawable/src/test/java/com/facebook/fresco/animation/backend/AnimationBackendDelegateWithInactivityCheckTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.backend\n\nimport android.graphics.Canvas\nimport android.graphics.drawable.Drawable\nimport com.facebook.imagepipeline.testing.FakeClock\nimport com.facebook.imagepipeline.testing.TestScheduledExecutorService\nimport org.junit.Before\nimport org.junit.Test\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.verifyNoMoreInteractions\n\n/** Tests [AnimationBackendDelegateWithInactivityCheck] */\nclass AnimationBackendDelegateWithInactivityCheckTest {\n\n private lateinit var animationBackendDelegateWithInactivityCheck:\n AnimationBackendDelegate\n private lateinit var animationBackend: AnimationBackend\n private lateinit var inactivityListener:\n AnimationBackendDelegateWithInactivityCheck.InactivityListener\n private lateinit var parent: Drawable\n private lateinit var canvas: Canvas\n private lateinit var fakeClock: FakeClock\n private lateinit var testScheduledExecutorService: TestScheduledExecutorService\n\n @Before\n fun setup() {\n animationBackend = mock()\n inactivityListener = mock()\n parent = mock()\n canvas = mock()\n\n fakeClock = FakeClock()\n testScheduledExecutorService = TestScheduledExecutorService(fakeClock)\n\n animationBackendDelegateWithInactivityCheck =\n AnimationBackendDelegateWithInactivityCheck.createForBackend(\n animationBackend,\n inactivityListener,\n fakeClock,\n testScheduledExecutorService,\n )\n }\n\n @Test\n fun testNotifyInactive() {\n verifyNoMoreInteractions(inactivityListener)\n animationBackendDelegateWithInactivityCheck.drawFrame(parent, canvas, 0)\n verifyNoMoreInteractions(inactivityListener)\n fakeClock.incrementBy(100)\n verifyNoMoreInteractions(inactivityListener)\n fakeClock.incrementBy(AnimationBackendDelegateWithInactivityCheck.INACTIVITY_THRESHOLD_MS)\n verify(inactivityListener).onInactive()\n }\n}\n" }, { "path": "animated-drawable/src/test/java/com/facebook/fresco/animation/bitmap/BitmapAnimationBackendTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap\n\nimport android.graphics.Bitmap\nimport android.graphics.Canvas\nimport android.graphics.Paint\nimport android.graphics.Rect\nimport android.graphics.drawable.Drawable\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.common.references.ResourceReleaser\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.backend.AnimationInformation\nimport com.facebook.fresco.animation.bitmap.preparation.BitmapFramePreparationStrategy\nimport com.facebook.fresco.animation.bitmap.preparation.BitmapFramePreparer\nimport com.facebook.fresco.vito.options.AnimatedOptions\nimport com.facebook.fresco.vito.options.RoundingOptions\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport org.assertj.core.api.Assertions.assertThat\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.ArgumentCaptor\nimport org.mockito.ArgumentMatchers\nimport org.mockito.ArgumentMatchers.anyInt\nimport org.mockito.Captor\nimport org.mockito.Mock\nimport org.mockito.MockitoAnnotations\nimport org.mockito.kotlin.any\nimport org.mockito.kotlin.capture\nimport org.mockito.kotlin.eq\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.never\nimport org.mockito.kotlin.times\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.verifyNoMoreInteractions\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\n\n/** Tests [BitmapAnimationBackend] */\n@RunWith(RobolectricTestRunner::class)\nclass BitmapAnimationBackendTest {\n\n @Mock lateinit var platformBitmapFactory: PlatformBitmapFactory\n @Mock lateinit var bitmapFrameCache: BitmapFrameCache\n @Mock lateinit var animationInformation: AnimationInformation\n @Mock lateinit var bitmapFrameRenderer: BitmapFrameRenderer\n @Mock lateinit var bounds: Rect\n @Mock lateinit var parentDrawable: Drawable\n @Mock lateinit var canvas: Canvas\n @Mock lateinit var bitmap: Bitmap\n @Mock lateinit var bitmapResourceReleaser: ResourceReleaser\n @Mock lateinit var frameListener: BitmapAnimationBackend.FrameListener\n @Mock lateinit var bitmapFramePreparationStrategy: BitmapFramePreparationStrategy\n @Mock lateinit var bitmapFramePreparer: BitmapFramePreparer\n @Captor lateinit var capturedBitmapReference: ArgumentCaptor>\n private lateinit var bitmapReference: CloseableReference\n private lateinit var bitmapAnimationBackend: BitmapAnimationBackend\n\n @Before\n fun setup() {\n MockitoAnnotations.initMocks(this)\n bitmapReference = CloseableReference.of(bitmap, bitmapResourceReleaser)\n bitmapAnimationBackend =\n BitmapAnimationBackend(\n platformBitmapFactory,\n bitmapFrameCache,\n animationInformation,\n bitmapFrameRenderer,\n false, /* isNewRenderImplementation */\n bitmapFramePreparationStrategy,\n bitmapFramePreparer,\n null,\n )\n bitmapAnimationBackend.setFrameListener(frameListener)\n }\n\n @Test\n fun testSetBounds() {\n bitmapAnimationBackend.setBounds(bounds)\n verify(bitmapFrameRenderer).setBounds(bounds)\n }\n\n @Test\n fun testSetBoundsUpdatesIntrinsicDimensionsWhenBackendDimensionsUnset() {\n val boundsWidth = 160\n val boundsHeight = 90\n val backendIntrinsicWidth = AnimationBackend.INTRINSIC_DIMENSION_UNSET\n val backendIntrinsicHeight = AnimationBackend.INTRINSIC_DIMENSION_UNSET\n setupBoundsAndRendererDimensions(\n boundsWidth,\n boundsHeight,\n backendIntrinsicWidth,\n backendIntrinsicHeight,\n )\n\n bitmapAnimationBackend.setBounds(bounds)\n\n assertThat(bitmapAnimationBackend.intrinsicWidth).isEqualTo(boundsWidth)\n assertThat(bitmapAnimationBackend.intrinsicHeight).isEqualTo(boundsHeight)\n }\n\n @Test\n fun testSetBoundsUpdatesIntrinsicDimensionsWhenBackendDimensionWidthSet() {\n val boundsWidth = 160\n val boundsHeight = 90\n val backendIntrinsicWidth = 260\n val backendIntrinsicHeight = AnimationBackend.INTRINSIC_DIMENSION_UNSET\n setupBoundsAndRendererDimensions(\n boundsWidth,\n boundsHeight,\n backendIntrinsicWidth,\n backendIntrinsicHeight,\n )\n\n bitmapAnimationBackend.setBounds(bounds)\n\n assertThat(bitmapAnimationBackend.intrinsicWidth).isEqualTo(backendIntrinsicWidth)\n assertThat(bitmapAnimationBackend.intrinsicHeight).isEqualTo(boundsHeight)\n }\n\n @Test\n fun testSetBoundsUpdatesIntrinsicDimensionsWhenBackendDimensionHeightSet() {\n val boundsWidth = 160\n val boundsHeight = 90\n val backendIntrinsicWidth = AnimationBackend.INTRINSIC_DIMENSION_UNSET\n val backendIntrinsicHeight = 260\n setupBoundsAndRendererDimensions(\n boundsWidth,\n boundsHeight,\n backendIntrinsicWidth,\n backendIntrinsicHeight,\n )\n\n bitmapAnimationBackend.setBounds(bounds)\n\n assertThat(bitmapAnimationBackend.intrinsicWidth).isEqualTo(boundsWidth)\n assertThat(bitmapAnimationBackend.intrinsicHeight).isEqualTo(backendIntrinsicHeight)\n }\n\n @Test\n fun testSetBoundsUpdatesIntrinsicDimensionsWhenBackendDimensionsSet() {\n val boundsWidth = 160\n val boundsHeight = 90\n val backendIntrinsicWidth = 260\n val backendIntrinsicHeight = 300\n setupBoundsAndRendererDimensions(\n boundsWidth,\n boundsHeight,\n backendIntrinsicWidth,\n backendIntrinsicHeight,\n )\n\n bitmapAnimationBackend.setBounds(bounds)\n\n assertThat(bitmapAnimationBackend.intrinsicWidth).isEqualTo(backendIntrinsicWidth)\n assertThat(bitmapAnimationBackend.intrinsicHeight).isEqualTo(backendIntrinsicHeight)\n }\n\n @Test\n fun testSetBoundsUpdatesIntrinsicDimensionsWhenBackendDimensionsUnsetAndNullBounds() {\n val boundsWidth = 160\n val boundsHeight = 90\n val backendIntrinsicWidth = AnimationBackend.INTRINSIC_DIMENSION_UNSET\n val backendIntrinsicHeight = AnimationBackend.INTRINSIC_DIMENSION_UNSET\n setupBoundsAndRendererDimensions(\n boundsWidth,\n boundsHeight,\n backendIntrinsicWidth,\n backendIntrinsicHeight,\n )\n\n bitmapAnimationBackend.setBounds(null)\n\n assertThat(bitmapAnimationBackend.intrinsicWidth)\n .isEqualTo(AnimationBackend.INTRINSIC_DIMENSION_UNSET)\n assertThat(bitmapAnimationBackend.intrinsicHeight)\n .isEqualTo(AnimationBackend.INTRINSIC_DIMENSION_UNSET)\n }\n\n @Test\n fun testSetBoundsUpdatesIntrinsicDimensionsWhenBackendDimensionsSetAndNullBounds() {\n val boundsWidth = 160\n val boundsHeight = 90\n val backendIntrinsicWidth = 260\n val backendIntrinsicHeight = 300\n setupBoundsAndRendererDimensions(\n boundsWidth,\n boundsHeight,\n backendIntrinsicWidth,\n backendIntrinsicHeight,\n )\n\n bitmapAnimationBackend.setBounds(null)\n\n assertThat(bitmapAnimationBackend.intrinsicWidth).isEqualTo(backendIntrinsicWidth)\n assertThat(bitmapAnimationBackend.intrinsicHeight).isEqualTo(backendIntrinsicHeight)\n }\n\n @Test\n fun testSetBoundsUpdatesIntrinsicDimensionsWhenBackendWidthSetAndNullBounds() {\n val boundsWidth = 160\n val boundsHeight = 90\n val backendIntrinsicWidth = 260\n val backendIntrinsicHeight = AnimationBackend.INTRINSIC_DIMENSION_UNSET\n setupBoundsAndRendererDimensions(\n boundsWidth,\n boundsHeight,\n backendIntrinsicWidth,\n backendIntrinsicHeight,\n )\n\n bitmapAnimationBackend.setBounds(null)\n\n assertThat(bitmapAnimationBackend.intrinsicWidth).isEqualTo(backendIntrinsicWidth)\n assertThat(bitmapAnimationBackend.intrinsicHeight).isEqualTo(backendIntrinsicHeight)\n }\n\n @Test\n fun testSetBoundsUpdatesIntrinsicDimensionsWhenBackendHeightSetAndNullBounds() {\n val boundsWidth = 160\n val boundsHeight = 90\n val backendIntrinsicWidth = AnimationBackend.INTRINSIC_DIMENSION_UNSET\n val backendIntrinsicHeight = 400\n setupBoundsAndRendererDimensions(\n boundsWidth,\n boundsHeight,\n backendIntrinsicWidth,\n backendIntrinsicHeight,\n )\n\n bitmapAnimationBackend.setBounds(null)\n\n assertThat(bitmapAnimationBackend.intrinsicWidth).isEqualTo(backendIntrinsicWidth)\n assertThat(bitmapAnimationBackend.intrinsicHeight).isEqualTo(backendIntrinsicHeight)\n }\n\n @Test\n fun testGetFrameCount() {\n whenever(animationInformation.frameCount).thenReturn(123)\n assertThat(bitmapAnimationBackend.frameCount).isEqualTo(123)\n }\n\n @Test\n fun testGetLoopCount() {\n whenever(animationInformation.loopCount).thenReturn(AnimationInformation.LOOP_COUNT_INFINITE)\n assertThat(bitmapAnimationBackend.loopCount).isEqualTo(AnimationInformation.LOOP_COUNT_INFINITE)\n\n whenever(animationInformation.loopCount).thenReturn(123)\n assertThat(bitmapAnimationBackend.loopCount).isEqualTo(123)\n }\n\n @Test\n fun testGetFrameDuration() {\n whenever(animationInformation.getFrameDurationMs(1)).thenReturn(50)\n whenever(animationInformation.getFrameDurationMs(2)).thenReturn(100)\n\n assertThat(bitmapAnimationBackend.getFrameDurationMs(1)).isEqualTo(50)\n assertThat(bitmapAnimationBackend.getFrameDurationMs(2)).isEqualTo(100)\n }\n\n @Test\n fun testDrawCachedBitmap() {\n whenever(bitmapFrameCache.getCachedFrame(anyInt())).thenReturn(bitmapReference)\n\n bitmapAnimationBackend.drawFrame(parentDrawable, canvas, 1)\n verify(frameListener).onDrawFrameStart(bitmapAnimationBackend, 1)\n verify(bitmapFrameCache).getCachedFrame(1)\n verify(canvas).drawBitmap(eq(bitmap), eq(0f), eq(0f), any())\n verifyFramePreparationStrategyCalled(1)\n assertReferencesClosed()\n }\n\n @Test\n fun testDrawReusedBitmap() {\n whenever(bitmapFrameCache.getBitmapToReuseForFrame(anyInt(), anyInt(), anyInt()))\n .thenReturn(bitmapReference)\n whenever(bitmapFrameRenderer.renderFrame(anyInt(), any())).thenReturn(true)\n\n bitmapAnimationBackend.drawFrame(parentDrawable, canvas, 1)\n\n verify(frameListener).onDrawFrameStart(bitmapAnimationBackend, 1)\n verify(bitmapFrameCache).getCachedFrame(1)\n verify(bitmapFrameCache).getBitmapToReuseForFrame(1, 0, 0)\n verify(bitmapFrameRenderer).renderFrame(1, bitmap)\n verify(canvas).drawBitmap(eq(bitmap), eq(0f), eq(0f), any())\n verifyFramePreparationStrategyCalled(1)\n verifyListenersAndCacheNotified(1, BitmapAnimationBackend.FRAME_TYPE_REUSED)\n assertReferencesClosed()\n }\n\n @Test\n fun testDrawNewBitmap() {\n whenever(platformBitmapFactory.createBitmap(anyInt(), anyInt(), any()))\n .thenReturn(bitmapReference)\n whenever(bitmapFrameRenderer.renderFrame(anyInt(), any())).thenReturn(true)\n\n bitmapAnimationBackend.drawFrame(parentDrawable, canvas, 2)\n\n verify(frameListener).onDrawFrameStart(bitmapAnimationBackend, 2)\n verify(bitmapFrameCache).getCachedFrame(2)\n verify(bitmapFrameCache).getBitmapToReuseForFrame(2, 0, 0)\n verify(platformBitmapFactory).createBitmap(0, 0, Bitmap.Config.ARGB_8888)\n verify(bitmapFrameRenderer).renderFrame(2, bitmap)\n verify(canvas).drawBitmap(eq(bitmap), eq(0f), eq(0f), any())\n verifyFramePreparationStrategyCalled(2)\n verifyListenersAndCacheNotified(2, BitmapAnimationBackend.FRAME_TYPE_CREATED)\n assertReferencesClosed()\n }\n\n @Test\n fun testDrawNewBitmapWithBounds() {\n val width = 160\n val height = 90\n whenever(bounds.width()).thenReturn(width)\n whenever(bounds.height()).thenReturn(height)\n\n whenever(platformBitmapFactory.createBitmap(anyInt(), anyInt(), any()))\n .thenReturn(bitmapReference)\n whenever(bitmapFrameRenderer.renderFrame(anyInt(), any())).thenReturn(true)\n whenever(bitmapFrameRenderer.intrinsicWidth)\n .thenReturn(AnimationBackend.INTRINSIC_DIMENSION_UNSET)\n whenever(bitmapFrameRenderer.intrinsicHeight)\n .thenReturn(AnimationBackend.INTRINSIC_DIMENSION_UNSET)\n\n bitmapAnimationBackend.setBounds(bounds)\n bitmapAnimationBackend.drawFrame(parentDrawable, canvas, 2)\n\n verify(frameListener).onDrawFrameStart(bitmapAnimationBackend, 2)\n verify(bitmapFrameCache).getCachedFrame(2)\n verify(bitmapFrameCache).getBitmapToReuseForFrame(2, width, height)\n verify(platformBitmapFactory).createBitmap(width, height, Bitmap.Config.ARGB_8888)\n verify(bitmapFrameRenderer).renderFrame(2, bitmap)\n verify(canvas)\n .drawBitmap(eq(bitmap), ArgumentMatchers.isNull(Rect::class.java), eq(bounds), any())\n verifyFramePreparationStrategyCalled(2)\n verifyListenersAndCacheNotified(2, BitmapAnimationBackend.FRAME_TYPE_CREATED)\n assertReferencesClosed()\n }\n\n @Test\n fun testDrawFallbackBitmapWhenCreateBitmapNotWorking() {\n whenever(bitmapFrameCache.getFallbackFrame(anyInt())).thenReturn(bitmapReference)\n whenever(bitmapFrameRenderer.renderFrame(anyInt(), any())).thenReturn(true)\n\n bitmapAnimationBackend.drawFrame(parentDrawable, canvas, 3)\n\n verify(frameListener).onDrawFrameStart(bitmapAnimationBackend, 3)\n verify(bitmapFrameCache).getCachedFrame(3)\n verify(bitmapFrameCache).getBitmapToReuseForFrame(3, 0, 0)\n verify(platformBitmapFactory).createBitmap(0, 0, Bitmap.Config.ARGB_8888)\n verify(bitmapFrameCache).getFallbackFrame(3)\n verify(canvas).drawBitmap(eq(bitmap), eq(0f), eq(0f), any())\n verifyFramePreparationStrategyCalled(3)\n verifyListenersNotifiedWithoutCache(3, BitmapAnimationBackend.FRAME_TYPE_FALLBACK)\n assertReferencesClosed()\n }\n\n @Test\n fun testDrawFallbackBitmapWhenRenderFrameNotWorking() {\n whenever(bitmapFrameCache.getFallbackFrame(anyInt())).thenReturn(bitmapReference)\n\n // Return a different bitmap for PlatformBitmapFactory\n val temporaryBitmap = CloseableReference.of(bitmap, bitmapResourceReleaser)\n whenever(platformBitmapFactory.createBitmap(anyInt(), anyInt(), any()))\n .thenReturn(temporaryBitmap)\n whenever(bitmapFrameRenderer.renderFrame(anyInt(), any())).thenReturn(false)\n\n bitmapAnimationBackend.drawFrame(parentDrawable, canvas, 3)\n\n verify(frameListener).onDrawFrameStart(bitmapAnimationBackend, 3)\n verify(bitmapFrameCache).getCachedFrame(3)\n verify(bitmapFrameCache).getBitmapToReuseForFrame(3, 0, 0)\n verify(platformBitmapFactory).createBitmap(0, 0, Bitmap.Config.ARGB_8888)\n // Verify that the bitmap has been closed\n assertThat(temporaryBitmap.isValid).isFalse()\n verify(bitmapFrameCache).getFallbackFrame(3)\n verify(canvas).drawBitmap(eq(bitmap), eq(0f), eq(0f), any())\n verifyFramePreparationStrategyCalled(3)\n verifyListenersNotifiedWithoutCache(3, BitmapAnimationBackend.FRAME_TYPE_FALLBACK)\n assertReferencesClosed()\n }\n\n @Test\n fun testDrawNoFrame() {\n bitmapAnimationBackend.drawFrame(parentDrawable, canvas, 4)\n\n verify(frameListener).onDrawFrameStart(bitmapAnimationBackend, 4)\n verify(bitmapFrameCache).getCachedFrame(4)\n verify(bitmapFrameCache).getBitmapToReuseForFrame(4, 0, 0)\n verify(platformBitmapFactory).createBitmap(0, 0, Bitmap.Config.ARGB_8888)\n verify(bitmapFrameCache).getFallbackFrame(4)\n verifyNoMoreInteractions(canvas, bitmapFrameCache)\n verifyFramePreparationStrategyCalled(4)\n verify(frameListener).onFrameDropped(bitmapAnimationBackend, 4)\n }\n\n private fun verifyFramePreparationStrategyCalled(frameNumber: Int) {\n verify(bitmapFramePreparationStrategy)\n .prepareFrames(\n bitmapFramePreparer,\n bitmapFrameCache,\n bitmapAnimationBackend,\n frameNumber,\n null,\n )\n }\n\n private fun verifyListenersAndCacheNotified(\n frameNumber: Int,\n @BitmapAnimationBackend.FrameType frameType: Int,\n ) {\n // Verify cache callback\n verify(bitmapFrameCache)\n .onFrameRendered(eq(frameNumber), capture(capturedBitmapReference), eq(frameType))\n assertThat(capturedBitmapReference.value).isEqualTo(bitmapReference)\n\n // Verify frame listener\n verify(frameListener).onFrameDrawn(bitmapAnimationBackend, frameNumber, frameType)\n }\n\n private fun verifyListenersNotifiedWithoutCache(\n frameNumber: Int,\n @BitmapAnimationBackend.FrameType frameType: Int,\n ) {\n // Verify cache callback\n verify(bitmapFrameCache, never()).onFrameRendered(anyInt(), any(), eq(frameType))\n\n // Verify frame listener\n verify(frameListener).onFrameDrawn(bitmapAnimationBackend, frameNumber, frameType)\n }\n\n private fun assertReferencesClosed() {\n assertThat(bitmapReference.isValid).isFalse()\n }\n\n private fun setupBoundsAndRendererDimensions(\n boundsWidth: Int,\n boundsHeight: Int,\n backendIntrinsicWidth: Int,\n backendIntrinsicHeight: Int,\n ) {\n whenever(bounds.width()).thenReturn(boundsWidth)\n whenever(bounds.height()).thenReturn(boundsHeight)\n\n whenever(bitmapFrameRenderer.intrinsicWidth).thenReturn(backendIntrinsicWidth)\n whenever(bitmapFrameRenderer.intrinsicHeight).thenReturn(backendIntrinsicHeight)\n }\n\n fun createBackendWithRounding(roundingOptions: RoundingOptions?): BitmapAnimationBackend {\n return BitmapAnimationBackend(\n platformBitmapFactory,\n bitmapFrameCache,\n animationInformation,\n bitmapFrameRenderer,\n false,\n bitmapFramePreparationStrategy,\n bitmapFramePreparer,\n roundingOptions,\n )\n }\n\n fun createBackendWithNewRenderImplementation(\n isNewRenderImplementation: Boolean\n ): BitmapAnimationBackend {\n return BitmapAnimationBackend(\n platformBitmapFactory,\n bitmapFrameCache,\n animationInformation,\n bitmapFrameRenderer,\n isNewRenderImplementation,\n bitmapFramePreparationStrategy,\n bitmapFramePreparer,\n null,\n )\n }\n\n /** Verifies circular rounding options are preserved and cornerRadii is null */\n @Test\n fun testCircularRoundingInitialization() {\n val circularRounding = RoundingOptions.asCircle()\n val backend = createBackendWithRounding(circularRounding)\n\n assertThat(backend.roundingOptions).isEqualTo(circularRounding)\n assertThat(backend.cornerRadii).isNull()\n }\n\n /** Verifies rectangular rounding creates an 8-element cornerRadii array with correct values */\n @Test\n fun testRectangularRoundingInitialization() {\n val rectangularRounding = RoundingOptions.forCornerRadiusPx(20f)\n val backend = createBackendWithRounding(rectangularRounding)\n\n assertThat(backend.roundingOptions?.isCircular).isFalse()\n assertThat(backend.cornerRadii).isNotNull()\n assertThat(backend.cornerRadii).hasSize(8)\n backend.cornerRadii?.forEach { radius -> assertThat(radius).isEqualTo(20f) }\n }\n\n /** Verifies null rounding options result in null cornerRadii */\n @Test\n fun testNoRoundingInitialization() {\n val backend = createBackendWithRounding(null)\n\n assertThat(backend.roundingOptions).isNull()\n assertThat(backend.cornerRadii).isNull()\n }\n\n /** Verifies custom corner radii arrays are preserved correctly */\n @Test\n fun testRoundingWithCornerRadiiArray() {\n val cornerRadii = floatArrayOf(10f, 10f, 20f, 20f, 30f, 30f, 40f, 40f)\n val roundingOptions = RoundingOptions.forCornerRadii(cornerRadii)\n val backend = createBackendWithRounding(roundingOptions)\n\n assertThat(backend.roundingOptions?.isCircular).isFalse()\n assertThat(backend.cornerRadii).isEqualTo(cornerRadii)\n }\n\n /** Verifies unset corner radius results in null cornerRadii */\n @Test\n fun testRoundingWithUnsetCornerRadius() {\n val roundingOptions = RoundingOptions.forCornerRadiusPx(RoundingOptions.CORNER_RADIUS_UNSET)\n val backend = createBackendWithRounding(roundingOptions)\n\n assertThat(backend.roundingOptions?.isCircular).isFalse()\n assertThat(backend.cornerRadii).isNull()\n }\n\n /** Verifies circular rounding options can be accessed and isCircular flag is true */\n @Test\n fun testRoundingOptionsAccessibilityForCircular() {\n val circularRounding = RoundingOptions.asCircle()\n val backend = createBackendWithRounding(circularRounding)\n\n assertThat(backend.roundingOptions).isEqualTo(circularRounding)\n assertThat(backend.roundingOptions?.isCircular).isTrue()\n }\n\n /** Verifies rectangular rounding options can be accessed and isCircular flag is false */\n @Test\n fun testRoundingOptionsAccessibilityForRectangular() {\n val cornerRadius = 25f\n val rectangularRounding = RoundingOptions.forCornerRadiusPx(cornerRadius)\n val backend = createBackendWithRounding(rectangularRounding)\n\n assertThat(backend.roundingOptions?.cornerRadius).isEqualTo(cornerRadius)\n assertThat(backend.roundingOptions?.isCircular).isFalse()\n }\n\n /** Verifies frame drawing works correctly with circular rounding applied */\n @Test\n fun testDrawFrameWithCircularRounding() {\n val circularRounding = RoundingOptions.asCircle()\n val backend = createBackendWithRounding(circularRounding)\n backend.setFrameListener(frameListener)\n\n whenever(bitmapFrameCache.getCachedFrame(anyInt())).thenReturn(bitmapReference)\n\n val result = backend.drawFrame(parentDrawable, canvas, 1)\n\n assertThat(result).isTrue()\n verify(frameListener).onDrawFrameStart(backend, 1)\n }\n\n /** Verifies frame drawing works correctly with rectangular rounding applied */\n @Test\n fun testDrawFrameWithRectangularRounding() {\n val rectangularRounding = RoundingOptions.forCornerRadiusPx(20f)\n val backend = createBackendWithRounding(rectangularRounding)\n backend.setFrameListener(frameListener)\n\n whenever(bitmapFrameCache.getCachedFrame(anyInt())).thenReturn(bitmapReference)\n\n val result = backend.drawFrame(parentDrawable, canvas, 1)\n\n assertThat(result).isTrue()\n verify(frameListener).onDrawFrameStart(backend, 1)\n }\n\n /** Verifies bounds setting works correctly with circular rounding */\n @Test\n fun testCircularRoundingWithBounds() {\n val circularRounding = RoundingOptions.asCircle()\n val backend = createBackendWithRounding(circularRounding)\n\n val testBounds = Rect(0, 0, 150, 150)\n backend.setBounds(testBounds)\n\n verify(bitmapFrameRenderer).setBounds(testBounds)\n }\n\n /** Verifies empty corner radii arrays are handled correctly */\n @Test\n fun testRoundingOptionsWithEmptyCornerRadiiArray() {\n val emptyCornerRadii = floatArrayOf()\n val roundingOptions = RoundingOptions.forCornerRadii(emptyCornerRadii)\n val backend = createBackendWithRounding(roundingOptions)\n\n assertThat(backend.roundingOptions?.isCircular).isFalse()\n assertThat(backend.cornerRadii).isEqualTo(emptyCornerRadii)\n }\n\n /** Verifies cornerRadii is null specifically for circular rounding */\n @Test\n fun testCornerRadiiNullForCircularRounding() {\n val circularRounding = RoundingOptions.asCircle()\n val backend = createBackendWithRounding(circularRounding)\n\n // For circular rounding, cornerRadii should be null\n assertThat(backend.cornerRadii).isNull()\n assertThat(backend.roundingOptions?.isCircular).isTrue()\n }\n\n /** Verifies cornerRadii is a proper 8-element array for rectangular rounding */\n @Test\n fun testCornerRadiiArrayForRectangularRounding() {\n val cornerRadius = 15f\n val rectangularRounding = RoundingOptions.forCornerRadiusPx(cornerRadius)\n val backend = createBackendWithRounding(rectangularRounding)\n\n // For rectangular rounding, cornerRadii should be an array of 8 elements\n assertThat(backend.cornerRadii).isNotNull()\n assertThat(backend.cornerRadii).hasSize(8)\n backend.cornerRadii?.forEach { radius -> assertThat(radius).isEqualTo(cornerRadius) }\n }\n\n /** Verifies rounding options are preserved during backend creation */\n @Test\n fun testRoundingOptionsPreservation() {\n val originalRounding = RoundingOptions.asCircle()\n val backend = createBackendWithRounding(originalRounding)\n\n assertThat(backend.roundingOptions).isEqualTo(originalRounding)\n }\n\n /** Verifies custom corner radii arrays are preserved in both backend and options */\n @Test\n fun testRoundingWithCustomCornerRadiiPreservation() {\n val customRadii = floatArrayOf(5f, 5f, 10f, 10f, 15f, 15f, 20f, 20f)\n val roundingOptions = RoundingOptions.forCornerRadii(customRadii)\n val backend = createBackendWithRounding(roundingOptions)\n\n assertThat(backend.cornerRadii).isEqualTo(customRadii)\n assertThat(backend.roundingOptions?.cornerRadii).isEqualTo(customRadii)\n }\n\n /** Verifies circular rounding behavior when bounds are set and frames are drawn */\n @Test\n fun testCircularRoundingBehaviorWithBounds() {\n val circularRounding = RoundingOptions.asCircle()\n val backend = createBackendWithRounding(circularRounding)\n backend.setFrameListener(frameListener)\n\n val testBounds = Rect(0, 0, 100, 100)\n backend.setBounds(testBounds)\n\n whenever(bitmapFrameCache.getCachedFrame(anyInt())).thenReturn(bitmapReference)\n\n val result = backend.drawFrame(parentDrawable, canvas, 1)\n\n assertThat(result).isTrue()\n verify(bitmapFrameRenderer).setBounds(testBounds)\n verify(frameListener).onDrawFrameStart(backend, 1)\n }\n\n /** Verifies rectangular rounding behavior when bounds are set and frames are drawn */\n @Test\n fun testRectangularRoundingBehaviorWithBounds() {\n val rectangularRounding = RoundingOptions.forCornerRadiusPx(10f)\n val backend = createBackendWithRounding(rectangularRounding)\n backend.setFrameListener(frameListener)\n\n val testBounds = Rect(0, 0, 200, 150)\n backend.setBounds(testBounds)\n\n whenever(bitmapFrameCache.getCachedFrame(anyInt())).thenReturn(bitmapReference)\n\n val result = backend.drawFrame(parentDrawable, canvas, 1)\n\n assertThat(result).isTrue()\n verify(bitmapFrameRenderer).setBounds(testBounds)\n verify(frameListener).onDrawFrameStart(backend, 1)\n }\n\n private fun createThumbnailBackend(\n thumbnailUrl: String?,\n loopCount: Int,\n roundingOptions: RoundingOptions? = null,\n ): BitmapAnimationBackend {\n val animatedOptions =\n if (thumbnailUrl != null) {\n AnimatedOptions.loop(loopCount, thumbnailUrl)\n } else {\n AnimatedOptions.loop(loopCount)\n }\n return BitmapAnimationBackend(\n platformBitmapFactory,\n bitmapFrameCache,\n animationInformation,\n bitmapFrameRenderer,\n false,\n bitmapFramePreparationStrategy,\n bitmapFramePreparer,\n roundingOptions,\n animatedOptions,\n )\n }\n\n private fun createBackendWithAnimatedOptions(\n animatedOptions: AnimatedOptions?\n ): BitmapAnimationBackend {\n return BitmapAnimationBackend(\n platformBitmapFactory,\n bitmapFrameCache,\n animationInformation,\n bitmapFrameRenderer,\n false,\n bitmapFramePreparationStrategy,\n bitmapFramePreparer,\n null,\n animatedOptions,\n )\n }\n\n private fun setupAnimationInformation(frameCount: Int = 3, loopCount: Int = 1) {\n whenever(animationInformation.frameCount).thenReturn(frameCount)\n whenever(animationInformation.loopCount).thenReturn(loopCount)\n }\n\n /**\n * Tests that thumbnail fallback is enabled when valid thumbnail URL and finite loop count are\n * provided.\n */\n @Test\n fun testThumbnailInitializationWithValidOptions() {\n val thumbnailUrl = \"https://example.com/thumbnail.jpg\"\n val backend = createThumbnailBackend(thumbnailUrl, 3)\n\n assertThat(backend.animatedOptions?.useFallbackThumbnail()).isTrue()\n assertThat(backend.animatedOptions?.thumbnailUrl).isEqualTo(thumbnailUrl)\n }\n\n /** Tests that backend handles null AnimatedOptions without errors. */\n @Test\n fun testThumbnailInitializationWithNullOptions() {\n val backend = createBackendWithAnimatedOptions(null)\n assertThat(backend.animatedOptions).isNull()\n }\n\n /** Tests that thumbnail fallback is disabled when empty thumbnail URL is provided. */\n @Test\n fun testThumbnailInitializationWithEmptyUrl() {\n val backend = createThumbnailBackend(\"\", 3)\n assertThat(backend.animatedOptions?.useFallbackThumbnail()).isFalse()\n }\n\n /** Tests that infinite loop animations don't use thumbnail fallback even with valid URL. */\n @Test\n fun testThumbnailInitializationWithInfiniteLoop() {\n val backend =\n createThumbnailBackend(\"https://example.com/thumb.jpg\", AnimatedOptions.LOOP_COUNT_INFINITE)\n assertThat(backend.animatedOptions?.useFallbackThumbnail()).isFalse()\n }\n\n /** Tests that AnimatedOptions loop count overrides AnimationInformation loop count. */\n @Test\n fun testLoopCountWithAnimatedOptions() {\n setupAnimationInformation(loopCount = 10)\n val backend = createBackendWithAnimatedOptions(AnimatedOptions.loop(5))\n\n assertThat(backend.loopCount).isEqualTo(5)\n }\n\n /** Tests that infinite AnimatedOptions correctly returns infinite loop count. */\n @Test\n fun testLoopCountWithInfiniteAnimatedOptions() {\n setupAnimationInformation(loopCount = 10)\n val backend = createBackendWithAnimatedOptions(AnimatedOptions.infinite())\n\n assertThat(backend.loopCount).isEqualTo(AnimationInformation.LOOP_COUNT_INFINITE)\n }\n\n /**\n * Tests that backend falls back to AnimationInformation loop count when no AnimatedOptions\n * provided.\n */\n @Test\n fun testLoopCountWithoutAnimatedOptions() {\n setupAnimationInformation(loopCount = 7)\n val backend = createBackendWithAnimatedOptions(null)\n\n assertThat(backend.loopCount).isEqualTo(7)\n }\n\n /** Tests that normal frame drawing works when animation hasn't completed yet. */\n @Test\n fun testDrawFrameWithThumbnailFallback() {\n setupAnimationInformation(frameCount = 3)\n whenever(bitmapFrameCache.getCachedFrame(anyInt())).thenReturn(bitmapReference)\n\n val backend = createThumbnailBackend(\"https://example.com/thumb.jpg\", 2)\n backend.setFrameListener(frameListener)\n\n val result = backend.drawFrame(parentDrawable, canvas, 0)\n\n assertThat(result).isTrue()\n verify(frameListener).onDrawFrameStart(backend, 0)\n verify(canvas).drawBitmap(eq(bitmap), eq(0f), eq(0f), any())\n }\n\n /**\n * Tests the useFallbackThumbnail() logic with various URL and loop configurations including\n * static options.\n */\n @Test\n fun testAnimatedOptionsUseFallbackThumbnail() {\n val validOptions = AnimatedOptions.loop(3, \"https://example.com/thumb.jpg\")\n assertThat(validOptions.useFallbackThumbnail()).isTrue()\n\n val emptyUrlOptions = AnimatedOptions.loop(3, \"\")\n assertThat(emptyUrlOptions.useFallbackThumbnail()).isFalse()\n\n val nullUrlOptions = AnimatedOptions.loop(3, null)\n assertThat(nullUrlOptions.useFallbackThumbnail()).isFalse()\n\n val infiniteOptions = AnimatedOptions.infinite()\n assertThat(infiniteOptions.useFallbackThumbnail()).isFalse()\n }\n\n /** Tests equality and hashCode methods for AnimatedOptions with thumbnail URLs. */\n @Test\n fun testAnimatedOptionsEquality() {\n val options1 = AnimatedOptions.loop(3, \"https://example.com/thumb.jpg\")\n val options2 = AnimatedOptions.loop(3, \"https://example.com/thumb.jpg\")\n val options3 = AnimatedOptions.loop(3, \"https://different.com/thumb.jpg\")\n val options4 = AnimatedOptions.loop(5, \"https://example.com/thumb.jpg\")\n\n assertThat(options1).isEqualTo(options2)\n assertThat(options1).isNotEqualTo(options3)\n assertThat(options1).isNotEqualTo(options4)\n\n assertThat(options1.hashCode()).isEqualTo(options2.hashCode())\n }\n\n /** Tests isAnimationDisabled() method returns correct values. */\n @Test\n fun testIsAnimationDisabled() {\n val normalOptions = AnimatedOptions.loop(3)\n assertThat(normalOptions.isAnimationDisabled()).isFalse()\n\n val infiniteOptions = AnimatedOptions.infinite()\n assertThat(infiniteOptions.isAnimationDisabled()).isFalse()\n\n val disabledOptions = AnimatedOptions.disableAnimation()\n assertThat(disabledOptions.isAnimationDisabled()).isTrue()\n\n val thumbnailOptions = AnimatedOptions.loop(2, \"https://example.com/thumb.jpg\")\n assertThat(thumbnailOptions.isAnimationDisabled()).isFalse()\n }\n\n /** Tests that disableAnimation() creates options with correct properties. */\n @Test\n fun testDisableAnimationOptions() {\n val disabledOptions = AnimatedOptions.disableAnimation()\n\n assertThat(disabledOptions.isAnimationDisabled()).isTrue()\n assertThat(disabledOptions.loopCount).isEqualTo(-1)\n assertThat(disabledOptions.thumbnailUrl).isNull()\n assertThat(disabledOptions.isInfinite()).isFalse()\n assertThat(disabledOptions.useFallbackThumbnail()).isFalse()\n }\n\n /** Tests equality and hashCode for AnimatedOptions with disableAnimation flag. */\n @Test\n fun testAnimatedOptionsEqualityWithDisableAnimation() {\n val disabledOptions1 = AnimatedOptions.disableAnimation()\n val disabledOptions2 = AnimatedOptions.disableAnimation()\n val normalOptions = AnimatedOptions.loop(3)\n\n assertThat(disabledOptions1).isEqualTo(disabledOptions2)\n assertThat(disabledOptions1).isNotEqualTo(normalOptions)\n assertThat(disabledOptions1.hashCode()).isEqualTo(disabledOptions2.hashCode())\n }\n\n /** Tests that disabled animation options don't use thumbnail fallback. */\n @Test\n fun testDisabledAnimationWithThumbnailFallback() {\n val disabledOptions = AnimatedOptions.disableAnimation()\n assertThat(disabledOptions.useFallbackThumbnail()).isFalse()\n }\n\n /** Tests backend behavior with disabled animation options. */\n @Test\n fun testBackendWithDisabledAnimationOptions() {\n val disabledOptions = AnimatedOptions.disableAnimation()\n val backend = createBackendWithAnimatedOptions(disabledOptions)\n\n assertThat(backend.animatedOptions?.isAnimationDisabled()).isTrue()\n assertThat(backend.animatedOptions?.useFallbackThumbnail()).isFalse()\n }\n\n /** Tests that thumbnail and rounding options work together correctly. */\n @Test\n fun testAnimatedOptionsWithRoundingOptions() {\n val roundingOptions = RoundingOptions.asCircle()\n val backend = createThumbnailBackend(\"https://example.com/thumb.jpg\", 3, roundingOptions)\n\n assertThat(backend.animatedOptions?.useFallbackThumbnail()).isTrue()\n assertThat(backend.roundingOptions).isEqualTo(roundingOptions)\n }\n\n /** Tests that thumbnail resources are properly cleaned up when backend becomes inactive. */\n @Test\n fun testOnInactiveReleasesResources() {\n val backend = createThumbnailBackend(\"https://example.com/thumb.jpg\", 3)\n backend.onInactive()\n\n verify(bitmapFrameCache).clear()\n }\n\n /** Tests that setting bounds works correctly when thumbnail drawable is present. */\n @Test\n fun testSetBoundsWithThumbnailDrawable() {\n val testBounds = Rect(10, 20, 110, 120)\n val backend = createThumbnailBackend(\"https://example.com/thumb.jpg\", 3)\n\n backend.setBounds(testBounds)\n\n verify(bitmapFrameRenderer).setBounds(testBounds)\n }\n\n /** Tests that setting null bounds with thumbnail drawable doesn't cause errors. */\n @Test\n fun testSetBoundsWithNullBoundsAndThumbnail() {\n val backend = createThumbnailBackend(\"https://example.com/thumb.jpg\", 3)\n\n backend.setBounds(null)\n\n verify(bitmapFrameRenderer).setBounds(null)\n }\n\n /** Tests that roundingOptions is accessible as a property for circular rounding. */\n @Test\n fun testRoundingOptionsAccessibility() {\n val roundingOptions = RoundingOptions.asCircle()\n val backend = createThumbnailBackend(\"https://example.com/thumb.jpg\", 3, roundingOptions)\n\n assertThat(backend.roundingOptions).isEqualTo(roundingOptions)\n assertThat(backend.roundingOptions?.isCircular).isTrue()\n }\n\n /** Tests that corner radius rounding options are properly accessible and configured. */\n @Test\n fun testRoundingOptionsWithCornerRadius() {\n val cornerRadius = 15f\n val roundingOptions = RoundingOptions.forCornerRadiusPx(cornerRadius)\n val backend = createThumbnailBackend(\"https://example.com/thumb.jpg\", 3, roundingOptions)\n\n assertThat(backend.roundingOptions?.cornerRadius).isEqualTo(cornerRadius)\n assertThat(backend.roundingOptions?.isCircular).isFalse()\n }\n\n /** Tests that null rounding options are handled correctly without errors. */\n @Test\n fun testRoundingOptionsWithNullRounding() {\n val backend = createThumbnailBackend(\"https://example.com/thumb.jpg\", 3, null)\n assertThat(backend.roundingOptions).isNull()\n }\n\n /** Tests that circular rounding and thumbnail fallback work together seamlessly. */\n @Test\n fun testThumbnailWithCircularRounding() {\n val roundingOptions = RoundingOptions.asCircle()\n val backend = createThumbnailBackend(\"https://example.com/thumb.jpg\", 2, roundingOptions)\n\n assertThat(backend.roundingOptions?.isCircular).isTrue()\n assertThat(backend.animatedOptions?.useFallbackThumbnail()).isTrue()\n }\n\n /** Tests that thumbnail fallback is disabled when null thumbnail URL is provided. */\n @Test\n fun testThumbnailFallbackDisabledWithoutUrl() {\n val backend = createThumbnailBackend(null, 3)\n assertThat(backend.animatedOptions?.useFallbackThumbnail()).isFalse()\n }\n\n /** Tests that empty string thumbnail URL disables thumbnail fallback functionality. */\n @Test\n fun testThumbnailFallbackDisabledWithEmptyUrl() {\n val backend = createThumbnailBackend(\"\", 3)\n assertThat(backend.animatedOptions?.useFallbackThumbnail()).isFalse()\n }\n\n /** Tests setAnimationListener and callback functionality */\n @Test\n fun testSetAnimationListener() {\n val mockListener = mock()\n bitmapAnimationBackend.setAnimationListener(mockListener)\n\n // Trigger preload to test listener callback\n bitmapAnimationBackend.preloadAnimation()\n\n verify(bitmapFramePreparationStrategy)\n .prepareFrames(\n eq(bitmapFramePreparer),\n eq(bitmapFrameCache),\n eq(bitmapAnimationBackend),\n eq(0),\n any(),\n )\n }\n\n /** Tests animation progress tracking for finite animations */\n @Test\n fun testAnimationProgressTrackingFiniteAnimation() {\n setupAnimationInformation(frameCount = 3, loopCount = 2)\n val backend = createThumbnailBackend(\"https://example.com/thumb.jpg\", 2)\n backend.setFrameListener(frameListener)\n\n whenever(bitmapFrameCache.getCachedFrame(anyInt())).thenReturn(bitmapReference)\n\n // Draw frames for first loop\n backend.drawFrame(parentDrawable, canvas, 0)\n backend.drawFrame(parentDrawable, canvas, 1)\n backend.drawFrame(parentDrawable, canvas, 2)\n\n // Draw frames for second loop\n backend.drawFrame(parentDrawable, canvas, 0)\n backend.drawFrame(parentDrawable, canvas, 1)\n backend.drawFrame(parentDrawable, canvas, 2) // This should complete the animation\n\n // Verify frames were drawn\n verify(frameListener, times(6)).onDrawFrameStart(eq(backend), anyInt())\n }\n\n /** Tests that infinite animations don't trigger animation completion */\n @Test\n fun testAnimationProgressTrackingInfiniteAnimation() {\n setupAnimationInformation(frameCount = 3)\n val backend =\n createThumbnailBackend(\n \"https://example.com/thumb.jpg\",\n AnimationInformation.LOOP_COUNT_INFINITE,\n )\n backend.setFrameListener(frameListener)\n\n whenever(bitmapFrameCache.getCachedFrame(anyInt())).thenReturn(bitmapReference)\n\n for (i in 0..10) {\n backend.drawFrame(parentDrawable, canvas, i % 3)\n }\n\n verify(frameListener, org.mockito.kotlin.times(11)).onDrawFrameStart(eq(backend), anyInt())\n }\n\n /** Tests preloadAnimation with old render implementation */\n @Test\n fun testPreloadAnimationOldImplementation() {\n val mockListener = mock()\n bitmapAnimationBackend.setAnimationListener(mockListener)\n\n bitmapAnimationBackend.preloadAnimation()\n\n verify(bitmapFramePreparationStrategy)\n .prepareFrames(\n eq(bitmapFramePreparer),\n eq(bitmapFrameCache),\n eq(bitmapAnimationBackend),\n eq(0),\n any(),\n )\n }\n\n /** Tests preloadAnimation with new render implementation */\n @Test\n fun testPreloadAnimationNewImplementation() {\n val newBackend = createBackendWithNewRenderImplementation(true)\n\n whenever(animationInformation.width()).thenReturn(100)\n whenever(animationInformation.height()).thenReturn(200)\n\n newBackend.preloadAnimation()\n\n verify(bitmapFramePreparationStrategy).prepareFrames(eq(100), eq(200), any())\n }\n\n /** Tests new render implementation draw frame path */\n @Test\n fun testDrawFrameNewImplementation() {\n val newBackend = createBackendWithNewRenderImplementation(true)\n\n whenever(canvas.width).thenReturn(100)\n whenever(canvas.height).thenReturn(200)\n whenever(bitmapFramePreparationStrategy.getBitmapFrame(anyInt(), anyInt(), anyInt()))\n .thenReturn(bitmapReference)\n\n val result = newBackend.drawFrame(parentDrawable, canvas, 1)\n\n assertThat(result).isTrue()\n verify(bitmapFramePreparationStrategy).getBitmapFrame(1, 100, 200)\n verify(canvas).drawBitmap(eq(bitmap), eq(0f), eq(0f), any())\n }\n\n /** Tests new render implementation when getBitmapFrame returns null */\n @Test\n fun testDrawFrameNewImplementationNoBitmap() {\n val newBackend = createBackendWithNewRenderImplementation(true)\n\n whenever(canvas.width).thenReturn(100)\n whenever(canvas.height).thenReturn(200)\n whenever(bitmapFramePreparationStrategy.getBitmapFrame(anyInt(), anyInt(), anyInt()))\n .thenReturn(null)\n\n val result = newBackend.drawFrame(parentDrawable, canvas, 1)\n\n assertThat(result).isFalse()\n verify(bitmapFramePreparationStrategy).getBitmapFrame(1, 100, 200)\n verify(bitmapFramePreparationStrategy).prepareFrames(100, 200, null)\n }\n\n /** Tests onInactive with old render implementation */\n @Test\n fun testOnInactiveOldImplementation() {\n bitmapAnimationBackend.onInactive()\n\n verify(bitmapFrameCache).clear()\n verify(bitmapFramePreparationStrategy, never()).onStop()\n }\n\n /** Tests onInactive with new render implementation */\n @Test\n fun testOnInactiveNewImplementation() {\n val newBackend = createBackendWithNewRenderImplementation(true)\n\n newBackend.onInactive()\n\n verify(bitmapFramePreparationStrategy).onStop()\n verify(bitmapFrameCache, never()).clear()\n }\n\n /** Tests clear method with old render implementation */\n @Test\n fun testClearOldImplementation() {\n bitmapAnimationBackend.clear()\n\n verify(bitmapFrameCache).clear()\n verify(bitmapFramePreparationStrategy, never()).clearFrames()\n }\n\n /** Tests clear method with new render implementation */\n @Test\n fun testClearNewImplementation() {\n val newBackend = createBackendWithNewRenderImplementation(true)\n\n newBackend.clear()\n\n verify(bitmapFramePreparationStrategy).clearFrames()\n verify(bitmapFrameCache, never()).clear()\n }\n\n /** Tests setAlpha method updates paint alpha correctly */\n @Test\n fun testSetAlpha() {\n val alpha = 128\n bitmapAnimationBackend.setAlpha(alpha)\n\n // Verify alpha is applied when drawing\n whenever(bitmapFrameCache.getCachedFrame(anyInt())).thenReturn(bitmapReference)\n bitmapAnimationBackend.drawFrame(parentDrawable, canvas, 1)\n\n // Verify the frame as drawn\n verify(canvas).drawBitmap(eq(bitmap), eq(0f), eq(0f), any())\n }\n\n /** Tests setColorFilter with null removes color filter */\n @Test\n fun testSetColorFilterNull() {\n bitmapAnimationBackend.setColorFilter(null)\n\n whenever(bitmapFrameCache.getCachedFrame(anyInt())).thenReturn(bitmapReference)\n bitmapAnimationBackend.drawFrame(parentDrawable, canvas, 1)\n\n verify(canvas).drawBitmap(eq(bitmap), eq(0f), eq(0f), any())\n }\n\n /** Tests getSizeInBytes delegates to bitmap frame cache */\n @Test\n fun testGetSizeInBytes() {\n val expectedSize = 1024\n whenever(bitmapFrameCache.sizeInBytes).thenReturn(expectedSize)\n\n assertThat(bitmapAnimationBackend.sizeInBytes).isEqualTo(expectedSize)\n }\n\n /** Tests that width and height delegate to animation information */\n @Test\n fun testWidthAndHeight() {\n whenever(animationInformation.width()).thenReturn(150)\n whenever(animationInformation.height()).thenReturn(250)\n\n assertThat(bitmapAnimationBackend.width()).isEqualTo(150)\n assertThat(bitmapAnimationBackend.height()).isEqualTo(250)\n }\n\n /** Tests getLoopDurationMs delegates to animation information */\n @Test\n fun testGetLoopDurationMs() {\n whenever(animationInformation.loopDurationMs).thenReturn(5000)\n\n assertThat(bitmapAnimationBackend.loopDurationMs).isEqualTo(5000)\n }\n}\n" }, { "path": "animated-drawable/src/test/java/com/facebook/fresco/animation/bitmap/preparation/DefaultBitmapFramePreparerTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation\n\nimport android.graphics.Bitmap\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapAnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\nimport com.facebook.fresco.animation.bitmap.BitmapFrameRenderer\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.testing.FakeClock\nimport com.facebook.imagepipeline.testing.TestExecutorService\nimport org.assertj.core.api.Assertions.assertThat\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.reset\nimport org.mockito.kotlin.times\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.verifyNoMoreInteractions\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\n\n/** Tests [DefaultBitmapFramePreparer]. */\n@RunWith(RobolectricTestRunner::class)\nclass DefaultBitmapFramePreparerTest {\n\n companion object {\n private const val FRAME_COUNT = 10\n private const val BACKEND_INTRINSIC_WIDTH = 160\n private const val BACKEND_INTRINSIC_HEIGHT = 90\n private val BITMAP_CONFIG = Bitmap.Config.ARGB_8888\n }\n\n private lateinit var animationBackend: AnimationBackend\n private lateinit var bitmapFrameCache: BitmapFrameCache\n private lateinit var platformBitmapFactory: PlatformBitmapFactory\n private lateinit var bitmapFrameRenderer: BitmapFrameRenderer\n private lateinit var bitmapReference: CloseableReference\n private lateinit var bitmap: Bitmap\n\n private lateinit var fakeClock: FakeClock\n private lateinit var executorService: TestExecutorService\n private lateinit var defaultBitmapFramePreparer: DefaultBitmapFramePreparer\n\n @Before\n fun setup() {\n animationBackend = mock()\n bitmapFrameCache = mock()\n platformBitmapFactory = mock()\n bitmapFrameRenderer = mock()\n bitmapReference = mock()\n bitmap = mock()\n\n fakeClock = FakeClock()\n executorService = TestExecutorService(fakeClock)\n\n defaultBitmapFramePreparer =\n DefaultBitmapFramePreparer(\n platformBitmapFactory,\n bitmapFrameRenderer,\n BITMAP_CONFIG,\n executorService,\n )\n whenever(animationBackend.frameCount).thenReturn(FRAME_COUNT)\n whenever(animationBackend.intrinsicWidth).thenReturn(BACKEND_INTRINSIC_WIDTH)\n whenever(animationBackend.intrinsicHeight).thenReturn(BACKEND_INTRINSIC_HEIGHT)\n whenever(bitmapReference.isValid).thenReturn(true)\n whenever(bitmapReference.get()).thenReturn(bitmap)\n }\n\n @Test\n fun testPrepareFrame_whenBitmapAlreadyCached_thenDoNothing() {\n whenever(bitmapFrameCache.contains(1)).thenReturn(true)\n whenever(bitmapFrameRenderer.renderFrame(1, bitmap)).thenReturn(true)\n\n defaultBitmapFramePreparer.prepareFrame(bitmapFrameCache, animationBackend, 1)\n\n assertThat(executorService.scheduledQueue.isIdle).isTrue()\n\n verify(bitmapFrameCache).contains(1)\n verifyNoMoreInteractions(bitmapFrameCache)\n verifyNoMoreInteractions(platformBitmapFactory, bitmapFrameRenderer, bitmapReference)\n }\n\n @Test\n fun testPrepareFrame_whenNoBitmapAvailable_thenDoNothing() {\n defaultBitmapFramePreparer.prepareFrame(bitmapFrameCache, animationBackend, 1)\n\n verify(bitmapFrameCache).contains(1)\n verifyNoMoreInteractions(bitmapFrameCache)\n reset(bitmapFrameCache)\n\n executorService.scheduledQueue.runNextPendingCommand()\n\n verify(bitmapFrameCache).contains(1)\n verify(bitmapFrameCache)\n .getBitmapToReuseForFrame(1, BACKEND_INTRINSIC_WIDTH, BACKEND_INTRINSIC_HEIGHT)\n verifyNoMoreInteractions(bitmapFrameCache)\n\n verify(platformBitmapFactory)\n .createBitmap(BACKEND_INTRINSIC_WIDTH, BACKEND_INTRINSIC_HEIGHT, BITMAP_CONFIG)\n\n verifyNoMoreInteractions(bitmapFrameRenderer)\n }\n\n @Test\n fun testPrepareFrame_whenReusedBitmapAvailable_thenCacheReusedBitmap() {\n whenever(\n bitmapFrameCache.getBitmapToReuseForFrame(\n 1,\n BACKEND_INTRINSIC_WIDTH,\n BACKEND_INTRINSIC_HEIGHT,\n )\n )\n .thenReturn(bitmapReference)\n whenever(bitmapFrameRenderer.renderFrame(1, bitmap)).thenReturn(true)\n\n defaultBitmapFramePreparer.prepareFrame(bitmapFrameCache, animationBackend, 1)\n\n executorService.scheduledQueue.runNextPendingCommand()\n\n verify(bitmapFrameCache, times(2)).contains(1)\n verify(bitmapFrameCache)\n .getBitmapToReuseForFrame(1, BACKEND_INTRINSIC_WIDTH, BACKEND_INTRINSIC_HEIGHT)\n verify(bitmapFrameRenderer).renderFrame(1, bitmap)\n\n verify(bitmapFrameCache)\n .onFramePrepared(1, bitmapReference, BitmapAnimationBackend.FRAME_TYPE_REUSED)\n\n verifyNoMoreInteractions(platformBitmapFactory)\n }\n\n @Test\n fun testPrepareFrame_whenPlatformBitmapAvailable_thenCacheCreatedBitmap() {\n whenever(\n platformBitmapFactory.createBitmap(\n BACKEND_INTRINSIC_WIDTH,\n BACKEND_INTRINSIC_HEIGHT,\n BITMAP_CONFIG,\n )\n )\n .thenReturn(bitmapReference)\n whenever(bitmapFrameRenderer.renderFrame(1, bitmap)).thenReturn(true)\n\n defaultBitmapFramePreparer.prepareFrame(bitmapFrameCache, animationBackend, 1)\n\n executorService.scheduledQueue.runNextPendingCommand()\n\n verify(bitmapFrameCache, times(2)).contains(1)\n verify(bitmapFrameCache)\n .getBitmapToReuseForFrame(1, BACKEND_INTRINSIC_WIDTH, BACKEND_INTRINSIC_HEIGHT)\n verify(platformBitmapFactory)\n .createBitmap(BACKEND_INTRINSIC_WIDTH, BACKEND_INTRINSIC_HEIGHT, BITMAP_CONFIG)\n verify(bitmapFrameRenderer).renderFrame(1, bitmap)\n\n verify(bitmapFrameCache)\n .onFramePrepared(1, bitmapReference, BitmapAnimationBackend.FRAME_TYPE_CREATED)\n\n verifyNoMoreInteractions(platformBitmapFactory)\n }\n\n @Test\n fun testPrepareFrame_whenReusedAndPlatformBitmapAvailable_thenCacheReusedBitmap() {\n whenever(\n bitmapFrameCache.getBitmapToReuseForFrame(\n 1,\n BACKEND_INTRINSIC_WIDTH,\n BACKEND_INTRINSIC_HEIGHT,\n )\n )\n .thenReturn(bitmapReference)\n whenever(\n platformBitmapFactory.createBitmap(\n BACKEND_INTRINSIC_WIDTH,\n BACKEND_INTRINSIC_HEIGHT,\n BITMAP_CONFIG,\n )\n )\n .thenReturn(bitmapReference)\n whenever(bitmapFrameRenderer.renderFrame(1, bitmap)).thenReturn(true)\n\n defaultBitmapFramePreparer.prepareFrame(bitmapFrameCache, animationBackend, 1)\n\n executorService.scheduledQueue.runNextPendingCommand()\n\n verify(bitmapFrameCache, times(2)).contains(1)\n verify(bitmapFrameCache)\n .getBitmapToReuseForFrame(1, BACKEND_INTRINSIC_WIDTH, BACKEND_INTRINSIC_HEIGHT)\n verify(bitmapFrameRenderer).renderFrame(1, bitmap)\n\n verify(bitmapFrameCache)\n .onFramePrepared(1, bitmapReference, BitmapAnimationBackend.FRAME_TYPE_REUSED)\n\n verifyNoMoreInteractions(platformBitmapFactory)\n }\n\n @Test\n fun testPrepareFrame_whenRenderingFails_thenDoNothing() {\n whenever(\n bitmapFrameCache.getBitmapToReuseForFrame(\n 1,\n BACKEND_INTRINSIC_WIDTH,\n BACKEND_INTRINSIC_HEIGHT,\n )\n )\n .thenReturn(bitmapReference)\n whenever(\n platformBitmapFactory.createBitmap(\n BACKEND_INTRINSIC_WIDTH,\n BACKEND_INTRINSIC_HEIGHT,\n BITMAP_CONFIG,\n )\n )\n .thenReturn(bitmapReference)\n whenever(bitmapFrameRenderer.renderFrame(1, bitmap)).thenReturn(false)\n\n defaultBitmapFramePreparer.prepareFrame(bitmapFrameCache, animationBackend, 1)\n\n executorService.scheduledQueue.runNextPendingCommand()\n\n verify(bitmapFrameCache, times(2)).contains(1)\n verify(bitmapFrameCache)\n .getBitmapToReuseForFrame(1, BACKEND_INTRINSIC_WIDTH, BACKEND_INTRINSIC_HEIGHT)\n verify(platformBitmapFactory)\n .createBitmap(BACKEND_INTRINSIC_WIDTH, BACKEND_INTRINSIC_HEIGHT, BITMAP_CONFIG)\n verify(bitmapFrameRenderer, times(2)).renderFrame(1, bitmap)\n\n verifyNoMoreInteractions(bitmapFrameCache)\n }\n}\n" }, { "path": "animated-drawable/src/test/java/com/facebook/fresco/animation/bitmap/preparation/FixedNumberBitmapFramePreparationStrategyTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.bitmap.preparation\n\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport com.facebook.fresco.animation.bitmap.BitmapFrameCache\nimport kotlin.Unit\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.Mock\nimport org.mockito.MockitoAnnotations\nimport org.mockito.kotlin.any\nimport org.mockito.kotlin.eq\nimport org.mockito.kotlin.inOrder\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\n\n/** Tests [FixedNumberBitmapFramePreparationStrategy]. */\n@RunWith(RobolectricTestRunner::class)\nclass FixedNumberBitmapFramePreparationStrategyTest {\n\n companion object {\n const val NUMBER_OF_FRAMES_TO_PREPARE = 3\n const val FRAME_COUNT = 10\n }\n\n @Mock lateinit var animationBackend: AnimationBackend\n @Mock lateinit var bitmapFramePreparer: BitmapFramePreparer\n @Mock lateinit var bitmapFrameCache: BitmapFrameCache\n @Mock lateinit var onAnimationLoaded: () -> Unit\n\n private lateinit var bitmapFramePreparationStrategy: BitmapFramePreparationStrategy\n\n @Before\n fun setup() {\n MockitoAnnotations.initMocks(this)\n bitmapFramePreparationStrategy =\n FixedNumberBitmapFramePreparationStrategy(NUMBER_OF_FRAMES_TO_PREPARE)\n whenever(animationBackend.frameCount).thenReturn(FRAME_COUNT)\n whenever(bitmapFramePreparer.prepareFrame(eq(bitmapFrameCache), eq(animationBackend), any()))\n .thenReturn(true)\n }\n\n @Test\n fun testPrepareFrames_FromFirstFrame() {\n bitmapFramePreparationStrategy.prepareFrames(\n bitmapFramePreparer,\n bitmapFrameCache,\n animationBackend,\n 0,\n onAnimationLoaded,\n )\n verifyPrepareCalledForFramesInOrder(1, 2, 3)\n }\n\n @Test\n fun testPrepareFrames_FromLastFrame() {\n bitmapFramePreparationStrategy.prepareFrames(\n bitmapFramePreparer,\n bitmapFrameCache,\n animationBackend,\n 9,\n onAnimationLoaded,\n )\n verifyPrepareCalledForFramesInOrder(0, 1, 2)\n }\n\n @Test\n fun testPrepareFrames_ExactlyLastFrames() {\n bitmapFramePreparationStrategy.prepareFrames(\n bitmapFramePreparer,\n bitmapFrameCache,\n animationBackend,\n 6,\n onAnimationLoaded,\n )\n verifyPrepareCalledForFramesInOrder(7, 8, 9)\n }\n\n @Test\n fun testPrepareFrames_FrameOverflow() {\n bitmapFramePreparationStrategy.prepareFrames(\n bitmapFramePreparer,\n bitmapFrameCache,\n animationBackend,\n 8,\n onAnimationLoaded,\n )\n verifyPrepareCalledForFramesInOrder(9, 0, 1)\n }\n\n @Test\n fun testPrepareFrames_FromFirstFrame_WhenBitmapFramePreparerAlwaysFails() {\n whenever(bitmapFramePreparer.prepareFrame(eq(bitmapFrameCache), eq(animationBackend), any()))\n .thenReturn(false)\n bitmapFramePreparationStrategy.prepareFrames(\n bitmapFramePreparer,\n bitmapFrameCache,\n animationBackend,\n 0,\n onAnimationLoaded,\n )\n verifyPrepareCalledForFramesInOrder(1)\n }\n\n @Test\n fun testPrepareFrames_FromFirstFrame_WhenBitmapFramePreparerFailsForSelectedFrames() {\n whenever(bitmapFramePreparer.prepareFrame(eq(bitmapFrameCache), eq(animationBackend), eq(2)))\n .thenReturn(false)\n whenever(bitmapFramePreparer.prepareFrame(eq(bitmapFrameCache), eq(animationBackend), eq(3)))\n .thenReturn(false)\n bitmapFramePreparationStrategy.prepareFrames(\n bitmapFramePreparer,\n bitmapFrameCache,\n animationBackend,\n 0,\n onAnimationLoaded,\n )\n verifyPrepareCalledForFramesInOrder(1, 2)\n }\n\n @Test\n fun testPrepareFrames_onAnimationLoadedIsTrigger_WhenFramesAreLoaded() {\n bitmapFramePreparationStrategy.prepareFrames(\n bitmapFramePreparer,\n bitmapFrameCache,\n animationBackend,\n 0,\n onAnimationLoaded,\n )\n\n verify(onAnimationLoaded).invoke()\n }\n\n private fun verifyPrepareCalledForFramesInOrder(vararg frameNumbers: Int) {\n val inOrderBitmapFramePreparer = inOrder(bitmapFramePreparer)\n for (frameNumber in frameNumbers) {\n inOrderBitmapFramePreparer\n .verify(bitmapFramePreparer)\n .prepareFrame(bitmapFrameCache, animationBackend, frameNumber)\n }\n inOrderBitmapFramePreparer.verifyNoMoreInteractions()\n }\n}\n" }, { "path": "animated-drawable/src/test/java/com/facebook/fresco/animation/frame/DropFramesFrameSchedulerTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.animation.frame\n\nimport android.graphics.Canvas\nimport android.graphics.ColorFilter\nimport android.graphics.Rect\nimport android.graphics.drawable.Drawable\nimport androidx.annotation.IntRange\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport org.assertj.core.api.Assertions.assertThat\nimport org.junit.Before\nimport org.junit.Test\n\n/** Tests [DropFramesFrameScheduler]. */\nclass DropFramesFrameSchedulerTest {\n\n private lateinit var dummyAnimationBackend: DummyAnimationBackend\n private lateinit var frameScheduler: DropFramesFrameScheduler\n\n @Before\n fun setUp() {\n dummyAnimationBackend = DummyAnimationBackend(5)\n frameScheduler = DropFramesFrameScheduler(dummyAnimationBackend)\n }\n\n @Test\n fun testGetFrameNumberToRender() {\n assertThat(frameScheduler.getFrameNumberToRender(0, -1)).isEqualTo(0)\n assertThat(frameScheduler.getFrameNumberToRender(50, -1)).isEqualTo(0)\n assertThat(frameScheduler.getFrameNumberToRender(100, -1)).isEqualTo(1)\n assertThat(frameScheduler.getFrameNumberToRender(499, -1)).isEqualTo(4)\n assertThat(frameScheduler.getFrameNumberToRender(500, -1)).isEqualTo(0)\n assertThat(frameScheduler.getFrameNumberToRender(600, -1)).isEqualTo(1)\n assertThat(frameScheduler.getFrameNumberToRender(601, -1)).isEqualTo(1)\n }\n\n @Test\n fun testGetLoopDurationMs() {\n assertThat(frameScheduler.loopDurationMs).isEqualTo(500)\n }\n\n @Test\n fun testGetTargetRenderTimeMs() {\n assertThat(frameScheduler.getTargetRenderTimeMs(0)).isEqualTo(0)\n assertThat(frameScheduler.getTargetRenderTimeMs(1)).isEqualTo(100)\n assertThat(frameScheduler.getTargetRenderTimeMs(2)).isEqualTo(200)\n assertThat(frameScheduler.getTargetRenderTimeMs(3)).isEqualTo(300)\n assertThat(frameScheduler.getTargetRenderTimeMs(4)).isEqualTo(400)\n }\n\n @Test\n fun testGetTargetRenderTimeForNextFrameMs() {\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(0)).isEqualTo(100)\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(1)).isEqualTo(100)\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(50)).isEqualTo(100)\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(100)).isEqualTo(200)\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(170)).isEqualTo(200)\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(460)).isEqualTo(500)\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(499)).isEqualTo(500)\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(500)).isEqualTo(600)\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(501)).isEqualTo(600)\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(510)).isEqualTo(600)\n }\n\n @Test\n fun testGetTargetRenderTimeForNextFrameMsWhenAnimationOver() {\n val animationDurationMs = dummyAnimationBackend.getAnimationDurationMs()\n\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(animationDurationMs - 1))\n .isEqualTo(animationDurationMs)\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(animationDurationMs))\n .isEqualTo(FrameScheduler.NO_NEXT_TARGET_RENDER_TIME.toLong())\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(animationDurationMs + 1))\n .isEqualTo(FrameScheduler.NO_NEXT_TARGET_RENDER_TIME.toLong())\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(animationDurationMs + 100))\n .isEqualTo(FrameScheduler.NO_NEXT_TARGET_RENDER_TIME.toLong())\n assertThat(frameScheduler.getTargetRenderTimeForNextFrameMs(animationDurationMs * 100))\n .isEqualTo(FrameScheduler.NO_NEXT_TARGET_RENDER_TIME.toLong())\n }\n\n @Test\n fun testIsInfiniteAnimation() {\n assertThat(frameScheduler.isInfiniteAnimation).isFalse()\n }\n\n @Test\n fun testLoopCount() {\n val animationDurationMs = dummyAnimationBackend.getAnimationDurationMs()\n val lastFrameNumber = dummyAnimationBackend.frameCount - 1\n\n assertThat(frameScheduler.getFrameNumberToRender(animationDurationMs, -1))\n .isEqualTo(FrameScheduler.FRAME_NUMBER_DONE)\n\n assertThat(frameScheduler.getFrameNumberToRender(animationDurationMs + 1, -1))\n .isEqualTo(FrameScheduler.FRAME_NUMBER_DONE)\n\n assertThat(\n frameScheduler.getFrameNumberToRender(\n animationDurationMs + dummyAnimationBackend.getFrameDurationMs(lastFrameNumber),\n -1,\n )\n )\n .isEqualTo(FrameScheduler.FRAME_NUMBER_DONE)\n\n assertThat(\n frameScheduler.getFrameNumberToRender(\n animationDurationMs +\n dummyAnimationBackend.getFrameDurationMs(lastFrameNumber) +\n 100,\n -1,\n )\n )\n .isEqualTo(FrameScheduler.FRAME_NUMBER_DONE)\n }\n\n @Test\n fun testGetFrameNumberWithinLoop() {\n assertThat(frameScheduler.getFrameNumberWithinLoop(0)).isEqualTo(0)\n assertThat(frameScheduler.getFrameNumberWithinLoop(1)).isEqualTo(0)\n assertThat(frameScheduler.getFrameNumberWithinLoop(99)).isEqualTo(0)\n assertThat(frameScheduler.getFrameNumberWithinLoop(100)).isEqualTo(1)\n assertThat(frameScheduler.getFrameNumberWithinLoop(101)).isEqualTo(1)\n assertThat(frameScheduler.getFrameNumberWithinLoop(250)).isEqualTo(2)\n assertThat(frameScheduler.getFrameNumberWithinLoop(499)).isEqualTo(4)\n }\n\n @Test\n fun testGetFrameNumberToRender_whenNoFrames_thenReturnFirstFrame() {\n val backend = DummyAnimationBackend(0)\n val frameScheduler = DropFramesFrameScheduler(backend)\n\n assertThat(frameScheduler.loopDurationMs).isEqualTo(0)\n assertThat(frameScheduler.getFrameNumberToRender(0, 0)).isEqualTo(0)\n }\n\n private class DummyAnimationBackend(private val frameCount: Int) : AnimationBackend {\n\n override fun getLoopDurationMs(): Int {\n var loopDuration = 0L\n for (i in 0 until frameCount) {\n loopDuration += getFrameDurationMs(i)\n }\n return loopDuration.toInt()\n }\n\n override fun width(): Int = intrinsicWidth\n\n override fun height(): Int = intrinsicHeight\n\n fun getAnimationDurationMs(): Long = getLoopDurationMs().toLong() * getLoopCount()\n\n override fun getFrameCount(): Int = frameCount\n\n override fun getFrameDurationMs(frameNumber: Int): Int = 100\n\n override fun getLoopCount(): Int = 7\n\n override fun drawFrame(parent: Drawable, canvas: Canvas, frameNumber: Int): Boolean = false\n\n override fun setAlpha(@IntRange(from = 0, to = 255) alpha: Int) = Unit\n\n override fun setColorFilter(colorFilter: ColorFilter?) = Unit\n\n override fun setBounds(bounds: Rect) = Unit\n\n override fun getIntrinsicWidth(): Int = AnimationBackend.INTRINSIC_DIMENSION_UNSET\n\n override fun getIntrinsicHeight(): Int = AnimationBackend.INTRINSIC_DIMENSION_UNSET\n\n override fun getSizeInBytes(): Int = 0\n\n override fun clear() = Unit\n\n override fun preloadAnimation() = Unit\n\n override fun setAnimationListener(listener: AnimationBackend.Listener?) = Unit\n }\n}\n" }, { "path": "animated-drawable/src/test/java/javax/microedition/khronos/opengles/GL.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage javax.microedition.khronos.opengles;\n\n/** Dummy interface to get Canvas mocks to work. */\npublic interface GL {}\n" }, { "path": "animated-gif/.gitignore", "content": "nativedeps/\n" }, { "path": "animated-gif/build.gradle", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nimport com.facebook.fresco.buildsrc.Deps\nimport com.facebook.fresco.buildsrc.GradleDeps\nimport com.facebook.fresco.buildsrc.TestDeps\n\napply plugin: 'com.android.library'\napply plugin: 'kotlin-android'\n\nkotlin {\n jvmToolchain(11)\n}\n\ndependencies {\n compileOnly Deps.inferAnnotation\n compileOnly Deps.jsr305\n implementation Deps.Bolts.tasks\n compileOnly Deps.javaxAnnotation\n implementation Deps.SoLoader.nativeloader\n implementation project(':fbcore')\n implementation project(':animated-base')\n implementation project(':animated-gif-lite')\n implementation project(':middleware')\n\n testCompileOnly Deps.inferAnnotation\n testImplementation project(':imagepipeline-base-test')\n testImplementation project(':imagepipeline-test')\n testImplementation project(':middleware')\n testImplementation TestDeps.junit\n testImplementation TestDeps.assertjCore\n testImplementation TestDeps.mockitoCore3\n testImplementation TestDeps.mockitoInline3\n testImplementation TestDeps.mockitoKotlin3\n testImplementation(TestDeps.robolectric) {\n exclude group: 'commons-logging', module: 'commons-logging'\n exclude group: 'org.apache.httpcomponents', module: 'httpclient'\n }\n}\n\n// We download various C++ open-source dependencies from SourceForge into nativedeps/downloads.\n// We then copy both downloaded code and our custom makefiles and headers into nativedeps/merge.\n\ntask fetchNativeDeps(dependsOn: [copyGiflib]) {\n}\n\nandroid {\n ndkVersion GradleDeps.Native.version\n\n def ndkLibs = [['gifimage', [copyGiflib]]]\n\n buildToolsVersion FrescoConfig.buildToolsVersion\n compileSdkVersion FrescoConfig.compileSdkVersion\n\n namespace \"com.facebook.animated.gif\"\n\n defaultConfig {\n minSdkVersion FrescoConfig.minSdkVersion\n targetSdkVersion FrescoConfig.targetSdkVersion\n }\n\n sourceSets {\n main {\n jni.srcDirs = []\n jniLibs.srcDirs = ndkLibs.collect { \"$buildDir/${it[0]}\" }\n }\n }\n ndkLibs.each { lib -> makeNdkTasks lib[0], lib[1] }\n preBuild.dependsOn(\"ndk_build_gifimage\")\n}\n\napply plugin: \"com.vanniktech.maven.publish\"\n" }, { "path": "animated-gif/gradle.properties", "content": "POM_NAME=AnimatedGif\nPOM_DESCRIPTION=The classes to support animated gif\nPOM_ARTIFACT_ID=animated-gif\nPOM_PACKAGING=aar\n\n" }, { "path": "animated-gif/src/main/AndroidManifest.xml", "content": "\n\n\n" }, { "path": "animated-gif/src/main/java/com/facebook/animated/gif/AnimatedImageGifValidator.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.gif\n\nimport com.facebook.animated.giflite.decoder.GifMetadataDecoder\nimport com.facebook.imagepipeline.animated.base.AnimatedImageValidator\nimport com.facebook.imagepipeline.animated.base.ValidationResult\nimport com.facebook.imagepipeline.image.EncodedImage\n\nprivate const val MAX_GIF_TOTAL_PIXELS = 100_000_000\n\nobject AnimatedImageGifValidator : AnimatedImageValidator {\n\n override fun validateImage(encodedImage: EncodedImage): ValidationResult {\n val inputStream =\n encodedImage.inputStream ?: return ValidationResult.Failure(\"No input stream available\")\n\n try {\n inputStream.use { stream ->\n val decoder = GifMetadataDecoder.create(stream, null)\n\n val width = decoder.screenWidth\n val height = decoder.screenHeight\n if (width <= 0 || height <= 0) {\n return ValidationResult.Failure(\"GIF invalid logical screen size: $width x $height\")\n }\n\n val totalPixels = width * height * decoder.frameCount\n if (totalPixels > MAX_GIF_TOTAL_PIXELS) {\n return ValidationResult.Failure(\n \"GIF too large: $width x $height x ${decoder.frameCount} frames = $totalPixels pixels\"\n )\n }\n }\n return ValidationResult.Success\n } catch (e: Exception) {\n return ValidationResult.Failure(\"Error parsing GIF: ${e.message}\")\n }\n }\n}\n" }, { "path": "animated-gif/src/main/java/com/facebook/animated/gif/GifFrame.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.gif;\n\nimport android.graphics.Bitmap;\nimport com.facebook.common.internal.DoNotStrip;\nimport com.facebook.imagepipeline.animated.base.AnimatedImageFrame;\nimport com.facebook.infer.annotation.Nullsafe;\nimport javax.annotation.concurrent.ThreadSafe;\n\n/** A single frame of a {@link GifImage}. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\n@ThreadSafe\npublic class GifFrame implements AnimatedImageFrame {\n\n // Accessed by native methods\n @SuppressWarnings(\"unused\")\n @DoNotStrip\n private long mNativeContext;\n\n /**\n * Constructs the frame with the native pointer. This is called by native code.\n *\n * @param nativeContext the native pointer\n */\n @DoNotStrip\n GifFrame(long nativeContext) {\n mNativeContext = nativeContext;\n }\n\n // This is a valid use of finalize. No other mechanism is appropriate.\n @Override\n protected void finalize() {\n nativeFinalize();\n }\n\n @Override\n public void dispose() {\n nativeDispose();\n }\n\n @Override\n public void renderFrame(int width, int height, Bitmap bitmap) {\n nativeRenderFrame(width, height, bitmap);\n }\n\n @Override\n public int getDurationMs() {\n return nativeGetDurationMs();\n }\n\n @Override\n public int getWidth() {\n return nativeGetWidth();\n }\n\n @Override\n public int getHeight() {\n return nativeGetHeight();\n }\n\n @Override\n public int getXOffset() {\n return nativeGetXOffset();\n }\n\n @Override\n public int getYOffset() {\n return nativeGetYOffset();\n }\n\n public boolean hasTransparency() {\n return nativeHasTransparency();\n }\n\n public int getTransparentPixelColor() {\n return nativeGetTransparentPixelColor();\n }\n\n public int getDisposalMode() {\n return nativeGetDisposalMode();\n }\n\n @DoNotStrip\n private native void nativeRenderFrame(int width, int height, Bitmap bitmap);\n\n @DoNotStrip\n private native int nativeGetDurationMs();\n\n @DoNotStrip\n private native int nativeGetWidth();\n\n @DoNotStrip\n private native int nativeGetHeight();\n\n @DoNotStrip\n private native int nativeGetXOffset();\n\n @DoNotStrip\n private native int nativeGetYOffset();\n\n @DoNotStrip\n private native int nativeGetDisposalMode();\n\n @DoNotStrip\n private native int nativeGetTransparentPixelColor();\n\n @DoNotStrip\n private native boolean nativeHasTransparency();\n\n @DoNotStrip\n private native void nativeDispose();\n\n @DoNotStrip\n private native void nativeFinalize();\n}\n" }, { "path": "animated-gif/src/main/java/com/facebook/animated/gif/GifImage.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.gif;\n\nimport android.graphics.Bitmap;\nimport com.facebook.common.internal.DoNotStrip;\nimport com.facebook.common.internal.Preconditions;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo.BlendOperation;\nimport com.facebook.imagepipeline.animated.base.AnimatedImage;\nimport com.facebook.imagepipeline.animated.factory.AnimatedImageDecoder;\nimport com.facebook.imagepipeline.common.ImageDecodeOptions;\nimport com.facebook.infer.annotation.Nullsafe;\nimport com.facebook.soloader.nativeloader.NativeLoader;\nimport java.nio.ByteBuffer;\nimport javax.annotation.Nullable;\nimport javax.annotation.concurrent.ThreadSafe;\n\n/**\n * A representation of a GIF image. An instance of this class will hold a copy of the encoded data\n * in memory along with the parsed header data. Frames are decoded on demand via {@link GifFrame}.\n */\n@Nullsafe(Nullsafe.Mode.LOCAL)\n@ThreadSafe\n@DoNotStrip\npublic class GifImage implements AnimatedImage, AnimatedImageDecoder {\n\n private static final int LOOP_COUNT_FOREVER = 0;\n private static final int LOOP_COUNT_MISSING = -1;\n\n private static volatile boolean sInitialized;\n\n // Accessed by native methods\n @SuppressWarnings(\"unused\")\n @DoNotStrip\n private long mNativeContext;\n\n @Nullable private Bitmap.Config mDecodeBitmapConfig = null;\n\n private static synchronized void ensure() {\n if (!sInitialized) {\n sInitialized = true;\n NativeLoader.loadLibrary(\"gifimage\");\n }\n }\n\n /**\n * Creates a {@link GifImage} from the specified encoded data. This will throw if it fails to\n * create. This is meant to be called on a worker thread.\n *\n * @param source the data to the image (a copy will be made)\n */\n public static GifImage createFromByteArray(byte[] source) {\n Preconditions.checkNotNull(source, \"Source byte array cannot be null\");\n\n ByteBuffer byteBuffer = ByteBuffer.allocateDirect(source.length);\n byteBuffer.put(source);\n byteBuffer.rewind();\n\n return createFromByteBuffer(byteBuffer, ImageDecodeOptions.defaults());\n }\n\n /**\n * Creates a {@link GifImage} from a ByteBuffer containing the image. This will throw if it fails\n * to create.\n *\n * @param byteBuffer the ByteBuffer containing the image (a copy will be made)\n */\n public static GifImage createFromByteBuffer(ByteBuffer byteBuffer) {\n return createFromByteBuffer(byteBuffer, ImageDecodeOptions.defaults());\n }\n\n /**\n * Creates a {@link GifImage} from a ByteBuffer containing the image. This will throw if it fails\n * to create.\n *\n * @param byteBuffer the ByteBuffer containing the image (a copy will be made)\n */\n public static GifImage createFromByteBuffer(ByteBuffer byteBuffer, ImageDecodeOptions options) {\n ensure();\n byteBuffer.rewind();\n\n GifImage image =\n nativeCreateFromDirectByteBuffer(\n byteBuffer, options.maxDimensionPx, options.forceStaticImage);\n image.mDecodeBitmapConfig = options.animatedBitmapConfig;\n return image;\n }\n\n public static GifImage createFromNativeMemory(\n long nativePtr, int sizeInBytes, ImageDecodeOptions options) {\n ensure();\n Preconditions.checkArgument(nativePtr != 0);\n GifImage image =\n nativeCreateFromNativeMemory(\n nativePtr, sizeInBytes, options.maxDimensionPx, options.forceStaticImage);\n image.mDecodeBitmapConfig = options.animatedBitmapConfig;\n return image;\n }\n\n /**\n * Creates a {@link GifImage} from a file descriptor containing the image. This will throw if it\n * fails to create.\n *\n * @param fileDescriptor the file descriptor containing the image (a copy will be made)\n */\n public static GifImage createFromFileDescriptor(int fileDescriptor, ImageDecodeOptions options) {\n ensure();\n\n return nativeCreateFromFileDescriptor(\n fileDescriptor, options.maxDimensionPx, options.forceStaticImage);\n }\n\n @Override\n public AnimatedImage decodeFromNativeMemory(\n long nativePtr, int sizeInBytes, ImageDecodeOptions options) {\n return GifImage.createFromNativeMemory(nativePtr, sizeInBytes, options);\n }\n\n @Override\n public AnimatedImage decodeFromByteBuffer(ByteBuffer byteBuffer, ImageDecodeOptions options) {\n return GifImage.createFromByteBuffer(byteBuffer, options);\n }\n\n @DoNotStrip\n public GifImage() {}\n\n /**\n * Constructs the image with the native pointer. This is called by native code.\n *\n * @param nativeContext the native pointer\n */\n @DoNotStrip\n GifImage(long nativeContext) {\n mNativeContext = nativeContext;\n }\n\n // This is a valid use of finalize. No other mechanism is appropriate.\n @Override\n protected void finalize() {\n nativeFinalize();\n }\n\n @Override\n public void dispose() {\n nativeDispose();\n }\n\n @Override\n public int getWidth() {\n return nativeGetWidth();\n }\n\n @Override\n public int getHeight() {\n return nativeGetHeight();\n }\n\n @Override\n public int getFrameCount() {\n return nativeGetFrameCount();\n }\n\n @Override\n public int getDuration() {\n return nativeGetDuration();\n }\n\n @Override\n public int[] getFrameDurations() {\n return nativeGetFrameDurations();\n }\n\n @Override\n public int getLoopCount() {\n // If a GIF image has no Netscape 2.0 loop extension, it is meant to play once and then stop. A\n // loop count of 0 indicates an endless looping of the animation. Any loop count X>0 indicates\n // that the animation shall be repeated X times, resulting in the animation to play X+1 times.\n final int loopCount = nativeGetLoopCount();\n switch (loopCount) {\n case LOOP_COUNT_FOREVER:\n return AnimatedImage.LOOP_COUNT_INFINITE;\n\n case LOOP_COUNT_MISSING:\n return 1;\n\n default:\n return loopCount + 1;\n }\n }\n\n @Override\n public GifFrame getFrame(int frameNumber) {\n return nativeGetFrame(frameNumber);\n }\n\n @Override\n public boolean doesRenderSupportScaling() {\n return false;\n }\n\n @Override\n public int getSizeInBytes() {\n return nativeGetSizeInBytes();\n }\n\n public boolean isAnimated() {\n return nativeIsAnimated();\n }\n\n @Override\n public AnimatedDrawableFrameInfo getFrameInfo(int frameNumber) {\n GifFrame frame = getFrame(frameNumber);\n try {\n return new AnimatedDrawableFrameInfo(\n frameNumber,\n frame.getXOffset(),\n frame.getYOffset(),\n frame.getWidth(),\n frame.getHeight(),\n BlendOperation.BLEND_WITH_PREVIOUS,\n fromGifDisposalMethod(frame.getDisposalMode()));\n } finally {\n frame.dispose();\n }\n }\n\n @Override\n @Nullable\n public Bitmap.Config getAnimatedBitmapConfig() {\n return mDecodeBitmapConfig;\n }\n\n private static AnimatedDrawableFrameInfo.DisposalMethod fromGifDisposalMethod(int disposalMode) {\n if (disposalMode == 0 /* DISPOSAL_UNSPECIFIED */) {\n return AnimatedDrawableFrameInfo.DisposalMethod.DISPOSE_DO_NOT;\n } else if (disposalMode == 1 /* DISPOSE_DO_NOT */) {\n return AnimatedDrawableFrameInfo.DisposalMethod.DISPOSE_DO_NOT;\n } else if (disposalMode == 2 /* DISPOSE_BACKGROUND */) {\n return AnimatedDrawableFrameInfo.DisposalMethod.DISPOSE_TO_BACKGROUND;\n } else if (disposalMode == 3 /* DISPOSE_PREVIOUS */) {\n return AnimatedDrawableFrameInfo.DisposalMethod.DISPOSE_TO_PREVIOUS;\n } else {\n return AnimatedDrawableFrameInfo.DisposalMethod.DISPOSE_DO_NOT;\n }\n }\n\n @DoNotStrip\n private static native GifImage nativeCreateFromDirectByteBuffer(\n ByteBuffer buffer, int maxDimension, boolean forceStatic);\n\n @DoNotStrip\n private static native GifImage nativeCreateFromNativeMemory(\n long nativePtr, int sizeInBytes, int maxDimension, boolean forceStatic);\n\n @DoNotStrip\n private static native GifImage nativeCreateFromFileDescriptor(\n int fileDescriptor, int maxDimension, boolean forceStatic);\n\n @DoNotStrip\n private native int nativeGetWidth();\n\n @DoNotStrip\n private native int nativeGetHeight();\n\n @DoNotStrip\n private native int nativeGetDuration();\n\n @DoNotStrip\n private native int nativeGetFrameCount();\n\n @DoNotStrip\n private native int[] nativeGetFrameDurations();\n\n @DoNotStrip\n private native int nativeGetLoopCount();\n\n @DoNotStrip\n private native GifFrame nativeGetFrame(int frameNumber);\n\n @DoNotStrip\n private native int nativeGetSizeInBytes();\n\n @DoNotStrip\n private native boolean nativeIsAnimated();\n\n @DoNotStrip\n private native void nativeDispose();\n\n @DoNotStrip\n private native void nativeFinalize();\n}\n" }, { "path": "animated-gif/src/main/java/com/facebook/animated/gif/GifImageDecoder.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.gif\n\nimport com.facebook.common.logging.FLog\nimport com.facebook.imagepipeline.animated.factory.AnimatedImageDecoderBase\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.common.ImageDecodeOptions\nimport com.facebook.imagepipeline.decoder.ImageDecoder\nimport com.facebook.imagepipeline.image.CloseableImage\nimport com.facebook.imagepipeline.image.EncodedImage\nimport com.facebook.imagepipeline.image.QualityInfo\n\nclass GifImageDecoder(\n platformBitmapFactory: PlatformBitmapFactory,\n isNewRenderImplementation: Boolean,\n downscaleFrameToDrawableDimensions: Boolean,\n treatAnimatedImagesAsStateful: Boolean = true,\n) :\n AnimatedImageDecoderBase(\n platformBitmapFactory,\n downscaleFrameToDrawableDimensions,\n isNewRenderImplementation,\n treatAnimatedImagesAsStateful,\n ),\n ImageDecoder {\n\n /**\n * Decodes an animated GIF image into a CloseableImage.\n *\n * @param encodedImage encoded image (native byte array holding the encoded bytes and meta data)\n * @param length the length of the encoded data\n * @param qualityInfo quality information about the image\n * @param options decode options specifying how the image should be decoded\n * @return a CloseableImage\n */\n override fun decode(\n encodedImage: EncodedImage,\n length: Int,\n qualityInfo: QualityInfo,\n options: ImageDecodeOptions,\n ): CloseableImage? {\n val bytesRef = encodedImage.byteBufferRef\n checkNotNull(bytesRef)\n\n bytesRef.use {\n val validationResult = AnimatedImageGifValidator.validateImage(encodedImage)\n if (validationResult.isValid == false) {\n FLog.w(TAG, \"Image validation failed: ${validationResult.message}\")\n throw UnsupportedOperationException(\"Invalid image: ${validationResult.message}\")\n }\n\n val input = bytesRef.get()\n val image =\n input.byteBuffer?.let { byteBuffer -> GifImage.createFromByteBuffer(byteBuffer, options) }\n ?: GifImage.createFromNativeMemory(input.nativePtr, input.size(), options)\n return getCloseableImage(\n encodedImage.source,\n options,\n checkNotNull(image),\n options.animatedBitmapConfig,\n )\n }\n }\n\n companion object {\n private const val TAG = \"GifImageDecoder\"\n }\n}\n" }, { "path": "animated-gif/src/main/jni/Application.mk", "content": "# Copyright (c) Meta Platforms, Inc. and affiliates.\n#\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\nAPP_BUILD_SCRIPT := Android.mk\n\nAPP_ABI := armeabi-v7a arm64-v8a x86 x86_64\n\nAPP_MK_DIR := $(dir $(lastword $(MAKEFILE_LIST)))\nNDK_MODULE_PATH := $(APP_MK_DIR)$(HOST_DIRSEP)$(APP_MK_DIR)../../../nativedeps/merge\n\nAPP_STL := c++_static\nAPP_SUPPORT_FLEXIBLE_PAGE_SIZES := true\n# Make sure every shared lib includes a .note.gnu.build-id header\nAPP_LDFLAGS := -Wl,--build-id\n\nNDK_TOOLCHAIN_VERSION := clang\n\n\n# We link our libs with static stl implementation. Because of that we need to\n# hide all stl related symbols to make them unaccessible from the outside.\n# We also need to make sure that our library does not use any stl functions\n# coming from other stl implementations as well\n\n# This hides all symbols exported from libgnustl_static\nFRESCO_CPP_LDFLAGS := -Wl,--gc-sections,--exclude-libs,libc++_static.a\n" }, { "path": "animated-gif/src/main/jni/gifimage/Android.mk", "content": "# Copyright (c) Meta Platforms, Inc. and affiliates.\n#\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\nLOCAL_PATH := $(call my-dir)\n\ninclude $(CLEAR_VARS)\n\nLOCAL_MODULE := gifimage\n\nLOCAL_SRC_FILES := \\\n OnLoad.cpp \\\n gif.cpp \\\n jni_helpers.cpp \\\n\nCXX11_FLAGS := -std=c++11\nLOCAL_CFLAGS += $(CXX11_FLAGS)\nLOCAL_CFLAGS += -fvisibility=hidden\nLOCAL_CFLAGS += $(FRESCO_CPP_CFLAGS)\nLOCAL_EXPORT_CPPFLAGS := $(CXX11_FLAGS)\nLOCAL_LDLIBS += -latomic -ljnigraphics\nLOCAL_LDFLAGS += $(FRESCO_CPP_LDFLAGS)\nLOCAL_LDLIBS += -llog -ldl -landroid\nLOCAL_STATIC_LIBRARIES += gif\ninclude $(BUILD_SHARED_LIBRARY)\n$(call import-module, giflib)\n" }, { "path": "animated-gif/src/main/jni/gifimage/OnLoad.cpp", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\n#include \n#include \n#include \n#include \n#include \n\n#include \n\nint initGifImage(JNIEnv* env);\n\n// Registers jni methods.\n__attribute__((visibility(\"default\"))) jint\nJNI_OnLoad(JavaVM* vm, void* reserved) {\n // get the current env\n JNIEnv* env = nullptr;\n if (vm->GetEnv(reinterpret_cast(&env), JNI_VERSION_1_6) != JNI_OK) {\n return JNI_ERR;\n }\n\n int result = initGifImage(env);\n if (result != JNI_OK) {\n return result;\n }\n return JNI_VERSION_1_6;\n}\n" }, { "path": "animated-gif/src/main/jni/gifimage/gif.cpp", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\n#define LOG_TAG \"GifImage\"\n\n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n\n#include \"gif_lib.h\"\n#include \"locks.h\"\n#include \"secure_memcpy.h\"\n\n#ifdef __ANGLIRU__\n#include \n#else\n#define __ANGLIRU_SOURCE__\n#endif // For Angliru analysis\n\n#if defined(__has_include) && __has_include()\n#include \n#else\n#include \"jni_helpers.h\"\n#endif\n\nusing namespace facebook;\n\n#define APPLICATION_EXT_NETSCAPE \"NETSCAPE2.0\"\n#define APPLICATION_EXT_NETSCAPE_LEN sizeof(APPLICATION_EXT_NETSCAPE) - 1\n\n#define EXTRA_LOGGING false\n\n#define LOOP_COUNT_MISSING -1;\n\nstatic void DGifCloseFile2(GifFileType* pGifFile) {\n int errorCode;\n DGifCloseFile(pGifFile, &errorCode);\n}\n\nclass DataWrapper {\n public:\n DataWrapper() {}\n\n virtual ~DataWrapper() {}\n\n virtual size_t read(GifByteType* dest, size_t size) = 0;\n\n virtual size_t getBufferSize() = 0;\n\n virtual size_t getPosition() = 0;\n\n virtual bool setPosition(size_t position) = 0;\n};\n\nclass BytesDataWrapper : public DataWrapper {\n public:\n BytesDataWrapper(std::vector&& pBuffer)\n : DataWrapper(), m_pBuffer(std::move(pBuffer)), m_position(0) {\n m_length = m_pBuffer.size();\n }\n\n inline static size_t rangeAdd(size_t current, size_t increment, size_t max) {\n size_t end = current + increment;\n if (end < current || // integer overflow\n end > max // buffer overflow\n ) {\n end = max;\n }\n\n return end;\n }\n\n size_t read(GifByteType* dest, size_t size) override {\n size_t endPosition = rangeAdd(m_position, size, m_length);\n size_t readSize = endPosition - m_position;\n if (try_checked_memcpy(\n dest, size, m_pBuffer.data() + m_position, readSize) != 0) {\n return 0; // memcpy error\n } else {\n m_position = endPosition;\n return readSize;\n }\n }\n\n size_t getBufferSize() override {\n return m_length;\n }\n\n size_t getPosition() override {\n return m_position;\n }\n\n bool setPosition(size_t position) override {\n if (position < m_length) {\n m_position = position;\n return true;\n } else {\n return false;\n }\n }\n\n private:\n std::vector m_pBuffer;\n size_t m_position;\n size_t m_length;\n};\n\nclass FileDataWrapper : public DataWrapper {\n public:\n static FileDataWrapper* create(JNIEnv* pEnv, int fd) {\n fd = dup(fd);\n FILE* file = fdopen(fd, \"rb\");\n if (file == nullptr) {\n throwIllegalStateException(\n pEnv, \"Unable to open file: %s\", strerror(errno));\n return nullptr;\n }\n if (fseek(file, 0, SEEK_END) != 0) {\n throwIllegalStateException(\n pEnv, \"Unable to seek to end of file: %s\", strerror(errno));\n return nullptr;\n }\n long size = ftell(file);\n if (size < 0) {\n throwIllegalStateException(\n pEnv, \"Unable to get file size: %s\", strerror(errno));\n return nullptr;\n }\n if (fseek(file, 0, SEEK_SET) != 0) {\n throwIllegalStateException(\n pEnv, \"Unable to seek to beginning of file: %s\", strerror(errno));\n return nullptr;\n }\n return new FileDataWrapper(file, size);\n }\n\n FileDataWrapper(FILE* file, size_t length)\n : DataWrapper(), m_file(file), m_length(length) {}\n\n ~FileDataWrapper() override {\n fclose(m_file);\n }\n\n size_t read(GifByteType* dest, size_t size) override {\n return fread(dest, 1, size, m_file);\n }\n\n size_t getBufferSize() override {\n return m_length;\n }\n\n size_t getPosition() override {\n long position = ftell(m_file);\n return position >= 0 ? position : 0;\n }\n\n bool setPosition(size_t position) override {\n return fseek(m_file, position, SEEK_SET) == 0;\n }\n\n private:\n FILE* m_file;\n size_t m_length;\n};\n\nclass GifWrapper {\n public:\n GifWrapper(\n std::unique_ptr&& pGifFile,\n std::shared_ptr& pData)\n : m_spGifFile(std::move(pGifFile)),\n m_spData(pData),\n m_rasterBits(m_spGifFile->SWidth * m_spGifFile->SHeight) {}\n\n virtual ~GifWrapper() {\n // FBLOGD(\"Deleting GifWrapper\");\n }\n\n GifFileType* get() {\n return m_spGifFile.get();\n }\n\n DataWrapper* getData() {\n return m_spData.get();\n }\n\n void addFrameByteOffset(size_t offset) {\n m_vectorFrameByteOffsets.push_back(offset);\n }\n\n size_t getFrameByteOffset(int frameNum) {\n return m_vectorFrameByteOffsets[frameNum];\n }\n\n size_t getFrameSize() {\n return m_vectorFrameByteOffsets.size();\n }\n\n int getLoopCount() {\n return m_loopCount;\n }\n\n uint8_t* getRasterBits() {\n return m_rasterBits.data();\n }\n\n size_t getRasterBitsCapacity() {\n return m_rasterBits.capacity();\n }\n\n void resizeRasterBuffer(size_t bufferSize) {\n m_rasterBits.resize(bufferSize);\n }\n\n std::mutex& getRasterMutex() {\n return m_rasterMutex;\n }\n\n void setLoopCount(int pLoopCount) {\n m_loopCount = pLoopCount;\n }\n\n bool isAnimated() {\n return m_animated;\n }\n\n void setAnimated(bool animated) {\n m_animated = animated;\n }\n\n RWLock* getSavedImagesRWLock() {\n return &m_savedImagesRWLock;\n }\n\n private:\n int m_loopCount = LOOP_COUNT_MISSING;\n bool m_animated = false;\n std::unique_ptr m_spGifFile;\n std::shared_ptr m_spData;\n std::vector m_vectorFrameByteOffsets;\n std::vector m_rasterBits;\n std::mutex m_rasterMutex;\n mutable RWLock m_savedImagesRWLock;\n};\n\n/**\n * Native context for GifImage.\n */\nstruct GifImageNativeContext {\n /** Reference to the GifWrapper */\n std::shared_ptr spGifWrapper;\n\n /** Cached width of the image */\n int pixelWidth;\n\n /** Cached height of the image */\n int pixelHeight;\n\n /** Cached number of the frames in the image */\n int numFrames;\n\n /** Cached loop count for the image. 0 means infinite. */\n int loopCount;\n\n /** Duration of all the animation (the sum of all the frames duration) */\n int durationMs;\n\n /** Array of each frame's duration (size of array is numFrames) */\n std::vector frameDurationsMs;\n\n /** Reference counter. Instance is deleted when it goes from 1 to 0 */\n size_t refCount;\n\n#if EXTRA_LOGGING\n ~GifImageNativeContext() {\n __android_log_write(\n ANDROID_LOG_DEBUG, LOG_TAG, \"GifImageNativeContext destructor\");\n }\n#endif\n};\n\n/**\n * Native context for GifFrame.\n */\nstruct GifFrameNativeContext {\n /* Reference to the GifWrapper */\n std::shared_ptr spGifWrapper;\n\n /** Frame number for the image. Starts at 0. */\n int frameNum;\n\n /** X offset for the frame relative to the image canvas */\n int xOffset;\n\n /** Y offset for the frame relative to the image canvas */\n int yOffset;\n\n /** Display duration for the frame in ms */\n int durationMs;\n\n /** Width of this frame */\n int width;\n\n /** Height of this frame */\n int height;\n\n /** How the GIF is disposed. See DISPOSAL_* constants in gif_lib.h */\n int disposalMode;\n\n /** Palette index of the transparency color, or -1 for none */\n int transparentIndex;\n\n /** Reference counter. Instance is deleted when it goes from 1 to 0 */\n size_t refCount;\n\n#if EXTRA_LOGGING\n ~GifFrameNativeContext() {\n __android_log_write(\n ANDROID_LOG_DEBUG, LOG_TAG, \"GifFrameNativeContext destructor\");\n }\n#endif\n};\n\n/**\n * giflib takes a callback function for reading from the file.\n */\nstatic int directByteBufferReadFun(\n GifFileType* gifFileType,\n GifByteType* bytes,\n int size) {\n DataWrapper* pData = (DataWrapper*)gifFileType->UserData;\n if (size > 0) {\n return pData->read(bytes, size);\n }\n return 0;\n}\n\n/**\n * Struct to represent a 32-bit ARGB in the correct order.\n */\nstruct PixelType32 {\n uint8_t red;\n uint8_t green;\n uint8_t blue;\n uint8_t alpha;\n};\n\n/**\n * Transparent pixel constant.\n */\nstatic const PixelType32 TRANSPARENT{0, 0, 0, 0};\n\n// Class Names.\nstatic const char* const kGifImageClassPathName =\n \"com/facebook/animated/gif/GifImage\";\nstatic const char* const kGifFrameClassPathName =\n \"com/facebook/animated/gif/GifFrame\";\n\n// Cached fields related to GifImage\nstatic jclass sClazzGifImage;\nstatic jmethodID sGifImageConstructor;\nstatic jfieldID sGifImageFieldNativeContext;\n\n// Cached fields related to GifFrame\nstatic jclass sClazzGifFrame;\nstatic jmethodID sGifFrameConstructor;\nstatic jfieldID sGifFrameFieldNativeContext;\n\n// Static default color map.\nstatic ColorMapObject* sDefaultColorMap;\n\nstatic ColorMapObject* genDefColorMap(void) {\n ColorMapObject* pColorMap = GifMakeMapObject(256, NULL);\n if (pColorMap != NULL) {\n int iColor;\n for (iColor = 0; iColor < 256; iColor++) {\n pColorMap->Colors[iColor].Red = (GifByteType)iColor;\n pColorMap->Colors[iColor].Green = (GifByteType)iColor;\n pColorMap->Colors[iColor].Blue = (GifByteType)iColor;\n }\n }\n return pColorMap;\n}\n\n////////////////////////////////////////////////////////////////\n/// Related to GifImage\n////////////////////////////////////////////////////////////////\n\nbool getGraphicsControlBlockForImage(\n SavedImage* pSavedImage,\n GraphicsControlBlock* pGcp) {\n int resultCode = GIF_ERROR;\n // If a GIF has multiple graphic control extension blocks, we use the last one\n for (int i = 0; i < pSavedImage->ExtensionBlockCount; i++) {\n ExtensionBlock* pExtensionBlock = &pSavedImage->ExtensionBlocks[i];\n if (pExtensionBlock->Function == GRAPHICS_EXT_FUNC_CODE) {\n resultCode = DGifExtensionToGCB(\n pExtensionBlock->ByteCount, pExtensionBlock->Bytes, pGcp);\n }\n }\n return resultCode == GIF_OK;\n}\n\n/**\n * Reads a single frame by reading data using giflib. The method expects the\n data source\n * referenced by pGifFile to point to the first byte of the encoded frame data.\n When the method\n * returns, the data source will point to the byte just past the encoded frame\n data. Unlike standard\n * decoding with giflib, the raster data is written to the passed-in buffer\n instead of being\n * written to the SavedImage structure. This is the key to how we avoid caching\n all the decoded\n * frame pixels in memory.\n *\n * @param pGifWrapper the gif wrapper containing the giflib struct and\n additional data\n * @param decodeFrame if set to true, next frame will be decoded to pGifWrapper\n bits buffer, otherwise it will only decode frame data and skip it\n * @param addToSavedImages if set to true, will add an additional SavedImage to\n * pGifFile->SavedImages\n * @param maxDimension Maximum allowed dimension of each decoded frame\n * @return a gif error code\n */\nint readSingleFrame(\n GifWrapper* pGifWrapper,\n bool decodeFramePixels,\n bool addToSavedImages,\n int maxDimension) {\n GifFileType* pGifFile = pGifWrapper->get();\n\n int imageCount = pGifFile->ImageCount;\n int imageDescResult = GIF_ERROR;\n {\n WriterLock wlock_{pGifWrapper->getSavedImagesRWLock()};\n imageDescResult = DGifGetImageDesc(pGifFile);\n }\n\n // DGifGetImageDesc may have changed the count, temporarily restoring until we\n // know whether the frame was read successfully.\n pGifFile->ImageCount = imageCount;\n\n if (imageDescResult == GIF_ERROR) {\n return GIF_ERROR;\n }\n\n ReaderLock rlock_{pGifWrapper->getSavedImagesRWLock()};\n SavedImage* pSavedImage = &pGifFile->SavedImages[imageCount];\n\n // Check size of image. Note: Frames with 0 width or height should be allowed.\n if (pSavedImage->ImageDesc.Width < 0 || pSavedImage->ImageDesc.Height < 0 ||\n pSavedImage->ImageDesc.Width > maxDimension ||\n pSavedImage->ImageDesc.Height > maxDimension) {\n return GIF_ERROR;\n }\n\n // Check for image size overflow.\n if (pSavedImage->ImageDesc.Height != 0 &&\n pSavedImage->ImageDesc.Width >\n (INT_MAX / pSavedImage->ImageDesc.Height)) {\n return GIF_ERROR;\n }\n\n if (decodeFramePixels) {\n // Reserve larger raster bits buffer if needed\n size_t imageSize =\n pSavedImage->ImageDesc.Width * pSavedImage->ImageDesc.Height;\n pGifWrapper->resizeRasterBuffer(imageSize);\n\n // Decode frame image and save it to temporary raster bits buffer\n uint8_t* pRasterBits = pGifWrapper->getRasterBits();\n if (pSavedImage->ImageDesc.Interlace) {\n // The way an interlaced image should be read - offsets and jumps...\n int interlacedOffset[] = {0, 4, 2, 1};\n int interlacedJumps[] = {8, 8, 4, 2};\n // Need to perform 4 passes on the image.\n for (int i = 0; i < 4; i++) {\n for (int j = interlacedOffset[i]; j < pSavedImage->ImageDesc.Height;\n j += interlacedJumps[i]) {\n GifPixelType* pLine = pRasterBits + j * pSavedImage->ImageDesc.Width;\n int lineLength = pSavedImage->ImageDesc.Width;\n if (DGifGetLine(pGifFile, pLine, lineLength) == GIF_ERROR) {\n return GIF_ERROR;\n }\n }\n }\n } else {\n if (DGifGetLine(pGifFile, pRasterBits, imageSize) == GIF_ERROR) {\n return GIF_ERROR;\n }\n }\n } else {\n // Don't decode. Just read the encoded data to skip past it.\n int codeSize;\n GifByteType* pCodeBlock;\n if (DGifGetCode(pGifFile, &codeSize, &pCodeBlock) == GIF_ERROR) {\n return GIF_ERROR;\n }\n while (pCodeBlock != NULL) {\n if (DGifGetCodeNext(pGifFile, &pCodeBlock) == GIF_ERROR) {\n return GIF_ERROR;\n }\n }\n }\n\n if (pGifFile->ExtensionBlocks) {\n pSavedImage->ExtensionBlocks = pGifFile->ExtensionBlocks;\n pSavedImage->ExtensionBlockCount = pGifFile->ExtensionBlockCount;\n\n pGifFile->ExtensionBlocks = nullptr;\n pGifFile->ExtensionBlockCount = 0;\n }\n\n if (addToSavedImages) {\n // giflib wasn't designed to work with decoding arbitrary frames on the fly.\n // By default, it keeps adding more images to the SavedImages array, and we\n // reset the value after calling DGifGetImageDesc. Now, as the result of\n // decoding is known to be successful, we can increment the value to\n // represent correct number of images.\n pGifFile->ImageCount = imageCount + 1;\n }\n\n return GIF_OK;\n}\n\n/**\n * Decodes an extension as part of modifiedDGifSlurp.\n *\n * @param pGifFile the gif data structure to read to and write to\n * @return a gif error code\n */\nint decodeExtension(GifFileType* pGifFile) {\n GifByteType* pExtData;\n int extFunction;\n\n if (DGifGetExtension(pGifFile, &extFunction, &pExtData) == GIF_ERROR) {\n return GIF_ERROR;\n }\n\n // Create an extension block with our data.\n if (pExtData != nullptr) {\n if (GifAddExtensionBlock(\n &pGifFile->ExtensionBlockCount,\n &pGifFile->ExtensionBlocks,\n extFunction,\n pExtData[0],\n &pExtData[1]) == GIF_ERROR) {\n return GIF_ERROR;\n }\n }\n while (pExtData != nullptr) {\n if (DGifGetExtensionNext(pGifFile, &pExtData) == GIF_ERROR) {\n return GIF_ERROR;\n }\n // Continue the extension block.\n if (pExtData != NULL) {\n if (GifAddExtensionBlock(\n &pGifFile->ExtensionBlockCount,\n &pGifFile->ExtensionBlocks,\n CONTINUE_EXT_FUNC_CODE,\n pExtData[0],\n &pExtData[1]) == GIF_ERROR) {\n return GIF_ERROR;\n }\n }\n }\n return GIF_OK;\n}\n\n/**\n * Tries to parse known application extensions of a given SavedImage and adds\n * the information to the GifWrapper accordingly. Currently, this method only\n * parses the Netscape 2.0 looping extension which can indicate how often a GIF\n * animation shall be played.\n *\n * @param pSavedImage saved image that might contain several ExtensionBlocks\n * @param pGifWrapper gif wrapper containing the giflib struct and additional\n * data\n */\nvoid parseApplicationExtensions(\n SavedImage* pSavedImage,\n GifWrapper* pGifWrapper) {\n const int extensionCount = pSavedImage->ExtensionBlockCount;\n for (int j = 0; j < extensionCount; j++) {\n const ExtensionBlock* extensionBlock = &pSavedImage->ExtensionBlocks[j];\n\n if (extensionBlock->Function != APPLICATION_EXT_FUNC_CODE) {\n continue;\n }\n\n // Check for Netscape 2.0 looping block\n if (extensionBlock->ByteCount == APPLICATION_EXT_NETSCAPE_LEN &&\n strncmp(\n APPLICATION_EXT_NETSCAPE,\n (const char*)extensionBlock->Bytes,\n APPLICATION_EXT_NETSCAPE_LEN) == 0) {\n // The data sub-block has been added as the following extension block\n ExtensionBlock* subBlock = NULL;\n if (j + 1 < extensionCount) {\n subBlock = &pSavedImage->ExtensionBlocks[j + 1];\n }\n\n if (subBlock != NULL && subBlock->Function == CONTINUE_EXT_FUNC_CODE &&\n subBlock->ByteCount == 3) {\n // The loop count is stored little endian\n const int loopCount = subBlock->Bytes[1] | subBlock->Bytes[2] << 8;\n pGifWrapper->setLoopCount(loopCount);\n\n // The looping extension is the only block that we are interested in\n break;\n }\n }\n }\n}\n\n/**\n * A heavily modified version of giflib's DGifSlurp. This uses some hacks to\n * avoid caching the decoded pixel data for each frame in memory. Like\n * DGifSlurp, GifFileType will contain the results of slurping the GIF but there\n * will be no frame pixel data cached in SavedImage.RasterBits.\n *\n * @param pGifWrapper the gif wrapper containing the giflib struct and\n * additional data\n * @param maxDimension Maximum allowed dimension of each frame\n * @param forceStatic whether GIF will be loaded as static image\n * @return a gif error code\n */\nint modifiedDGifSlurp(\n GifWrapper* pGifWrapper,\n int maxDimension,\n bool forceStatic) {\n GifFileType* pGifFile = pGifWrapper->get();\n GifRecordType recordType;\n\n pGifFile->ExtensionBlocks = NULL;\n pGifFile->ExtensionBlockCount = 0;\n bool isStop = false;\n do {\n if (DGifGetRecordType(pGifFile, &recordType) == GIF_ERROR) {\n break;\n }\n\n switch (recordType) {\n case IMAGE_DESC_RECORD_TYPE:\n // Set the flag whether gif is animated, but give up slurping after the\n // first frame, when static image is requested.\n if (pGifFile->ImageCount >= 1) {\n pGifWrapper->setAnimated(true);\n if (forceStatic) {\n isStop = true;\n break;\n }\n }\n\n // We save the byte offset where each frame begins. This allows us to\n // avoid storing the pixel data for each frame and instead decode it on\n // the fly.\n pGifWrapper->addFrameByteOffset(pGifWrapper->getData()->getPosition());\n\n if (readSingleFrame(\n pGifWrapper,\n false, // Don't decode frame pixels\n true, // Add to saved images\n maxDimension // Max dimension\n ) == GIF_ERROR) {\n isStop = true;\n }\n break;\n\n case EXTENSION_RECORD_TYPE:\n if (decodeExtension(pGifFile) == GIF_ERROR) {\n isStop = true;\n }\n break;\n\n case TERMINATE_RECORD_TYPE:\n isStop = true;\n break;\n\n default: // Should be trapped by DGifGetRecordType.\n break;\n }\n } while (!isStop);\n isStop = false;\n\n // parse application extensions\n const int imageCount = pGifFile->ImageCount;\n ReaderLock rlock_{pGifWrapper->getSavedImagesRWLock()};\n for (int i = 0; i < imageCount; i++) {\n parseApplicationExtensions(&pGifFile->SavedImages[i], pGifWrapper);\n }\n\n return pGifWrapper->getFrameSize() > 0 ? GIF_OK : GIF_ERROR;\n}\n\n/**\n * Creates a new GifImage from the specified data.\n *\n * @param spDataWrapper the wrapper providing bytes\n * @param maxDimension Maximum allowed dimension of canvas and each decoded\n * frame\n * @param forceStatic Whether GIF should be decoded as static image\n * @return a newly allocated GifImage\n */\njobject createFromDataWrapper(\n JNIEnv* pEnv,\n std::shared_ptr spDataWrapper,\n int maxDimension,\n bool forceStatic) {\n std::unique_ptr spNativeContext(\n new GifImageNativeContext());\n if (!spNativeContext) {\n throwOutOfMemoryError(pEnv, \"Unable to allocate native context\");\n return 0;\n }\n\n int gifError = 0;\n auto spGifFileIn = std::unique_ptr{\n DGifOpen((void*)spDataWrapper.get(), &directByteBufferReadFun, &gifError),\n DGifCloseFile2};\n\n if (spGifFileIn == nullptr) {\n throwIllegalStateException(pEnv, \"Error %d\", gifError);\n return nullptr;\n }\n\n int width = spGifFileIn->SWidth;\n int height = spGifFileIn->SHeight;\n size_t wxh = width * height;\n if (wxh < 1 || wxh > SIZE_MAX || width > maxDimension ||\n height > maxDimension) {\n throwIllegalStateException(pEnv, \"Invalid dimensions\");\n return nullptr;\n }\n\n // Create the GifWrapper\n spNativeContext->spGifWrapper = std::shared_ptr(\n new GifWrapper(std::move(spGifFileIn), spDataWrapper));\n\n GifFileType* pGifFile = spNativeContext->spGifWrapper->get();\n\n spNativeContext->pixelWidth = width;\n spNativeContext->pixelHeight = height;\n\n int error = modifiedDGifSlurp(\n spNativeContext->spGifWrapper.get(), maxDimension, forceStatic);\n if (error != GIF_OK) {\n throwIllegalStateException(pEnv, \"Failed to slurp image %d\", error);\n return nullptr;\n }\n\n if (pGifFile->ImageCount < 1) {\n throwIllegalStateException(pEnv, \"No frames in image\");\n return nullptr;\n }\n spNativeContext->numFrames = pGifFile->ImageCount;\n\n // Compute cached fields that require iterating the frames.\n int durationMs = 0;\n std::vector frameDurationsMs;\n ReaderLock rlock_{spNativeContext->spGifWrapper->getSavedImagesRWLock()};\n for (int i = 0; i < pGifFile->ImageCount; i++) {\n SavedImage* pSavedImage = &pGifFile->SavedImages[i];\n GraphicsControlBlock gcp;\n if (getGraphicsControlBlockForImage(pSavedImage, &gcp)) {\n int frameDurationMs = gcp.DelayTime * 10;\n durationMs += frameDurationMs;\n frameDurationsMs.push_back(frameDurationMs);\n } else {\n frameDurationsMs.push_back(0);\n }\n }\n spNativeContext->durationMs = durationMs;\n spNativeContext->frameDurationsMs = frameDurationsMs;\n\n // Cache loop count\n spNativeContext->loopCount = spNativeContext->spGifWrapper->getLoopCount();\n\n // Create the GifImage with the native context.\n jobject ret = pEnv->NewObject(\n sClazzGifImage, sGifImageConstructor, (jlong)spNativeContext.get());\n if (ret != nullptr) {\n // Ownership was transferred.\n spNativeContext->refCount = 1;\n spNativeContext.release();\n }\n return ret;\n}\n\n/**\n * Creates a new GifImage from the specified buffer.\n *\n * @param vBuffer the vector containing the bytes\n * @return a newly allocated GifImage\n */\njobject GifImage_nativeCreateFromByteVector(\n JNIEnv* pEnv,\n __ANGLIRU_SOURCE__ std::vector& vBuffer,\n int maxDimension,\n bool forceStatic) {\n // Create the DataWrapper\n std::shared_ptr spDataWrapper =\n std::shared_ptr(new BytesDataWrapper(std::move(vBuffer)));\n return createFromDataWrapper(pEnv, spDataWrapper, maxDimension, forceStatic);\n}\n\n/**\n * Releases a reference to the GifPImageNativeContext and deletes it when the\n * reference count reaches 0\n */\nvoid GifImageNativeContext_releaseRef(\n JNIEnv* pEnv,\n jobject thiz,\n GifImageNativeContext* p) {\n pEnv->MonitorEnter(thiz);\n p->refCount--;\n if (p->refCount == 0) {\n delete p;\n }\n pEnv->MonitorExit(thiz);\n}\n\n/**\n * Functor for getGifImageNativeContext that releases the reference.\n */\nstruct GifImageNativeContextReleaser {\n JNIEnv* pEnv;\n jobject gifImage;\n\n GifImageNativeContextReleaser(JNIEnv* pEnv, jobject gifImage)\n : pEnv(pEnv), gifImage(gifImage) {}\n void operator()(GifImageNativeContext* pNativeContext) {\n GifImageNativeContext_releaseRef(pEnv, gifImage, pNativeContext);\n }\n};\n\n/**\n * Gets the GifImageNativeContext from the mNativeContext of the GifImage\n * object. This returns a reference counted pointer.\n *\n * @return the referenced counted pointer which will be a nullptr in the case\n * where the object has already been disposed\n */\nstd::unique_ptr\ngetGifImageNativeContext(JNIEnv* pEnv, jobject thiz) {\n GifImageNativeContextReleaser releaser(pEnv, thiz);\n std::unique_ptr ret(\n nullptr, releaser);\n pEnv->MonitorEnter(thiz);\n GifImageNativeContext* pNativeContext =\n (GifImageNativeContext*)pEnv->GetLongField(\n thiz, sGifImageFieldNativeContext);\n if (pNativeContext != nullptr) {\n pNativeContext->refCount++;\n ret.reset(pNativeContext);\n }\n pEnv->MonitorExit(thiz);\n return ret;\n}\n\n/**\n * Creates a new GifImage from the specified byte buffer. The data from the byte\n * buffer is copied into native memory managed by GifImage.\n *\n * @param byteBuffer A java.nio.ByteBuffer. Must be direct. Assumes data is the\n * entire capacity of the buffer\n * @param maxDimension Maximum allowed dimension of canvas and each decoded\n * frame\n * @param forceStatic Whether GIF should be decoded as static image\n * @return a newly allocated GifImage\n */\njobject GifImage_nativeCreateFromDirectByteBuffer(\n JNIEnv* pEnv,\n jclass clazz,\n jobject byteBuffer,\n jint maxDimension,\n jboolean forceStatic) {\n jbyte* bbufInput = (jbyte*)pEnv->GetDirectBufferAddress(byteBuffer);\n if (!bbufInput) {\n throwIllegalArgumentException(pEnv, \"ByteBuffer must be direct\");\n return 0;\n }\n\n jlong capacity = pEnv->GetDirectBufferCapacity(byteBuffer);\n if (pEnv->ExceptionCheck()) {\n return 0;\n }\n\n std::vector vBuffer(bbufInput, bbufInput + capacity);\n return GifImage_nativeCreateFromByteVector(\n pEnv, vBuffer, maxDimension, forceStatic);\n}\n\n/**\n * Creates a new GifImage from the specified native pointer. The data is copied\ninto memory managed by GifImage.\n *\n * @param nativePtr the native memory pointer\n * @param sizeInBytes size in bytes of the buffer\n* @param maxDimension Maximum allowed dimension of canvas and each decoded frame\n * @param forceStatic whether GIF will be loaded as static image\n * @return a newly allocated GifImage\n */\njobject GifImage_nativeCreateFromNativeMemory(\n JNIEnv* pEnv,\n jclass clazz,\n jlong nativePtr,\n jint sizeInBytes,\n jint maxDimension,\n jboolean forceStatic) {\n jbyte* const pointer = (jbyte*)nativePtr;\n\n if (sizeInBytes < 0) {\n throwIllegalArgumentException(pEnv, \"Size must be non-negative\");\n return 0;\n }\n\n std::vector vBuffer(pointer, pointer + sizeInBytes);\n return GifImage_nativeCreateFromByteVector(\n pEnv, vBuffer, maxDimension, forceStatic);\n}\n\n/**\n * Creates a new GifImage from the specified byte buffer. The data from the byte\n * buffer is copied into native memory managed by GifImage.\n *\n * @param fileDescriptor File descriptor to open\n * @param maxDimension Maximum allowed dimension of canvas and each decoded\n * frame\n * @param forceStatic Whether GIF should be decoded as static image\n * @return a newly allocated GifImage\n */\njobject GifImage_nativeCreateFromFileDescriptor(\n JNIEnv* pEnv,\n jclass clazz,\n jint fileDescriptor,\n jint maxDimension,\n jboolean forceStatic) {\n // Create the DataWrapper\n std::shared_ptr spDataWrapper =\n std::shared_ptr(\n FileDataWrapper::create(pEnv, fileDescriptor));\n if (pEnv->ExceptionCheck() || !spDataWrapper) {\n return 0;\n }\n return createFromDataWrapper(pEnv, spDataWrapper, maxDimension, forceStatic);\n}\n\n/**\n * Gets the width of the image.\n *\n * @return the width of the image\n */\njint GifImage_nativeGetWidth(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifImageNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return 0;\n }\n return spNativeContext->pixelWidth;\n}\n\n/**\n * Gets the height of the image.\n *\n * @return the height of the image\n */\njint GifImage_nativeGetHeight(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifImageNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return 0;\n }\n return spNativeContext->pixelHeight;\n}\n\n/**\n * Gets the number of frames in the image.\n *\n * @return the number of frames in the image\n */\njint GifImage_nativeGetFrameCount(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifImageNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return 0;\n }\n return spNativeContext->numFrames;\n}\n\n/**\n * Gets the duration of the animated image.\n *\n * @return the duration of the animated image in milliseconds\n */\njint GifImage_nativeGetDuration(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifImageNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return 0;\n }\n return spNativeContext->durationMs;\n}\n\n/**\n * Gets the number of loops to run the animation for.\n *\n * @return the number of loops, or 0 to indicate infinite\n */\njint GifImage_nativeGetLoopCount(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifImageNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return 0;\n }\n return spNativeContext->loopCount;\n}\n\n/**\n * Gets the duration of each frame of the animated image.\n *\n * @return an array that is the size of the number of frames containing the\n * duration of each frame in milliseconds\n */\njintArray GifImage_nativeGetFrameDurations(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifImageNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return NULL;\n }\n jintArray result = pEnv->NewIntArray(spNativeContext->numFrames);\n if (result == nullptr) {\n // pEnv->NewIntArray will have already instructed the environment to throw\n // an exception.\n return nullptr;\n }\n\n pEnv->SetIntArrayRegion(\n result,\n 0,\n spNativeContext->numFrames,\n spNativeContext->frameDurationsMs.data());\n return result;\n}\n\n/**\n * Gets the Frame at the specified index.\n *\n * @param index the index of the frame (0-based)\n * @return a newly created GifFrame for the specified frame\n */\njobject GifImage_nativeGetFrame(JNIEnv* pEnv, jobject thiz, jint index) {\n auto spNativeContext = getGifImageNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return nullptr;\n }\n\n GifFileType* pGifFile = spNativeContext->spGifWrapper->get();\n\n ReaderLock rlock_{spNativeContext->spGifWrapper->getSavedImagesRWLock()};\n\n if (index < 0 || index >= pGifFile->ImageCount) {\n throwIllegalStateException(pEnv, \"Index exceeds GIF file image count\");\n return nullptr;\n }\n\n SavedImage* pSavedImage = &pGifFile->SavedImages[index];\n\n std::unique_ptr spFrameNativeContext(\n new GifFrameNativeContext());\n if (!spFrameNativeContext) {\n throwOutOfMemoryError(pEnv, \"Unable to allocate GifFrameNativeContext\");\n return nullptr;\n }\n\n spFrameNativeContext->spGifWrapper = spNativeContext->spGifWrapper;\n spFrameNativeContext->frameNum = index;\n spFrameNativeContext->xOffset = pSavedImage->ImageDesc.Left;\n spFrameNativeContext->yOffset = pSavedImage->ImageDesc.Top;\n spFrameNativeContext->durationMs = spNativeContext->frameDurationsMs[index];\n spFrameNativeContext->width = pSavedImage->ImageDesc.Width;\n spFrameNativeContext->height = pSavedImage->ImageDesc.Height;\n\n GraphicsControlBlock gcp;\n if (getGraphicsControlBlockForImage(pSavedImage, &gcp)) {\n spFrameNativeContext->transparentIndex = gcp.TransparentColor;\n spFrameNativeContext->disposalMode = gcp.DisposalMode;\n } else {\n spFrameNativeContext->transparentIndex = NO_TRANSPARENT_COLOR;\n spFrameNativeContext->disposalMode = DISPOSAL_UNSPECIFIED;\n }\n\n jobject ret = pEnv->NewObject(\n sClazzGifFrame, sGifFrameConstructor, (jlong)spFrameNativeContext.get());\n if (ret != nullptr) {\n // pEnv->NewObject will have already instructed the environment to throw an\n // exception.\n spFrameNativeContext->refCount = 1;\n spFrameNativeContext.release();\n }\n return ret;\n}\n\n/**\n * Releases a reference to the WebPFrameNativeContext and deletes it when the\n * reference count reaches 0\n */\nvoid GifFrameNativeContext_releaseRef(\n JNIEnv* pEnv,\n jobject thiz,\n GifFrameNativeContext* p) {\n pEnv->MonitorEnter(thiz);\n p->refCount--;\n if (p->refCount == 0) {\n delete p;\n }\n pEnv->MonitorExit(thiz);\n}\n\n/**\n * Functor for getGifFrameNativeContext.\n */\nstruct GifFrameNativeContextReleaser {\n JNIEnv* pEnv;\n jobject gifFrame;\n\n GifFrameNativeContextReleaser(JNIEnv* pEnv, jobject gifFrame)\n : pEnv(pEnv), gifFrame(gifFrame) {}\n void operator()(GifFrameNativeContext* pNativeContext) {\n GifFrameNativeContext_releaseRef(pEnv, gifFrame, pNativeContext);\n }\n};\n\n/**\n * Gets the GifFrameNativeContext from the mNativeContext of the GifFrame\n * object. This returns a reference counted pointer.\n *\n * @return the reference counted pointer which will be a nullptr in the case\n * where the object has already been disposed\n */\nstd::unique_ptr\ngetGifFrameNativeContext(JNIEnv* pEnv, jobject thiz) {\n GifFrameNativeContextReleaser releaser(pEnv, thiz);\n std::unique_ptr ret(\n nullptr, releaser);\n pEnv->MonitorEnter(thiz);\n GifFrameNativeContext* pNativeContext =\n (GifFrameNativeContext*)pEnv->GetLongField(\n thiz, sGifFrameFieldNativeContext);\n if (pNativeContext != nullptr) {\n pNativeContext->refCount++;\n ret.reset(pNativeContext);\n }\n pEnv->MonitorExit(thiz);\n return ret;\n}\n\n/**\n * Gets the size in bytes used by the {@link GifImage}. The implementation only\n * takes into account the encoded data buffer as the other data structures are\n * relatively tiny.\n *\n * @return approximate size in bytes used by the {@link GifImage}\n */\njint GifImage_nativeGetSizeInBytes(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifImageNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return 0;\n }\n\n // This is an approximate amount based on the data buffer and the saved images\n int size = 0;\n size += spNativeContext->spGifWrapper->getData()->getBufferSize();\n size += spNativeContext->spGifWrapper->getRasterBitsCapacity();\n return size;\n}\n\n/**\n * Gets information whether {@link GifImage} is animated (has more than 1\n * frame). It will return `true`, even if animated file was opened as static\n * image.\n *\n * @return whether {@link GifImage} is animated image\n */\njint GifImage_nativeIsAnimated(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifImageNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return 0;\n }\n\n return spNativeContext->spGifWrapper->isAnimated();\n}\n\n/**\n * Disposes the GifImage, freeing native resources.\n */\nvoid GifImage_nativeDispose(JNIEnv* pEnv, jobject thiz) {\n pEnv->MonitorEnter(thiz);\n GifImageNativeContext* pNativeContext =\n (GifImageNativeContext*)pEnv->GetLongField(\n thiz, sGifImageFieldNativeContext);\n if (pNativeContext != nullptr) {\n pEnv->SetLongField(thiz, sGifImageFieldNativeContext, 0);\n GifImageNativeContext_releaseRef(pEnv, thiz, pNativeContext);\n }\n pEnv->MonitorExit(thiz);\n}\n\n/**\n * Finalizer for GifImage that frees native resources.\n */\nvoid GifImage_nativeFinalize(JNIEnv* pEnv, jobject thiz) {\n GifImage_nativeDispose(pEnv, thiz);\n}\n\n////////////////////////////////////////////////////////////////\n/// Related to GifFrame\n////////////////////////////////////////////////////////////////\n\n/**\n * Packs a components of a pixel into a 32-bit PixelType32.\n */\nstatic PixelType32 packARGB32(\n GifByteType alpha,\n GifByteType red,\n GifByteType green,\n GifByteType blue) {\n PixelType32 pixel;\n pixel.alpha = alpha;\n pixel.red = red;\n pixel.green = green;\n pixel.blue = blue;\n return pixel;\n}\n\n/**\n * Gets a color from the color table given an index.\n *\n * @param idx the index of the color\n * @param pColorMap the color map\n * @return a 32-bit pixel\n */\nstatic PixelType32 getColorFromTable(\n unsigned int idx,\n const ColorMapObject* pColorMap) {\n if (pColorMap == NULL) {\n return TRANSPARENT;\n }\n int colIdx = (idx >= pColorMap->ColorCount) ? 0 : idx;\n GifColorType* pColor = &pColorMap->Colors[colIdx];\n return packARGB32(0xFF, pColor->Red, pColor->Green, pColor->Blue);\n}\n\n/**\n * Blits a line of an 8-bit GIF frame to a 32-bit destination performing the\n * color conversion along the way.\n *\n * @param pDest the 32-bit pixel destination to write into\n * @param pSource the 8-bit frame source where values are indices into the color\n * table\n * @param pColorMap the color map\n * @param transparentIndex index to use for the transparent pixel\n * @param width number of pixels to copy\n */\nstatic void blitLine(\n PixelType32* pDest,\n const GifByteType* pSource,\n const ColorMapObject* pColorMap,\n int transparentIndex,\n int width) {\n std::transform(pSource, pSource + width, pDest, [=](uint8_t color) {\n if (color == transparentIndex) {\n return TRANSPARENT;\n }\n return getColorFromTable(color, pColorMap);\n });\n}\n\n/**\n * Blits an 8-bit GIF frame into a 32-bit destination performing the color\n * conversion along the way.\n *\n * @param pDest the byte buffer to write into\n * @param destWidth the width of the destination\n * @param destHeight the height of the destination\n * @param pFrame the frame to read from\n * @param pColorMap the color map\n * @param transparentIndex index to use for the transparent pixel\n */\nstatic void blitNormal(\n uint8_t* pDest,\n int destWidth,\n int destHeight,\n int destStride,\n const SavedImage* pFrame,\n const GifByteType* pSrcRasterBits,\n const ColorMapObject* cmap,\n int transparentIndex) {\n GifWord copyWidth = pFrame->ImageDesc.Width;\n if (copyWidth > destWidth) {\n copyWidth = destWidth;\n }\n\n GifWord copyHeight = pFrame->ImageDesc.Height;\n if (copyHeight > destHeight) {\n copyHeight = destHeight;\n }\n\n for (; copyHeight > 0; copyHeight--) {\n blitLine(\n (PixelType32*)pDest, pSrcRasterBits, cmap, transparentIndex, copyWidth);\n pSrcRasterBits += pFrame->ImageDesc.Width;\n pDest += destStride;\n }\n}\n\n/**\n * Renders the frame to the specified pixel array. The array is expected to have\n * a size that is at least the the width and height of the frame. The frame is\n * rendered where each pixel is represented as a 32-bit BGRA pixel. The rendered\n * stride is the same as the frame width. Note, the number of pixels written to\n * the array may be smaller than the canvas if the frame's width/height is\n * smaller than the canvas.\n *\n * @param jPixels the array to render into\n */\nvoid GifFrame_nativeRenderFrame(\n JNIEnv* pEnv,\n jobject thiz,\n jint width,\n jint height,\n jobject bitmap) {\n auto spNativeContext = getGifFrameNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return;\n }\n\n AndroidBitmapInfo bitmapInfo;\n if (AndroidBitmap_getInfo(pEnv, bitmap, &bitmapInfo) !=\n ANDROID_BITMAP_RESULT_SUCCESS) {\n throwIllegalStateException(pEnv, \"Bad bitmap\");\n return;\n }\n\n if (width < 0 || height < 0) {\n throwIllegalArgumentException(pEnv, \"Width or height is negative\");\n return;\n }\n\n if (bitmapInfo.width < (unsigned)width ||\n bitmapInfo.height < (unsigned)height) {\n throwIllegalStateException(pEnv, \"Width or height is too small\");\n return;\n }\n\n if (bitmapInfo.format != ANDROID_BITMAP_FORMAT_RGBA_8888) {\n throwIllegalStateException(pEnv, \"Wrong color format\");\n return;\n }\n\n GifWrapper* pGifWrapper = spNativeContext->spGifWrapper.get();\n\n // Note, there is some major hackery below since giflib is not intended to\n // incrementally decode arbitrary frames on demand.\n\n // We need to lock because the raster data and the data offset are shared\n // resources and only one thread can use them at a time.\n std::unique_lock lock(pGifWrapper->getRasterMutex());\n\n // We set the data buffer that giflib will read from to be at the beginning of\n // where the encoded data for the frame starts. We know this offset because we\n // stored it when we originally decoded the GIF.\n int frameNum = spNativeContext->frameNum;\n int byteOffset = pGifWrapper->getFrameByteOffset(frameNum);\n if (!pGifWrapper->getData()->setPosition(byteOffset)) {\n // Unable to position to frame, ignore it\n return;\n }\n\n // Now we kick off the decoding process.\n int readRes = readSingleFrame(\n pGifWrapper,\n true, // Decode frame pixels\n false, // Don't add frame to saved images\n INT_MAX // Don't limit the size, it was checked in modifiedDGifSlurp\n );\n if (readRes != GIF_OK) {\n // Probably, broken canvas, and we can ignore it\n return;\n }\n\n // Get the right color table to use.\n ColorMapObject* pColorMap = spNativeContext->spGifWrapper->get()->SColorMap;\n ReaderLock rlock_{pGifWrapper->getSavedImagesRWLock()};\n SavedImage* pSavedImage = &pGifWrapper->get()->SavedImages[frameNum];\n if (pSavedImage->ImageDesc.ColorMap != NULL) {\n // use local color table\n pColorMap = pSavedImage->ImageDesc.ColorMap;\n if (pColorMap->ColorCount != (1 << pColorMap->BitsPerPixel)) {\n pColorMap = sDefaultColorMap;\n }\n }\n\n uint8_t* pixels;\n if (AndroidBitmap_lockPixels(pEnv, bitmap, (void**)&pixels) !=\n ANDROID_BITMAP_RESULT_SUCCESS) {\n throwIllegalStateException(pEnv, \"Bad bitmap\");\n return;\n }\n blitNormal(\n pixels,\n width,\n height,\n bitmapInfo.stride,\n pSavedImage,\n spNativeContext->spGifWrapper->getRasterBits(),\n pColorMap,\n spNativeContext->transparentIndex);\n AndroidBitmap_unlockPixels(pEnv, bitmap);\n}\n\n/**\n * Gets the duration of the frame.\n *\n * @return the duration of the frame in milliseconds\n */\njint GifFrame_nativeGetDurationMs(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifFrameNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return -1;\n }\n return spNativeContext->durationMs;\n}\n\n/**\n * Gets the color (as an int, as in Android) of the transparent pixel of this\n * frame\n *\n * @return the color (as an int, as in Android) of the transparent pixel of this\n * frame\n */\njint GifFrame_nativeGetTransparentPixelColor(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifFrameNativeContext(pEnv, thiz);\n auto pGifWrapper = spNativeContext->spGifWrapper;\n\n //\n // Get the right color table to use, then get index of transparent pixel into\n // that table\n //\n int frameNum = spNativeContext->frameNum;\n ColorMapObject* pColorMap = pGifWrapper->get()->SColorMap;\n ReaderLock rlock_{pGifWrapper->getSavedImagesRWLock()};\n SavedImage* pSavedImage = &pGifWrapper->get()->SavedImages[frameNum];\n\n if (pSavedImage->ImageDesc.ColorMap != NULL) {\n // use local color table\n pColorMap = pSavedImage->ImageDesc.ColorMap;\n if (pColorMap->ColorCount != (1 << pColorMap->BitsPerPixel)) {\n pColorMap = sDefaultColorMap;\n }\n }\n\n int colorIndex = spNativeContext->transparentIndex;\n\n if (pColorMap != NULL && colorIndex >= 0) {\n PixelType32 color = getColorFromTable(colorIndex, pColorMap);\n\n //\n // convert PixelType32 to Android-style int color value.\n // the c++ compiler will optimize these four lines of bit-shifting -- there\n // is no need to collapse them into a single confusing expression\n //\n int alphaShifted = color.alpha << 24;\n int redShifted = color.red << 16;\n int greenShifted = color.green << 8;\n int blueShifted = color.blue << 0;\n\n int iColor = alphaShifted | redShifted | greenShifted | blueShifted;\n\n return iColor;\n } else {\n return 0; // in android, 0 == Color.TRANSPARENT\n }\n}\n\njboolean GifFrame_nativeHasTransparency(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifFrameNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return -1;\n }\n return spNativeContext->transparentIndex >= 0;\n}\n\n/**\n * Gets the width of the frame.\n *\n * @return the width of the frame\n */\njint GifFrame_nativeGetWidth(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifFrameNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return -1;\n }\n return spNativeContext->width;\n}\n\n/**\n * Gets the height of the frame.\n *\n * @return the height of the frame\n */\njint GifFrame_nativeGetHeight(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifFrameNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return -1;\n }\n return spNativeContext->height;\n}\n\n/**\n * Gets the x-offset of the frame relative to the image canvas.\n *\n * @return the x-offset of the frame\n */\njint GifFrame_nativeGetXOffset(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifFrameNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return -1;\n }\n return spNativeContext->xOffset;\n}\n\n/**\n * Gets the y-offset of the frame relative to the image canvas.\n *\n * @return the y-offset of the frame\n */\njint GifFrame_nativeGetYOffset(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifFrameNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return -1;\n }\n return spNativeContext->yOffset;\n}\n\n/**\n * Gets the constant of the disposal mode for the frame.\n *\n * @return one of the GIF disposal mode constants\n */\njint GifFrame_nativeGetDisposalMode(JNIEnv* pEnv, jobject thiz) {\n auto spNativeContext = getGifFrameNativeContext(pEnv, thiz);\n if (!spNativeContext) {\n throwIllegalStateException(pEnv, \"Already disposed\");\n return -1;\n }\n return spNativeContext->disposalMode;\n}\n\n/**\n * Disposes the GifFrame, freeing native resources.\n */\nvoid GifFrame_nativeDispose(JNIEnv* pEnv, jobject thiz) {\n pEnv->MonitorEnter(thiz);\n GifFrameNativeContext* pNativeContext =\n (GifFrameNativeContext*)pEnv->GetLongField(\n thiz, sGifFrameFieldNativeContext);\n if (pNativeContext) {\n pEnv->SetLongField(thiz, sGifFrameFieldNativeContext, 0);\n GifFrameNativeContext_releaseRef(pEnv, thiz, pNativeContext);\n }\n pEnv->MonitorExit(thiz);\n}\n\n/**\n * Finalizer for GifFrame that frees native resources.\n */\nvoid GifFrame_nativeFinalize(JNIEnv* pEnv, jobject thiz) {\n GifFrame_nativeDispose(pEnv, thiz);\n}\n\nstatic JNINativeMethod sGifImageMethods[] = {\n {\"nativeCreateFromDirectByteBuffer\",\n \"(Ljava/nio/ByteBuffer;IZ)Lcom/facebook/animated/gif/GifImage;\",\n (void*)GifImage_nativeCreateFromDirectByteBuffer},\n {\"nativeCreateFromNativeMemory\",\n \"(JIIZ)Lcom/facebook/animated/gif/GifImage;\",\n (void*)GifImage_nativeCreateFromNativeMemory},\n {\"nativeCreateFromFileDescriptor\",\n \"(IIZ)Lcom/facebook/animated/gif/GifImage;\",\n (void*)GifImage_nativeCreateFromFileDescriptor},\n {\"nativeGetWidth\", \"()I\", (void*)GifImage_nativeGetWidth},\n {\"nativeGetHeight\", \"()I\", (void*)GifImage_nativeGetHeight},\n {\"nativeGetDuration\", \"()I\", (void*)GifImage_nativeGetDuration},\n {\"nativeGetFrameCount\", \"()I\", (void*)GifImage_nativeGetFrameCount},\n {\"nativeGetFrameDurations\",\n \"()[I\",\n (void*)GifImage_nativeGetFrameDurations},\n {\"nativeGetLoopCount\", \"()I\", (void*)GifImage_nativeGetLoopCount},\n {\"nativeGetFrame\",\n \"(I)Lcom/facebook/animated/gif/GifFrame;\",\n (void*)GifImage_nativeGetFrame},\n {\"nativeGetSizeInBytes\", \"()I\", (void*)GifImage_nativeGetSizeInBytes},\n {\"nativeIsAnimated\", \"()Z\", (void*)GifImage_nativeIsAnimated},\n {\"nativeDispose\", \"()V\", (void*)GifImage_nativeDispose},\n {\"nativeFinalize\", \"()V\", (void*)GifImage_nativeFinalize}};\n\nstatic JNINativeMethod sGifFrameMethods[] = {\n {\"nativeRenderFrame\",\n \"(IILandroid/graphics/Bitmap;)V\",\n (void*)GifFrame_nativeRenderFrame},\n {\"nativeGetDurationMs\", \"()I\", (void*)GifFrame_nativeGetDurationMs},\n {\"nativeGetWidth\", \"()I\", (void*)GifFrame_nativeGetWidth},\n {\"nativeGetHeight\", \"()I\", (void*)GifFrame_nativeGetHeight},\n {\"nativeGetXOffset\", \"()I\", (void*)GifFrame_nativeGetXOffset},\n {\"nativeGetYOffset\", \"()I\", (void*)GifFrame_nativeGetYOffset},\n {\"nativeGetTransparentPixelColor\",\n \"()I\",\n (void*)GifFrame_nativeGetTransparentPixelColor},\n {\"nativeHasTransparency\", \"()Z\", (void*)GifFrame_nativeHasTransparency},\n {\"nativeGetDisposalMode\", \"()I\", (void*)GifFrame_nativeGetDisposalMode},\n {\"nativeDispose\", \"()V\", (void*)GifFrame_nativeDispose},\n {\"nativeFinalize\", \"()V\", (void*)GifFrame_nativeFinalize},\n};\n\n/**\n * Called by JNI_OnLoad to initialize the classes.\n */\nint initGifImage(JNIEnv* pEnv) {\n // GifImage\n sClazzGifImage = findClassOrThrow(pEnv, kGifImageClassPathName);\n if (sClazzGifImage == NULL) {\n return JNI_ERR;\n }\n\n // GifImage.mNativeContext\n sGifImageFieldNativeContext =\n getFieldIdOrThrow(pEnv, sClazzGifImage, \"mNativeContext\", \"J\");\n if (!sGifImageFieldNativeContext) {\n return JNI_ERR;\n }\n\n // GifImage.\n sGifImageConstructor =\n getMethodIdOrThrow(pEnv, sClazzGifImage, \"\", \"(J)V\");\n if (!sGifImageConstructor) {\n return JNI_ERR;\n }\n\n int result = pEnv->RegisterNatives(\n sClazzGifImage,\n sGifImageMethods,\n std::extent::value);\n if (result != JNI_OK) {\n return result;\n }\n\n // GifFrame\n sClazzGifFrame = findClassOrThrow(pEnv, kGifFrameClassPathName);\n if (sClazzGifFrame == NULL) {\n return JNI_ERR;\n }\n\n // GifFrame.mNativeContext\n sGifFrameFieldNativeContext =\n getFieldIdOrThrow(pEnv, sClazzGifFrame, \"mNativeContext\", \"J\");\n if (!sGifFrameFieldNativeContext) {\n return JNI_ERR;\n }\n\n // GifFrame.\n sGifFrameConstructor =\n getMethodIdOrThrow(pEnv, sClazzGifFrame, \"\", \"(J)V\");\n if (!sGifFrameConstructor) {\n return JNI_ERR;\n }\n\n result = pEnv->RegisterNatives(\n sClazzGifFrame,\n sGifFrameMethods,\n std::extent::value);\n if (result != JNI_OK) {\n return result;\n }\n\n sDefaultColorMap = genDefColorMap();\n\n return JNI_OK;\n}\n" }, { "path": "animated-gif/src/main/jni/gifimage/jni_helpers.cpp", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\n#include \n#include \n#include \n\n#define MSG_SIZE 1024\n\nnamespace facebook {\n\n/**\n * Instructs the JNI environment to throw an exception.\n *\n * @param pEnv JNI environment\n * @param szClassName class name to throw\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwException(\n JNIEnv* pEnv,\n const char* szClassName,\n const char* szFmt,\n va_list va_args) {\n char szMsg[MSG_SIZE];\n vsnprintf(szMsg, MSG_SIZE, szFmt, va_args);\n jclass exClass = pEnv->FindClass(szClassName);\n return pEnv->ThrowNew(exClass, szMsg);\n}\n\n/**\n * Instructs the JNI environment to throw a NoClassDefFoundError.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwNoClassDefError(JNIEnv* pEnv, const char* szFmt, ...) {\n va_list va_args;\n va_start(va_args, szFmt);\n jint ret =\n throwException(pEnv, \"java/lang/NoClassDefFoundError\", szFmt, va_args);\n va_end(va_args);\n return ret;\n}\n\n/**\n * Instructs the JNI environment to throw a RuntimeException.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwRuntimeException(JNIEnv* pEnv, const char* szFmt, ...) {\n va_list va_args;\n va_start(va_args, szFmt);\n jint ret = throwException(pEnv, \"java/lang/RuntimeException\", szFmt, va_args);\n va_end(va_args);\n return ret;\n}\n\n/**\n * Instructs the JNI environment to throw an IllegalArgumentException.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwIllegalArgumentException(JNIEnv* pEnv, const char* szFmt, ...) {\n va_list va_args;\n va_start(va_args, szFmt);\n jint ret = throwException(\n pEnv, \"java/lang/IllegalArgumentException\", szFmt, va_args);\n va_end(va_args);\n return ret;\n}\n\n/**\n * Instructs the JNI environment to throw an IllegalStateException.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwIllegalStateException(JNIEnv* pEnv, const char* szFmt, ...) {\n va_list va_args;\n va_start(va_args, szFmt);\n jint ret =\n throwException(pEnv, \"java/lang/IllegalStateException\", szFmt, va_args);\n va_end(va_args);\n return ret;\n}\n\n/**\n * Instructs the JNI environment to throw an OutOfMemoryError.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwOutOfMemoryError(JNIEnv* pEnv, const char* szFmt, ...) {\n va_list va_args;\n va_start(va_args, szFmt);\n jint ret = throwException(pEnv, \"java/lang/OutOfMemoryError\", szFmt, va_args);\n va_end(va_args);\n return ret;\n}\n\n/**\n * Instructs the JNI environment to throw an AssertionError.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwAssertionError(JNIEnv* pEnv, const char* szFmt, ...) {\n va_list va_args;\n va_start(va_args, szFmt);\n jint ret = throwException(pEnv, \"java/lang/AssertionError\", szFmt, va_args);\n va_end(va_args);\n return ret;\n}\n\n/**\n * Instructs the JNI environment to throw an IOException.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwIOException(JNIEnv* pEnv, const char* szFmt, ...) {\n va_list va_args;\n va_start(va_args, szFmt);\n jint ret = throwException(pEnv, \"java/io/IOException\", szFmt, va_args);\n va_end(va_args);\n return ret;\n}\n\n/**\n * Finds the specified class. If it's not found, instructs the JNI environment\n * to throw an exception.\n *\n * @param pEnv JNI environment\n * @param szClassName the classname to find in JNI format (e.g.\n * \"java/lang/String\")\n * @return the class or NULL if not found (in which case a pending exception\n * will be queued). This returns a global reference (JNIEnv::NewGlobalRef).\n */\njclass findClassOrThrow(JNIEnv* pEnv, const char* szClassName) {\n jclass clazz = pEnv->FindClass(szClassName);\n if (!clazz) {\n return NULL;\n }\n return (jclass)pEnv->NewGlobalRef(clazz);\n}\n\n/**\n * Finds the specified field of the specified class. If it's not found,\n * instructs the JNI environment to throw an exception.\n *\n * @param pEnv JNI environment\n * @param clazz the class to lookup the field in\n * @param szFieldName the name of the field to find\n * @param szSig the signature of the field\n * @return the field or NULL if not found (in which case a pending exception\n * will be queued)\n */\njfieldID getFieldIdOrThrow(\n JNIEnv* pEnv,\n jclass clazz,\n const char* szFieldName,\n const char* szSig) {\n return pEnv->GetFieldID(clazz, szFieldName, szSig);\n}\n\n/**\n * Finds the specified method of the specified class. If it's not found,\n * instructs the JNI environment to throw an exception.\n *\n * @param pEnv JNI environment\n * @param clazz the class to lookup the method in\n * @param szMethodName the name of the method to find\n * @param szSig the signature of the method\n * @return the method or NULL if not found (in which case a pending exception\n * will be queued)\n */\njmethodID getMethodIdOrThrow(\n JNIEnv* pEnv,\n jclass clazz,\n const char* szMethodName,\n const char* szSig) {\n return pEnv->GetMethodID(clazz, szMethodName, szSig);\n}\n\n} // namespace facebook\n" }, { "path": "animated-gif/src/main/jni/gifimage/jni_helpers.h", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\n#pragma once\n\n#include \n\n#include \n\nnamespace facebook {\n\n/**\n * Instructs the JNI environment to throw an exception.\n *\n * @param pEnv JNI environment\n * @param szClassName class name to throw\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwException(\n JNIEnv* pEnv,\n const char* szClassName,\n const char* szFmt,\n va_list va_args);\n\n/**\n * Instructs the JNI environment to throw a NoClassDefFoundError.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwNoClassDefError(JNIEnv* pEnv, const char* szFmt, ...);\n\n/**\n * Instructs the JNI environment to throw a RuntimeException.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwRuntimeException(JNIEnv* pEnv, const char* szFmt, ...);\n\n/**\n * Instructs the JNI environment to throw a IllegalArgumentException.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwIllegalArgumentException(JNIEnv* pEnv, const char* szFmt, ...);\n\n/**\n * Instructs the JNI environment to throw a IllegalStateException.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwIllegalStateException(JNIEnv* pEnv, const char* szFmt, ...);\n\n/**\n * Instructs the JNI environment to throw an IOException.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwIOException(JNIEnv* pEnv, const char* szFmt, ...);\n\n/**\n * Instructs the JNI environment to throw an AssertionError.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwAssertionError(JNIEnv* pEnv, const char* szFmt, ...);\n\n/**\n * Instructs the JNI environment to throw an OutOfMemoryError.\n *\n * @param pEnv JNI environment\n * @param szFmt sprintf-style format string\n * @param ... sprintf-style args\n * @return 0 on success; a negative value on failure\n */\njint throwOutOfMemoryError(JNIEnv* pEnv, const char* szFmt, ...);\n\n/**\n * Finds the specified class. If it's not found, instructs the JNI environment\n * to throw an exception.\n *\n * @param pEnv JNI environment\n * @param szClassName the classname to find in JNI format (e.g.\n * \"java/lang/String\")\n * @return the class or NULL if not found (in which case a pending exception\n * will be queued). This returns a global reference (JNIEnv::NewGlobalRef).\n */\njclass findClassOrThrow(JNIEnv* pEnv, const char* szClassName);\n\n/**\n * Finds the specified field of the specified class. If it's not found,\n * instructs the JNI environment to throw an exception.\n *\n * @param pEnv JNI environment\n * @param clazz the class to lookup the field in\n * @param szFieldName the name of the field to find\n * @param szSig the signature of the field\n * @return the field or NULL if not found (in which case a pending exception\n * will be queued)\n */\njfieldID getFieldIdOrThrow(\n JNIEnv* pEnv,\n jclass clazz,\n const char* szFieldName,\n const char* szSig);\n\n/**\n * Finds the specified method of the specified class. If it's not found,\n * instructs the JNI environment to throw an exception.\n *\n * @param pEnv JNI environment\n * @param clazz the class to lookup the method in\n * @param szMethodName the name of the method to find\n * @param szSig the signature of the method\n * @return the method or NULL if not found (in which case a pending exception\n * will be queued)\n */\njmethodID getMethodIdOrThrow(\n JNIEnv* pEnv,\n jclass clazz,\n const char* szMethodName,\n const char* szSig);\n\n} // namespace facebook\n" }, { "path": "animated-gif/src/main/jni/gifimage/locks.h", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\n#pragma once\n\n#include \n#include \n#include \n\nclass RWLock {\n public:\n RWLock() : mutex_(PTHREAD_RWLOCK_INITIALIZER) {};\n // No copying allowed\n RWLock(const RWLock&) = delete;\n void operator=(const RWLock&) = delete;\n\n ~RWLock() {\n pthread_rwlock_destroy(&mutex_);\n };\n\n inline int ReadLock() {\n return pthread_rwlock_rdlock(&mutex_);\n };\n\n inline int ReadUnlock() {\n return pthread_rwlock_unlock(&mutex_);\n };\n\n inline int WriteLock() {\n return pthread_rwlock_wrlock(&mutex_);\n }\n\n inline int WriteUnlock() {\n return pthread_rwlock_unlock(&mutex_);\n }\n\n private:\n pthread_rwlock_t mutex_;\n};\n\nclass ReaderLock {\n private:\n RWLock* rlock_;\n\n public:\n inline explicit ReaderLock(RWLock* rlock) : rlock_(rlock) {\n int ret = rlock_->ReadLock();\n if (ret != 0) {\n __android_log_print(\n ANDROID_LOG_ERROR,\n LOG_TAG,\n \"pthread_rwlock_rdlock returned %s\",\n strerror(ret));\n }\n }\n\n inline ~ReaderLock() {\n int ret = rlock_->ReadUnlock();\n if (ret != 0) {\n __android_log_print(\n ANDROID_LOG_ERROR,\n LOG_TAG,\n \"pthread_rwlock_unlock read returned %s\",\n strerror(ret));\n }\n }\n};\n\nclass WriterLock {\n private:\n RWLock* wlock_;\n\n public:\n inline explicit WriterLock(RWLock* wlock) : wlock_(wlock) {\n int ret = wlock_->WriteLock();\n if (ret != 0) {\n __android_log_print(\n ANDROID_LOG_ERROR,\n LOG_TAG,\n \"pthread_rwlock_wrlock returned %s\",\n strerror(ret));\n }\n }\n\n inline ~WriterLock() {\n int ret = wlock_->WriteUnlock();\n if (ret != 0) {\n __android_log_print(\n ANDROID_LOG_ERROR,\n LOG_TAG,\n \"pthread_rwlock_unlock write returned %s\",\n strerror(ret));\n }\n }\n};\n" }, { "path": "animated-gif/src/main/jni/gifimage/secure_memcpy.h", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\n#define ERR_POTENTIAL_BUFFER_OVERFLOW 34 // matches with ERANGE in errno.h\n\n/**\n * Bounds checking (i.e. destination) wrapper for std::memcpy. This version adds\n * bounds checking capability and returns an error code if there's any potential\n * buffer overflow detected. Error handling is mandatory. Note that using this\n * function without error handling does not guarantee security.\n *\n * @param destination\n * Pointer to the destination where the content is to be copied.\n * @param destination_size\n * Max number of bytes to modify in the destination (typically the size of\n * the destination buffer).\n * @param source\n * Pointer to the source of data to be copied.\n * @param count\n * Number of bytes to copy.\n * @return int\n * Returns zero on success and non-zero value on error.\n */\n__attribute__((warn_unused_result)) inline int try_checked_memcpy(\n void* destination,\n size_t destination_size,\n const void* source,\n size_t count) {\n if (destination_size < count) {\n return ERR_POTENTIAL_BUFFER_OVERFLOW;\n }\n memcpy(destination, source, count);\n return 0;\n}\n" }, { "path": "animated-gif/src/main/jni/third-party/giflib/Android.mk", "content": "LOCAL_PATH := $(call my-dir)\n\ninclude $(CLEAR_VARS)\nLOCAL_CFLAGS := -DHAVE_CONFIG_H\nLOCAL_MODULE := gif\nLOCAL_SRC_FILES := \\\n\tdgif_lib.c \\\n\tgifalloc.c \\\n\topenbsd-reallocarray.c\nLOCAL_EXPORT_C_INCLUDES := $(LOCAL_PATH)\ninclude $(BUILD_STATIC_LIBRARY)\n" }, { "path": "animated-gif/src/test/java/com/facebook/animated/gif/GifImageDecoderTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.gif\n\nimport android.graphics.Bitmap\nimport com.facebook.common.memory.PooledByteBuffer\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.common.references.ResourceReleaser\nimport com.facebook.imageformat.ImageFormat\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult\nimport com.facebook.imagepipeline.animated.impl.AnimatedImageCompositor\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.common.ImageDecodeOptions\nimport com.facebook.imagepipeline.image.CloseableAnimatedImage\nimport com.facebook.imagepipeline.image.CloseableStaticBitmap\nimport com.facebook.imagepipeline.image.EncodedImage\nimport com.facebook.imagepipeline.image.ImmutableQualityInfo\nimport com.facebook.imagepipeline.testing.MockBitmapFactory\nimport com.facebook.imagepipeline.testing.TrivialBufferPooledByteBuffer\nimport com.facebook.imagepipeline.testing.TrivialPooledByteBuffer\nimport java.io.ByteArrayOutputStream\nimport java.io.IOException\nimport java.nio.ByteBuffer\nimport org.assertj.core.api.Assertions.assertThat\nimport org.assertj.core.api.Assertions.assertThatThrownBy\nimport org.junit.After\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.ArgumentMatchers\nimport org.mockito.MockedConstruction\nimport org.mockito.MockedStatic\nimport org.mockito.Mockito\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.times\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.verifyNoMoreInteractions\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\n\n/** Tests for [GifImageDecoder] */\n@RunWith(RobolectricTestRunner::class)\nclass GifImageDecoderTest {\n private var mockBitmapFactory: PlatformBitmapFactory? = null\n private var gifImageDecoder: GifImageDecoder? = null\n\n private var gifImageStaticMock: MockedStatic? = null\n\n @Before\n fun setup() {\n gifImageStaticMock = Mockito.mockStatic(GifImage::class.java)\n\n mockBitmapFactory = mock()\n\n val bitmapFactory = mockBitmapFactory\n if (bitmapFactory != null) {\n gifImageDecoder =\n GifImageDecoder(\n bitmapFactory,\n isNewRenderImplementation = false,\n downscaleFrameToDrawableDimensions = false,\n treatAnimatedImagesAsStateful = true,\n )\n }\n }\n\n @After\n fun tearDown() {\n gifImageStaticMock?.close()\n }\n\n @Test\n fun testCreateDefaultsUsingPointer() {\n val mockGifImage: GifImage? = mock()\n\n // Expect a call to GifImage.createFromNativeMemory\n val byteBuffer: TrivialPooledByteBuffer = createByteBuffer()\n whenever(\n GifImage.createFromNativeMemory(\n ArgumentMatchers.eq(byteBuffer.nativePtr),\n ArgumentMatchers.eq(byteBuffer.size()),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockGifImage)\n\n testCreateDefaults(mockGifImage, byteBuffer)\n }\n\n @Test\n fun testCreateDefaultsUsingByteBuffer() {\n val mockGifImage: GifImage? = mock()\n\n // Expect a call to GifImage.createFromByteBuffer\n val byteBuffer: TrivialBufferPooledByteBuffer = createDirectByteBuffer()\n whenever(\n GifImage.createFromByteBuffer(\n ArgumentMatchers.eq(byteBuffer.byteBuffer),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockGifImage)\n\n testCreateDefaults(mockGifImage, byteBuffer)\n }\n\n @Test\n @Throws(Exception::class)\n fun testCreateWithPreviewBitmapUsingPointer() {\n val mockGifImage: GifImage = mock()\n val mockBitmap: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n\n // Expect a call to GifImage.createFromNativeMemory\n val byteBuffer: TrivialPooledByteBuffer = createByteBuffer()\n whenever(\n GifImage.createFromNativeMemory(\n ArgumentMatchers.eq(byteBuffer.nativePtr),\n ArgumentMatchers.eq(byteBuffer.size()),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockGifImage)\n whenever(mockGifImage.getWidth()).thenReturn(50)\n whenever(mockGifImage.getHeight()).thenReturn(50)\n whenever(mockGifImage.getFrameCount()).thenReturn(1)\n whenever(mockGifImage.getFrameDurations()).thenReturn(intArrayOf(100))\n\n testCreateWithPreviewBitmap(mockGifImage, mockBitmap, byteBuffer)\n }\n\n @Test\n @Throws(Exception::class)\n fun testCreateWithPreviewBitmapUsingByteBuffer() {\n val mockGifImage: GifImage = mock()\n val mockBitmap: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n\n // Expect a call to GifImage.createFromByteBuffer\n val byteBuffer: TrivialBufferPooledByteBuffer = createDirectByteBuffer()\n whenever(\n GifImage.createFromByteBuffer(\n ArgumentMatchers.eq(byteBuffer.byteBuffer),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockGifImage)\n whenever(mockGifImage.getWidth()).thenReturn(50)\n whenever(mockGifImage.getHeight()).thenReturn(50)\n whenever(mockGifImage.getFrameCount()).thenReturn(1)\n whenever(mockGifImage.getFrameDurations()).thenReturn(intArrayOf(100))\n\n testCreateWithPreviewBitmap(mockGifImage, mockBitmap, byteBuffer)\n }\n\n @Test\n @Throws(Exception::class)\n fun testCreateWithDecodeAlFramesUsingPointer() {\n val mockGifImage: GifImage = mock()\n\n val mockBitmap1: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n val mockBitmap2: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n\n // Expect a call to GifImage.createFromNativeMemory\n val byteBuffer: TrivialPooledByteBuffer = createByteBuffer()\n whenever(\n GifImage.createFromNativeMemory(\n ArgumentMatchers.eq(byteBuffer.nativePtr),\n ArgumentMatchers.eq(byteBuffer.size()),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockGifImage)\n whenever(mockGifImage.getWidth()).thenReturn(50)\n whenever(mockGifImage.getHeight()).thenReturn(50)\n whenever(mockGifImage.getFrameCount()).thenReturn(2)\n whenever(mockGifImage.getFrameDurations()).thenReturn(intArrayOf(100, 150))\n\n testCreateWithDecodeAllFrames(mockGifImage, mockBitmap1, mockBitmap2, byteBuffer)\n }\n\n @Test\n @Throws(Exception::class)\n fun testCreateWithDecodeAlFramesUsingByteBuffer() {\n val mockGifImage: GifImage = mock()\n\n val mockBitmap1: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n val mockBitmap2: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n\n // Expect a call to GifImage.createFromByteBuffer\n val byteBuffer: TrivialBufferPooledByteBuffer = createDirectByteBuffer()\n whenever(\n GifImage.createFromByteBuffer(\n ArgumentMatchers.eq(byteBuffer.byteBuffer),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockGifImage)\n whenever(mockGifImage.getWidth()).thenReturn(50)\n whenever(mockGifImage.getHeight()).thenReturn(50)\n whenever(mockGifImage.getFrameCount()).thenReturn(2)\n whenever(mockGifImage.getFrameDurations()).thenReturn(intArrayOf(100, 150))\n\n testCreateWithDecodeAllFrames(mockGifImage, mockBitmap1, mockBitmap2, byteBuffer)\n }\n\n private fun testCreateDefaults(mockGifImage: GifImage?, byteBuffer: PooledByteBuffer) {\n val encodedImage: EncodedImage =\n EncodedImage(CloseableReference.of(byteBuffer, FAKE_RESOURCE_RELEASER))\n encodedImage.setImageFormat(ImageFormat.UNKNOWN)\n\n val closeableImage: CloseableAnimatedImage? =\n gifImageDecoder?.decode(\n encodedImage,\n byteBuffer.size(),\n ImmutableQualityInfo.FULL_QUALITY,\n ImageDecodeOptions.defaults(),\n ) as? CloseableAnimatedImage\n\n // Verify we got the right result\n val imageResult: AnimatedImageResult? = closeableImage?.getImageResult()\n assertThat(imageResult?.getImage()).isSameAs(mockGifImage)\n assertThat(imageResult?.getPreviewBitmap()).isNull()\n assertThat(imageResult?.hasDecodedFrame(0) ?: false).isFalse()\n\n // Should not have interacted with these.\n mockBitmapFactory?.let { Mockito.verifyNoInteractions(it) }\n }\n\n @Throws(Exception::class)\n private fun testCreateWithPreviewBitmap(\n mockGifImage: GifImage?,\n mockBitmap: Bitmap,\n byteBuffer: PooledByteBuffer,\n ) {\n whenever(mockBitmapFactory?.createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG))\n .thenReturn(CloseableReference.of(mockBitmap, FAKE_BITMAP_RESOURCE_RELEASER))\n\n Mockito.mockConstruction(AnimatedImageCompositor::class.java).use {\n animatedImageCompositorConstruction: MockedConstruction ->\n val imageDecodeOptions: ImageDecodeOptions =\n ImageDecodeOptions.newBuilder().setDecodePreviewFrame(true).build()\n val encodedImage: EncodedImage =\n EncodedImage(CloseableReference.of(byteBuffer, FAKE_RESOURCE_RELEASER))\n encodedImage.setImageFormat(ImageFormat.UNKNOWN)\n val closeableImage: CloseableAnimatedImage? =\n gifImageDecoder?.decode(\n encodedImage,\n byteBuffer.size(),\n ImmutableQualityInfo.FULL_QUALITY,\n imageDecodeOptions,\n ) as? CloseableAnimatedImage\n\n // Verify we got the right result\n val imageResult: AnimatedImageResult? = closeableImage?.getImageResult()\n assertThat(imageResult?.getImage()).isSameAs(mockGifImage)\n assertThat(imageResult?.getPreviewBitmap()).isNotNull()\n assertThat(imageResult?.hasDecodedFrame(0) ?: false).isFalse()\n\n mockBitmapFactory?.let { factory ->\n verify(factory).createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG)\n verifyNoMoreInteractions(factory)\n }\n verify(animatedImageCompositorConstruction.constructed()[0]).renderFrame(0, mockBitmap)\n }\n }\n\n @Throws(Exception::class)\n private fun testCreateWithDecodeAllFrames(\n mockGifImage: GifImage?,\n mockBitmap1: Bitmap,\n mockBitmap2: Bitmap,\n byteBuffer: PooledByteBuffer,\n ) {\n whenever(mockBitmapFactory?.createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG))\n .thenReturn(CloseableReference.of(mockBitmap1, FAKE_BITMAP_RESOURCE_RELEASER))\n .thenReturn(CloseableReference.of(mockBitmap2, FAKE_BITMAP_RESOURCE_RELEASER))\n\n Mockito.mockConstruction(AnimatedImageCompositor::class.java).use {\n animatedImageCompositorConstruction: MockedConstruction ->\n val imageDecodeOptions: ImageDecodeOptions =\n ImageDecodeOptions.newBuilder()\n .setDecodePreviewFrame(true)\n .setDecodeAllFrames(true)\n .build()\n val encodedImage: EncodedImage =\n EncodedImage(CloseableReference.of(byteBuffer, FAKE_RESOURCE_RELEASER))\n encodedImage.setImageFormat(ImageFormat.UNKNOWN)\n\n val closeableImage: CloseableAnimatedImage? =\n gifImageDecoder?.decode(\n encodedImage,\n byteBuffer.size(),\n ImmutableQualityInfo.FULL_QUALITY,\n imageDecodeOptions,\n ) as? CloseableAnimatedImage\n\n // Verify we got the right result\n val imageResult: AnimatedImageResult? = closeableImage?.getImageResult()\n assertThat(imageResult?.getImage()).isSameAs(mockGifImage)\n assertThat(imageResult?.getDecodedFrame(0)).isNotNull()\n assertThat(imageResult?.getDecodedFrame(1)).isNotNull()\n assertThat(imageResult?.getPreviewBitmap()).isNotNull()\n\n mockBitmapFactory?.let { factory ->\n verify(factory, times(2)).createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG)\n verifyNoMoreInteractions(factory)\n }\n val mockCompositor: AnimatedImageCompositor? =\n animatedImageCompositorConstruction.constructed().get(0)\n mockCompositor?.let { compositor ->\n verify(compositor).renderFrame(0, mockBitmap1)\n verify(compositor).renderFrame(1, mockBitmap2)\n }\n }\n }\n\n @Test\n fun testDecodeForceStaticImage() {\n val mockGifImage: GifImage = mock()\n val mockBitmap: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n\n val byteBuffer: TrivialPooledByteBuffer = createByteBuffer()\n whenever(\n GifImage.createFromNativeMemory(\n ArgumentMatchers.eq(byteBuffer.nativePtr),\n ArgumentMatchers.eq(byteBuffer.size()),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockGifImage)\n whenever(mockGifImage.getWidth()).thenReturn(50)\n whenever(mockGifImage.getHeight()).thenReturn(50)\n whenever(mockGifImage.getFrameCount()).thenReturn(1)\n whenever(mockGifImage.getFrameDurations()).thenReturn(intArrayOf(100))\n whenever(mockBitmapFactory?.createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG))\n .thenReturn(CloseableReference.of(mockBitmap, FAKE_BITMAP_RESOURCE_RELEASER))\n\n Mockito.mockConstruction(AnimatedImageCompositor::class.java).use {\n animatedImageCompositorConstruction: MockedConstruction ->\n val imageDecodeOptions: ImageDecodeOptions =\n ImageDecodeOptions.newBuilder().setForceStaticImage(true).build()\n val encodedImage: EncodedImage =\n EncodedImage(CloseableReference.of(byteBuffer, FAKE_RESOURCE_RELEASER))\n encodedImage.setImageFormat(ImageFormat.UNKNOWN)\n\n val closeableImage: CloseableStaticBitmap? =\n gifImageDecoder?.decode(\n encodedImage,\n byteBuffer.size(),\n ImmutableQualityInfo.FULL_QUALITY,\n imageDecodeOptions,\n ) as? CloseableStaticBitmap\n\n // Verify static bitmap instead of animated image\n assertThat(closeableImage).isNotNull()\n assertThat(closeableImage?.underlyingBitmap).isNotNull()\n\n mockBitmapFactory?.let { factory ->\n verify(factory).createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG)\n verifyNoMoreInteractions(factory)\n }\n verify(animatedImageCompositorConstruction.constructed()[0]).renderFrame(0, mockBitmap)\n }\n }\n\n @Test\n fun testDecodeWithInvalidGif() {\n // Create an invalid GIF by using an empty byte buffer\n val invalidGifData = ByteArray(0) // Empty array will cause validation to fail\n val byteBuffer = TrivialPooledByteBuffer(invalidGifData)\n\n val encodedImage: EncodedImage =\n EncodedImage(CloseableReference.of(byteBuffer, FAKE_RESOURCE_RELEASER))\n encodedImage.setImageFormat(ImageFormat.UNKNOWN)\n\n assertThatThrownBy {\n gifImageDecoder?.decode(\n encodedImage,\n byteBuffer.size(),\n ImmutableQualityInfo.FULL_QUALITY,\n ImageDecodeOptions.defaults(),\n )\n }\n .isInstanceOf(UnsupportedOperationException::class.java)\n .hasMessageContaining(\"Invalid image\")\n }\n\n private fun createByteBuffer(): TrivialPooledByteBuffer {\n val gifData: ByteArray = createValidGif()\n return TrivialPooledByteBuffer(gifData)\n }\n\n companion object {\n private val DEFAULT_BITMAP_CONFIG = Bitmap.Config.ARGB_8888\n\n private val FAKE_RESOURCE_RELEASER: ResourceReleaser =\n object : ResourceReleaser {\n override fun release(value: PooledByteBuffer) = Unit\n }\n\n private val FAKE_BITMAP_RESOURCE_RELEASER: ResourceReleaser =\n object : ResourceReleaser {\n override fun release(value: Bitmap) = Unit\n }\n\n private fun createDirectByteBuffer(): TrivialBufferPooledByteBuffer {\n val gifData: ByteArray = createValidGif()\n return TrivialBufferPooledByteBuffer(gifData)\n }\n\n /**\n * Creates a valid GIF Structure: Header + Logical Screen Descriptor + Image Descriptor +\n * Image * Data + Trailer\n */\n private fun createValidGif(): ByteArray {\n val gif = ByteArrayOutputStream()\n\n try {\n // GIF Header (6 bytes) with GIF89a signature\n gif.write(\"GIF89a\".toByteArray(charset(\"ASCII\")))\n\n // Logical Screen Descriptor (7 bytes)\n writeShort(gif, 1) // width = 1\n writeShort(gif, 1) // height = 1\n gif.write(0x00) // Packed field (no global color table)\n gif.write(0x00) // Background color index\n gif.write(0x00) // Pixel aspect ratio\n\n // Image Descriptor (10 bytes)\n gif.write(0x2C) // Image separator\n writeShort(gif, 0) // Left position\n writeShort(gif, 0) // Top position\n writeShort(gif, 1) // width = 1\n writeShort(gif, 1) // height = 1\n gif.write(0x00) // Packed field (no local color table)\n\n // Image Data\n gif.write(0x02) // LZW minimum code size\n gif.write(0x02) // Sub-block size\n gif.write(0x4C) // Minimal LZW data\n gif.write(0x01) // Minimal LZW data\n gif.write(0x00) // Sub-block terminator\n\n // GIF Trailer\n gif.write(0x3B)\n\n return gif.toByteArray()\n } catch (e: IOException) {\n throw RuntimeException(\"Failed to create test GIF data\", e)\n }\n }\n\n /** Helper method to write a 16-bit value in little-endian format */\n private fun writeShort(stream: ByteArrayOutputStream, value: Int) {\n stream.write(value and 0xFF) // Low byte\n stream.write((value shr 8) and 0xFF) // High byte\n }\n }\n}\n" }, { "path": "animated-gif-lite/.gitignore", "content": "" }, { "path": "animated-gif-lite/build.gradle", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nimport com.facebook.fresco.buildsrc.Deps\nimport com.facebook.fresco.buildsrc.GradleDeps\n\napply plugin: 'com.android.library'\napply plugin: 'kotlin-android'\n\nkotlin {\n jvmToolchain(11)\n}\n\ndependencies {\n compileOnly Deps.inferAnnotation\n compileOnly Deps.jsr305\n \n implementation project(':animated-base')\n implementation project(':fbcore')\n implementation project(':middleware')\n}\n\nandroid {\n ndkVersion GradleDeps.Native.version\n\n buildToolsVersion FrescoConfig.buildToolsVersion\n compileSdkVersion FrescoConfig.compileSdkVersion\n\n namespace \"com.facebook.animated.giflite\"\n\n defaultConfig {\n minSdkVersion FrescoConfig.minSdkVersion\n targetSdkVersion FrescoConfig.targetSdkVersion\n }\n\n sourceSets {\n main\n }\n}\n\napply plugin: \"com.vanniktech.maven.publish\"\n" }, { "path": "animated-gif-lite/gradle.properties", "content": "POM_NAME=AnimatedGifLite\nPOM_DESCRIPTION=The classes to support animated gif without ndk\nPOM_ARTIFACT_ID=animated-gif-lite\nPOM_PACKAGING=aar\n" }, { "path": "animated-gif-lite/src/main/AndroidManifest.xml", "content": "\n\n\n" }, { "path": "animated-gif-lite/src/main/java/com/facebook/animated/giflite/GifDecoder.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.giflite;\n\nimport android.graphics.Movie;\nimport com.facebook.animated.giflite.decoder.GifMetadataDecoder;\nimport com.facebook.animated.giflite.draw.MovieAnimatedImage;\nimport com.facebook.animated.giflite.draw.MovieDrawer;\nimport com.facebook.animated.giflite.draw.MovieFrame;\nimport com.facebook.common.internal.Preconditions;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo;\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult;\nimport com.facebook.imagepipeline.common.ImageDecodeOptions;\nimport com.facebook.imagepipeline.decoder.ImageDecoder;\nimport com.facebook.imagepipeline.image.CloseableAnimatedImage;\nimport com.facebook.imagepipeline.image.CloseableImage;\nimport com.facebook.imagepipeline.image.EncodedImage;\nimport com.facebook.imagepipeline.image.QualityInfo;\nimport com.facebook.infer.annotation.Nullsafe;\nimport java.io.ByteArrayInputStream;\nimport java.io.ByteArrayOutputStream;\nimport java.io.IOException;\nimport java.io.InputStream;\n\n/** A simple Gif decoder that uses Android's {@link Movie} class to decode Gif images. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class GifDecoder implements ImageDecoder {\n\n @Override\n public CloseableImage decode(\n final EncodedImage encodedImage,\n int length,\n QualityInfo qualityInfo,\n ImageDecodeOptions options) {\n InputStream is = encodedImage.getInputStream();\n try {\n ByteArrayOutputStream out = new ByteArrayOutputStream();\n\n // NULLSAFE_FIXME[Parameter Not Nullable]\n GifMetadataDecoder decoder = GifMetadataDecoder.create(is, out);\n\n if (out.size() > 0) { // let's use the fixed gif version if exists\n Preconditions.checkNotNull(is, \"InputStream cannot be null\").close();\n is = new ByteArrayInputStream(out.toByteArray());\n }\n\n Preconditions.checkNotNull(is, \"InputStream cannot be null\").reset();\n\n Movie movie = Movie.decodeStream(is);\n\n MovieDrawer drawer = new MovieDrawer(movie);\n\n MovieFrame[] frames = new MovieFrame[decoder.getFrameCount()];\n int currTime = 0;\n for (int frameNumber = 0, N = frames.length; frameNumber < N; frameNumber++) {\n int frameDuration = decoder.getFrameDurationMs(frameNumber);\n currTime += frameDuration;\n frames[frameNumber] =\n new MovieFrame(\n drawer,\n currTime,\n frameDuration,\n movie.width(),\n movie.height(),\n translateFrameDisposal(decoder.getFrameDisposal(frameNumber)));\n }\n return new CloseableAnimatedImage(\n AnimatedImageResult.forAnimatedImage(\n new MovieAnimatedImage(\n frames,\n encodedImage.getSize(),\n movie.duration(),\n decoder.getLoopCount(),\n options.animatedBitmapConfig)),\n false);\n } catch (IOException e) {\n throw new RuntimeException(\"Error while decoding gif\", e);\n } finally {\n try {\n Preconditions.checkNotNull(is, \"InputStream cannot be null\").close();\n } catch (IOException ignored) {\n }\n }\n }\n\n private static AnimatedDrawableFrameInfo.DisposalMethod translateFrameDisposal(int raw) {\n switch (raw) {\n case 2: // restore to background\n return AnimatedDrawableFrameInfo.DisposalMethod.DISPOSE_TO_BACKGROUND;\n case 3: // restore to previous\n return AnimatedDrawableFrameInfo.DisposalMethod.DISPOSE_TO_PREVIOUS;\n case 1: // do not dispose\n // fallthrough\n default: // unspecified\n return AnimatedDrawableFrameInfo.DisposalMethod.DISPOSE_DO_NOT;\n }\n }\n}\n" }, { "path": "animated-gif-lite/src/main/java/com/facebook/animated/giflite/decoder/GifMetadataDecoder.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.giflite.decoder;\n\nimport com.facebook.common.internal.Preconditions;\nimport com.facebook.infer.annotation.Nullsafe;\nimport java.io.EOFException;\nimport java.io.IOException;\nimport java.io.InputStream;\nimport java.io.OutputStream;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.List;\nimport javax.annotation.Nullable;\n\n@Nullsafe(Nullsafe.Mode.LOCAL)\npublic class GifMetadataDecoder {\n\n private static final int MAX_BLOCK_SIZE = 256; // blocks sizes are defined by a single byte\n private static final char[] NETSCAPE =\n new char[] {'N', 'E', 'T', 'S', 'C', 'A', 'P', 'E', '2', '.', '0'};\n private static final int CONTROL_INDEX_DISPOSE = 0;\n private static final int CONTROL_INDEX_DELAY = 1;\n private static final int DEFAULT_FRAME_DURATION_MS = 100;\n\n private final byte[] block = new byte[MAX_BLOCK_SIZE];\n private final InputStream mInputStream;\n @Nullable private final OutputStream mOutputStream;\n private boolean shouldFixStream;\n private int screenWidth;\n private int screenHeight;\n private final List mFrameControls = new ArrayList<>();\n private int mLoopCount = 1; // default loop count is 1\n private boolean mDecoded = false;\n private int mCurrentOffset = 0;\n\n public static GifMetadataDecoder create(InputStream is, @Nullable OutputStream os)\n throws IOException {\n GifMetadataDecoder decoder = new GifMetadataDecoder(is, os);\n decoder.decode();\n return decoder;\n }\n\n /**\n * @param is InputStream to decode\n * @param os OutputStream to write fixed version of gif, if needed. (optional)\n */\n private GifMetadataDecoder(InputStream is, @Nullable OutputStream os) {\n mInputStream = is;\n mOutputStream = os;\n }\n\n public void decode() throws IOException {\n if (mDecoded) {\n throw new IllegalStateException(\"decode called multiple times\");\n }\n mDecoded = true;\n readGifInfo();\n }\n\n public int getScreenWidth() {\n if (!mDecoded) {\n throw new IllegalStateException(\"getScreenWidth called before decode\");\n }\n return screenWidth;\n }\n\n public int getScreenHeight() {\n if (!mDecoded) {\n throw new IllegalStateException(\"getScreenHeight called before decode\");\n }\n return screenHeight;\n }\n\n public int getFrameCount() {\n if (!mDecoded) {\n throw new IllegalStateException(\"getFrameCount called before decode\");\n }\n return mFrameControls.size();\n }\n\n public int getLoopCount() {\n if (!mDecoded) {\n throw new IllegalStateException(\"getLoopCount called before decode\");\n }\n return mLoopCount;\n }\n\n public int getFrameDisposal(int frameNumber) {\n if (!mDecoded) {\n throw new IllegalStateException(\"getFrameDisposal called before decode\");\n }\n return mFrameControls.get(frameNumber)[CONTROL_INDEX_DISPOSE];\n }\n\n public int getFrameDurationMs(int frameNumber) {\n if (!mDecoded) {\n throw new IllegalStateException(\"getFrameDurationMs called before decode\");\n }\n\n // For frame number higher than frame count, returning 1 ms ensures that animation backend can\n // fetch loop duration of a frame correctly in case when some frames do not have correct delay.\n if (frameNumber >= getFrameCount()) {\n return 1;\n }\n\n return mFrameControls.get(frameNumber)[CONTROL_INDEX_DELAY];\n }\n\n private void readGifInfo() throws IOException {\n validateAndIgnoreHeader();\n\n final int[] control = new int[] {0, 0};\n\n boolean done = false;\n while (!done) {\n int code = readAndWriteNextByte();\n switch (code) {\n case 0x21: // extension\n int extCode = readAndWriteNextByte();\n switch (extCode) {\n case 0xff: // application extension\n readBlock();\n if (isNetscape()) {\n readNetscapeExtension();\n } else {\n skipExtension();\n }\n break;\n case 0xf9: // graphics control extension\n readGraphicsControlExtension(control);\n break;\n case 0x01: // plain text extension, counts as a frame\n addFrame(control);\n skipExtension();\n break;\n default:\n skipExtension();\n }\n break;\n case 0x2C: // image\n addFrame(control);\n skipImage();\n // count as a frame\n break;\n case 0x3b: // terminator\n done = true;\n break;\n default:\n throw new IOException(\"Unknown block header [\" + Integer.toHexString(code) + \"]\");\n }\n }\n }\n\n private void addFrame(int[] control) {\n mFrameControls.add(Arrays.copyOf(control, control.length));\n }\n\n private void validateAndIgnoreHeader() throws IOException {\n readIntoBlock(0 /* offset */, 6 /* length */);\n boolean valid =\n 'G' == (char) block[0]\n && 'I' == (char) block[1]\n && 'F' == (char) block[2]\n && '8' == (char) block[3]\n && ('7' == (char) block[4] || '9' == (char) block[4])\n && 'a' == (char) block[5];\n if (!valid) {\n throw new IOException(\"Illegal header for gif\");\n }\n\n screenWidth = readAndWriteNextByte() | (readAndWriteNextByte() << 8);\n screenHeight = readAndWriteNextByte() | (readAndWriteNextByte() << 8);\n\n int fields = readAndWriteNextByte();\n boolean hasGlobalColorTable = (fields & 0x80) != 0;\n int globalColorTableSize = 2 << (fields & 7);\n\n skipAndWriteBytes(2); // bgc index, aspect ratio\n\n if (hasGlobalColorTable) {\n ignoreColorTable(globalColorTableSize);\n }\n }\n\n private void ignoreColorTable(int numColors) throws IOException {\n skipAndWriteBytes(3 * numColors);\n }\n\n private int readBlock() throws IOException {\n int blockSize = readAndWriteNextByte();\n int n = 0;\n if (blockSize > 0) {\n while (n < blockSize) {\n n += readIntoBlock(n, blockSize - n);\n }\n }\n return n;\n }\n\n private void skipExtension() throws IOException {\n int size;\n do {\n size = readBlock();\n } while (size > 0);\n }\n\n private void skipImage() throws IOException {\n skipAndWriteBytes(8);\n\n int flags = readAndWriteNextByte();\n boolean hasLct = (flags & 0x80) != 0;\n if (hasLct) {\n int lctSize = 2 << (flags & 7);\n ignoreColorTable(lctSize);\n }\n skipAndWriteBytes(1);\n skipExtension();\n }\n\n private boolean isNetscape() {\n if (block.length < NETSCAPE.length) {\n return false;\n }\n\n for (int i = 0, N = NETSCAPE.length; i < N; i++) {\n if (NETSCAPE[i] != (char) block[i]) {\n return false;\n }\n }\n return true;\n }\n\n private void readNetscapeExtension() throws IOException {\n int size;\n do {\n size = readBlock();\n if (block[0] == 1) {\n mLoopCount = ((((int) block[2]) & 0xff) << 8) | (((int) block[1]) & 0xff);\n }\n } while (size > 0);\n }\n\n private void readGraphicsControlExtension(int[] control) throws IOException {\n skipAndWriteBytes(1);\n int flags = readAndWriteNextByte();\n control[CONTROL_INDEX_DISPOSE] = (flags & 0x1c) >> 2; // dispose\n control[CONTROL_INDEX_DELAY] = readTwoByteInt() * 10; // delay\n if (control[CONTROL_INDEX_DELAY] == 0) {\n control[CONTROL_INDEX_DELAY] = DEFAULT_FRAME_DURATION_MS;\n initFixedOutputStream();\n }\n writeTwoByteInt(control[CONTROL_INDEX_DELAY] / 10);\n skipAndWriteBytes(2);\n }\n\n private int readNextByte() throws IOException {\n int read = mInputStream.read();\n mCurrentOffset++;\n if (read == -1) {\n throw new EOFException(\"Unexpected end of gif file\");\n }\n return read;\n }\n\n private int readTwoByteInt() throws IOException {\n return readNextByte() | (readNextByte() << 8);\n }\n\n private int readIntoBlock(int offset, int length) throws IOException {\n int count = mInputStream.read(block, offset, length);\n mCurrentOffset += length;\n if (shouldFixStream) {\n Preconditions.checkNotNull(mOutputStream).write(block, offset, length);\n }\n if (count == -1) {\n throw new EOFException(\"Unexpected end of gif file\");\n }\n return count;\n }\n\n private int readAndWriteNextByte() throws IOException {\n int read = readNextByte();\n writeNextByte(read);\n return read;\n }\n\n private void writeNextByte(int b) throws IOException {\n if (shouldFixStream) {\n Preconditions.checkNotNull(mOutputStream, \"OutputStream cannot be null when fixing stream\")\n .write(b);\n }\n }\n\n private void writeTwoByteInt(int content) throws IOException {\n writeNextByte(content);\n writeNextByte(content >> 8);\n }\n\n private void skipAndWriteBytes(int length) throws IOException {\n if (shouldFixStream) {\n // NULLSAFE_FIXME[Parameter Not Nullable]\n copyFromIsToOs(mInputStream, mOutputStream, length);\n } else {\n mInputStream.skip(length);\n }\n mCurrentOffset += length;\n }\n\n private void initFixedOutputStream() throws IOException {\n if (shouldFixStream || mOutputStream == null) {\n return;\n }\n shouldFixStream = true;\n mInputStream.reset();\n copyFromIsToOs(mInputStream, mOutputStream, mCurrentOffset - 2);\n mInputStream.skip(2);\n }\n\n private void copyFromIsToOs(InputStream in, OutputStream out, int length) throws IOException {\n while (length > 0) {\n int bytesRead = in.read(block, 0, Math.min(MAX_BLOCK_SIZE, length));\n length -= MAX_BLOCK_SIZE;\n out.write(block, 0, bytesRead);\n }\n }\n}\n" }, { "path": "animated-gif-lite/src/main/java/com/facebook/animated/giflite/draw/MovieAnimatedImage.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.giflite.draw\n\nimport android.graphics.Bitmap\nimport android.graphics.Bitmap.Config\nimport android.graphics.Movie\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo.BlendOperation\nimport com.facebook.imagepipeline.animated.base.AnimatedImage\nimport com.facebook.imagepipeline.animated.base.AnimatedImageFrame\n\n/** Simple wrapper for an animated image backed by [Movie]. */\nclass MovieAnimatedImage\n@JvmOverloads\nconstructor(\n private val frames: Array,\n private val _sizeInBytes: Int,\n private val _duration: Int,\n private val _loopCount: Int,\n animatedBitmapConfig: Bitmap.Config? = null,\n) : AnimatedImage {\n\n private val _frameDurations: IntArray = IntArray(frames.size)\n private val _animatedBitmapConfig: Bitmap.Config?\n\n init {\n\n var i = 0\n val N = frames.size\n while (i < N) {\n _frameDurations[i] = frames[i].durationMs\n i++\n }\n this._animatedBitmapConfig = animatedBitmapConfig\n }\n\n override fun dispose() = Unit\n\n override fun getWidth(): Int = frames[0].width\n\n override fun getHeight(): Int = frames[0].height\n\n override fun getFrameCount(): Int = frames.size\n\n override fun getDuration(): Int = _duration\n\n override fun getFrameDurations(): IntArray = _frameDurations\n\n override fun getLoopCount(): Int = _loopCount\n\n override fun getFrame(frameNumber: Int): AnimatedImageFrame = frames[frameNumber]\n\n override fun doesRenderSupportScaling(): Boolean = true\n\n override fun getSizeInBytes(): Int = _sizeInBytes\n\n override fun getFrameInfo(frameNumber: Int): AnimatedDrawableFrameInfo {\n val frame = frames[frameNumber]\n return AnimatedDrawableFrameInfo(\n frameNumber,\n frame.xOffset,\n frame.yOffset,\n frame.width,\n frame.height,\n AnimatedDrawableFrameInfo.BlendOperation.BLEND_WITH_PREVIOUS,\n frames[frameNumber].disposalMode,\n )\n }\n\n override fun getAnimatedBitmapConfig(): Bitmap.Config? = _animatedBitmapConfig\n}\n" }, { "path": "animated-gif-lite/src/main/java/com/facebook/animated/giflite/draw/MovieDrawer.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.giflite.draw\n\nimport android.graphics.Bitmap\nimport android.graphics.Canvas\nimport android.graphics.Movie\n\n/**\n * Pronounced Draw-er Draws frames of a [Movie] to a bitmap. All methods are synchronized, so can be\n * used in parallel. The underlying [mMovie] is not threadsafe, and should therefore not be accessed\n * outside of [MovieDrawer]. Attempts to optimize work done by the drawing [Canvas] by detecting if\n * the underlying [Bitmap] has changed.\n */\nclass MovieDrawer(private val movie: Movie) {\n\n private val scaleHolder: MovieScaleHolder = MovieScaleHolder(movie.width(), movie.height())\n private val canvas: Canvas = Canvas()\n private var previousBitmap: Bitmap? = null\n\n @Synchronized\n fun drawFrame(movieTime: Int, w: Int, h: Int, bitmap: Bitmap) {\n movie.setTime(movieTime)\n if (previousBitmap?.isRecycled == true) {\n previousBitmap = null\n }\n if (previousBitmap != bitmap) {\n previousBitmap = bitmap\n canvas.setBitmap(bitmap)\n }\n scaleHolder.updateViewPort(w, h)\n canvas.save()\n canvas.scale(scaleHolder.scale, scaleHolder.scale)\n movie.draw(canvas, scaleHolder.left, scaleHolder.top)\n canvas.restore()\n }\n}\n" }, { "path": "animated-gif-lite/src/main/java/com/facebook/animated/giflite/draw/MovieFrame.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.giflite.draw\n\nimport android.graphics.Bitmap\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo.DisposalMethod\nimport com.facebook.imagepipeline.animated.base.AnimatedImageFrame\n\n/**\n * Simple wrapper for an animated image frame back by [MovieDrawer]. All [MovieFrame] for the same\n * [MovieAnimatedImage] will be backed by the same [MovieDrawer].\n */\nclass MovieFrame(\n private val movieDrawer: MovieDrawer,\n private val frameStart: Int,\n private val frameDuration: Int,\n private val frameWidth: Int,\n private val frameHeight: Int,\n val disposalMode: DisposalMethod,\n) : AnimatedImageFrame {\n\n override fun dispose() = Unit\n\n override fun renderFrame(w: Int, h: Int, bitmap: Bitmap) {\n movieDrawer.drawFrame(frameStart, w, h, bitmap)\n }\n\n override fun getDurationMs(): Int = frameDuration\n\n override fun getWidth(): Int = frameWidth\n\n override fun getHeight(): Int = frameHeight\n\n override fun getXOffset(): Int = 0\n\n override fun getYOffset(): Int = 0\n}\n" }, { "path": "animated-gif-lite/src/main/java/com/facebook/animated/giflite/draw/MovieScaleHolder.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.giflite.draw\n\ninternal class MovieScaleHolder(private val movieWidth: Int, private val movieHeight: Int) {\n\n private var viewPortWidth = 0\n private var viewPortHeight = 0\n\n @get:Synchronized\n var scale = 1f\n private set\n\n @get:Synchronized\n var left = 0f\n private set\n\n @get:Synchronized\n var top = 0f\n private set\n\n @Synchronized\n fun updateViewPort(viewPortWidth: Int, viewPortHeight: Int) {\n if (this.viewPortWidth == viewPortWidth && this.viewPortHeight == viewPortHeight) {\n return\n }\n this.viewPortWidth = viewPortWidth\n this.viewPortHeight = viewPortHeight\n determineScaleAndPosition()\n }\n\n @Synchronized\n private fun determineScaleAndPosition() {\n val inputRatio = (movieWidth / movieHeight).toFloat()\n val outputRatio = (viewPortWidth / viewPortHeight).toFloat()\n var width = viewPortWidth\n var height = viewPortHeight\n if (outputRatio > inputRatio) {\n // Not enough width to fill the output. (Black bars on left and right.)\n width = (viewPortHeight * inputRatio).toInt()\n } else if (outputRatio < inputRatio) {\n // Not enough height to fill the output. (Black bars on top and bottom.)\n height = (viewPortWidth / inputRatio).toInt()\n }\n if (viewPortWidth > movieWidth) {\n scale = movieWidth / viewPortWidth.toFloat()\n } else if (movieWidth > viewPortWidth) {\n scale = viewPortWidth / movieWidth.toFloat()\n } else {\n scale = 1f\n }\n left = (viewPortWidth - width) / 2f / scale\n top = (viewPortHeight - height) / 2f / scale\n }\n}\n" }, { "path": "animated-gif-lite/src/main/java/com/facebook/animated/giflite/drawable/GifAnimationBackend.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.giflite.drawable\n\nimport android.graphics.Canvas\nimport android.graphics.ColorFilter\nimport android.graphics.Movie\nimport android.graphics.Rect\nimport android.graphics.drawable.Drawable\nimport com.facebook.animated.giflite.decoder.GifMetadataDecoder\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport java.io.BufferedInputStream\nimport java.io.Closeable\nimport java.io.FileInputStream\nimport java.io.IOException\nimport java.io.InputStream\n\nclass GifAnimationBackend\nprivate constructor(private val gifDecoder: GifMetadataDecoder, private val movie: Movie) :\n AnimationBackend {\n\n private val frameStartTimes = IntArray(gifDecoder.frameCount)\n\n private var midX = 0f\n private var midY = 0f\n\n override fun drawFrame(parent: Drawable, canvas: Canvas, frameNumber: Int): Boolean {\n movie.setTime(getFrameStartTime(frameNumber))\n movie.draw(canvas, midX, midY)\n return true\n }\n\n override fun setAlpha(alpha: Int) {\n // unimplemented\n }\n\n override fun setColorFilter(colorFilter: ColorFilter?) {\n // unimplemented\n }\n\n override fun setBounds(bounds: Rect) {\n scale(\n bounds.right - bounds.left, /* viewPortWidth */\n bounds.bottom - bounds.top, /* viewPortHeight */\n movie.width(), /* sourceWidth */\n movie.height(), /* sourceHeight */\n )\n }\n\n override fun getIntrinsicWidth(): Int = movie.width()\n\n override fun getIntrinsicHeight(): Int = movie.height()\n\n override fun getSizeInBytes(): Int = 0 // no cached data\n\n override fun clear() {\n // unimplemented\n }\n\n override fun preloadAnimation() {\n // unimplemented\n }\n\n override fun setAnimationListener(listener: AnimationBackend.Listener?) {\n // unimplemented\n }\n\n override fun width(): Int = movie.width()\n\n override fun height(): Int = movie.height()\n\n override fun getLoopDurationMs(): Int {\n var total = 0\n for (i in 0..= frameStartTimes.size) {\n return 0\n }\n if (frameStartTimes[frameNumber] != 0) {\n return frameStartTimes[frameNumber]\n }\n for (i in 0.. inputRatio) {\n // Not enough width to fill the output. (Black bars on left and right.)\n scaledWidth = (viewPortHeight * inputRatio).toInt()\n scaledHeight = viewPortHeight\n } else if (outputRatio < inputRatio) {\n // Not enough height to fill the output. (Black bars on top and bottom.)\n scaledHeight = (viewPortWidth / inputRatio).toInt()\n scaledWidth = viewPortWidth\n }\n val scale = scaledWidth / sourceWidth.toFloat()\n\n midX = ((viewPortWidth - scaledWidth) / 2f) / scale\n midY = ((viewPortHeight - scaledHeight) / 2f) / scale\n }\n\n companion object {\n @JvmStatic\n @Throws(IOException::class)\n fun create(filePath: String?): GifAnimationBackend {\n var `is`: InputStream? = null\n try {\n `is` = BufferedInputStream(FileInputStream(filePath))\n `is`.mark(Int.MAX_VALUE)\n\n val decoder = GifMetadataDecoder.create(`is`, null)\n `is`.reset()\n\n val movie = Movie.decodeStream(`is`)\n return GifAnimationBackend(decoder, movie)\n } finally {\n closeSilently(`is`)\n }\n }\n\n private fun closeSilently(closeable: Closeable?) {\n if (closeable == null) {\n return\n }\n try {\n closeable.close()\n } catch (ignored: IOException) {\n // ignore\n }\n }\n }\n}\n" }, { "path": "animated-webp/.gitignore", "content": "nativedeps/\n" }, { "path": "animated-webp/build.gradle", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nimport com.facebook.fresco.buildsrc.Deps\nimport com.facebook.fresco.buildsrc.GradleDeps\nimport com.facebook.fresco.buildsrc.TestDeps\n\napply plugin: 'com.android.library'\napply plugin: 'kotlin-android'\n\nkotlin {\n jvmToolchain(11)\n}\n\ndependencies {\n compileOnly Deps.inferAnnotation\n compileOnly Deps.jsr305\n compileOnly Deps.javaxAnnotation\n\n implementation Deps.Bolts.tasks\n implementation project(':static-webp')\n implementation project(':animated-base')\n implementation project(':middleware')\n\n testCompileOnly Deps.inferAnnotation\n testImplementation project(':imagepipeline-base-test')\n testImplementation project(':imagepipeline-test')\n testImplementation project(':middleware')\n testImplementation TestDeps.junit\n testImplementation TestDeps.assertjCore\n testImplementation TestDeps.mockitoCore3\n testImplementation TestDeps.mockitoInline3\n testImplementation TestDeps.mockitoKotlin3\n testImplementation(TestDeps.robolectric) {\n exclude group: 'commons-logging', module: 'commons-logging'\n exclude group: 'org.apache.httpcomponents', module: 'httpclient'\n }\n}\n\nandroid {\n ndkVersion GradleDeps.Native.version\n\n buildToolsVersion FrescoConfig.buildToolsVersion\n compileSdkVersion FrescoConfig.compileSdkVersion\n\n namespace \"com.facebook.animated.webp\"\n\n defaultConfig {\n minSdkVersion FrescoConfig.minSdkVersion\n targetSdkVersion FrescoConfig.targetSdkVersion\n }\n\n sourceSets {\n main {\n jni.srcDirs = []\n }\n }\n\n lintOptions {\n abortOnError false\n }\n}\n\napply plugin: \"com.vanniktech.maven.publish\"\n" }, { "path": "animated-webp/gradle.properties", "content": "POM_NAME=AnimatedWebp\nPOM_DESCRIPTION=The classes to support animated webp\nPOM_ARTIFACT_ID=animated-webp\nPOM_PACKAGING=aar\n\n" }, { "path": "animated-webp/src/main/AndroidManifest.xml", "content": "\n\n\n" }, { "path": "animated-webp/src/main/java/com/facebook/animated/webp/WebPFrame.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.webp;\n\nimport android.graphics.Bitmap;\nimport com.facebook.common.internal.DoNotStrip;\nimport com.facebook.imagepipeline.animated.base.AnimatedImageFrame;\nimport com.facebook.infer.annotation.Nullsafe;\nimport javax.annotation.concurrent.ThreadSafe;\n\n/** A single frame of a {@link WebPImage}. */\n@Nullsafe(Nullsafe.Mode.LOCAL)\n@ThreadSafe\npublic class WebPFrame implements AnimatedImageFrame {\n\n // Accessed by native methods\n @SuppressWarnings(\"unused\")\n @DoNotStrip\n private long mNativeContext;\n\n /**\n * Constructs the frame with the native pointer. This is called by native code.\n *\n * @param nativeContext the native pointer\n */\n @DoNotStrip\n WebPFrame(long nativeContext) {\n mNativeContext = nativeContext;\n }\n\n // This is a valid use of finalize. No other mechanism is appropriate.\n @Override\n protected void finalize() {\n nativeFinalize();\n }\n\n @Override\n public void dispose() {\n nativeDispose();\n }\n\n @Override\n public void renderFrame(int width, int height, Bitmap bitmap) {\n nativeRenderFrame(width, height, bitmap);\n }\n\n @Override\n public int getDurationMs() {\n return nativeGetDurationMs();\n }\n\n @Override\n public int getWidth() {\n return nativeGetWidth();\n }\n\n @Override\n public int getHeight() {\n return nativeGetHeight();\n }\n\n @Override\n public int getXOffset() {\n return nativeGetXOffset();\n }\n\n @Override\n public int getYOffset() {\n return nativeGetYOffset();\n }\n\n public boolean shouldDisposeToBackgroundColor() {\n return nativeShouldDisposeToBackgroundColor();\n }\n\n public boolean isBlendWithPreviousFrame() {\n return nativeIsBlendWithPreviousFrame();\n }\n\n private native void nativeRenderFrame(int width, int height, Bitmap bitmap);\n\n private native int nativeGetDurationMs();\n\n private native int nativeGetWidth();\n\n private native int nativeGetHeight();\n\n private native int nativeGetXOffset();\n\n private native int nativeGetYOffset();\n\n private native boolean nativeShouldDisposeToBackgroundColor();\n\n private native boolean nativeIsBlendWithPreviousFrame();\n\n private native void nativeDispose();\n\n private native void nativeFinalize();\n}\n" }, { "path": "animated-webp/src/main/java/com/facebook/animated/webp/WebPImage.java", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.webp;\n\nimport static com.facebook.imagepipeline.nativecode.StaticWebpNativeLoader.ensure;\n\nimport android.graphics.Bitmap;\nimport com.facebook.common.internal.DoNotStrip;\nimport com.facebook.common.internal.Preconditions;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo.BlendOperation;\nimport com.facebook.imagepipeline.animated.base.AnimatedDrawableFrameInfo.DisposalMethod;\nimport com.facebook.imagepipeline.animated.base.AnimatedImage;\nimport com.facebook.imagepipeline.animated.factory.AnimatedImageDecoder;\nimport com.facebook.imagepipeline.common.ImageDecodeOptions;\nimport com.facebook.infer.annotation.Nullsafe;\nimport java.nio.ByteBuffer;\nimport javax.annotation.Nullable;\nimport javax.annotation.concurrent.ThreadSafe;\n\n/**\n * A representation of a WebP image. An instance of this class will hold a copy of the encoded data\n * in memory along with the parsed header data. Frames are decoded on demand via {@link WebPFrame}.\n */\n@Nullsafe(Nullsafe.Mode.LOCAL)\n@ThreadSafe\n@DoNotStrip\npublic class WebPImage implements AnimatedImage, AnimatedImageDecoder {\n\n // Accessed by native methods\n @SuppressWarnings(\"unused\")\n @DoNotStrip\n private long mNativeContext;\n\n @Nullable private Bitmap.Config mDecodeBitmapConfig = null;\n\n @DoNotStrip\n public WebPImage() {}\n\n /**\n * Constructs the image with the native pointer. This is called by native code.\n *\n * @param nativeContext the native pointer\n */\n @DoNotStrip\n WebPImage(long nativeContext) {\n mNativeContext = nativeContext;\n }\n\n // This is a valid use of finalize. No other mechanism is appropriate.\n @Override\n protected void finalize() {\n nativeFinalize();\n }\n\n @Override\n public void dispose() {\n nativeDispose();\n }\n\n /**\n * Creates a {@link WebPImage} from the specified encoded data. This will throw if it fails to\n * create. This is meant to be called on a worker thread.\n *\n * @param source the data to the image (a copy will be made)\n */\n public static WebPImage createFromByteArray(byte[] source, @Nullable ImageDecodeOptions options) {\n ensure();\n Preconditions.checkNotNull(source, \"Source byte array cannot be null\");\n\n ByteBuffer byteBuffer = ByteBuffer.allocateDirect(source.length);\n byteBuffer.put(source);\n byteBuffer.rewind();\n\n WebPImage image = nativeCreateFromDirectByteBuffer(byteBuffer);\n if (options != null) {\n image.mDecodeBitmapConfig = options.animatedBitmapConfig;\n }\n return image;\n }\n\n /**\n * Creates a {@link WebPImage} from a ByteBuffer containing the image. This will throw if it fails\n * to create.\n *\n * @param byteBuffer the ByteBuffer containing the image\n */\n public static WebPImage createFromByteBuffer(\n ByteBuffer byteBuffer, @Nullable ImageDecodeOptions options) {\n ensure();\n byteBuffer.rewind();\n\n WebPImage image = nativeCreateFromDirectByteBuffer(byteBuffer);\n if (options != null) {\n image.mDecodeBitmapConfig = options.animatedBitmapConfig;\n }\n return image;\n }\n\n public static WebPImage createFromNativeMemory(\n long nativePtr, int sizeInBytes, @Nullable ImageDecodeOptions options) {\n ensure();\n Preconditions.checkArgument(nativePtr != 0);\n WebPImage image = nativeCreateFromNativeMemory(nativePtr, sizeInBytes);\n if (options != null) {\n image.mDecodeBitmapConfig = options.animatedBitmapConfig;\n }\n return image;\n }\n\n @Override\n public AnimatedImage decodeFromNativeMemory(\n long nativePtr, int sizeInBytes, ImageDecodeOptions options) {\n return WebPImage.createFromNativeMemory(nativePtr, sizeInBytes, options);\n }\n\n @Override\n public AnimatedImage decodeFromByteBuffer(ByteBuffer byteBuffer, ImageDecodeOptions options) {\n return WebPImage.createFromByteBuffer(byteBuffer, options);\n }\n\n @Override\n public int getWidth() {\n return nativeGetWidth();\n }\n\n @Override\n public int getHeight() {\n return nativeGetHeight();\n }\n\n @Override\n public int getFrameCount() {\n return nativeGetFrameCount();\n }\n\n @Override\n public int getDuration() {\n return nativeGetDuration();\n }\n\n @Override\n public int[] getFrameDurations() {\n return nativeGetFrameDurations();\n }\n\n @Override\n public int getLoopCount() {\n return nativeGetLoopCount();\n }\n\n @Override\n public WebPFrame getFrame(int frameNumber) {\n return nativeGetFrame(frameNumber);\n }\n\n @Override\n public int getSizeInBytes() {\n return nativeGetSizeInBytes();\n }\n\n @Override\n public boolean doesRenderSupportScaling() {\n return true;\n }\n\n @Override\n public AnimatedDrawableFrameInfo getFrameInfo(int frameNumber) {\n WebPFrame frame = getFrame(frameNumber);\n try {\n return new AnimatedDrawableFrameInfo(\n frameNumber,\n frame.getXOffset(),\n frame.getYOffset(),\n frame.getWidth(),\n frame.getHeight(),\n frame.isBlendWithPreviousFrame()\n ? BlendOperation.BLEND_WITH_PREVIOUS\n : BlendOperation.NO_BLEND,\n frame.shouldDisposeToBackgroundColor()\n ? DisposalMethod.DISPOSE_TO_BACKGROUND\n : DisposalMethod.DISPOSE_DO_NOT);\n } finally {\n frame.dispose();\n }\n }\n\n @Override\n @Nullable\n public Bitmap.Config getAnimatedBitmapConfig() {\n return mDecodeBitmapConfig;\n }\n\n private static native WebPImage nativeCreateFromDirectByteBuffer(ByteBuffer buffer);\n\n private static native WebPImage nativeCreateFromNativeMemory(long nativePtr, int sizeInBytes);\n\n private native int nativeGetWidth();\n\n private native int nativeGetHeight();\n\n private native int nativeGetDuration();\n\n private native int nativeGetFrameCount();\n\n private native int[] nativeGetFrameDurations();\n\n private native int nativeGetLoopCount();\n\n private native WebPFrame nativeGetFrame(int frameNumber);\n\n private native int nativeGetSizeInBytes();\n\n private native void nativeDispose();\n\n private native void nativeFinalize();\n}\n" }, { "path": "animated-webp/src/main/java/com/facebook/animated/webp/WebPImageDecoder.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.webp\n\nimport com.facebook.imagepipeline.animated.factory.AnimatedImageDecoderBase\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.common.ImageDecodeOptions\nimport com.facebook.imagepipeline.decoder.ImageDecoder\nimport com.facebook.imagepipeline.image.CloseableImage\nimport com.facebook.imagepipeline.image.EncodedImage\nimport com.facebook.imagepipeline.image.QualityInfo\n\nclass WebPImageDecoder(\n platformBitmapFactory: PlatformBitmapFactory,\n isNewRenderImplementation: Boolean,\n downscaleFrameToDrawableDimensions: Boolean,\n treatAnimatedImagesAsStateful: Boolean = true,\n) :\n AnimatedImageDecoderBase(\n platformBitmapFactory,\n downscaleFrameToDrawableDimensions,\n isNewRenderImplementation,\n treatAnimatedImagesAsStateful,\n ),\n ImageDecoder {\n\n /**\n * Decodes an animated WebP image into a CloseableImage.\n *\n * @param encodedImage encoded image (native byte array holding the encoded bytes and meta data)\n * @param length the length of the encoded data\n * @param qualityInfo quality information about the image\n * @param options decode options specifying how the image should be decoded\n * @return a CloseableImage\n */\n override fun decode(\n encodedImage: EncodedImage,\n length: Int,\n qualityInfo: QualityInfo,\n options: ImageDecodeOptions,\n ): CloseableImage? {\n val bytesRef = encodedImage.byteBufferRef\n checkNotNull(bytesRef)\n\n bytesRef.use {\n val input = bytesRef.get()\n val image =\n input.byteBuffer?.let { byteBuffer ->\n WebPImage.createFromByteBuffer(byteBuffer, options)\n } ?: WebPImage.createFromNativeMemory(input.nativePtr, input.size(), options)\n return getCloseableImage(\n encodedImage.source,\n options,\n checkNotNull(image),\n options.animatedBitmapConfig,\n )\n }\n }\n}\n" }, { "path": "animated-webp/src/main/java/com/facebook/animated/webpdrawable/WebpAnimationBackend.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.webpdrawable\n\nimport android.graphics.Bitmap\nimport android.graphics.Canvas\nimport android.graphics.Color\nimport android.graphics.ColorFilter\nimport android.graphics.Rect\nimport android.graphics.drawable.Drawable\nimport com.facebook.animated.webp.WebPImage\nimport com.facebook.fresco.animation.backend.AnimationBackend\nimport java.io.BufferedInputStream\nimport java.io.Closeable\nimport java.io.FileInputStream\nimport java.io.IOException\nimport java.io.InputStream\nimport javax.annotation.concurrent.GuardedBy\n\n/** Animation backend that is used to draw webp frames. */\nclass WebpAnimationBackend private constructor(private val webPImage: WebPImage) :\n AnimationBackend {\n\n private val renderDstRect = Rect()\n private val renderSrcRect = Rect()\n\n private var bounds: Rect? = null\n\n @GuardedBy(\"this\") private var tempBitmap: Bitmap? = null\n\n override fun drawFrame(parent: Drawable, canvas: Canvas, frameNumber: Int): Boolean {\n val frame = webPImage.getFrame(frameNumber)\n\n val xScale = bounds!!.width().toDouble() / parent.intrinsicWidth.toDouble()\n val yScale = bounds!!.height().toDouble() / parent.intrinsicHeight.toDouble()\n\n val frameWidth = Math.round(frame.width * xScale).toInt()\n val frameHeight = Math.round(frame.height * yScale).toInt()\n val xOffset = (frame.xOffset * xScale).toInt()\n val yOffset = (frame.yOffset * yScale).toInt()\n\n synchronized(this) {\n val renderedWidth = bounds!!.width()\n val renderedHeight = bounds!!.height()\n // Update the temp bitmap to be >= rendered dimensions\n prepareTempBitmapForThisSize(renderedWidth, renderedHeight)\n if (tempBitmap == null) {\n return false\n }\n frame.renderFrame(frameWidth, frameHeight, tempBitmap!!)\n // Temporary bitmap can be bigger than frame, so we should draw only rendered area of bitmap\n renderSrcRect[0, 0, renderedWidth] = renderedHeight\n renderDstRect[xOffset, yOffset, xOffset + renderedWidth] = yOffset + renderedHeight\n canvas.drawBitmap(tempBitmap!!, renderSrcRect, renderDstRect, null)\n }\n return true\n }\n\n override fun setAlpha(alpha: Int) {\n // unimplemented\n }\n\n override fun setColorFilter(colorFilter: ColorFilter?) {\n // unimplemented\n }\n\n @Synchronized\n override fun setBounds(bounds: Rect) {\n this.bounds = bounds\n }\n\n override fun getIntrinsicWidth(): Int = webPImage.width\n\n override fun getIntrinsicHeight(): Int = webPImage.height\n\n override fun getSizeInBytes(): Int = 0\n\n override fun clear() {\n webPImage.dispose()\n }\n\n override fun getFrameCount(): Int = webPImage.frameCount\n\n override fun getFrameDurationMs(frameNumber: Int): Int = webPImage.frameDurations[frameNumber]\n\n override fun getLoopDurationMs(): Int = webPImage.duration\n\n override fun width(): Int = webPImage.width\n\n override fun height(): Int = webPImage.height\n\n override fun getLoopCount(): Int = webPImage.loopCount\n\n override fun preloadAnimation() {\n // not needed as bitmaps are extracted on fly\n }\n\n override fun setAnimationListener(listener: AnimationBackend.Listener?) {\n // unimplementedå\n }\n\n @Synchronized\n private fun prepareTempBitmapForThisSize(width: Int, height: Int) {\n // Different webp frames can be different size,\n // So we need to ensure we can fit next frame to temporary bitmap\n if (tempBitmap != null && (tempBitmap!!.width < width || tempBitmap!!.height < height)) {\n clearTempBitmap()\n }\n if (tempBitmap == null) {\n tempBitmap = Bitmap.createBitmap(width, height, Bitmap.Config.ARGB_8888)\n }\n tempBitmap!!.eraseColor(Color.TRANSPARENT)\n }\n\n @Synchronized\n private fun clearTempBitmap() {\n if (tempBitmap != null) {\n tempBitmap!!.recycle()\n tempBitmap = null\n }\n }\n\n companion object {\n @JvmStatic\n @Throws(IOException::class)\n fun create(filePath: String?): WebpAnimationBackend {\n var `is`: InputStream? = null\n try {\n `is` = BufferedInputStream(FileInputStream(filePath))\n `is`.mark(Int.MAX_VALUE)\n val targetArray = ByteArray(`is`.available())\n `is`.read(targetArray)\n\n val webPImage = WebPImage.createFromByteArray(targetArray, null)\n `is`.reset()\n\n return WebpAnimationBackend(webPImage)\n } finally {\n closeSilently(`is`)\n }\n }\n\n private fun closeSilently(closeable: Closeable?) {\n if (closeable == null) {\n return\n }\n try {\n closeable.close()\n } catch (ignored: IOException) {\n // ignore\n }\n }\n }\n}\n" }, { "path": "animated-webp/src/test/java/com/facebook/animated/webp/WebPImageDecoderTest.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.animated.webp\n\nimport android.graphics.Bitmap\nimport com.facebook.common.memory.PooledByteBuffer\nimport com.facebook.common.references.CloseableReference\nimport com.facebook.common.references.ResourceReleaser\nimport com.facebook.imageformat.ImageFormat\nimport com.facebook.imagepipeline.animated.base.AnimatedImageResult\nimport com.facebook.imagepipeline.animated.impl.AnimatedImageCompositor\nimport com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory\nimport com.facebook.imagepipeline.common.ImageDecodeOptions\nimport com.facebook.imagepipeline.image.CloseableAnimatedImage\nimport com.facebook.imagepipeline.image.CloseableStaticBitmap\nimport com.facebook.imagepipeline.image.EncodedImage\nimport com.facebook.imagepipeline.image.ImmutableQualityInfo\nimport com.facebook.imagepipeline.testing.MockBitmapFactory\nimport com.facebook.imagepipeline.testing.TrivialBufferPooledByteBuffer\nimport com.facebook.imagepipeline.testing.TrivialPooledByteBuffer\nimport java.nio.ByteBuffer\nimport org.assertj.core.api.Assertions.assertThat\nimport org.junit.After\nimport org.junit.Before\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.mockito.ArgumentMatchers\nimport org.mockito.MockedConstruction\nimport org.mockito.MockedStatic\nimport org.mockito.Mockito\nimport org.mockito.kotlin.mock\nimport org.mockito.kotlin.times\nimport org.mockito.kotlin.verify\nimport org.mockito.kotlin.verifyNoMoreInteractions\nimport org.mockito.kotlin.whenever\nimport org.robolectric.RobolectricTestRunner\n\n/** Tests for [WebPImageDecoder] */\n@RunWith(RobolectricTestRunner::class)\nclass WebPImageDecoderTest {\n private var mockBitmapFactory: PlatformBitmapFactory? = null\n private var webPImageDecoder: WebPImageDecoder? = null\n private var webPImageMockedStatic: MockedStatic? = null\n\n @Before\n fun setup() {\n webPImageMockedStatic = Mockito.mockStatic(WebPImage::class.java)\n mockBitmapFactory = mock()\n\n val bitmapFactory = mockBitmapFactory\n if (bitmapFactory != null) {\n webPImageDecoder =\n WebPImageDecoder(\n bitmapFactory,\n isNewRenderImplementation = false,\n downscaleFrameToDrawableDimensions = false,\n treatAnimatedImagesAsStateful = true,\n )\n }\n }\n\n @After\n fun tearDown() {\n webPImageMockedStatic?.close()\n }\n\n @Test\n fun testCreateDefaultsUsingPointer() {\n val mockWebPImage: WebPImage = mock()\n\n // Expect a call to WebPImage.createFromNativeMemory\n val byteBuffer: TrivialPooledByteBuffer = createByteBuffer()\n whenever(\n WebPImage.createFromNativeMemory(\n ArgumentMatchers.eq(byteBuffer.nativePtr),\n ArgumentMatchers.eq(byteBuffer.size()),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockWebPImage)\n\n testCreateDefaults(mockWebPImage, byteBuffer)\n }\n\n @Test\n fun testCreateDefaultsUsingByteBuffer() {\n val mockWebPImage: WebPImage = mock()\n\n // Expect a call to WebPImage.createFromByteBuffer\n val byteBuffer: TrivialBufferPooledByteBuffer = createDirectByteBuffer()\n whenever(\n WebPImage.createFromByteBuffer(\n ArgumentMatchers.any(),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockWebPImage)\n\n testCreateDefaults(mockWebPImage, byteBuffer)\n }\n\n @Test\n @Throws(Exception::class)\n fun testCreateWithPreviewBitmapUsingPointer() {\n val mockWebPImage: WebPImage = mock()\n val mockBitmap: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n\n // Expect a call to WebPImage.createFromNativeMemory\n val byteBuffer: TrivialPooledByteBuffer = createByteBuffer()\n whenever(\n WebPImage.createFromNativeMemory(\n ArgumentMatchers.eq(byteBuffer.nativePtr),\n ArgumentMatchers.eq(byteBuffer.size()),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockWebPImage)\n whenever(mockWebPImage.width).thenReturn(50)\n whenever(mockWebPImage.height).thenReturn(50)\n whenever(mockWebPImage.frameCount).thenReturn(1)\n whenever(mockWebPImage.frameDurations).thenReturn(intArrayOf(100))\n\n testCreateWithPreviewBitmap(mockWebPImage, byteBuffer, mockBitmap)\n }\n\n @Test\n @Throws(Exception::class)\n fun testCreateWithPreviewBitmapUsingByteBuffer() {\n val mockWebPImage: WebPImage = mock()\n val mockBitmap: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n\n // Expect a call to WebPImage.createFromByteBuffer\n val byteBuffer: TrivialBufferPooledByteBuffer = createDirectByteBuffer()\n whenever(\n WebPImage.createFromByteBuffer(\n ArgumentMatchers.any(),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockWebPImage)\n whenever(mockWebPImage.width).thenReturn(50)\n whenever(mockWebPImage.height).thenReturn(50)\n whenever(mockWebPImage.frameCount).thenReturn(1)\n whenever(mockWebPImage.frameDurations).thenReturn(intArrayOf(100))\n\n testCreateWithPreviewBitmap(mockWebPImage, byteBuffer, mockBitmap)\n }\n\n @Test\n @Throws(Exception::class)\n fun testCreateWithDecodeAlFramesUsingPointer() {\n val mockWebPImage: WebPImage = mock()\n\n val mockBitmap1: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n val mockBitmap2: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n\n // Expect a call to WebPImage.createFromNativeMemory\n val byteBuffer: TrivialPooledByteBuffer = createByteBuffer()\n whenever(\n WebPImage.createFromNativeMemory(\n ArgumentMatchers.eq(byteBuffer.nativePtr),\n ArgumentMatchers.eq(byteBuffer.size()),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockWebPImage)\n whenever(mockWebPImage.width).thenReturn(50)\n whenever(mockWebPImage.height).thenReturn(50)\n whenever(mockWebPImage.frameCount).thenReturn(2)\n whenever(mockWebPImage.frameDurations).thenReturn(intArrayOf(100, 150))\n\n testCreateWithDecodeAlFrames(mockWebPImage, byteBuffer, mockBitmap1, mockBitmap2)\n }\n\n @Test\n @Throws(Exception::class)\n fun testCreateWithDecodeAlFramesUsingByteBuffer() {\n val mockWebPImage: WebPImage = mock()\n\n val mockBitmap1: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n val mockBitmap2: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n\n // Expect a call to WebPImage.createFromByteBuffer\n val byteBuffer: TrivialBufferPooledByteBuffer = createDirectByteBuffer()\n whenever(\n WebPImage.createFromByteBuffer(\n ArgumentMatchers.any(),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockWebPImage)\n whenever(mockWebPImage.width).thenReturn(50)\n whenever(mockWebPImage.height).thenReturn(50)\n whenever(mockWebPImage.frameCount).thenReturn(2)\n whenever(mockWebPImage.frameDurations).thenReturn(intArrayOf(100, 150))\n\n testCreateWithDecodeAlFrames(mockWebPImage, byteBuffer, mockBitmap1, mockBitmap2)\n }\n\n private fun testCreateDefaults(mockWebPImage: WebPImage, byteBuffer: PooledByteBuffer) {\n val encodedImage: EncodedImage =\n EncodedImage(CloseableReference.of(byteBuffer, FAKE_RESOURCE_RELEASER))\n encodedImage.imageFormat = ImageFormat.UNKNOWN\n\n val closeableImage: CloseableAnimatedImage? =\n webPImageDecoder?.decode(\n encodedImage,\n byteBuffer.size(),\n ImmutableQualityInfo.FULL_QUALITY,\n ImageDecodeOptions.defaults(),\n ) as? CloseableAnimatedImage\n\n // Verify we got the right result\n val imageResult: AnimatedImageResult? = closeableImage?.imageResult\n assertThat(imageResult?.image).isSameAs(mockWebPImage)\n assertThat(imageResult?.previewBitmap).isNull()\n assertThat(imageResult?.hasDecodedFrame(0) == true).isFalse()\n\n // Should not have interacted with bitmap factory for basic decoding\n mockBitmapFactory?.let { Mockito.verifyNoInteractions(it) }\n }\n\n @Throws(Exception::class)\n private fun testCreateWithPreviewBitmap(\n mockWebPImage: WebPImage,\n byteBuffer: PooledByteBuffer,\n mockBitmap: Bitmap,\n ) {\n whenever(mockBitmapFactory?.createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG))\n .thenReturn(CloseableReference.of(mockBitmap, FAKE_BITMAP_RESOURCE_RELEASER))\n\n Mockito.mockConstruction(AnimatedImageCompositor::class.java).use {\n animatedImageCompositorConstruction: MockedConstruction ->\n val imageDecodeOptions: ImageDecodeOptions =\n ImageDecodeOptions.newBuilder().setDecodePreviewFrame(true).build()\n val encodedImage: EncodedImage =\n EncodedImage(CloseableReference.of(byteBuffer, FAKE_RESOURCE_RELEASER))\n encodedImage.imageFormat = ImageFormat.UNKNOWN\n val closeableImage: CloseableAnimatedImage? =\n webPImageDecoder?.decode(\n encodedImage,\n byteBuffer.size(),\n ImmutableQualityInfo.FULL_QUALITY,\n imageDecodeOptions,\n ) as? CloseableAnimatedImage\n\n // Verify we got the right result\n val imageResult: AnimatedImageResult? = closeableImage?.imageResult\n assertThat(imageResult?.image).isSameAs(mockWebPImage)\n assertThat(imageResult?.previewBitmap).isNotNull()\n assertThat(imageResult?.hasDecodedFrame(0) == true).isFalse()\n\n mockBitmapFactory?.let { factory ->\n verify(factory).createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG)\n verifyNoMoreInteractions(factory)\n }\n animatedImageCompositorConstruction.constructed().getOrNull(0)?.let { compositor ->\n verify(compositor).renderFrame(0, mockBitmap)\n }\n }\n }\n\n @Throws(Exception::class)\n private fun testCreateWithDecodeAlFrames(\n mockWebPImage: WebPImage,\n byteBuffer: PooledByteBuffer,\n mockBitmap1: Bitmap,\n mockBitmap2: Bitmap,\n ) {\n whenever(mockBitmapFactory?.createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG))\n .thenReturn(CloseableReference.of(mockBitmap1, FAKE_BITMAP_RESOURCE_RELEASER))\n .thenReturn(CloseableReference.of(mockBitmap2, FAKE_BITMAP_RESOURCE_RELEASER))\n\n Mockito.mockConstruction(AnimatedImageCompositor::class.java).use {\n animatedImageCompositorConstruction: MockedConstruction ->\n val imageDecodeOptions: ImageDecodeOptions =\n ImageDecodeOptions.newBuilder()\n .setDecodePreviewFrame(true)\n .setDecodeAllFrames(true)\n .build()\n\n val encodedImage: EncodedImage =\n EncodedImage(CloseableReference.of(byteBuffer, FAKE_RESOURCE_RELEASER))\n encodedImage.imageFormat = ImageFormat.UNKNOWN\n\n val closeableImage: CloseableAnimatedImage? =\n webPImageDecoder?.decode(\n encodedImage,\n byteBuffer.size(),\n ImmutableQualityInfo.FULL_QUALITY,\n imageDecodeOptions,\n ) as? CloseableAnimatedImage\n\n // Verify we got the right result\n val imageResult: AnimatedImageResult? = closeableImage?.imageResult\n assertThat(imageResult?.image).isSameAs(mockWebPImage)\n assertThat(imageResult?.getDecodedFrame(0)).isNotNull()\n assertThat(imageResult?.getDecodedFrame(1)).isNotNull()\n assertThat(imageResult?.previewBitmap).isNotNull()\n\n mockBitmapFactory?.let { factory ->\n verify(factory, times(2)).createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG)\n verifyNoMoreInteractions(factory)\n }\n val mockCompositor = animatedImageCompositorConstruction.constructed().getOrNull(0)\n mockCompositor?.let { compositor ->\n verify(compositor).renderFrame(0, mockBitmap1)\n verify(compositor).renderFrame(1, mockBitmap2)\n }\n }\n }\n\n @Test\n fun testDecodeForceStaticImage() {\n val mockWebPImage: WebPImage = mock()\n val mockBitmap: Bitmap = MockBitmapFactory.create(50, 50, DEFAULT_BITMAP_CONFIG)\n\n val byteBuffer: TrivialPooledByteBuffer = createByteBuffer()\n whenever(\n WebPImage.createFromNativeMemory(\n ArgumentMatchers.eq(byteBuffer.nativePtr),\n ArgumentMatchers.eq(byteBuffer.size()),\n ArgumentMatchers.any(ImageDecodeOptions::class.java),\n )\n )\n .thenReturn(mockWebPImage)\n whenever(mockWebPImage.width).thenReturn(50)\n whenever(mockWebPImage.height).thenReturn(50)\n whenever(mockWebPImage.frameCount).thenReturn(1)\n whenever(mockWebPImage.frameDurations).thenReturn(intArrayOf(100))\n whenever(mockBitmapFactory?.createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG))\n .thenReturn(CloseableReference.of(mockBitmap, FAKE_BITMAP_RESOURCE_RELEASER))\n\n Mockito.mockConstruction(AnimatedImageCompositor::class.java).use {\n animatedImageCompositorConstruction: MockedConstruction ->\n val imageDecodeOptions: ImageDecodeOptions =\n ImageDecodeOptions.newBuilder().setForceStaticImage(true).build()\n val encodedImage: EncodedImage =\n EncodedImage(CloseableReference.of(byteBuffer, FAKE_RESOURCE_RELEASER))\n encodedImage.imageFormat = ImageFormat.UNKNOWN\n\n val closeableImage: CloseableStaticBitmap? =\n webPImageDecoder?.decode(\n encodedImage,\n byteBuffer.size(),\n ImmutableQualityInfo.FULL_QUALITY,\n imageDecodeOptions,\n ) as? CloseableStaticBitmap\n\n // Verify we got a static bitmap instead of animated image\n assertThat(closeableImage).isNotNull()\n assertThat(closeableImage?.underlyingBitmap).isNotNull()\n\n mockBitmapFactory?.let { factory ->\n verify(factory).createBitmapInternal(50, 50, DEFAULT_BITMAP_CONFIG)\n verifyNoMoreInteractions(factory)\n }\n verify(animatedImageCompositorConstruction.constructed()[0]).renderFrame(0, mockBitmap)\n }\n }\n\n @Test\n fun testDecodeWithInvalidWebP() {\n // Create an invalid WebP by using an empty byte buffer\n val invalidWebPData = ByteArray(0) // Empty array will cause validation to fail\n val byteBuffer = TrivialPooledByteBuffer(invalidWebPData)\n\n val encodedImage: EncodedImage =\n EncodedImage(CloseableReference.of(byteBuffer, FAKE_RESOURCE_RELEASER))\n encodedImage.imageFormat = ImageFormat.UNKNOWN\n\n try {\n webPImageDecoder?.decode(\n encodedImage,\n byteBuffer.size(),\n ImmutableQualityInfo.FULL_QUALITY,\n ImageDecodeOptions.defaults(),\n )\n assertThat(false).`as`(\"Expected exception to be thrown\").isTrue()\n } catch (e: Exception) {\n // Expected - invalid WebP should cause an exception\n assertThat(e).isNotNull()\n }\n }\n\n companion object {\n private val DEFAULT_BITMAP_CONFIG = Bitmap.Config.ARGB_8888\n\n private val FAKE_RESOURCE_RELEASER: ResourceReleaser =\n object : ResourceReleaser {\n override fun release(value: PooledByteBuffer) = Unit\n }\n\n private val FAKE_BITMAP_RESOURCE_RELEASER: ResourceReleaser =\n object : ResourceReleaser {\n override fun release(value: Bitmap) = Unit\n }\n\n private fun createByteBuffer(): TrivialPooledByteBuffer {\n val buf = ByteArray(16)\n return TrivialPooledByteBuffer(buf)\n }\n\n private fun createDirectByteBuffer(): TrivialBufferPooledByteBuffer {\n val buf = ByteArray(16)\n return TrivialBufferPooledByteBuffer(buf)\n }\n }\n}\n" }, { "path": "bots/IssueCommands.txt", "content": "@facebook-github-bot stack-overflow\ncomment Hey {issue_author} and thanks for posting this! {author} tells me this issue looks like a question that would be best asked on [StackOverflow](http://stackoverflow.com/questions/tagged/fresco). StackOverflow is amazing for Q&A: it has a reputation system, voting, the ability to mark a question as answered. Because of the reputation system it is likely the community will see and answer your question there. This also helps us use the GitHub bug tracker for bugs only. Will close this as this is really a question that should be asked on SO.\nadd-label Stack Overflow\nclose\n" }, { "path": "build.gradle", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nimport de.undercouch.gradle.tasks.download.Download\nimport org.apache.tools.ant.taskdefs.condition.Os\nimport com.facebook.fresco.buildsrc.Deps\nimport com.facebook.fresco.buildsrc.GradleDeps\n\n// Top-level build file where you can add configuration options common to all sub-projects/modules.\n\nbuildscript {\n repositories {\n google()\n mavenCentral()\n }\n dependencies {\n classpath GradleDeps.Android.gradlePlugin\n classpath GradleDeps.Kotlin.gradlePlugin\n\n // NOTE: Do not place your application dependencies here; they belong\n // in the individual module build.gradle files\n }\n}\n\nplugins {\n id \"de.undercouch.download\" version \"5.3.1\"\n id \"com.vanniktech.maven.publish\" version \"0.25.3\"\n}\n\n// Make sure to add trailing slash to the absolute paths\nLinkedHashMap commonNdkLocations = [\n \"macOS-internal\":\"/opt/android_sdk/ndk/\",\n \"linux-ubuntu\":\"/usr/local/lib/android/sdk/ndk/\",\n]\n\nsubprojects {\n\n repositories {\n google()\n mavenCentral()\n }\n\n // FIXME: This picks up non-Java files by default, failing to parse them.\n // Need to configure this more carefully.\n tasks.withType(Javadoc).all {\n enabled = false\n }\n\n tasks.withType(com.android.build.gradle.tasks.JavaDocGenerationTask).all {\n enabled = false\n }\n\n\n if (System.getenv(\"SANDCASTLE\") == \"1\") {\n tasks.withType(Test).all {\n systemProperty(\"robolectric.dependency.repo.id\", \"central\")\n systemProperty(\"robolectric.dependency.repo.url\", \"https://maven.thefacebook.com/nexus/content/repositories/central/\")\n systemProperty(\"robolectric.logging\", \"stdout\")\n systemProperty(\"robolectric.logging.enabled\", \"true\")\n systemProperty(\"java.net.preferIPv6Addresses\", \"true\")\n systemProperty(\"java.net.preferIPv4Stack\", \"false\")\n systemProperty(\"jdk.attach.allowAttachSelf\", \"true\")\n jvmArgs '-XX:+StartAttachListener'\n }\n }\n\n configurations.all {\n resolutionStrategy.force Deps.jsr305\n }\n\n task allclean {\n }\n\n // Sets the ndkPath for each module when running on CI\n if (System.getenv(\"SANDCASTLE\") == \"1\") {\n String ndkDir = System.getenv(\"ANDROID_NDK_HOME\")\n project.plugins.whenPluginAdded { plugin ->\n if (\"com.android.build.gradle.AppPlugin\" == plugin.class.name) {\n project.android.ndkPath = ndkDir\n } else if (\"com.android.build.gradle.LibraryPlugin\" == plugin.class.name) {\n project.android.ndkPath = ndkDir\n }\n }\n }\n\n apply plugin: 'de.undercouch.download'\n\n ext.makeNdkTasks = { name, deps ->\n task \"ndk_build_${name}\"(dependsOn: deps, type: Exec) {\n inputs.files(\"src/main/jni/${name}\")\n outputs.dir(\"$buildDir/${name}\")\n commandLine getNdkBuildFullPath(project),\n 'NDK_PROJECT_PATH=null',\n 'NDK_APPLICATION_MK=../Application.mk',\n 'NDK_OUT=' + temporaryDir,\n \"NDK_LIBS_OUT=$buildDir/${name}\",\n '-C', file(\"src/main/jni/${name}\").absolutePath,\n '--jobs', Runtime.getRuntime().availableProcessors()\n }\n\n task \"ndk_clean_$name\"(type: Exec) {\n ignoreExitValue true\n commandLine getNdkBuildFullPath(project),\n 'NDK_PROJECT_PATH=null',\n 'NDK_APPLICATION_MK=../Application.mk',\n 'NDK_OUT=' + temporaryDir,\n \"NDK_LIBS_OUT=$buildDir/${name}\",\n '-C', file(\"src/main/jni/${name}\").absolutePath,\n 'clean'\n }\n\n tasks.withType(JavaCompile) {\n compileTask -> compileTask.dependsOn \"ndk_build_$name\"\n }\n clean.dependsOn \"ndk_clean_$name\"\n }\n\n ext.getNdkBuildName = {\n if (Os.isFamily(Os.FAMILY_WINDOWS)) {\n return \"ndk-build.cmd\"\n } else {\n return \"ndk-build\"\n }\n }\n\n ext.discoverNdkPathFromCommonLocations = { String ndkVersion ->\n String foundNdkLocation = null\n for (entry in commonNdkLocations) {\n String variant = entry.key\n String location = entry.value\n\n String ndkDir = location + ndkVersion\n File ndkFolder = new File(ndkDir)\n if (ndkFolder.exists()) {\n println(\"NDK Path found using: common $variant location\")\n foundNdkLocation = ndkDir\n break\n }\n }\n\n return foundNdkLocation\n }\n\n ext.getNdkBuildFullPath = { Project project ->\n String path = null\n\n // Latest method using the common NDK version used throughout the project and using the standard NDK SxS location on macOS\n if (path == null) {\n path = discoverNdkPathFromCommonLocations(GradleDeps.Native.version)\n }\n\n // Fallback method for CI\n if (path == null) {\n String ndkDir = System.getenv(\"ANDROID_NDK_HOME\")\n if (ndkDir != null) {\n File ndkFolder = new File(ndkDir)\n if (ndkFolder.exists()) {\n path = ndkDir\n println(\"NDK Path found using: ANDROID_NDK_HOME\")\n }\n }\n }\n\n // Legacy methods of finding NDK path\n if (path == null) {\n File propFile = project.rootProject.file('local.properties')\n if (!propFile.exists()) {\n println(\"NDK Path found using: local.props missing, just the command name\")\n return getNdkBuildName()\n }\n Properties properties = new Properties()\n properties.load(propFile.newDataInputStream())\n def ndkCommand = properties.getProperty('ndk.command')\n if (ndkCommand != null) {\n println(\"NDK Path found using: ndk.command\")\n return ndkCommand\n }\n def ndkPath = properties.getProperty('ndk.path')\n if (ndkPath != null) {\n println(\"NDK Path found using: ndk.path\")\n path = ndkPath\n } else {\n def ndkDir = properties.getProperty('ndk.dir')\n if (ndkDir != null) {\n println(\"NDK Path found using: ndk.dir\")\n path = ndkDir\n }\n }\n }\n\n if (path != null) {\n if (!path.endsWith(File.separator)) {\n path += File.separator\n }\n return path + getNdkBuildName()\n } else {\n // if none of above is provided, we assume ndk-build is already in $PATH\n return getNdkBuildName()\n }\n }\n\n ext.nativeDepsDir = new File(\"${projectDir}/nativedeps\")\n ext.downloadsDir = new File(\"${nativeDepsDir}/downloads\")\n ext.mergeDir = new File(\"${nativeDepsDir}/merge\")\n\n task removeNativeDeps(type: Delete) {\n delete nativeDepsDir\n }\n allclean.dependsOn removeNativeDeps\n\n task createNativeDepsDirectories {\n nativeDepsDir.mkdirs()\n downloadsDir.mkdirs()\n mergeDir.mkdirs()\n }\n\n ext.createNativeLibrariesTasks = {name, libraryUrl, libraryFileName, libraryDestinationDir, sourceDir, includePaths, destinationDir ->\n // We create the DownloadTask\n tasks.create(\"download${name}\", Download) {\n src libraryUrl\n onlyIfNewer true\n overwrite false\n dest \"${downloadsDir}/${libraryFileName}\"\n dependsOn createNativeDepsDirectories\n }\n // The unpack task\n tasks.create(\"unpack${name}\", Copy) {\n String filePath = \"${downloadsDir}/${libraryFileName}\"\n ReadableResource resource\n if (filePath.endsWith(\"gz\")) {\n resource = resources.gzip(filePath)\n } else if (filePath.endsWith(\"bz2\")) {\n resource = resources.bzip2(filePath)\n } else {\n throw new GradleException(\"Could not unpack library \" + filePath)\n }\n from tarTree(resource)\n into \"${downloadsDir}/${libraryDestinationDir}\"\n dependsOn \"download${name}\"\n }\n // The copy task\n Task unpackTask = tasks.getByName(\"unpack${name}\")\n tasks.create(\"copy${name}\", Copy) {\n from \"${unpackTask.destinationDir}/${sourceDir}\"\n from \"src/main/jni/third-party/${destinationDir}\"\n // Allows for overriding when duplicates are encountered.\n duplicatesStrategy DuplicatesStrategy.INCLUDE\n include(includePaths)\n into \"${mergeDir}/${destinationDir}\"\n dependsOn \"unpack${name}\"\n }\n\n }\n\n // Libjpeg-turbo\n createNativeLibrariesTasks(\n 'Libjpeg', // Name for the tasks\n \"https://github.com/libjpeg-turbo/libjpeg-turbo/archive/${LIBJPEG_TURBO_VERSION}.tar.gz\", // The Url for download\n \"${LIBJPEG_TURBO_VERSION}.tar.gz\", // The downloaded file\n 'libjpeg', // The folder where the file is downloaded\n \"libjpeg-turbo-${LIBJPEG_TURBO_VERSION}\", // The first dir where we have put our customisation\n ['**/*.c', '**/*.h','**/*.S', '**/*.asm', '**/*.inc', '*.mk'], // Files to compile\n \"libjpeg-turbo-${LIBJPEG_TURBO_VERSION}\" // Final destination dir\n )\n\n // Libpng\n createNativeLibrariesTasks(\n 'Libpng', // Name for the tasks\n \"https://github.com/glennrp/libpng/archive/v${LIBPNG_VERSION}.tar.gz\", // The Url for download\n \"v${LIBPNG_VERSION}.tar.gz\", // The downloaded file\n 'libpng', // The folder where the file is downloaded\n \"libpng-${LIBPNG_VERSION}\", // The first dir where we have put our customisation\n ['**/*.c', '**/*.h', '**/*.S', '*.mk'], // Files to compile\n \"libpng-${LIBPNG_VERSION}\" // Final destination dir\n )\n\n // Gif\n createNativeLibrariesTasks(\n 'Giflib', // Name for the tasks\n \"https://sourceforge.net/projects/giflib/files/giflib-${GIFLIB_VERSION}.tar.gz/download\", // The Url for download\n \"giflib-${GIFLIB_VERSION}.tar.gz\", // The downloaded file\n 'giflib', // The folder where the file is downloaded\n \"giflib-${GIFLIB_VERSION}\", // The first dir where we have put our customisation\n ['*.c', '*.h', '*.mk'], // Files to compile\n \"giflib\" // Final destination dir\n )\n\n // Webp\n createNativeLibrariesTasks(\n 'Libwebp', // Name for the tasks\n \"https://github.com/webmproject/libwebp/archive/v${LIBWEBP_VERSION}.tar.gz\", // The Url for download\n \"v${LIBWEBP_VERSION}.tar.gz\", // The downloaded file\n 'libwebp', // The folder where the file is downloaded\n \"libwebp-${LIBWEBP_VERSION}\", // The first dir where we have put our customisation\n ['**/*.c', '**/*.h', '*.mk'], // Files to compile\n \"libwebp-${LIBWEBP_VERSION}\" // Final destination dir\n )\n}\n" }, { "path": "buildSrc/build.gradle.kts", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nrepositories { mavenCentral() }\n\nplugins { `kotlin-dsl` }\n" }, { "path": "buildSrc/src/main/java/com/facebook/fresco/buildsrc/FrescoConfig.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nobject FrescoConfig {\n const val buildToolsVersion = \"34.0.0\"\n\n const val compileSdkVersion = 34\n const val minSdkVersion = 21\n const val flipperPluginMinSdkVersion = 21\n const val vitoLithoMinSdkVersion = 21\n const val samplesMinSdkVersion = 21\n const val targetSdkVersion = 34\n}\n" }, { "path": "buildSrc/src/main/java/com/facebook/fresco/buildsrc/GradleDeps.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.buildsrc\n\nobject GradleDeps {\n\n object Android {\n private const val version = \"8.5.2\"\n\n const val gradlePlugin = \"com.android.tools.build:gradle:$version\"\n }\n\n object Kotlin {\n const val version = \"2.0.0\"\n const val gradlePlugin = \"org.jetbrains.kotlin:kotlin-gradle-plugin:$version\"\n const val stdlib = \"org.jetbrains.kotlin:kotlin-stdlib:$version\"\n }\n\n object Native {\n const val version = \"27.1.12297006\"\n }\n\n object Publishing {\n const val gradleMavenPublishPlugin = \"com.vanniktech:gradle-maven-publish-plugin:0.25.3\"\n }\n}\n" }, { "path": "buildSrc/src/main/java/com/facebook/fresco/buildsrc/TestDeps.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.buildsrc\n\nobject TestDeps {\n const val assertjCore = \"org.assertj:assertj-core:2.9.1\"\n\n const val junit = \"junit:junit:4.12\"\n\n const val mockitoCore = \"org.mockito:mockito-core:2.28.2\"\n const val mockitoInline = \"org.mockito:mockito-inline:2.28.2\"\n const val mockitoKotlin = \"org.mockito.kotlin:mockito-kotlin:2.2.11\"\n\n const val mockitoCore3 = \"org.mockito:mockito-core:3.12.4\"\n const val mockitoInline3 = \"org.mockito:mockito-inline:3.12.4\"\n const val mockitoKotlin3 = \"org.mockito.kotlin:mockito-kotlin:3.1.0\"\n\n const val festAssertCore = \"org.easytesting:fest-assert-core:2.0M10\"\n\n const val robolectric = \"org.robolectric:robolectric:4.12.2\"\n\n const val truth = \"com.google.truth:truth:1.0.1\"\n\n object AndroidX {\n const val espressoCore = \"androidx.test.espresso:espresso-core:3.1.1\"\n const val testRules = \"androidx.test:rules:1.1.1\"\n const val testRunner = \"androidx.test:runner:1.1.1\"\n }\n}\n" }, { "path": "buildSrc/src/main/java/com/facebook/fresco/buildsrc/dependencies-samples.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.buildsrc\n\nobject SampleDeps {\n\n object AndroidX {\n const val appcompat = \"androidx.appcompat:appcompat:1.0.2\"\n const val cardview = \"androidx.cardview:cardview:1.0.0\"\n const val multidex = \"androidx.multidex:multidex:2.0.1\"\n const val preference = \"androidx.preference:preference:1.0.0\"\n const val recyclerview = \"androidx.recyclerview:recyclerview:1.0.0\"\n }\n\n object Google {\n const val material = \"com.google.android.material:material:1.1.0-alpha03\"\n }\n\n object Comparison {\n object Glide {\n private const val version = \"4.9.0\"\n const val glide = \"com.github.bumptech.glide:glide:$version\"\n const val compiler = \"com.github.bumptech.glide:compiler:$version\"\n }\n\n object Uil {\n private const val version = \"1.9.5\"\n const val uil = \"com.nostra13.universalimageloader:universal-image-loader:$version\"\n }\n\n object Picasso {\n private const val version = \"2.71828\"\n const val picasso = \"com.squareup.picasso:picasso:$version\"\n const val okhttpDownloader = \"com.jakewharton.picasso:picasso2-okhttp3-downloader:1.0.2\"\n }\n\n object AndroidQuery {\n private const val version = \"0.25.9\"\n const val aquery = \"com.googlecode.android-query:android-query:$version\"\n }\n }\n\n object Showcase {\n\n const val caverockSvg = \"com.caverock:androidsvg-aar:1.4\"\n }\n\n object Zoomable {\n const val legacyAndroidXSupportCoreUi = \"androidx.legacy:legacy-support-core-ui:1.0.0\"\n }\n}\n" }, { "path": "buildSrc/src/main/java/com/facebook/fresco/buildsrc/dependencies.kt", "content": "/*\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n *\n * This source code is licensed under the MIT license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\npackage com.facebook.fresco.buildsrc\n\nobject Deps {\n const val javaxAnnotation = \"javax.annotation:javax.annotation-api:1.3.2\"\n const val jsr305 = \"com.google.code.findbugs:jsr305:3.0.2\"\n\n const val inferAnnotation = \"com.facebook.infer.annotation:infer-annotation:0.18.0\"\n\n const val okhttp3 = \"com.squareup.okhttp3:okhttp:3.14.9\"\n\n const val volley = \"com.android.volley:volley:1.2.1\"\n\n object AndroidX {\n const val androidxAnnotation = \"androidx.annotation:annotation:1.6.0\"\n const val core = \"androidx.core:core:1.13.1\"\n const val exifInterface = \"androidx.exifinterface:exifinterface:1.3.7\"\n const val legacySupportCoreUtils = \"androidx.legacy:legacy-support-core-utils:1.0.0\"\n }\n\n object Bolts {\n const val tasks = \"com.parse.bolts:bolts-tasks:1.4.0\"\n }\n\n object Kotlin {\n const val version = GradleDeps.Kotlin.version\n\n const val stdlibJdk = \"org.jetbrains.kotlin:kotlin-stdlib:$version\"\n }\n\n object Litho {\n private const val version = \"0.50.1\"\n\n const val core = \"com.facebook.litho:litho-core:$version\"\n const val lithoAnnotations = \"com.facebook.litho:litho-annotations:$version\"\n const val processor = \"com.facebook.litho:litho-processor:$version\"\n const val widget = \"com.facebook.litho:litho-widget:$version\"\n\n object Sections {\n const val core = \"com.facebook.litho:litho-sections-core:$version\"\n const val processor = \"com.facebook.litho:litho-sections-processor:$version\"\n const val sectionsAnnotations = \"com.facebook.litho:litho-sections-annotations:$version\"\n const val widget = \"com.facebook.litho:litho-sections-widget:$version\"\n }\n }\n\n object SoLoader {\n private const val version = \"0.11.0\"\n const val soloaderAnnotation = \"com.facebook.soloader:annotation:$version\"\n const val nativeloader = \"com.facebook.soloader:nativeloader:$version\"\n const val soloader = \"com.facebook.soloader:soloader:$version\"\n }\n\n object Tools {\n object Flipper {\n private const val version = \"0.183.0\"\n const val flipper = \"com.facebook.flipper:flipper:$version\"\n }\n\n object Stetho {\n private const val version = \"1.6.0\"\n const val stetho = \"com.facebook.stetho:stetho:$version\"\n const val okhttp3 = \"com.facebook.stetho:stetho-okhttp3:$version\"\n }\n }\n}\n" }, { "path": "ci/build-and-test.sh", "content": "#!/bin/bash\n# Copyright (c) Meta Platforms, Inc. and affiliates.\n#\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\nif [[ $1 == \"--local\" || $1 == \"-l\" ]]; then\n # Local build with less verbose output\n ./gradlew test assembleDebug assembleDebugAndroidTest\nelse\n # Standard CI build command with maximum verbose output\n ./gradlew test assembleDebug assembleDebugAndroidTest --info\nfi\n" }, { "path": "ci/print-debug-info.sh", "content": "#!/bin/bash\n# Copyright (c) Meta Platforms, Inc. and affiliates.\n#\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\necho \"\"\necho \"Fresco CI Debug information begin\"\n\necho \"\"\necho \"env PATH: $PATH\"\n\necho \"\"\necho \"env ANDROID_NDK_HOME: $ANDROID_NDK_HOME\"\n\necho \"\"\necho \"Fresco CI Debug information end\"\n" }, { "path": "docs/.gitignore", "content": ".DS_STORE\n_site/\n*-e\nGemfile.lock\n*.swo\n*.swp\n.gradle\n.DS_Store\n.idea\nbuild/\nlocal.properties\nobj/\n*.iml\nnativedeps/\n.sass-cache/\n.jekyll-metadata\n" }, { "path": "docs/CNAME", "content": "frescolib.org" }, { "path": "docs/Gemfile", "content": "source 'https://rubygems.org'\n\ngem 'github-pages', '~> 145', group: :jekyll_plugins\n" }, { "path": "docs/NOGREP", "content": "\n\n" }, { "path": "docs/README.md", "content": "# User Documentation for frescolib.org\n\nThis folder contains the user and feature documentation for Fresco.\n\n### Run the Site Locally\n\n1. Make sure you have Ruby and [RubyGems](https://rubygems.org/) installed\n2. Make sure you have [Jekyll](https://jekyllrb.com/) installed\n\n gem install jekyll\n3. Run Jekyll's server\n\n jekyll serve\n4. The site will be served from http://localhost:4000\n" }, { "path": "docs/_config.yml", "content": "---\npermalink: /blog/:categories/:year/:month/:day/:title.html\nurl: \"https://frescolib.org\"\nbaseurl: \"\"\ntitle: Fresco\ntagline: An Image Management Library\nfbappid: \"1615782811974223\"\ngacode: \"UA-44373548-3\"\nrelative_permalinks: false\ndescription: >\n Fresco is a powerful system for displaying images in Android applications. It takes care of image loading and display so you don’t have to. Fresco supports Android 2.3 (Gingerbread) and later.\ntimezone: America/Los_Angeles\nghrepo: \"facebook/fresco\"\nlogo: /static/logo.png\n\ncurrent_version: 3.6.0\n\nsupport_library_version: 24.2.1\n\nmarkdown: kramdown\nkramdown:\n input: GFM\n syntax_highlighter: rouge\n\n syntax_highlighter_opts:\n css_class: 'rougeHighlight'\n span:\n line_numbers: false\n block:\n line_numbers: true\n start_line: 1\n\nsass:\n style: :compressed\n\ncollections:\n docs:\n output: true\n permalink: /docs/:name/\n support:\n output: true\n permalink: /support/\n\ncolor:\n primary: \"#db6130\"\n secondary: \"#f9f9f9\"\n # Use the following to specify whether the previous two colours are 'light'\n # or 'dark'\n primary-overlay: \"dark\"\n secondary-overlay: \"light\"\n\n# Gems\ngems:\n - jekyll-feed\n - jekyll-seo-tag\n - jekyll-sitemap\n - jekyll-redirect-from\n\n# Set default open graph image for all pages\ndefaults:\n -\n scope:\n path: \"\"\n values:\n image: /static/og_image.png\n" }, { "path": "docs/_data/authors.yml", "content": "balazsbalazs:\n full_name: Balazs Balazs\n fbid: 100000563635135\nkirwanlyster:\n full_name: Kirwan Lyster\n fbid: 688556227\noprisnik:\n full_name: Alexander Oprisnik\n fbid: 604555002\ntnicholas:\n full_name: Tyrone Nicholas\n fbid: 622549419\nmaxcarli:\n full_name: Massimo Carli\n fbid: 1218930908\njiew:\n full_name: Jie Wang\n fbid: 100008065290380\n" }, { "path": "docs/_data/nav.yml", "content": "- title: Docs\n href: /docs/\n category: docs\n\n- title: Support\n href: /support.html\n category: support\n\n- title: API\n href: /javadoc/\n category: apidocs\n\n- title: GitHub\n href: https://github.com/facebook/fresco\n category: github\n\n- title: 中文版\n href: http://fresco-cn.org/\n category: github\n" }, { "path": "docs/_data/nav_docs.yml", "content": "- title: Getting Started\n items:\n - id: index\n - id: proguard\n- title: Basic Features\n items:\n - id: using-simpledraweeview\n - id: rounded-corners-and-circles\n - id: progress-bars\n - id: scaletypes\n - id: placeholder-failure-retry\n - id: rotation\n - id: resizing\n - id: supported-uris\n- title: Advanced Topics\n items:\n - id: caching\n - id: closeable-references\n - id: configure-image-pipeline\n - id: datasources-datasubscribers\n - id: image-requests\n - id: images-in-notifications\n - id: listening-to-events\n - id: prefetching\n - id: post-processor\n - id: requesting-multiple-images\n - id: shared-transitions\n - id: using-controllerbuilder\n - id: using-image-pipeline\n - id: using-other-network-layers\n - id: writing-custom-views\n- title: Image formats\n items:\n - id: progressive-jpegs\n - id: animations\n - id: webp-support\n - id: customizing-image-formats\n- title: Troubleshooting & FAQ\n items:\n - id: faq\n - id: troubleshooting\n - id: gotchas\n- title: Contributors Guide\n items:\n - id: building-from-source\n - id: sample-code\n - id: concepts\n - id: drawee-branches\n - id: intro-image-pipeline\n" }, { "path": "docs/_data/powered_by.yml", "content": "- title: Apps Using Fresco\n items:\n - name: TamTam Messenger\n url: https://play.google.com/store/apps/details?id=ru.ok.messages\n - name: Frost Blur\n url: https://play.google.com/store/apps/details?id=com.rvnd.frostblur\n - name: Book Share\n url: https://play.google.com/store/apps/details?id=com.rvnd.bookshare\n - name: Vimeo\n url: https://play.google.com/store/apps/details?id=com.vimeo.android.videoapp\n - name: Best Apps Market\n url: https://play.google.com/store/apps/details?id=com.bestappsmarket.android.bestapps\n - name: Redfin\n url: https://play.google.com/store/apps/details?id=com.redfin.android\n - name: Memrise\n url: https://play.google.com/store/apps/details?id=com.memrise.android.memrisecompanion\n - name: local.ch\n url: https://play.google.com/store/apps/details?id=ch.local.android\n - name: Mappy\n url: https://play.google.com/store/apps/details?id=com.mappy.app\n - name: YOP\n url: https://play.google.com/store/apps/details?id=com.yopapp.yop\n - name: ChatGame\n url: https://play.google.com/store/apps/details?id=me.chatgame.mobilecg\n - name: Bobble\n url: https://play.google.com/store/apps/details?id=com.touchtalent.bobbleapp\n - name: ShareTheMeal\n url: https://play.google.com/store/apps/details?id=org.sharethemeal.app\n - name: NativeScript Apps\n url: https://www.nativescript.org/\n - name: TouTiao\n url: https://play.google.com/store/apps/details?id=com.ss.android.article.news\n - name: Playbuzz\n url: https://play.google.com/store/apps/details?id=com.playbuzz.android.app\n - name: Camerite\n url: https://play.google.com/store/apps/details?id=com.camerite\n - name: nice\n url: https://play.google.com/store/apps/details?id=com.nice.main\n - name: JokeEssay\n url: https://play.google.com/store/apps/details?id=com.ss.android.essay.joke\n - name: Phonotto\n url: https://play.google.com/store/apps/details?id=com.duckma.phonotto\n - name: Bakar\n url: https://play.google.com/store/apps/details?id=com.bakar\n - name: LaMaille\n url: https://play.google.com/store/apps/details?id=net.opalesurfcasting.lamaille\n - name: Poke\n url: https://play.google.com/store/apps/details?id=com.netpub.poke\n - name: SamePinch\n url: https://play.google.com/store/apps/details?id=co.samepinch.android.app\n - name: ChacuaTool\n url: https://play.google.com/store/apps/details?id=com.dak42.chacuatool\n - name: Facebook for Android\n url: https://play.google.com/store/apps/details?id=com.facebook.katana\n - name: Facebook Messenger\n url: https://play.google.com/store/apps/details?id=com.facebook.orca\n - name: Facebook Moments\n url: https://play.google.com/store/apps/details?id=com.facebook.moments\n - name: Facebook Pages Manager\n url: https://play.google.com/store/apps/details?id=com.facebook.pages.app\n - name: Facebook Groups\n url: https://play.google.com/store/apps/details?id=com.facebook.groups\n - name: Facebook Ads Manager\n url: https://play.google.com/store/apps/details?id=com.facebook.adsmanager\n - name: Snapster\n url: https://play.google.com/store/apps/details?id=com.vk.snapster\n - name: Butter Camera (黄油相机)\n url: https://play.google.com/store/apps/details?id=com.by.butter.camera\n - name: Myntra\n url: https://play.google.com/store/apps/details?id=com.myntra.android\n - name: Photo Safe\n url: https://play.google.com/store/apps/details?id=com.appmattus.photobackup\n - name: Tango Messenger\n url: https://play.google.com/store/apps/details?id=com.sgiggle.production\n - name: CondomCraze\n url: https://play.google.com/store/apps/details?id=com.condomcraze.android\n - name: memeham\n url: https://play.google.com/store/apps/details?id=com.memeham.beyourself.memeham\n - name: 9GAG\n url: https://play.google.com/store/apps/details?id=com.ninegag.android.app\n - name: Xiami Music\n url: https://play.google.com/store/apps/details?id=fm.xiami.main\n - name: Zhihu\n url: https://play.google.com/store/apps/details?id=com.zhihu.android\n - name: GigTown\n url: https://play.google.com/store/apps/details?id=com.gigtown.fender\n - name: Pics for Reddit\n url: https://play.google.com/store/apps/details?id=com.sitonmylab.picsforreddit\n - name: Apartment Buddy\n url: https://play.google.com/store/apps/details?id=com.apartmentbuddy.android\n - name: Wikimedia Commons\n url: https://play.google.com/store/apps/details?id=fr.free.nrw.commons\n - name: Waldo Photos\n url: https://play.google.com/store/apps/details?id=com.waldophotos.android\n - name: Degoo - Cloud Photo Storage\n url: https://play.google.com/store/apps/details?id=com.degoo.android\n - name: ROMEO - Gay Chat & Dating\n url: https://play.google.com/store/apps/details?id=com.planetromeo.android.app\n" }, { "path": "docs/_data/powered_by_highlight.yml", "content": "- title: Apps Using Fresco\n items:\n - name: Twitter\n url: https://play.google.com/store/apps/details?id=com.twitter.android\n img: static/images/twitter.png\n - name: Wikipedia\n url: https://play.google.com/store/apps/details?id=org.wikipedia\n img: static/images/wikipedia.png\n - name: Facebook\n url: https://code.facebook.com/posts/366199913563917\n img: static/images/facebook.png\n - name: React Native\n url: https://facebook.github.io/react-native/\n img: static/images/reactnative.png\n" }, { "path": "docs/_data/promo.yml", "content": "- type: plugin_row\n children:\n - type: button\n href: docs/index.html\n text: Get Started\n\n- type: github_star\n" }, { "path": "docs/_docs/03-customizing-image-formats.md", "content": "---\ndocid: customizing-image-formats\ntitle: Customizing Image Formats\nlayout: docs\npermalink: /docs/customizing-image-formats.html\n---\n\nIn general, two parts are involved until an image can be displayed on screen:\n1. decoding the image\n2. rendering the decoded image\n\nFresco allows you to customize both of these parts. For example, it's possible to add a custom image decoder for an existing image format or for a new image format that uses Fresco's built-in rendering architecture to render bitmaps. Or, it's possible to let the built-in decoder handle decoding and then create a custom Drawable used to render the image on screen. And, of course, you can also do both. These customizations can be either registered globally when Fresco is initialized or locally for selected images only.\n\nThe (much simplified) decoding and rendering process looks like this:\n1. The encoded image is downloaded from the network or loaded from the disk cache.\n2. The `ImageFormat` of the `EncodedImage` is determined using a class called `ImageFormatChecker`, which has a list of `ImageFormat.FormatChecker` objects, one for each recognized image format.\n3. The `EncodedImage` is decoded using a suitable `ImageDecoder` for the given format and returns an object that extends `CloseableImage`, which represents the decoded image.\n4. From a list of `DrawableFactory` objects, the first one that is able to handle the `CloseableImage` is used to create a `Drawable`.\n5. The drawable is rendered on screen.\n\nIt is possible to add custom image formats by adding an `ImageFormat.FormatChecker` for step 2. You can supply custom `ImageDecoder`s to add decoding support for new image formats or override built-in decoding. Finally, you can supply a custom `DrawableFactory` to use a custom `Drawable` for rendering the image.\n\nAll default image formats can be found in `DefaultImageFormats` and `DefaultImageFormatChecker`, the default drawable factory is in `PipelineDraweeController` and several samples for customizing them can be found in the Showcase sample app.\n\n## Custom decoders\n\nLet's start with an example. In order to create a custom decoder, simply implement the `ImageDecoder` interface:\n\n```java\npublic class CustomDecoder implements ImageDecoder {\n\n @Override\n public CloseableImage decode(\n EncodedImage encodedImage,\n int length,\n QualityInfo qualityInfo,\n ImageDecodeOptions options) {\n // Decode the given encodedImage and return a\n // corresponding (decoded) CloseableImage.\n CloseableImage closeableImage = ...;\n return closeableImage;\n }\n}\n```\n\nThe given encoded image can be used to return a class that extends `CloseableImage`, which represents the decoded image and which will then be automatically cached for you. You can either return one of the existing `CloseableImage` types, like `CloseableStaticBitmap` for bitmaps, or define your own `CloseableImage` class.\n\nCustom decoders can be set globally or locally on a per-image basis. For local overrides, you can set the custom decoder as follows:\n\n```java\nImageDecoder customDecoder = ...;\nUri uri = ...;\ndraweeView.setController(\n Fresco.newDraweeControllerBuilder()\n .setImageRequest(\n ImageRequestBuilder.newBuilderWithSource(uri)\n .setImageDecodeOptions(\n ImageDecodeOptions.newBuilder()\n .setCustomImageDecoder(customDecoder)\n .build())\n .build())\n .build());\n```\n\n**NOTE:** If you're supplying a custom decoder, it will be used for all images. The default decoder will be completely bypassed.\n\n## Custom image formats\n\nYou simply create a new `ImageFormat` object and hold on to it in your code:\n\n```java\nprivate static final ImageFormat CUSTOM_FORMAT = new ImageFormat(\"format name\", \"format file extension\");\n```\n\nAll supported default image formats can be found in `DefaultImageFormats`.\n\nThen, we need to create a custom `ImageFormat.FormatChecker` that is used to detect your new image format. The format checker has 2 methods, one to determine the number of header bytes required to make the decision (keep this number as small as possible since this operation is performed for all images) and the actual `determineFormat` method, which should return **the same `ImageFormat` instance**, `CUSTOM_FORMAT` in this example - or `null` if the image is of a different format. A simple format checker could look like this:\n\n```java\npublic static class ColorFormatChecker implements ImageFormat.FormatChecker {\n\n private static final byte[] HEADER = ImageFormatCheckerUtils.asciiBytes(\"my_header\");\n\n @Override\n public int getHeaderSize() {\n return HEADER.length;\n }\n\n @Nullable\n @Override\n public ImageFormat determineFormat(byte[] headerBytes, int headerSize) {\n if (headerSize < getHeaderSize()) {\n return null;\n }\n if (ImageFormatCheckerUtils.startsWithPattern(headerBytes, HEADER)) {\n return CUSTOM_FORMAT;\n }\n return null;\n }\n}\n```\n\nThe third component required for custom image format is a custom decoder as explained above that can create the actual decoded image.\n\nYou have to register your custom image format with Fresco by supplying a `ImageDecoderConfig` to Fresco when it is initialized. Similarly, you can override the default decoding behavior by using a built-in image format:\n\n```java\nImageFormat myFormat = ...;\nImageFormat.FormatChecker myFormatChecker = ...;\nImageDecoder myDecoder = ...;\nImageDecoderConfig imageDecoderConfig = new ImageDecoderConfig.Builder()\n .addDecodingCapability(\n myFormat,\n myFormatChecker,\n myDecoder)\n .build();\n\nImagePipelineConfig config = ImagePipelineConfig.newBuilder()\n .setImageDecoderConfig(imageDecoderConfig)\n .build();\n\nFresco.initialize(context, config);\n```\n\n## Custom drawables\n\nIf a `DraweeController` is used to load the image (e.g. if you're using a `DraweeView`), a corresponding `DrawableFactory` is used to create a drawable to render the decoded image based on the `CloseableImage`. If you're manually using the image pipeline, you have to handle the `CloseableImage` itself.\n\nIf you use one of the built-in types, like `CloseableStaticBitmap`, the `PipelineDraweeController` already knows how to handle the format and will create a `BitmapDrawable` for you. If you want to override that behavior or add support for custom `CloseableImage`s, you have to implement a drawable factory:\n\n```java\npublic static class CustomDrawableFactory implements DrawableFactory {\n\n @Override\n public boolean supportsImageType(CloseableImage image) {\n // You can either override a built-in format, like `CloseableStaticBitmap`\n // or your own implementations.\n return image instanceof CustomCloseableImage;\n }\n\n @Nullable\n @Override\n public Drawable createDrawable(CloseableImage image) {\n // Create and return your custom drawable for the given CloseableImage.\n // It is guaranteed that the `CloseableImage` is an instance of the\n // declared classes in `supportsImageType` above.\n CustomCloseableImage myCloseableImage = (CustomCloseableImage) image;\n Drawable myDrawable = ...; //e.g. new CustomDrawable(myCloseableImage)\n return myDrawable;\n }\n}\n```\n\nIn order to use your drawable factory, you can either use a global or local override.\n\n### Global custom drawable override\n\nYou have to register all global drawable factories when Fresco is initialized:\n\n```java\nDrawableFactory myDrawableFactory = ...;\n\nDraweeConfig draweeConfig = DraweeConfig.newBuilder()\n .addCustomDrawableFactory(myDrawableFactory)\n .build();\n\nFresco.initialize(this, imagePipelineConfig, draweeConfig);\n```\n\n### Local custom drawable override\n\nFor local overrides, the `PipelineDraweeControllerBuilder` offers methods to set custom drawable factories:\n\n```java\nDrawableFactory myDrawableFactory = ...;\nUri uri = ...;\n\nsimpleDraweeView.setController(Fresco.newDraweeControllerBuilder()\n .setUri(uri)\n .setCustomDrawableFactory(factory)\n .build());\n```\n" }, { "path": "docs/_docs/animations.md", "content": "---\ndocid: animations\ntitle: Animated Images\nlayout: docs\npermalink: /docs/animations.html\n---\n\nFresco supports animated GIF and WebP images.\n\nWe support WebP animations, even in the extended WebP format, on versions of Android going back to 2.3, even those that don't have built-in native support.\n\nFor adding this optional modules in your build.gradle please visit [here](index.html):\n\n### Playing animations automatically\n\nIf you want your animated image to start playing automatically when it comes on-screen, and stop when it goes off, just say so in your [image request](image-requests.html):\n\n```java\nUri uri;\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setUri(uri)\n .setAutoPlayAnimations(true)\n . // other setters\n .build();\nmSimpleDraweeView.setController(controller);\n```\n\n### Playing animations manually\n\nYou may prefer to directly control the animation in your own code. In that case you'll need to listen for when the image has loaded, so it's even possible to do that.\n\n```java\nControllerListener controllerListener = new BaseControllerListener() {\n @Override\n public void onFinalImageSet(\n String id,\n @Nullable ImageInfo imageInfo,\n @Nullable Animatable anim) {\n if (anim != null) {\n // app-specific logic to enable animation starting\n anim.start();\n }\n }\n};\n\nUri uri;\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setUri(uri)\n .setControllerListener(controllerListener)\n // other setters\n .build();\nmSimpleDraweeView.setController(controller);\n```\n\nThe controller exposes an instance of the [Animatable](http://developer.android.com/reference/android/graphics/drawable/Animatable.html) interface. If non-null, you can drive your animation with it:\n\n```java\nAnimatable animatable = mSimpleDraweeView.getController().getAnimatable();\nif (animatable != null) {\n animatable.start();\n // later\n animatable.stop();\n}\n```\n\n### Limitations\n\nAnimations do not currently support [postprocessors](modifying-image.html).\n" }, { "path": "docs/_docs/building-from-source.md", "content": "---\ndocid: building-from-source\ntitle: Building from Source\nlayout: docs\npermalink: /docs/building-from-source.html\n---\n\nYou should only build from source if you need to modify Fresco code itself. Most applications should simply [include](index.html#_) Fresco in their project.\n\n### Prerequisites\n\nThe following tools must be installed on your system in order to build Fresco:\n\n1. The Android [SDK](https://developer.android.com/sdk/index.html#Other)\n2. From the Android SDK Manager, install/upgrade the latest Support Library **and** Support Repository. Both are found in the Extras section.\n2. The Android [NDK](https://developer.android.com/tools/sdk/ndk/index.html). Version 10c or later is required.\n3. The [git](http://git-scm.com/) version control system.\n\nYou don't need to download Gradle itself; the build scripts or Android Studio will do that for you.\n\nFresco does not support source builds with Eclipse, Ant, or Maven. We do not plan to ever add such support.\n\n### Configuring Gradle\n\nBoth command-line and Android Studio users need to edit the `gradle.properties` file. This is normally located in your home directory, in a subdirectory called `.gradle`. If it is not already there, create it.\n\nOn Unix-like systems, including Mac OS X, add this line:\n\n```groovy\nndk.path=/path/to/android_ndk/r10e\n```\n\nOn Windows systems, add this line:\n\n```groovy\nndk.path=C\\:\\\\path\\\\to\\\\android_ndk\\\\r10e\n```\n\nOn *both* platforms, add these lines:\n\n```groovy\norg.gradle.daemon=true\norg.gradle.parallel=true\norg.gradle.configureondemand=true\n```\n\nWindows' backslashes and colons need to be escaped in order for Gradle to read them correctly.\n\n### Getting the source\n\n```sh\ngit clone https://github.com/facebook/fresco.git\n```\n\nThis will create a directory `fresco` where the code will live.\n\n### Building from the Command Line\n\nOn Unix-like systems, `cd` to the directory containing Fresco. Run the following command:\n\n```sh\n./gradlew build\n```\n\nOn Windows, open a Command Prompt, `cd` to the directory containing Fresco, and type in this command:\n\n```bat\ngradlew.bat build\n```\n\n### Building from Android Studio\n\nFrom Android Studio's Quick Start dialog, click Import Project. Navigate to the directory containing Fresco and click on the `build.gradle` file.\n\nAndroid Studio should build Fresco automatically.\n\n### Offline builds\n\nThe first time you build Fresco, your computer must be connected to the Internet. Incremental builds can use Gradle's `--offline` option.\n\n### Troubleshooting\n\n> Could not find com.android.support:...:x.x.x.\n\nMake sure your Support Repository is up to date (see Prerequisites above).\n\n### Windows support\n\nWe try our best to support building on Windows but we can't commit to it. We do not have a Windows build set up on our CI servers and none of us is using a Windows computer so the builds can break without us noticing it.\n\nPlease raise github issues if the Windows build is broken or submit a pull request with the fix. We do our best but we'd like the community's help to keep this up to date.\n\n\n### Contributing code upstream\n\nPlease see our [CONTRIBUTING](https://github.com/facebook/fresco/blob/main/CONTRIBUTING.md) page.\n" }, { "path": "docs/_docs/caching.md", "content": "---\ndocid: caching\ntitle: Caching\nlayout: docs\npermalink: /docs/caching.html\n---\n\nFresco stores images in three different types of caches, organized hierarchically, with the cost of retrieving an image increasing the deeper you go.\n\n#### 1. Bitmap cache\n\nThe bitmap cache stores decoded images as Android `Bitmap` objects. These are ready for display or [postprocessing](modifying-image.html).\n\nOn Android 4.x and lower, the bitmap cache's data lives in the *ashmem* heap, not in the Java heap. This means that images don't force extra runs of the garbage collector, slowing down your app.\n\nAndroid 5.0 and newer has much improved memory management than earlier versions, so it is safer to leave the bitmap cache on the Java heap.\n\nYour app should [clear this cache](#clearing-the-cache) when it is backgrounded.\n\nFor non-static image formats or custom image formats, the Bitmap cache can hold any decoded image data by extending the `CloseableImage` class. See [customizing image formats](customizing-image-formats.html) for more details.\n\n#### 2. Encoded memory cache\n\nThis cache stores images in their original compressed form. Images retrieved from this cache must be decoded before display.\n\nIf other transformations, such as [resizing](resizing.html), [rotation](rotation.html) or [transcoding](#webp) were requested, that happens before decode.\n\n#### 3. Disk cache\n\n(Yes, we know phones don't have disks, but it's too tedious to keep saying *local storage cache*...)\n\nLike the encoded memory cache, this cache stores compressed image, which must be decoded and sometimes transformed before display.\n\nUnlike the others, this cache is not cleared when your app exits, or even if the device is turned off.\n\nWhen disk cache is about to be to the size limits defined by [DiskCacheConfig](configure-image-pipeline.html#configuring-the-disk-cache) Fresco uses LRU logic of eviction in disk cache (see [DefaultEntryEvictionComparatorSupplier.java](https://github.com/facebook/fresco/blob/main/imagepipeline-base/src/main/java/com/facebook/cache/disk/DefaultEntryEvictionComparatorSupplier.java)).\n\nThe user can, of course, always clear it from Android's Settings menu.\n\n### Checking to see if an item is in cache\n\nYou can use the methods in [ImagePipeline](../javadoc/reference/com/facebook/imagepipeline/core/ImagePipeline.html) to see if an item is in cache. The check for the memory cache is synchronous:\n\n```java\nImagePipeline imagePipeline = Fresco.getImagePipeline();\nUri uri;\nboolean inMemoryCache = imagePipeline.isInBitmapMemoryCache(uri);\n```\n\nThe check for the disk cache is asynchronous, since the disk check must be done on another thread. You can call it like this:\n\n```java\nDataSource inDiskCacheSource = imagePipeline.isInDiskCache(uri);\nDataSubscriber subscriber = new BaseDataSubscriber() {\n @Override\n protected void onNewResultImpl(DataSource dataSource) {\n if (!dataSource.isFinished()) {\n return;\n }\n boolean isInCache = dataSource.getResult();\n // your code here\n }\n };\ninDiskCacheSource.subscribe(subscriber, executor);\n```\n\nThis assumes you are using the default cache key factory. If you have configured a custom one, you may need to use the methods that take an `ImageRequest` argument instead.\n\n### Evicting from cache\n\n[ImagePipeline](../javadoc/reference/com/facebook/imagepipeline/core/ImagePipeline.html) also has methods to evict individual entries from cache:\n\n```java\nImagePipeline imagePipeline = Fresco.getImagePipeline();\nUri uri;\nimagePipeline.evictFromMemoryCache(uri);\nimagePipeline.evictFromDiskCache(uri);\n\n// combines above two lines\nimagePipeline.evictFromCache(uri);\n```\n\nAs above, `evictFromDiskCache(Uri)` assumes you are using the default cache key factory. Users with a custom factory should use `evictFromDiskCache(ImageRequest)` instead.\n\n### Clearing the cache\n\n```java\nImagePipeline imagePipeline = Fresco.getImagePipeline();\nimagePipeline.clearMemoryCaches();\nimagePipeline.clearDiskCaches();\n\n// combines above two lines\nimagePipeline.clearCaches();\n```\n\n### Using one disk cache or two?\n\nMost apps need only a single disk cache. But in some circumstances you may want to keep smaller images in a separate cache, to prevent them from getting evicted too soon by larger images.\n\nTo do this, just call both `setMainDiskCacheConfig` and `setSmallImageDiskCacheConfig` methods when [configuring the image pipeline](configure-image-pipeline.html).\n\nWhat defines *small?* Your app does. When [making an image request](image-requests.html), you set its [CacheChoice](../javadoc/reference/com/facebook/imagepipeline/request/ImageRequest.CacheChoice.html):\n\n```java\nImageRequest request = ImageRequestBuilder.newBuilderWithSource(uri)\n .setCacheChoice(ImageRequest.CacheChoice.SMALL)\n```\n\nIf you need only one cache, you can simply avoid calling `setSmallImageDiskCacheConfig`. The pipeline will default to using the same cache for both and `CacheChoice` will be ignored.\n\n### Trimming the caches\n\nWhen [configuring](configure-image-pipeline.html) the image pipeline, you can set the maximum size of each of the caches. But there are times when you might want to go lower than that. For instance, your application might have caches for other kinds of data that might need more space and crowd out Fresco's. Or you might be checking to see if the device as a whole is running out of storage space.\n\nFresco's caches implement the [DiskTrimmable](../javadoc/reference/com/facebook/common/disk/DiskTrimmable.html) or [MemoryTrimmable](../javadoc/reference/com/facebook/common/memory/MemoryTrimmable.html) interfaces. These are hooks into which your app can tell them to do emergency evictions.\n\nYour application can then configure the pipeline with objects implementing the [DiskTrimmableRegistry](../javadoc/reference/com/facebook/common/disk/DiskTrimmableRegistry.html) and [MemoryTrimmableRegistry](../javadoc/reference/com/facebook/common/memory/MemoryTrimmableRegistry.html) interfaces.\n\nThese objects must keep a list of trimmables. They must use app-specific logic to determine when memory or disk space must be preserved. They then notify the trimmable objects to carry out their trims.\n" }, { "path": "docs/_docs/closeable-references.md", "content": "---\ndocid: closeable-references\ntitle: Closeable References\nlayout: docs\npermalink: /docs/closeable-references.html\n---\n\n**This page is intended for advanced usage only.**\n\nMost apps should use [Drawees](using-simpledraweeview.html) and not worry about closing.\n\nThe Java language is garbage-collected and most developers are used to creating objects willy-nilly and taking it for granted they will eventually disappear from memory.\n\nUntil Android 5.0's improvements, this was not at all a good idea for Bitmaps. They take up a large share of the memory of a mobile device. Their existence in memory would make the garbage collector run more frequently, making image-heavy apps slow and janky.\n\nBitmaps were the one thing that makes Java developers miss C++ and its many smart pointer libraries, such as [Boost](http://www.boost.org/doc/libs/1_57_0/libs/smart_ptr/smart_ptr.htm).\n\nFresco's solution is found in the [CloseableReference](../javadoc/reference/com/facebook/common/references/CloseableReference.html) class. In order to use it correctly, you must follow the rules below:\n\n#### 1. The caller owns the reference.\n\nHere, we create a reference, but since we're passing it to the caller, the caller takes the ownership:\n\n```java\nCloseableReference foo() {\n Val val;\n // We are returning the reference from this method,\n // so whoever is calling this method is the owner\n // of the reference and is in charge of closing it.\n return CloseableReference.of(val);\n}\n```\n\n#### 2. The owner must close the reference before leaving scope.\n\nHere we create a reference, but are not passing it to a caller. So we must close it:\n\n```java\nvoid gee() {\n // We are the caller of `foo` and so\n // we own the returned reference.\n CloseableReference ref = foo();\n try {\n // `haa` is a callee and not a caller, and so\n // it is NOT the owner of this reference, and\n // it must NOT close it.\n haa(ref);\n } finally {\n // We are not returning the reference to the\n // caller of this method, so we are still the owner,\n // and must close it before leaving the scope.\n ref.close();\n }\n}\n```\n\nThe `finally` block is almost always the best way to do this.\n\n#### 3. **Never** close the value.\n\n`CloseableReference` wraps a shared resource which gets released when there are no more active references pointing to it. Tracking of active references is done automatically by an internal reference counter. When the reference count drops to 0, `CloseableReference` will release the underlying resource. The very purpose of `CloseableReference` is to manage the underlying resource so that you don't have to. That said, you are responsible for closing the `CloseableReference` if you own it, but **not** the value it points to! If you explicitly close the underlying value, you will erroneously invalidate all the other active references pointing to that same resource.\n\n```java\n CloseableReference ref = foo();\n\n Val val = ref.get();\n // do something with val\n // ...\n\n // Do NOT close the value!\n //// val.close();\n\n // DO close the reference instead.\n ref.close();\n```\n\n#### 4. Something other than the owner should *not* close the reference.\n\nHere, we are receiving the reference via argument. The caller is still the owner, so we are not supposed to close it.\n\n```java\nvoid haa(CloseableReference ref) {\n // We are callee, and not a caller, and so\n // we must NOT close the reference.\n // We are guaranteed that the reference won't\n // become invalid for the duration of this call.\n Log.println(\"Haa: \" + ref.get());\n}\n```\n\nIf we called `.close()` here by mistake, then if the caller tried to call `.get()`, an `IllegalStateException` would be thrown.\n\n#### 5. Callee should always clone the reference before assigning.\n\nIf we need to hold onto the reference, we need to clone it.\n\nIf using it in a class:\n\n```java\nclass MyClass {\n CloseableReference myValRef;\n\n void mmm(CloseableReference ref) {\n // Some caller called this method. Caller owns the original\n // reference and if we want to have our own copy, we must clone it.\n myValRef = ref.clone();\n };\n // caller can now safely close its copy as we made our own clone.\n\n void close() {\n // We are in charge of closing our copy, of course.\n CloseableReference.closeSafely(myValRef);\n }\n}\n// Now the caller of MyClass must close it!\n```\n\nIf using it in an inner class:\n\n```java\nvoid haa(CloseableReference ref) {\n // Here we make our own copy of the original reference,\n // so that we can guarantee its validity when the executor\n // executes our runnable in the future.\n final CloseableReference refClone = ref.clone();\n executor.submit(new Runnable() {\n public void run() {\n try {\n Log.println(\"Haa Async: \" + refClone.get());\n } finally {\n // We need to close our copy once we are done with it.\n refClone.close();\n }\n }\n });\n // caller can now safely close its copy as we made our own clone.\n}\n```\n" }, { "path": "docs/_docs/concepts.md", "content": "---\ndocid: concepts\ntitle: Concepts\nlayout: docs\npermalink: /docs/concepts.html\n---\n\n## Drawees\n\nDrawees are spaces in which images are rendered. These are made up of three components, like a Model-View-Controller (MVC) framework.\n\n### DraweeView\n\nDescended from the Android [View](http://developer.android.com/reference/android/view/View.html) class.\n\nMost apps should use the `SimpleDraweeView` class. Place these in your application using XML or Java code. Set the URI to load with the `setImageURI` method, as explained in the [Getting Started](index.html) page.\n\nSee [Using SimpleDraweeView](using-simpledraweeview.html).\n\n### DraweeHierarchy\n\nThis is the hierarchy of Android [Drawable](http://developer.android.com/reference/android/graphics/drawable/Drawable.html) objects that will actually render your content. Think of it as the Model in an MVC.\n\nSee [Using SimpleDraweeView](using-simpledraweeview.html).\n\n### DraweeController\n\nThe `DraweeController` is the class responsible for actually dealing with the underlying image loader - whether Fresco's own image pipeline, or another.\n\nIf you need something more than a single URI to specify the image you want to display, you will need an instance of this class.\n\n### DraweeControllerBuilder\n\n`DraweeControllers` are immutable once constructed. They are [built](using-controllerbuilder.html) using the Builder pattern.\n\n### Listeners\n\nOne use of a builder is to specify a [Listener](listening-to-events.html) to execute code upon the arrival, full or partial, of image data from the server.\n\n## The Image Pipeline\n\nBehind the scenes, Fresco's image pipeline deals with the work done in getting an image. It fetches from the network, a local file, a content provider, or a local resource. It keeps a cache of compressed images on local storage, and a second cache of decompressed images in memory.\n\nThe image pipeline uses a special technique called *pinned purgeables* to keep images off the Java heap. This requires callers to `close` images when they are done with them.\n\n`SimpleDraweeView` does this for you automatically, so should be your first choice. Very few apps need to use the image pipeline directly.\n" }, { "path": "docs/_docs/configure-image-pipeline.md", "content": "---\ndocid: configure-image-pipeline\ntitle: Configuring the Image Pipeline\nlayout: docs\npermalink: /docs/configure-image-pipeline.html\n---\n\nMost apps can initialize Fresco completely by the simple command:\n\n```java\nFresco.initialize(context);\n```\n\nFor those apps that need more advanced customization, we offer it using the [ImagePipelineConfig](../javadoc/reference/com/facebook/imagepipeline/core/ImagePipelineConfig.html) class.\n\nHere is a maximal example. Rare is the app that actually needs all of these settings, but here they are for reference.\n\n\n```java\nImagePipelineConfig config = ImagePipelineConfig.newBuilder(context)\n .setBitmapMemoryCacheParamsSupplier(bitmapCacheParamsSupplier)\n .setCacheKeyFactory(cacheKeyFactory)\n .setDownsampleEnabled(true)\n .setEncodedMemoryCacheParamsSupplier(encodedCacheParamsSupplier)\n .setExecutorSupplier(executorSupplier)\n .setImageCacheStatsTracker(imageCacheStatsTracker)\n .setMainDiskCacheConfig(mainDiskCacheConfig)\n .setMemoryTrimmableRegistry(memoryTrimmableRegistry)\n .setNetworkFetchProducer(networkFetchProducer)\n .setPoolFactory(poolFactory)\n .setProgressiveJpegConfig(progressiveJpegConfig)\n .setRequestListeners(requestListeners)\n .setSmallImageDiskCacheConfig(smallImageDiskCacheConfig)\n .build();\nFresco.initialize(context, config);\n```\n\nBe sure to pass your `ImagePipelineConfig` object to `Fresco.initialize!` Otherwise, Fresco will use a default configuration instead of the one you built.\n\n### Understanding Suppliers\n\nSeveral of the configuration builder's methods take arguments of a [Supplier](../javadoc/reference/com/facebook/common/internal/Supplier.html) of an instance rather than an instance itself. This is a little more complex to create, but allows you to change behaviors while your app is running. Memory caches, for one, check their Supplier every five minutes.\n\nIf you don't need to dynamically change the params, use a Supplier that returns the same object each time:\n\n```java\nSupplier xSupplier = new Supplier() {\n private X mX = new X(xparam1, xparam2...);\n public X get() {\n return mX;\n }\n);\n// when creating image pipeline\n.setXSupplier(xSupplier);\n```\n\n### Thread pools\n\nBy default, the image pipeline uses three thread pools:\n\n1. Three threads for network downloads\n2. Two threads for all disk operations - local file reads, and the disk cache\n3. Two threads for all CPU-bound operations - decodes, transforms, and background operations, such as postprocessing.\n\nYou can customize networking behavior by [setting your own network layer](using-other-network-layers.html).\n\nTo change the behavior for all other operations, pass in an instance of [ExecutorSupplier](../javadoc/reference/com/facebook/imagepipeline/core/ExecutorSupplier.html).\n\n### Using a MemoryTrimmableRegistry\n\nIf your application listens to system memory events, it can pass them over to Fresco to trim memory caches.\n\nThe easiest way for most apps to listen to events is to override [Activity.onTrimMemory](http://developer.android.com/reference/android/app/Activity.html#onTrimMemory(int)). You can also use any subclass of [ComponentCallbacks2](http://developer.android.com/reference/android/content/ComponentCallbacks2.html).\n\nYou should have an implementation of [MemoryTrimmableRegistry](http://frescolib.org/javadoc/reference/com/facebook/common/memory/MemoryTrimmableRegistry.html). This object should keep a collection of [MemoryTrimmable](http://frescolib.org/javadoc/reference/com/facebook/common/memory/MemoryTrimmable.html) objects - Fresco's caches will be among them. When getting a system memory event, you call the appropriate `MemoryTrimmable` method on each of the trimmables.\n\n### Configuring the memory caches\n\nThe bitmap cache and the encoded memory cache are configured by a Supplier of a [MemoryCacheParams](../javadoc/reference/com/facebook/imagepipeline/cache/MemoryCacheParams.html#MemoryCacheParams\\(int, int, int, int, int\\)) object.\n\n### Configuring the disk cache\n\nYou use the builder pattern to create a [DiskCacheConfig](../javadoc/reference/com/facebook/cache/disk/DiskCacheConfig.Builder.html) object:\n\n```java\nDiskCacheConfig diskCacheConfig = DiskCacheConfig.newBuilder()\n .set....\n .set....\n .build()\n\n// when building ImagePipelineConfig\n.setMainDiskCacheConfig(diskCacheConfig)\n```\n\n### Keeping cache stats\n\nIf you want to keep track of metrics like the cache hit rate, you can implement the [ImageCacheStatsTracker](../javadoc/reference/com/facebook/imagepipeline/cache/ImageCacheStatsTracker.html) class. This provides callbacks for every cache event that you can use to keep your own statistics.\n" }, { "path": "docs/_docs/datasources-datasubscribers.md", "content": "---\ndocid: datasources-datasubscribers\ntitle: DataSources and DataSubscribers\nlayout: docs\npermalink: /docs/datasources-datasubscribers.html\n---\n\nA [DataSource](../javadoc/reference/com/facebook/datasource/DataSource.html) is, like a Java [Future](http://developer.android.com/reference/java/util/concurrent/Future.html), the result of an asynchronous computation. The different is that, unlike a Future, a DataSource can return you a whole series of results from a single command, not just one.\n\nAfter submitting an image request, the image pipeline returns a data source. To get a result out if it, you need to use a [DataSubscriber](../javadoc/reference/com/facebook/datasource/DataSubscriber.html).\n\n### Executors\n\nWhen subscribing to a data source, an executor must be provided. The purpose of executors is to execute runnables (in our case the subscriber callback methods) on a specific thread and with specific policy.\nFresco provides several [executors](https://github.com/facebook/fresco/tree/main/fbcore/src/main/java/com/facebook/common/executors) and one should carefully choose which one to be used:\n\n* If you need to do any UI stuff from your callback (accessing views, drawables, etc.), you must use `UiThreadImmediateExecutorService.getInstance()`. Android view system is not thread safe and is only to be accessed from the main thread (the UI thread).\n* If the callback is lightweight, and does not do any UI related stuff, you can simply use `CallerThreadExecutor.getInstance()`. This executor executes runnables on the caller's thread. Depending on what is the calling thread, callback may be executed either on the UI or a background thread. There are no guarantees which thread it is going to be and because of that this executor should be used with great caution. And again, only for lightweight non-UI related stuff.\n* If you need to do some expensive non-UI related work (database access, disk read/write, or any other slow operation), this should NOT be done either with `CallerThreadExecutor` nor with the `UiThreadExecutorService`, but with one of the background thread executors. See [DefaultExecutorSupplier.forBackgroundTasks](https://github.com/facebook/fresco/blob/main/imagepipeline-base/src/main/java/com/facebook/imagepipeline/core/DefaultExecutorSupplier.java) for an example implementation.\n\n### Getting result from a data source\n\nThis is a generic example of how to get a result from a data source of `CloseableReference` for arbitrary type `T`. The result is valid only in the scope of the `onNewResultImpl` callback. As soon as the callback gets executed, the result is no longer valid. See the next example if the result needs to be kept around.\n\n```java\n DataSource> dataSource = ...;\n\n DataSubscriber> dataSubscriber =\n new BaseDataSubscriber>() {\n @Override\n protected void onNewResultImpl(\n DataSource> dataSource) {\n if (!dataSource.isFinished()) {\n // if we are not interested in the intermediate images,\n // we can just return here.\n return;\n }\n CloseableReference ref = dataSource.getResult();\n if (ref != null) {\n try {\n // do something with the result\n T result = ref.get();\n ...\n } finally {\n CloseableReference.closeSafely(ref);\n }\n }\n }\n\n @Override\n protected void onFailureImpl(DataSource> dataSource) {\n Throwable t = dataSource.getFailureCause();\n // handle failure\n }\n };\n\n dataSource.subscribe(dataSubscriber, executor);\n```\n\n### Keeping result from a data source\n\nThe above example closes the reference as soon as the callback gets executed. If the result needs to be kept around, you must keep the corresponding `CloseableReference` for as long as the result is needed. This can be done as follows:\n\n```java\n DataSource> dataSource = ...;\n\n DataSubscriber> dataSubscriber =\n new BaseDataSubscriber>() {\n @Override\n protected void onNewResultImpl(\n DataSource> dataSource) {\n if (!dataSource.isFinished()) {\n // if we are not interested in the intermediate images,\n // we can just return here.\n return;\n }\n // keep the closeable reference\n mRef = dataSource.getResult();\n // do something with the result\n T result = mRef.get();\n ...\n }\n\n @Override\n protected void onFailureImpl(DataSource> dataSource) {\n Throwable t = dataSource.getFailureCause();\n // handle failure\n }\n };\n\n dataSource.subscribe(dataSubscriber, executor);\n```\n\nIMPORTANT: once you don't need the result anymore, you **must close the reference**. Not doing so may cause memory leaks.\nSee [closeable references](closeable-references.html) for more details.\n\n```java\n CloseableReference.closeSafely(mRef);\n mRef = null;\n```\n\nHowever, if you are using `BaseDataSubscriber` you do not have to manually close the `dataSource` (closing `mRef` is enough). `BaseDataSubscriber` automatically closes the `dataSource` for you right after `onNewResultImpl` is called.\nIf you are not using `BaseDataSubscriber` (e.g. if you're calling `dataSource.getResult()`), make sure to close the `dataSource` as well.\n\n### To get encoded image...\n\n```java\n DataSource> dataSource =\n mImagePipeline.fetchEncodedImage(imageRequest, CALLER_CONTEXT);\n```\n\nImage pipeline uses `PooledByteBuffer` for encoded images. This is our `T` in the above examples. Here is an example of creating an `InputStream` out of `PooledByteBuffer` so that we can read the image bytes:\n\n```java\n InputStream is = new PooledByteBufferInputStream(result);\n try {\n // Example: get the image format\n ImageFormat imageFormat = ImageFormatChecker.getImageFormat(is);\n // Example: write input stream to a file\n Files.copy(is, path);\n } catch (...) {\n ...\n } finally {\n Closeables.closeQuietly(is);\n }\n```\n\n### To get decoded image...\n\n```java\nDataSource>\n dataSource = imagePipeline.fetchDecodedImage(imageRequest, callerContext);\n```\n\nImage pipeline uses `CloseableImage` for decoded images. This is our `T` in the above examples. Here is an example of getting a `Bitmap` out of `CloseableImage`:\n\n```java\n CloseableImage image = ref.get();\n if (image instanceof CloseableBitmap) {\n // do something with the bitmap\n Bitmap bitmap = (CloseableBitmap image).getUnderlyingBitmap();\n ...\n }\n```\n\n\n### I just want a bitmap...\n\nIf your request to the pipeline is for a single [Bitmap](http://developer.android.com/reference/android/graphics/Bitmap.html), you can take advantage of our easier-to-use [BaseBitmapDataSubscriber](../javadoc/reference/com/facebook/imagepipeline/datasource/BaseBitmapDataSubscriber):\n\n```java\ndataSource.subscribe(new BaseBitmapDataSubscriber() {\n @Override\n public void onNewResultImpl(@Nullable Bitmap bitmap) {\n // You can use the bitmap here, but in limited ways.\n // No need to do any cleanup.\n }\n\n @Override\n public void onFailureImpl(DataSource dataSource) {\n // No cleanup required here.\n }\n },\n executor);\n```\n\nA snap to use, right? There are caveats.\n\nThis subscriber doesn't work for animated images as those can not be represented as a single bitmap.\n\nYou can **not** assign the bitmap to any variable not in the scope of the `onNewResultImpl` method. The reason is, as already explained in the above examples that, after the subscriber has finished executing, the image pipeline will recycle the bitmap and free its memory. If you try to draw the bitmap after that, your app will crash with an `IllegalStateException.`\n\nYou can still safely pass the Bitmap to an Android [notification](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Builder.html#setLargeIcon\\(android.graphics.Bitmap\\)) or [remote view](http://developer.android.com/reference/android/widget/RemoteViews.html#setImageViewBitmap\\(int, android.graphics.Bitmap\\)). If Android needs your Bitmap in order to pass it to a system process, it makes a copy of the Bitmap data in ashmem - the same heap used by Fresco. So Fresco's automatic cleanup will work without issue.\n\nIf those requirements prevent you from using `BaseBitmapDataSubscriber`, you can go with a more generic approach as explained above.\n" }, { "path": "docs/_docs/drawee-branches.md", "content": "---\ndocid: drawee-branches\ntitle: Drawee Branches\nlayout: docs\npermalink: /docs/drawee-branches.html\n---\n\n### What are Branches?\n\nDrawees are made up of different image \"branches\", one or more of which may be actually displayed at a time.\n\nThis page outlines the different branches that can be displayed in a Drawee, and how they are set.\n\nExcept for the actual image, all of them can be set by an XML attribute. The value in XML must be either an Android drawable or color resource.\n\n They can also be set by a method in the [GenericDraweeHierarchyBuilder](../javadoc/reference/com/facebook/drawee/generic/GenericDraweeHierarchyBuilder.html) class, if setting programmatically. In code, the value can either be from resources or be a custom subclass of [Drawable](http://developer.android.com/reference/android/graphics/drawable/Drawable.html).\n\nSome of the items can even be changed on the fly after the hierarchy has been built. These have a method in the [GenericDraweeHierarchy](../javadoc/reference/com/facebook/drawee/generic/GenericDraweeHierarchy.html) class.\n\nSeveral of the drawables can be [scaled](scaletypes.html).\n\n### Actual\n\nThe _actual_ image is the target; everything else is either an alternative or a decoration. This is specified using a URI, which can point to an image over the Internet, a local file, a resource, or a content provider.\n\nThis is a property of the controller, not the hierarchy. It therefore is not set by any of the methods used by the other Drawee branches.\n\nInstead, use the `setImageURI` method or [set a controller](using-controllerbuilder.html) programmatically.\n\nIn addition to the scale type, the hierarchy exposes other methods only for the actual image. These are:\n\n* the focus point (used for the [focusCrop](scaletypes.html#FocusCrop) scale type only)\n* a color filter\n\nDefault scale type: `centerCrop`\n\n### Placeholder\n\nThe _placeholder_ is shown in the Drawee when it first appears on screen. After you have called `setController` or `setImageURI` to load an image, the placeholder continues to be shown until the image has loaded.\n\nIn the case of a progressive JPEG, the placeholder only stays until your image has reached the quality threshold, whether the default, or one set by your app.\n\nXML attribute: `placeholderImage`\nHierarchy builder method: `setPlaceholderImage`\nHierarchy mutation method: `setPlaceholderImage`\nDefault value: None\nDefault scale type: `centerInside`\n\n### Failure\n\nThe _failure_ image appears if there is an error loading your image. The most common cause of this is an invalid URI, or lack of connection to the network.\n\nXML attribute: `failureImage`\nHierarchy builder method: `setFailureImage`\nHierarchy mutation method: `setFailureImage`\nDefault value: None\nDefault scale type: `centerInside`\n\n### Retry\n\nThe _retry_ image appears instead of the failure image if you have set your controller to enable the tap-to-retry feature.\n\nYou must [build your own Controller](using-controllerbuilder.html) to do this. Then add the following line\n\n```java\n.setTapToRetryEnabled(true)\n```\n\nThe image pipeline will then attempt to retry an image if the user taps on it. Up to four attempts are allowed before the failure image is shown instead.\n\nXML attribute: `retryImage`\nHierarchy builder method: `setRetryImage`\nHierarchy mutation method: `setRetryImage`\nDefault value: None\nDefault scale type: `centerInside`\n\n### Progress Bar\n\nIf specified, the _progress bar_ image is shown as an overlay over the Drawee until the final image is set.\n\nFor more details, see the [progress bar](progress-bars.html) page.\n\nXML attribute: `progressBarImage`\nHierarchy builder method: `setProgressBarImage`\nHierarchy mutation method: `setProgressBarImage`\nDefault value: None\nDefault scale type: `centerInside`\n\n### Backgrounds\n\n_Background_ drawables are drawn first, \"under\" the rest of the hierarchy.\n\nOnly one can be specified in XML, but in code more than one can be set. In that case, the first one in the list is drawn first, at the bottom.\n\nBackground images don't support scale-types and are scaled to the Drawee size.\n\nXML attribute: `backgroundImage`\nHierarchy builder method: `setBackground,` `setBackgrounds`\nDefault value: None\nDefault scale type: N/A\n\n### Overlays\n\n_Overlay_ drawables are drawn last, \"over\" the rest of the hierarchy.\n\nOnly one can be specified in XML, but in code more than one can be set. In that case, the first one in the list is drawn first, at the bottom.\n\nOverlay images don't support scale-types and are scaled to the Drawee size.\n\nXML attribute: `overlayImage`\nHierarchy builder method: `setOverlay,` `setOverlays`\nDefault value: None\nDefault scale type: N/A\n\n### Pressed State Overlay\n\nThe _pressed state overlay_ is a special overlay shown only when the user presses the screen area of the Drawee. For example, if the Drawee is showing a button, this overlay could have the button change color when pressed.\n\nThe pressed state overlay doesn't support scale-types.\n\nXML attribute: `pressedStateOverlayImage`\nHierarchy builder method: `setPressedStateOverlay`\nDefault value: None\nDefault scale type: N/A\n" }, { "path": "docs/_docs/faq.md", "content": "---\ndocid: faq\ntitle: FAQ\nlayout: docs\npermalink: /docs/faq.html\n---\n\nThese are common questions asked on our GitHub presence. Please create a pull-request if you have a Q&A that others will profit from.\n\n### How do I clear all caches?\n\nYou can use the following code to delete all cached images (both from storage and memory):\n\n```java\n// clear both memory and disk caches\nFresco.getImagePipeline().clearCaches();\n```\n\n### How can I create a Drawee that supports zoom gestures?\n\nHave a look at the [ZoomableDraweeView](https://github.com/facebook/fresco/tree/main/samples/zoomable) module which is part of our sample code on GitHub.\n\n### How do I create an URI for a local file?\n\nUse the `UriUtil` class:\n\n```java\nfinal File file = new File(\"your/file/path/img.jpg\");\nfinal URI uri = UriUtil.getUriForFile(file);\n```\n\n### How do I create an URI for a resource?\n\nUse the `UriUtil` class:\n\n```java\nfinal int resourceId = R.drawable.my_image;\nfinal URI uri = UriUtil.getUriForResourceId(resourceId);\n\n// alternatively, if it is from another package:\nfinal URI uri = UriUtil.getUriForQualifiedResource(\"com.myapp.plugin\", resourceId);\n```\n\n### How do I use Fresco in a RecyclerView?\n\nYou build your `RecyclerView` just like any other `RecyclerView`. The `DraweeView` is able to attach and detach itself appropriately. When being detached it can free up the memory of the referenced image. When being re-attached, the image is loaded from the BitmapCache if it is still available there.\n\nHave a look at [DraweeRecyclerViewFragment.java](https://github.com/facebook/fresco/blob/1472a3e1b1655e9b52c74e0b06d5ba60d15a42f9/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/drawee/DraweeRecyclerViewFragment.java) which is part of our showcase app.\n\n### How do I download a image without decoding?\n\nFor this, you can use the `imagePipeline#fetchEncodedImage(ImageRequest, ...)` method of the image pipeline. See our section on [Using the Image Pipeline Directly](using-image-pipeline.html) and [DataSources & DataSubscribers](datasources-datasubscribers.html) for detailed samples.\n\n### How do I modify an image before displaying?\n\nThe best way is to implement a [PostProcessor](post-processor.html). This allows the image pipeline to schedule the modification on the background and allocates the Bitmaps efficiently.\n\n### How large is Fresco?\n\nIf you are correctly following the steps from [Shipping Your App with Fresco](proguard.html), your release builds should not grow more than 500 KiB when adding Fresco.\n\nAdding support for animations (`com.facebook.fresco:animated-gif`, `com.facebook.fresco:animated-webp`) and WebP on old devices (`com.facebook.fresco:webpsupport`) is optional. This modularization allows the base Fresco library to be light-weight. Adding those additional libraries would account for ~100 KiB each.\n\n### Why can’t I use Android’s wrap_content attribute on a DraweeView?\n\nThe reason is that Drawee always returns -1 for [getIntrinsicHeight](http://developer.android.com/reference/android/graphics/drawable/Drawable.html#getIntrinsicHeight()) and getIntrinsicWidth methods.\n\nAnd the reason for that is that unlike a simple ImageView, Drawee may show more than one thing at the same time. For example, during the fade transition from the placeholder to the actual image, both images are visible. There may even be more than one actual image, one low-resolution, the other high-resolution. If all these images are not of exactly the same size, and they practically never are, then the concept of an \"intrinsic\" size cannot be well defined.\n\nWe could have returned the size of the placeholder until the image has finished loading, and then swap to the actual image's size. If we did that, though, the image would not appear correctly - it would be scaled or cropped to the placeholder's size. The only way to prevent that would be to force an Android layout pass when the image loads. Not only will that hurt your app's scroll perf, but it will be jarring for your users, who will suddenly see your app change on screen. Imagine if the user is reading a text article and all of a sudden the text jumps down because the image above it just loaded and caused everything to re-layout.\n\nFor this reason, you have to use an actual size or `match_parent` to lay out a DraweeView.\n\nIf your images are coming from a server, it may be possible to ask that server for the image dimensions, before you download it. This should be a faster request. Then use [setLayoutParams](http://developer.android.com/reference/android/view/View.html#setLayoutParams(android.view.ViewGroup.LayoutParams)) to dynamically size your view upfront.\n\nIf on the other hand your use case is a legitimate exception, you can actually resize Drawee view dynamically by using a controller listener as explained [here](http://stackoverflow.com/a/34075281/3027862). And remember, we intentionally removed this functionality because it is undesireable. [Ugly things should look ugly.](https://youtu.be/qCdpTji8nxo?t=890).\n" }, { "path": "docs/_docs/gotchas.md", "content": "---\ndocid: gotchas\ntitle: Gotchas\nlayout: docs\npermalink: /docs/gotchas.html\n---\n\n#### Don't use ScrollViews\n\nIf you want to scroll through a long list of images, you should use a [RecyclerView](http://developer.android.com/reference/android/support/v7/widget/RecyclerView.html), [ListView](https://developer.android.com/reference/android/widget/ListView.html), or [GridView](https://developer.android.com/reference/android/widget/GridView.html). All of these re-use their child views continually as you scroll through them. Fresco descendant views receive the system events that let them manage memory correctly.\n\n`ScrollView` does not do this. Thus, Fresco views aren't told when they have gone off-screen, and hold onto their image memory until your Fragment or Activity is stopped. Your app will be at a much greater risk of OOMs.\n\n#### Don't downcast\n\nIt is tempting to downcast objects returned by Fresco classes into actual objects that appear to give you greater control. At best, this will result in fragile code that gets broken in next release; at worst, it will lead to very subtle bugs.\n\n#### Don't use getTopLevelDrawable\n\n`DraweeHierarchy.getTopLevelDrawable()` should **only** be used by DraweeViews. Client code should almost never interact with it.\n\nThe sole exception is [custom views](writing-custom-views.html). Even there, the top-level drawable should never be downcast. We may change the actual type of the drawable in future releases.\n\n#### Don't re-use DraweeHierarchies\n\nNever call ```DraweeView.setHierarchy``` with the same argument on two different views. Hierarchies are made up of Drawables, and Drawables on Android cannot be shared among multiple views.\n\n#### Re-use Drawable resource IDs, not Java Drawable objects\n\nThis is for the same reason as the above. Drawables cannot be shared in multiple views.\n\nYou can freely use the same `@drawable` resource ID as a placeholder, error, or retry in multiple `SimpleDraweeViews` in XML. If you are using `GenericDraweeHierarchyBuilder`, you must call [Resources.getDrawable](http://developer.android.com/reference/android/content/res/Resources.html#getDrawable(int)) separate for *each* hierarchy. Do not call it just once and pass it to multiple hierarchies!\n\n#### Do not control hierarchy directly\n\nDo not interact with `SettableDraweeHierarchy` methods (`reset`, `setImage`, ...). Those are to be used by controller only. Do NOT be tempted to use `setControllerOverlay` in order to set an overlay. This method is to be called by controller only, and it refers to a very special controller overaly. If you just need to display an overlay see [Drawee branches] (http://frescolib.org/docs/drawee-branches.html#Overlays).\n\n#### Don't set images directly on a DraweeView\n\nCurrently ```DraweeView``` is a subclass of Android's ImageView. This has various methods to set an image (such as setImageBitmap, setImageDrawable)\n\nIf you set an image directly, you will completely lose your ```DraweeHierarchy```, and will not get any results from the image pipeline.\n\n#### Don't use ImageView attributes or methods with DraweeView\n\nAny XML attribute or method of ImageView not found in [View](http://developer.android.com/reference/android/view/View.html) will not work on a DraweeView. Typical cases are `src`, `scaleType`, `adjustViewBounds`, etc. Don't use those. DraweeView has its own counterparts as explained in the other sections of this documentation. Any ImageView attrribute or method will be removed in the upcoming release, so please don't use those.\n" }, { "path": "docs/_docs/image-requests.md", "content": "---\ndocid: image-requests\ntitle: Image Requests\nlayout: docs\npermalink: /docs/image-requests.html\n---\n\nIf you need an `ImageRequest` that consists only of a URI, you can use the helper method `ImageRequest.fromURI`. Loading [multiple-images](requesting-multiple-images.html) is a common case of this.\n\nIf you need to tell the image pipeline anything more than a simple URI, you need to use `ImageRequestBuilder`:\n\n```java\nUri uri;\n\nImageDecodeOptions decodeOptions = ImageDecodeOptions.newBuilder()\n .setBackgroundColor(Color.GREEN)\n .build();\n\nImageRequest request = ImageRequestBuilder\n .newBuilderWithSource(uri)\n .setImageDecodeOptions(decodeOptions)\n .setAutoRotateEnabled(true)\n .setLocalThumbnailPreviewsEnabled(true)\n .setLowestPermittedRequestLevel(RequestLevel.FULL_FETCH)\n .setProgressiveRenderingEnabled(false)\n .setResizeOptions(new ResizeOptions(width, height))\n .build();\n```\n\n#### Fields in ImageRequest\n\n- `uri` - the only mandatory field. See [Supported URIs](supported-uris.html)\n- `autoRotateEnabled` - whether to enable [auto-rotation](rotation.html).\n- `progressiveEnabled` - whether to enable [progressive loading](progressive-jpegs.html).\n- `postprocessor` - component to [postprocess](modifying-image.html) the decoded image.\n- `resizeOptions` - desired width and height. Use with caution. See [Resizing](resizing.html).\n\n#### Lowest Permitted Request Level\n\nThe image pipeline follows a [definite sequence](intro-image-pipeline.html) in where it looks for the image.\n\n1. Check the bitmap cache. This is nearly instant. If found, return.\n2. Check the encoded memory cache. If found, decode the image and return.\n3. Check the \"disk\" (local storage) cache. If found, load from disk, decode, and return.\n4. Go to the original file on network or local file. Download, resize and/or rotate if requested, decode, and return. For network images in particular, this will be the slowest by a long shot.\n\nThe `setLowestPermittedRequestLevel` field lets you control how far down this list the pipeline will go. Possible values are:\n\n- `BITMAP_MEMORY_CACHE`\n- `ENCODED_MEMORY_CACHE`\n- `DISK_CACHE`\n- `FULL_FETCH`\n\nThis is useful in situations where you need an instant, or at least relatively fast, image or none at all.\n" }, { "path": "docs/_docs/images-in-notifications.md", "content": "---\ndocid: images-in-notifications\ntitle: Images in Notifications\nlayout: docs\npermalink: /docs/images-in-notifications.html\n---\n\nIf you need to display an image in a notification, you can use the `BaseBitmapDataSubscriber` for requesting a bitmap from the `ImagePipeline`. This is safe to be passed to a notification as the system will parcel it after the `NotificationManager#notify` method. This page explains a full sample on how to do this.\n\n### Step by step\n\nFirst create an `ImageRequest` with the URI:\n\n```java\nImageRequest imageRequest = ImageRequest.fromUri(\"http://example.org/user/42/profile.jpg\"));\n```\n\nThen create a `DataSource` and request the decoded image from the `ImagePipeline`:\n\n```java\nImagePipeline imagePipeline = Fresco.getImagePipeline();\nDataSource> dataSource = imagePipeline.fetchDecodedImage(imageRequest, null);\n```\n\nAs a `DataSource` is similar to a `Future`, we need to add a `DataSubscriber` to handle the result. The `BaseBitmapDataSubscriber` abstracts some of the complexity away when dealing with `Bitmap`:\n\n```java\ndataSource.subscribe(\n new BaseBitmapDataSubscriber() {\n\n @Override\n protected void onNewResultImpl(Bitmap bitmap) {\n displayNotification(bitmap);\n }\n\n @Override\n protected void onFailureImpl(DataSource> dataSource) {\n // In general, failing to fetch the image should not keep us from displaying the\n // notification. We proceed without the bitmap.\n displayNotification(null);\n }\n },\n UiThreadImmediateExecutorService.getInstance());\n}\n```\n\nThe `displayNotification(Bitmap)` method then is similar to the 'normal' way to do this on Android:\n\n```java\nprivate void displayNotification(@Nullable Bitmap bitmap) {\n final NotificationCompat.Builder notificationBuilder =\n new NotificationCompat.Builder(getContext())\n .setSmallIcon(R.drawable.ic_done)\n .setLargeIcon(bitmap)\n .setContentTitle(\"Fresco Says Hello\")\n .setContentText(\"Notification Text ...\");\n\n final NotificationManager notificationManager =\n (NotificationManager) getContext().getSystemService(Context.NOTIFICATION_SERVICE);\n\n notificationManager.notify(NOTIFICATION_ID, notificationBuilder.build());\n}\n```\n\n### Full Sample\n\nFor the full sample see the `ImagePipelineNotificationFragment` in the showcase app: [ImagePipelineNotificationFragment.java](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/imagepipeline/ImagePipelineNotificationFragment.java)\n\n![Showcase app with a notification](/static/images/docs/02-images-in-notifications-sample.png)\n" }, { "path": "docs/_docs/index.md", "content": "---\ndocid: index\ntitle: Getting Started with Fresco\nlayout: docs\npermalink: /docs/index.html\n---\n\nThis Guide will walk you through the steps needed to start using Fresco in your app, including loading your first image.\n\n### 1. Update Gradle configuration\n\nEdit your `build.gradle` file. You must add the following line to the `dependencies` section:\n\n```groovy\ndependencies {\n // your app's other dependencies\n implementation 'com.facebook.fresco:fresco:{{site.current_version}}'\n}\n```\n\nStarting with Fresco version 2.1.0, you can also use a Java-only Fresco version (without native code).\nYou simply exclude artifacts with native code:\n\n```groovy\ndependencies {\n // your app's other dependencies\n implementation('com.facebook.fresco:fresco:{{site.current_version}}') {\n exclude group: 'com.facebook.soloader', module: 'soloader'\n exclude group: 'com.facebook.fresco', module: 'soloader'\n exclude group: 'com.facebook.fresco', module: 'nativeimagefilters'\n exclude group: 'com.facebook.fresco', module: 'nativeimagetranscoder'\n exclude group: 'com.facebook.fresco', module: 'memory-type-native'\n exclude group: 'com.facebook.fresco', module: 'imagepipeline-native'\n }\n}\n```\n\n### 2. Optional: Add additional Fresco feature modules\n\nThe following optional modules may also be added, depending on the needs of your app.\n\n```groovy\ndependencies {\n\n // For animated GIF support\n implementation 'com.facebook.fresco:animated-gif:{{site.current_version}}'\n\n // For WebP support, including animated WebP\n implementation 'com.facebook.fresco:animated-webp:{{site.current_version}}'\n implementation 'com.facebook.fresco:webpsupport:{{site.current_version}}'\n\n // For WebP support, without animations\n implementation 'com.facebook.fresco:webpsupport:{{site.current_version}}'\n\n // Provide the Android support library (you might already have this or a similar dependency)\n implementation 'com.android.support:support-core-utils:{{site.support_library_version}}'\n}\n```\n\n### 3. Initialize Fresco & Declare Permissions\n\nFresco needs to be initialized. You should only do this 1 time, so placing the initialization in your Application is a good idea. An example for this would be:\n\n```java\n[MyApplication.java]\npublic class MyApplication extends Application {\n @Override\n public void onCreate() {\n super.onCreate();\n Fresco.initialize(this);\n }\n}\n```\n\n*NOTE:* Remember to also declare you Application class in the ```AndroidManifest.xml``` as well as add the required permissions. In most cases you will need the INTERNET permission.\n\n```xml\n \n \n \n ...\n \n ...\n \n```\n\nOptional: For Java-only Fresco, you have to disable native code via `ImagePipelineConfig`.\n```java\nFresco.initialize(\n applicationContext,\n ImagePipelineConfig.newBuilder(applicationContext)\n .setMemoryChunkType(MemoryChunkType.BUFFER_MEMORY)\n .setImageTranscoderType(ImageTranscoderType.JAVA_TRANSCODER)\n .experiment().setNativeCodeDisabled(true)\n .build())\n```\n\n### 4. Create a Layout\n\nIn your layout XML, add a custom namespace to the top-level element. This is needed to access the custom `fresco:` attributes which allows you to control how the image is loaded and displayed.\n\n```xml\n\n\n```\n\nThen add the ```SimpleDraweeView``` to the layout:\n\n```xml\n\n```\n\nTo show an image, you need only do this:\n\n```java\nUri uri = Uri.parse(\"https://raw.githubusercontent.com/facebook/fresco/main/docs/static/logo.png\");\nSimpleDraweeView draweeView = (SimpleDraweeView) findViewById(R.id.my_image_view);\ndraweeView.setImageURI(uri);\n```\nand Fresco does the rest.\n\nThe placeholder is shown until the image is ready. The image will be downloaded, cached, displayed, and cleared from memory when your view goes off-screen.\n\n\n### 5. Optional: Setting a non-default native library loader (Only for Fresco 2.1 and above)\n\nThe default Fresco artifact employs SoLoader for loading native libraries. However, starting with Fresco version 2.1.0 this can be customized to use any other native code loading mechanism, such as the built-in `System.loadLibrary(...)`.\n\nIn order to set this up, you first have to exclude the default SoLoader implementation for all dependencies that are including it. To do this, simply edit your 'build.gradle' file in the following way:\n```groovy\ndependencies {\n // your app's other dependencies\n implementation 'com.facebook.fresco:fresco:{{site.current_version}}' {\n exclude group: 'com.facebook.soloader', module: 'soloader'\n }\n}\n```\nNow, `System.loadLibrary(...)` will be used for native code loading. You can also take a look at 'samples/scrollperf/build.gradle' where we set up two build variants, one with SoLoader, one without.\n\nYou can also employ your own native library loading mechanism by implementing a custom [`NativeLoaderDelegate`](https://github.com/facebook/SoLoader/blob/cdd144ab84d7af8c370a4a0e1e6b7ce5d7e19d5c/java/com/facebook/soloader/nativeloader/NativeLoaderDelegate.java). Then, simply call `NativeLoader.init(yourDelegate)` before Fresco is initialized.\n\n" }, { "path": "docs/_docs/intro-image-pipeline.md", "content": "---\ndocid: intro-image-pipeline\ntitle: Introduction to the Image Pipeline\nlayout: docs\npermalink: /docs/intro-image-pipeline.html\n---\n\nThe image pipeline does everything necessary to get an image into a form where it can be rendered into an Android device.\n\nThe pipeline goes through the following steps when given an image to load:\n\n1. Look in the bitmap cache. If found, return it.\n2. Hand off to other threads.\n3. Check in the encoded memory cache. If found, decode, transform, and return it. Store in the bitmap cache.\n3. Check in the disk cache. If found, decode, transform, and return it. Store in the encoded-memory and bitmap caches.\n4. Check on the network (or other original source). If found, decode, transform, and return it. Store in all three caches.\n\nThis being an image library, an image is worth a thousand words:\n\n![Image Pipeline Diagram](../static/imagepipeline.png \"Image Pipeline\")\n\n(The 'disk' cache as pictured includes the encoded memory cache, to keep the logic path clearer.) See [this page](caching.html) for more details on caching.\n\n\nThe pipeline can read from [local files](supported-uris.html) as well as network. PNG, GIF, and WebP are supported as well as JPEG.\n" }, { "path": "docs/_docs/listening-to-events.md", "content": "---\ndocid: listening-to-events\ntitle: Listening to Events\nlayout: docs\npermalink: /docs/listening-to-events.html\n---\n\n### Motivation\n\nThe image pipeline and the view controller in Fresco have built-in instrumentation interfaces. One can employ this to track both performance and to react to events.\n\nFresco comes with two main instrumentation interfaces:\n\n - The `RequestListener` is globally registered in the `ImagePipelineConfig` and logs all requests that are handled by the producer-consumer chain\n - The `ControllerListener` is added to an individual `DraweeView` and is convenient for reacting on events such as \"this image is fully loaded\"\n\n### ControllerListener\n\nWhile the `RequestListener` is a global listener, the `ControllerListener` is local to a certain `DraweeView`. It is a good way to react to changes to the displayed view such as \"image failed to load\" or \"image is fully loaded\". Again, it's best to extend `BaseControllerListener` for this.\n\nA simple listener might look like the following:\n\n```java\npublic class MyControllerListener extends new BaseControllerListener() {\n\n @Override\n public void onFinalImageSet(String id, ImageInfo imageInfo, Animatable animatable) {\n Log.i(\"DraweeUpdate\", \"Image is fully loaded!\");\n }\n\n @Override\n public void onIntermediateImageSet(String id, ImageInfo imageInfo, Animatable animatable) {\n Log.i(\"DraweeUpdate\", \"Image is partly loaded! (maybe it's a progressive JPEG?)\");\n if (imageInfo != null) {\n int quality = imageInfo.getQualityInfo().getQuality();\n Log.i(\"DraweeUpdate\", \"Image quality (number scans) is: \" + quality);\n }\n }\n\n @Override\n public void onFailure(String id, Throwable throwable) {\n Log.i(\"DraweeUpdate\", \"Image failed to load: \" + throwable.getMessage());\n }\n}\n```\n\nYou add it to your `DraweeController` in the following way:\n\n```java\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setImageRequest(request)\n .setControllerListener(new MyControllerListener())\n .build();\nmSimpleDraweeView.setController(controller);\n```\n\n### RequestListener\n\nThe `RequestListener` comes with a large interface of callback methods. Most importantly, you will notice that they all provide the unique `requestId` which allows to track a request across multiple stages.\n\nDue to the large number of callbacks, it is advisable to extend from `BaseRequestListener` instead and only implement the methods you are interested in. You register your listener in the Application class as follows:\n\n```java\nfinal Set listeners = new HashSet<>();\nlisteners.add(new MyRequestLoggingListener());\n\nImagePipelineConfig imagePipelineConfig = ImagePipelineConfig.newBuilder(this)\n .setRequestListeners(listeners)\n .build();\n\nFresco.initialize(this, imagePipelineConfig);\n```\n\nWe will walk through the generated logging of one image request from the showcase app and discuss the individual meanings. You can observe these yourself in `adb logcat` when running the showcase app:\n\n```java\nRequestLoggingListener: time 2095589: onRequestSubmit: {requestId: 5, callerContext: null, isPrefetch: false}\n```\n\n`onRequestSubmit(...)` is called when an `ImageRequest` enters the image pipeline. Here you can make use of the caller context object to identify which feature of the app is sending the request.\n\n```java\nRequestLoggingListener: time 2095590: onProducerStart: {requestId: 5, producer: BitmapMemoryCacheGetProducer}\nRequestLoggingListener: time 2095591: onProducerFinishWithSuccess: {requestId: 5, producer: BitmapMemoryCacheGetProducer, elapsedTime: 1 ms, extraMap: {cached_value_found=false}}\n```\n\nThe `onProducerStart(...)` and `onProducerFinishWithSuccess(...)` (or `onProducerFinishWithFailure(...)`) are called for all producers along the pipeline. The one above is a check of the Bitmap cache.\n\n```java\nRequestLoggingListener: time 2095592: onProducerStart: {requestId: 5, producer: BackgroundThreadHandoffProducer}\nRequestLoggingListener: time 2095593: onProducerFinishWithSuccess: {requestId: 5, producer: BackgroundThreadHandoffProducer, elapsedTime: 1 ms, extraMap: null}\nRequestLoggingListener: time 2095594: onProducerStart: {requestId: 5, producer: BitmapMemoryCacheProducer}\nRequestLoggingListener: time 2095594: onProducerFinishWithSuccess: {requestId: 5, producer: BitmapMemoryCacheProducer, elapsedTime: 0 ms, extraMap: {cached_value_found=false}}\nRequestLoggingListener: time 2095595: onProducerStart: {requestId: 5, producer: EncodedMemoryCacheProducer}\nRequestLoggingListener: time 2095596: onProducerFinishWithSuccess: {requestId: 5, producer: EncodedMemoryCacheProducer, elapsedTime: 1 ms, extraMap: {cached_value_found=false}}\nRequestLoggingListener: time 2095596: onProducerStart: {requestId: 5, producer: DiskCacheProducer}\nRequestLoggingListener: time 2095598: onProducerFinishWithSuccess: {requestId: 5, producer: DiskCacheProducer, elapsedTime: 2 ms, extraMap: {cached_value_found=false}}\nRequestLoggingListener: time 2095598: onProducerStart: {requestId: 5, producer: PartialDiskCacheProducer}\nRequestLoggingListener: time 2095602: onProducerFinishWithSuccess: {requestId: 5, producer: PartialDiskCacheProducer, elapsedTime: 4 ms, extraMap: {cached_value_found=false}}\n```\n\nWe see more of these when the request is handed over to the background (`BackgroundThreadHandoffProducer`) and performs look-ups in the caches.\n\n```java\nRequestLoggingListener: time 2095602: onProducerStart: {requestId: 5, producer: NetworkFetchProducer}\nRequestLoggingListener: time 2095745: onProducerEvent: {requestId: 5, stage: NetworkFetchProducer, eventName: intermediate_result; elapsedTime: 143 ms}\nRequestLoggingListener: time 2095764: onProducerFinishWithSuccess: {requestId: 5, producer: NetworkFetchProducer, elapsedTime: 162 ms, extraMap: {queue_time=140, total_time=161, image_size=40502, fetch_time=21}}\nRequestLoggingListener: time 2095764: onUltimateProducerReached: {requestId: 5, producer: NetworkFetchProducer, elapsedTime: -1 ms, success: true}\n```\n\nFor this particular request, the `NetworkFetchProducer` is the \"ultimate producer\". This means, it is the one that provides the definite input source for fulfilling the request. If the image is cached, the `DiskCacheProducer` would be the \"ultimate\" producer.\n\n```java\nRequestLoggingListener: time 2095766: onProducerStart: {requestId: 5, producer: DecodeProducer}\nRequestLoggingListener: time 2095786: onProducerFinishWithSuccess: {requestId: 5, producer: DecodeProducer, elapsedTime: 20 ms, extraMap: {imageFormat=JPEG, ,hasGoodQuality=true, bitmapSize=788x525, isFinal=true, requestedImageSize=unknown, encodedImageSize=788x525, sampleSize=1, queueTime=0}\nRequestLoggingListener: time 2095788: onRequestSuccess: {requestId: 5, elapsedTime: 198 ms}\n```\n\nOn the way up, the `DecodeProducer` also succeeds and finally the `onRequestSuccess(...)` method is called.\n\nYou will notice that most of these methods are given optional information as a `Map extraMap`. The string constants to look-up the elements are usually public constants in the corresponding producer classes.\n" }, { "path": "docs/_docs/media-variations.md", "content": "---\ndocid: media-variations\ntitle: Media Variations\nlayout: docs\npermalink: /docs/media-variations.html\n---\n\nComing soon!\n" }, { "path": "docs/_docs/placeholder-failure-retry.md", "content": "---\ndocid: placeholder-failure-retry\ntitle: Placeholder, failure and retry images\nlayout: docs\npermalink: /docs/placeholder-failure-retry.html\n---\n\nWhen you're loading network images things can go wrong, take a long time, or some images might not even be available at all. We've seen how to display [progress bars](progress-bars.html). On this page, we look at the other things that a `SimpleDraweeView` can display while the actual image is not available (yet, or at all). Note that all of these can have different [scale types](scaletypes.html), which you can customize.\n\n### Placeholder Image\n\nThe placeholder image is displayed from before you've set a URI or a controller until it has finished loading (successfully or not).\n\n#### XML\n\n```xml\n\n```\n\n#### Code\n\n```java\nmSimpleDraweeView.getHierarchy().setPlaceholderImage(placeholderImage);\n```\n\n### Failure Image\n\nThe failure image is displayed when a request has completed in error, either network-related (404, timeout) or image data-related (malformed image, unsupported format).\n\n#### XML\n\n```xml\n\n```\n\n#### Code\n\n```java\nmSimpleDraweeView.getHierarchy().setFailureImage(failureImage);\n```\n\n### Retry Image\n\nThe retry image appears instead of the failure image. When the user taps on it, the request is retried up to four times, before the failure image is displayed. In order for the retry image to work, you need to enable support for it in your controller, which means setting up your image request like so:\n\n```java\nmSimpleDraweeView.setController(\n Fresco.newDraweeControllerBuilder()\n .setTapToRetryEnabled(true)\n .setUri(uri)\n .build());\n```\n\n#### XML\n\n```xml\n\n```\n\n#### Code\n\n```java\nsimpleDraweeView.getHierarchy().setRetryImage(retryImage);\n```\n\n### Further Reading\n\nPlaceholder, failure and retry images are drawee *branches*. There are others than what is presented on this page, though these are the most commonly used ones. To read about all of the branches and how they work, check out [drawee branches](drawee-branches.html).\n\n### Example\n\nThe Fresco showcase app has a [DraweeHierarchyFragment](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/drawee/DraweeHierarchyFragment.java) that demonstrates using placeholder, failure and retry images.\n\n![Showcase app with placeholder, failure and retry images](/static/images/docs/01-placeholder-sample.png)\n" }, { "path": "docs/_docs/post-processor.md", "content": "---\ndocid: post-processor\ntitle: Modifying the Image (Post-processing)\nlayout: docs\nredirect_from: /docs/post-processor.html\npermalink: /docs/modifying-image.html\n---\n\n### Motivation\n\nPost-processors allow custom modifications of the fetched image. In most cases image processing should already be done by the server before the image is sent down to the client, as the mobile device's resources are usually more limited. However, there are many instances where client side processing is a valid option. For instance, if the images are being served by a third party which you do not control or if the images are local (on the device).\n\n### Background\n\nIn Fresco's pipeline, post-processors are applied at the very end when the image already has been decoded as a bitmap and the original version is stored in the in-memory Bitmap cache. While the post-processor can directly work on the provided Bitmap, it can also create a new Bitmap with a different dimension.\n\nIdeally, the implemented post-processor should provide a cache key for given parameters. By doing this, the newly generated bitmap is also cached in the in-memory Bitmap cache and don't need to be re-created.\n\nAll post-processors are executed using background executors. However, naive iteration or complex computations can still take a long time and should be avoided. If you aim for computations that are non-linear in the number of pixels, there is a section which contains tips for you how you can use native code to speed your post-processor up.\n\n### Example: Creating a Grey-Scale Filter\n\nLet's start with something simple: a post-processor that converts the bitmap into a grey-scale version. For this we need to iterate over the bitmap's pixels and replace their color value.\n\nThe image is copied before it enters the post-processor. The original image in cache is *not* affected by any changes you make in your post-processor. On Android 4.x and lower, the copy is stored outside the Java heap, just as the original image was.\n\nThe `BasePostprocessor` expects our sub-class to override one of its `BasePostprocessor#process` method. The simplest one performs in-place modifications of the provided bitmap. Here, the image is copied before it enters the post-processor. Thus, the original of the image in cache is *not* affected by any changes you make in the post-processor. We will later discuss how we can also modify the configuration and size of the outputted bitmap.\n\n```java\npublic class FastGreyScalePostprocessor extends BasePostprocessor {\n\n @Override\n public void process(Bitmap bitmap) {\n final int w = bitmap.getWidth();\n final int h = bitmap.getHeight();\n final int[] pixels = new int[w * h];\n\n bitmap.getPixels(pixels, 0, w, 0, 0, w, h);\n\n for (int x = 0; x < w; x++) {\n for (int y = 0; y < h; y++) {\n final int offset = y * w + x;\n pixels[offset] = getGreyColor(pixels[offset]);\n }\n }\n\n // this is much faster then calling #getPixel and #setPixel as it crosses\n // the JNI barrier only once\n bitmap.setPixels(pixels, 0, w, 0, 0, w, h);\n }\n\n static int getGreyColor(int color) {\n final int alpha = color & 0xFF000000;\n final int r = (color >> 16) & 0xFF;\n final int g = (color >> 8) & 0xFF;\n final int b = color & 0xFF;\n\n // see: https://en.wikipedia.org/wiki/Relative_luminance\n final int luminance = (int) (0.2126 * r + 0.7152 * g + 0.0722 * b);\n\n return alpha | luminance << 16 | luminance << 8 | luminance;\n }\n}\n```\n\n![Showcase app with grey-scale filter](/static/images/docs/02-post-processor-grey.png)\n\n### Caching Post-Processor Results\n\nAs we've seen that post-processing computations can be rather resource intensive, we want to cache the results. Cached output bitmaps are stored in the same cache as the decoded input bitmaps.\n\nIn order to use this feature, the post-processor must override the `PostProcessor#getPostProcessorCacheKey` method. It should return a cache key that is dependent on all important input values that effect the performed modifications.\n\nFor this example we extend an existing `WatermarkPostprocessor` that draws a watermark text multiple times on the image:\n\n```java\npublic class CachedWatermarkPostprocessor extends WatermarkPostprocessor {\n\n @Override\n public CacheKey getPostprocessorCacheKey() {\n return new SimpleCacheKey(String.format(\n (Locale) null,\n \"text=%s,count=%d\",\n mWatermarkText,\n mCount));\n }\n}\n```\n\n### In-place Bitmap transformation\nAs an alternative to post-processors, you can use a `BitmapTransformation` instead. Compared to normal post-processors, a `BitmapTransformation` will be applied to the original Bitmap immediately after it is decoded, which also means that the original image will not be cached and no additional Bitmap has to be allocated. In-place Bitmap transformations are the preferred way for images where you never need the original version. An example would be a `BitmapTransformation` for fully circular profile pictures:\n\n```java\npublic class CircularBitmapTransformation implements BitmapTransformation {\n\n @Override\n public void transform(Bitmap bitmap) {\n NativeRoundingFilter.toCircle(bitmap);\n }\n\n @Override\n public boolean modifiesTransparency() {\n return true; // We have transparent pixels\n }\n}\n```\n\n### Advanced: JNI and Blurring\n\nOne of the most commonly asked for post-processing effects is blurring. Luckily, Fresco ships with a very efficient implementation in native C code accessible through `NativeBlurFilter#iterativeBoxBlur`.\n\nWhen you are considering more advanced post-processing, using native code is a great way to improve performance. If you go down this path, have a look at the implementation in `blur_filter.c` on how to work with bitmaps in native code. Most importantly it explains you how to lock the pixels in memory and other important tricks.\n\n![Showcase app with blur post-processor](/static/images/docs/02-post-processor-blur.png)\n\n### Advanced: Changing the Bitmap's Size\n\nEven with an efficient implementation in native code, the post-processor can take a long time. For more efficient blurring, we can down-scale the image, blur the small version and then let the GPU scale it up when displayed. As blurred images do not have hard edges, this optimization usually goes unrecognized.\n\nIn our new post-processor we override an overloaded variant of the `BasePostProcessor#process()` method. That variant provides a `PlatformBitmapFactory` that we can use to create a custom output bitmap. Note that we must no longer modify the `sourceBitmap`, as it is not a copy that has been created for us.\n\n```java\npublic class ScalingBlurPostprocessor extends FullResolutionBlurPostprocessor {\n\n /**\n * A scale ration of 4 means that we reduce the total number of pixels to process by factor 16.\n */\n private static final int SCALE_RATIO = 4;\n\n @Override\n public CloseableReference process(\n Bitmap sourceBitmap,\n PlatformBitmapFactory bitmapFactory) {\n final CloseableReference bitmapRef = bitmapFactory.createBitmap(\n sourceBitmap.getWidth() / SCALE_RATIO,\n sourceBitmap.getHeight() / SCALE_RATIO);\n\n try {\n final Bitmap destBitmap = bitmapRef.get();\n final Canvas canvas = new Canvas(destBitmap);\n\n canvas.drawBitmap(\n sourceBitmap,\n null,\n new Rect(0, 0, destBitmap.getWidth(), destBitmap.getHeight()),\n mPaint);\n\n NativeBlurFilter.iterativeBoxBlur(destBitmap, BLUR_RADIUS / SCALE_RATIO, BLUR_ITERATIONS);\n\n return CloseableReference.cloneOrNull(bitmapRef);\n } finally {\n CloseableReference.closeSafely(bitmapRef);\n }\n }\n}\n```\n\n![Showcase app with scaling blur post-processor](/static/images/docs/02-post-processor-scaling-blur.png)\n\n### Limitations\n\nPlease keep the following rules in mind when creating post-processors\n\n* If you show the same image repeatedly, you must specify the post-processor each time it is requested. You are free to use different post-processors on different requests for the same image.\n* Post-processors are not currently supported for [animated](animations.html) images.\n* If you use transparency in your post-processor, call `destinationBitmap.setHasAlpha(true);`\n* Do **not** override more than one of the three `process` methods. Doing so can produce unpredictable results.\n* Do **not** modify the source Bitmap when using a `process` methods that requires you to create a new destination bitmap.\n* Do **not** keep a reference to either bitmap. Both have their memory managed by the image pipeline. The destBitmap will end up in your Drawee or DataSource normally.\n* Do **not** use the Android `Bitmap.createBitmap` method for creating a new Bitmap. This would work against the central Bitmap pool in Fresco.\n\n### Full Sample\n\nFor the full sample see the `ImagePipelinePostProcessorFragment` in the showcase app: [ImagePipelinePostProcessorFragment.java](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/imagepipeline/ImagePipelinePostProcessorFragment.java). It includes all post-processors from this page as well as additional ones.\n" }, { "path": "docs/_docs/prefetching.md", "content": "---\ndocid: prefetching\ntitle: Prefetching Images\nlayout: docs\npermalink: /docs/prefetching.html\n---\n\nPrefetching images in advance of showing them can sometimes lead to shorter wait times for users. Remember, however, that there are trade-offs. Prefetching takes up your users' data, and uses up its share of CPU and memory. As a rule, prefetching is not recommended for most apps.\n\nNonetheless, the image pipeline allows you to prefetch to either disk or bitmap cache. Both will use more data for network URIs, but the disk cache will not do a decode and will therefore use less CPU.\n\n__Note:__ Beware that if your network fetcher doesn't support priorities prefetch requests may slow down images which are immediately required on screen. Neither `OkHttpNetworkFetcher` nor `HttpUrlConnectionNetworkFetcher` currently support priorities.\n\nPrefetch to disk:\n\n```java\nimagePipeline.prefetchToDiskCache(imageRequest, callerContext);\n```\n\nPrefetch to bitmap cache:\n\n```java\nimagePipeline.prefetchToBitmapCache(imageRequest, callerContext);\n```\n\nCancelling prefetch:\n\n```java\n// keep the reference to the returned data source.\nDataSource prefetchDataSource = imagePipeline.prefetchTo...;\n\n// later on, if/when you need to cancel the prefetch:\nprefetchDataSource.close();\n```\n\nClosing a prefetch data source after the prefetch has already completed is a no-op and completely safe to do.\n\n### Example\n\nSee our [showcase app](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/imagepipeline/ImagePipelinePrefetchFragment.java) for a practical example of how to use prefetching.\n" }, { "path": "docs/_docs/progress-bars.md", "content": "---\ndocid: progress-bars\ntitle: Progress Bars\nlayout: docs\npermalink: /docs/progress-bars.html\n---\n\nThe easiest way to set a progress bar in your application is to use the [ProgressBarDrawable](../javadoc/reference/com/facebook/drawee/drawable/ProgressBarDrawable.html) class when building a hierarchy:\n\n```java\n.setProgressBarImage(new ProgressBarDrawable())\n```\n\nThis shows the progress bar as a dark blue rectangle along the bottom of the Drawee.\n\n### Defining your own progress bar\n\nIf you wish to customize your own progress indicator, be aware that in order for it to accurately reflect progress while loading, it needs to override the [Drawable.onLevelChange](http://developer.android.com/reference/android/graphics/drawable/Drawable.html#onLevelChange\\(int\\)) method:\n\n```java\nclass CustomProgressBar extends Drawable {\n @Override\n protected boolean onLevelChange(int level) {\n // level is on a scale of 0-10,000\n // where 10,000 means fully downloaded\n\n // your app's logic to change the drawable's\n // appearance here based on progress\n }\n}\n```\n\n### Example\n\nThe Fresco showcase app has a [DraweeHierarchyFragment](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/drawee/DraweeHierarchyFragment.java) that demonstrates using a progress bar drawable.\n\n\n" }, { "path": "docs/_docs/progressive-jpegs.md", "content": "---\ndocid: progressive-jpegs\ntitle: Progressive JPEGs\nlayout: docs\npermalink: /docs/progressive-jpegs.html\n---\n\nFresco supports the streaming of progressive JPEG images over the network.\n\nScans of the image will be shown in the view as you download them. Users will see the quality of the image start out low and gradually become clearer.\n\nThis is only supported for network images. Local images are decoded at once, so no need for progressiveness. Also, keep in mind that not all JPEG images are encoded in progressive format, and for those that are not, it is not possible to display them progressively.\n\n#### Building the image request\n\nCurrently, you must explicitly request progressive rendering while building the image request:\n\n```java\nUri uri;\nImageRequest request = ImageRequestBuilder.newBuilderWithSource(uri)\n .setProgressiveRenderingEnabled(true)\n .build();\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setImageRequest(request)\n .setOldController(mSimpleDraweeView.getController())\n .build();\nmSimpleDraweeView.setController(controller);\n```\n\nWe hope to add support for using progressive images with `setImageURI` in a future release.\n\n### Full Sample\n\nFor the full sample see the `ImageFormatProgressiveJpegFragment` in the showcase app:\n[ImageFormatProgressiveJpegFragment.java](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/imageformat/pjpeg/ImageFormatProgressiveJpegFragment.java)\n\n\n" }, { "path": "docs/_docs/proguard.md", "content": "---\ndocid: proguard\ntitle: Shipping Your App with Fresco\nlayout: docs\nredirect_from: /docs/proguard.html\npermalink: /docs/shipping.html\n---\n\nFresco's large size may seem intimidating, but it need not leave you with a large app. We strongly recommend use of the ProGuard tool as well as building split APKs to keep your app small.\n\n### ProGuard\n\nSince Fresco 1.9.0 a ProGuard configuration file is included in Fresco itself which is automatically applied if you enable ProGuard for your app.\nTo enable ProGuard, modify your `build.gradle` file to include the lines contained in the `release` section below.\n\n```groovy\nandroid {\n buildTypes {\n release {\n minifyEnabled true\n proguardFiles getDefaultProguardFile('proguard-android.txt')\n }\n }\n}\n```\n\n### Build Multiple APKs\n\nFresco is written mostly in Java, but there is some C++ as well. C++ code has to be compiled for each of the CPU types (called \"ABIs\") Android can run on. Currently, Fresco supports five ABIs.\n\n1. `armeabiv-v7a`: Version 7 or higher of the ARM processor. Most Android phones released from 2011-15 are using this.\n2. `arm64-v8a`: 64-bit ARM processors. Found on new devices, like the Samsung Galaxy S6.\n3. `x86`: Mostly used by tablets, and by emulators.\n4. `x86_64`: Used by 64-bit tablets.\n\nFresco's binary download has copies of native `.so` files for all five platforms. You can reduce the size of your app considerably by creating separate APKs for each processor type.\n\nIf your app does not support Android 2.3 (Gingerbread) you will not need the `armeabi` flavor.\n\nTo enable multiple APKs, add the `splits` section below to the `android` section of your `build.gradle` file.\n\n```groovy\nandroid {\n // rest of your app's logic\n splits {\n abi {\n enable true\n reset()\n include 'x86', 'x86_64', 'arm64-v8a', 'armeabi-v7a'\n universalApk false\n }\n }\n}\n```\n\nSee the [Android publishing documentation](https://developer.android.com/google/play/publishing/multiple-apks.html) for more details on how splits work.\n" }, { "path": "docs/_docs/requesting-multiple-images.md", "content": "---\ndocid: requesting-multiple-images\ntitle: Requesting Multiple Images (Multi-URI)\nlayout: docs\npermalink: /docs/requesting-multiple-images.html\n---\n\nThe methods on this page require [setting your own image request](using-controllerbuilder.html).\n\n### Going from low to high resolution\n\nSuppose you want to show users a high-resolution, slow-to-download image. Rather than let them stare a placeholder for a while, you might want to quickly download a smaller thumbnail first.\n\nYou can set two URIs, one for the low-res image, one for the high one:\n\n```java\nUri lowResUri, highResUri;\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setLowResImageRequest(ImageRequest.fromUri(lowResUri))\n .setImageRequest(ImageRequest.fromUri(highResUri))\n .setOldController(mSimpleDraweeView.getController())\n .build();\nmSimpleDraweeView.setController(controller);\n```\n\nAnimated images are not supported for the low-res request.\n\n### Using thumbnail previews\n\n*This option is supported only for local URIs, and only for images in the JPEG format.*\n\nIf your JPEG has a thumbnail stored in its EXIF metadata, the image pipeline can return that as an intermediate result. Your Drawee will first show the thumbnail preview, then the full image when it has finished loading and decoding.\n\n```java\nUri uri;\nImageRequest request = ImageRequestBuilder.newBuilderWithSource(uri)\n .setLocalThumbnailPreviewsEnabled(true)\n .build();\n\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setImageRequest(request)\n .setOldController(mSimpleDraweeView.getController())\n .build();\nmSimpleDraweeView.setController(controller);\n```\n\n\n### Loading the first available image\n\nMost of the time, an image has no more than one URI. Load it, and you're done.\n\nBut suppose you have multiple URIs for the same image. For instance, you might have uploaded an image taken from the camera. Original image would be too big to upload, so the image is downscaled first. In such case, it would be beneficial to first try to get the local-downscaled-uri, then if that fails, try to get the local-original-uri, and if even that fails, try to get the network-uploaded-uri. It would be a shame to download the image that we may have already locally.\n\nThe image pipeline normally searches for images in the memory cache first, then the disk cache, and only then goes out to the network or other source. Rather than doing this one by one for each image, we can have the pipeline check for *all* the images in the memory cache. Only if none were found would disk cache be searched in. Only if none were found there either would an external request be made.\n\nJust create an array of image requests, and pass it to the builder.\n\n```java\nUri uri1, uri2;\nImageRequest request = ImageRequest.fromUri(uri1);\nImageRequest request2 = ImageRequest.fromUri(uri2);\nImageRequest[] requests = { request1, request2 };\n\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setFirstAvailableImageRequests(requests)\n .setOldController(mSimpleDraweeView.getController())\n .build();\nmSimpleDraweeView.setController(controller);\n```\n\nOnly one of the requests will be displayed. The first one found, whether at memory, disk, or network level, will be the one returned. The pipeline will assume the order of requests in the array is the preference order.\n\n\n### Specifying a custom DataSource Supplier\n\nFor even more flexibility, it is possible to specify a custom `DataSource` `Supplier` while building a Drawee controller. You can implement your own supplier or just compose the existing ones in whichever way you like. See `FirstAvailableDataSourceSupplier` and `IncreasingQualityDataSourceSupplier` for an example implementation. See `AbstractDraweeControllerBuilder` for how those suppliers can be composed together.\n\n\n" }, { "path": "docs/_docs/resizing.md", "content": "---\ndocid: resizing\ntitle: Resizing\nlayout: docs\npermalink: /docs/resizing.html\nredirect_from:\n - /docs/resizing-rotating.html\n---\n\nWe use the following terminology for this section:\n\n- **Scaling** is a canvas operation and is usually hardware accelerated. The bitmap itself is always the same size. It just gets drawn downscaled or upscaled. See [ScaleTypes](scaletypes.html).\n- **Resizing** is a pipeline operation executed in software. This changes the encoded image in memory before it is being decoded. The decoded bitmap will be smaller than the original image.\n- **Downsampling** is also a pipeline operation implemented in software. Rather than creating a new encoded image, it simply decodes only a subset of the pixels, resulting in a smaller output bitmap.\n\n### Resizing\n\nResizing does not modify the original file, it just resizes an encoded image in memory, prior to being decoded.\n\nTo resize pass a `ResizeOptions` object when constructing an `ImageRequest`:\n\n```java\nImageRequest request = ImageRequestBuilder.newBuilderWithSource(uri)\n .setResizeOptions(new ResizeOptions(50, 50))\n .build();\nmSimpleDraweeView.setController(\n Fresco.newDraweeControllerBuilder()\n .setOldController(mSimpleDraweeView.getController())\n .setImageRequest(request)\n .build());\n```\n\nResizing has some limitations:\n\n- it only supports JPEG files\n- the actual resize is carried out to the nearest 1/8 of the original size\n- it cannot make your image bigger, only smaller (not a real limitation though)\n\n### Downsampling\n\nDownsampling is an experimental feature added recently to Fresco. To use it, you must explicitly enable it when [configuring the image pipeline](configure-image-pipeline.html):\n\n```java\n .setDownsampleEnabled(true)\n```\n\nIf this option is on, the image pipeline will downsample your images instead of resizing them. You must still call `setResizeOptions` for each image request as above.\n\nDownsampling is generally faster than resizing, since it is part of the decode step, rather than a separate step of its own. It also supports PNG and WebP (except animated) images as well as JPEG.\n\nThe trade-off right now is that, on Android 4.4 (KitKat) it uses more memory than resizing, while the decode is taking place. This should only be an issue for apps decoding a large number of images simultaneously. We hope to find a solution for this and make it the default in a future release.\n\n### Which should you use and when?\n\nIf the image is **not** much bigger than the view, then only scaling should be done. It's faster, easier to code, and results in a higher quality output. Of course, images smaller than the view are subset of those **not** much bigger than the view. Therefore, if you need to upscale the image, this should too be done by scaling, and not by resizing. That way memory won't be wasted on a larger bitmap that does not provide any better quality.\nHowever, for images much bigger than the view, such as **local camera images**, resizing in addition to scaling is highly recommended.\n\nAs for what exactly \"much bigger\" means, as a rule of thumb if the image is more than 2 times bigger than the view (in total number of pixels, i.e. width*height), you should resize it. This almost always applies for local images taken by camera. For example, a device with the screen size of 1080 x 1920 pixels (roughly 2MP) and a camera of 16MP produces images 8 times bigger than the display. Without any doubt resizing in such cases is always best to be done.\n\nFor network images, try to download an image as close as possible to the size you will be displaying. By downloading images of inappropriate size you are wasting the user's time and data.\n\nIf the image is bigger than the view, by not resizing it the memory gets wasted. However, there is also a performance trade-off to be considered.\nClearly, resizing imposes additional CPU cost on its own. But, by not resizing images bigger than the view, more bytes need to be transferred to the GPU, and images get evicted from the bitmap cache more often resulting in more decodes. In other words, not resizing when you should also imposes additional CPU cost.\nTherefore, there is no silver bullet and depending on the device characteristics there is a threshold point after which it becomes more performant to go with resize than without it.\n\n### Example\n\nThe Fresco showcase app has a [ImagePipelineResizingFragment](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/imagepipeline/ImagePipelineResizingFragment.java) that demonstrates using placeholder, failure and retry images.\n\n![Showcase app with resized example image](/static/images/docs/01-resizing-sample.png)\n" }, { "path": "docs/_docs/rotation.md", "content": "---\ndocid: rotation\ntitle: Rotation\nlayout: docs\npermalink: /docs/rotation.html\n---\n\nYou can rotate images by specifying a rotation angle in the image request, like so:\n\n```java\nfinal ImageRequest imageRequest = ImageRequestBuilder.newBuilderWithSource(uri)\n .setRotationOptions(RotationOptions.forceRotation(RotationOptions.ROTATE_90))\n .build();\nmSimpleDraweeView.setController(\n Fresco.newDraweeControllerBuilder()\n .setImageRequest(imageRequest)\n .build());\n```\n\n### Auto-rotation\n\nJPEG files sometimes store orientation information in the image metadata. If you want images to be automatically rotated to match the device's orientation, you can do so in the image request:\n\n```java\nfinal ImageRequest imageRequest = ImageRequestBuilder.newBuilderWithSource(uri)\n .setRotationOptions(RotationOptions.autoRotate())\n .build();\nmSimpleDraweeView.setController(\n Fresco.newDraweeControllerBuilder()\n .setImageRequest(imageRequest)\n .build());\n```\n\n### Combining rotations\n\nIf you're loading a JPEG file that has rotation information in its EXIF data, calling `forceRotation` will **add** to the default rotation of the image. For example, if the EXIF header specifies 90 degrees, and you call `forceRotation(ROTATE_90)`, the raw image will be rotated 180 degrees.\n\n### Examples\n\nThe Fresco showcase app has a [DraweeRotationFragment](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/drawee/DraweeRotationFragment.java) that demonstrates the various rotation settings. You can use it for example with the sample images [from here](https://github.com/recurser/exif-orientation-examples).\n\n![Showcase app with a rotation sample](/static/images/docs/01-rotation-sample.png)\n" }, { "path": "docs/_docs/rounded-corners-and-circles.md", "content": "---\ndocid: rounded-corners-and-circles\ntitle: Rounded Corners and Circles\nlayout: docs\npermalink: /docs/rounded-corners-and-circles.html\n---\n\nNot every image is a rectangle. Apps frequently need images that appear with softer, rounded corners, or as circles. Drawee supports a variety of scenarios, all without the memory overhead of copying bitmaps.\n\n### What\n\nImages can be rounded in two shapes:\n\n1. As a circle - set `roundAsCircle` to true.\n2. As a rectangle, but with rounded corners. Set `roundedCornerRadius` to some value.\n\nRectangles support having each of the four corners have a different radius, but this must be specified in Java code rather than XML.\n\n### How\n\nImages can be rounded with two different methods:\n\n1. `BITMAP_ONLY` - Uses a bitmap shader to draw the bitmap with rounded corners. This is the default rounding method. It doesn't support animations, and it does **not** support any scale types other than `centerCrop` (the default), `focusCrop` and `fit_xy`. If you use this rounding method with other scale types, such as `center`, you won't get an Exception but the image might look wrong (e.g. repeated edges due to how Android shaders work), especially in cases the source image is smaller than the view. See the Caveats section below.\n2. `OVERLAY_COLOR` - Draws rounded corners by overlaying a solid color, specified by the caller. The Drawee's background should be static and of the same solid color. Use `roundWithOverlayColor` in XML, or `setOverlayColor` in code to use this rounding method.\n\n### In XML\n\nThe `SimpleDraweeView` class will forward several attributes over to `RoundingParams`:\n\n```xml\n\n```\n\n### In code\n\nWhen constructing a hierarchy, you can pass an instance of [RoundingParams](../javadoc/reference/com/facebook/drawee/generic/RoundingParams.html) to your `GenericDraweeHierarchyBuilder:`\n\n```java\nRoundingParams roundingParams = RoundingParams.fromCornersRadius(7f);\nmSimpleDraweeView.setHierarchy(new GenericDraweeHierarchyBuilder(getResources())\n .setRoundingParams(roundingParams)\n .build());\n```\n\nYou can also change all of the rounding parameters after the hierarchy has been built:\n\n```java\nint color = getResources().getColor(R.color.red);\nRoundingParams roundingParams = RoundingParams.fromCornersRadius(5f);\nroundingParams.setBorder(color, 1.0f);\nroundingParams.setRoundAsCircle(true);\nmSimpleDraweeView.getHierarchy().setRoundingParams(roundingParams);\n```\n\n### Caveats\n\nThere are some limitations when `BITMAP_ONLY` (the default) mode is used:\n\n- Only images that resolve to `BitmapDrawable` or `ColorDrawable` can be rounded. Rounding `NinePatchDrawable`, `ShapeDrawable` and other such drawables is not supported (regardless whether they are specified in XML or programmatically).\n- Animations are not rounded.\n- Due to a limitation of Android's `BitmapShader`, if the image doesn't fully cover the view, instead of drawing nothing, edges are repeated. One workaround is to use a different scale type (e.g. centerCrop) that ensures that the whole view is covered. Another workaround is to make the image file contain a 1px transparent border so that the transparent pixels get repeated. This is the best solution for PNG resource images.\n\nIf the limitations of the `BITMAP_ONLY` mode affect your images, see if the `OVERLAY_COLOR` mode works for you. The `OVERLAY_COLOR` mode doesn't have the aforementioned limitations, but since it simulates rounded corners by overlaying a solid color over the image, this only looks good if the background under the view is static and of the same color.\n\nDrawee internally has an implementation for `CLIPPING` mode, but this mode has been disabled and not exposed as some `Canvas` implementation do not support path clipping. Furthermore, canvas clipping doesn't support antialiasing which makes the rounded edges very pixelated.\n\nFinally, all of those issues could be avoided by using a temporary bitmap, but this imposes a significant memory overhead and has not been supported because of that.\n\nAs explained above, there is no really good solution for rounding corners on Android and one has to choose between the aforementioned trade-offs.\n\n### Full Sample\n\nFor a full sample see the `DraweeRoundedCornersFragment` in the showcase app: [DraweeRoundedCornersFragment.java](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/drawee/DraweeRoundedCornersFragment.java)\n\n![Showcase app with a scale type example](/static/images/docs/01-rounded-corners-and-circles-sample.png)\n" }, { "path": "docs/_docs/sample-apps.md", "content": "---\ndocid: sample-code\ntitle: Sample code\nlayout: docs\npermalink: /docs/sample-code.html\n---\n\n*Note: the samples are licensed for non-commercial or evaluation purposes only, not the MIT license used for Fresco itself.*\n\nFresco's GitHub repository contains several samples to demonstrate how to use Fresco in your apps.\n\nThe samples are available in source form only. Follow the [build instructions](building-from-source.html) to set up your dev environment to build and run them.\n\n### The Showcase app\n\nThe [Showcase App](https://github.com/facebook/fresco/blob/main/samples/showcase) demonstrates various features and allows to customize parameters to show their effect.\nIt includes samples for Drawee and for the image pipeline. Furthermore, it showcases how to use both built-in and custom image formats.\n\n### The zoomable library\n\nThe [zoomable library](https://github.com/facebook/fresco/blob/main/samples/zoomable) features a `ZoomableDraweeView` class that supports gestures such as pinch-to-zoom and panning of a Drawee image.\n\n### The comparison app\n\nThe comparison app lets the user do a proper, apples-to-apples comparison of Fresco with [Picasso](http://square.github.io/picasso), [Universal Image Loader](https://github.com/nostra13/Android-Universal-Image-Loader), [Volley](https://developer.android.com/training/volley/index.html)'s image loader, and [Glide](https://github.com/bumptech/glide).\n\nFresco allows you to also compare its performance with OkHttp as its network layer. You can also see the performance of Drawee running over Volley instead of Fresco's image pipeline.\n\nThe app offers you a choice of images from your local camera or from the Internet. The network images come from [Imgur](http://imgur.com).\n\nYou can build, install, and run a controlled test of any combination of loaders using the [run_comparison.py](https://github.com/facebook/fresco/blob/main/run_comparison.py) script. The following command will run them all on a connected ARM v7 device:\n\n```./run_comparison.py -c armeabi-v7a```\n\n### The round app\n\nThe round app shows the same image scaled in several different ways, with and without a circle applied.\n" }, { "path": "docs/_docs/scaletypes.md", "content": "---\ndocid: scaletypes\ntitle: ScaleTypes\nlayout: docs\npermalink: /docs/scaletypes.html\n---\n\nYou can specify a different scale type for each of the different drawables in your Drawee.\n\n### Available Scale Types\n\n| Scale Type | Preserves Aspect Ratio | Always Fills Entire View | Performs Scaling | Explanation |\n| --------- | :-: | :-: | :-: | ----------- |\n| center | ✓ | | | Center the image in the view, but perform no scaling. |\n| centerCrop | ✓ | ✓ | ✓ | Scales the image so that both dimensions will be greater than or equal
to the corresponding dimension of the parent.
One of width or height will fit exactly.
The image is centered within parent's bounds. |\n| focusCrop | ✓ | ✓ | ✓ | Same as centerCrop, but based around
a caller-specified focus point instead of the center.\n| centerInside | ✓ | | ✓ | Downscales the image so that it fits entirely inside the parent.
Unlike `fitCenter,` no upscaling will be performed.
Aspect ratio is preserved.
The image is centered within parent's bounds. |\n| fitCenter | ✓ | | ✓ | Scales the image so that it fits entirely inside the parent.
One of width or height will fit exactly.
Aspect ratio is preserved.
The image is centered within the parent's bounds. |\n| fitStart | ✓ | | ✓ | Scales the image so that it fits entirely inside the parent.
One of width or height will fit exactly.
Aspect ratio is preserved.
The image is aligned to the top-left corner of the parent.\n| fitEnd | ✓ | | ✓ | Scales the image so that it fits entirely inside the parent.
One of width or height will fit exactly.
Aspect ratio is preserved.
The image is aligned to the bottom-right corner of the parent.\n| fitXY | | ✓ | ✓ | Scales width and height independently.
The image will match the parent exactly.
Aspect ratio is not preserved.\n| none | ✓ | | | Used for Android's tile mode. |\n\nThese are mostly the same as those supported by the Android [ImageView](http://developer.android.com/reference/android/widget/ImageView.ScaleType.html) class. The one unsupported type is `matrix`. In its place, Fresco offers `focusCrop,` which will usually work better.\n\n### How to Set a Scale Type\n\nScaleTypes of actual, placeholder, retry, and failure images can all be set in XML, using attributes like `fresco:actualImageScaleType`. You can also set them in code using the [GenericDraweeHierarchyBuilder](../javadoc/reference/com/facebook/drawee/generic/GenericDraweeHierarchyBuilder.html) class.\n\nEven after your hierarchy is built, the actual image scale type can be modified on the fly using [GenericDraweeHierarchy](../javadoc/reference/com/facebook/drawee/generic/GenericDraweeHierarchy.html).\n\nHowever, do **not** use the `android:scaleType` attribute, nor the `.setScaleType` method. These have no effect on Drawees.\n\n### Scale Type: \"focusCrop\"\n\nAndroid, and Fresco, offer a `centerCrop` scale type, which will fill the entire viewing area while preserving the aspect ratio of the image, cropping as necessary.\n\nThis is very useful, but the trouble is the cropping doesn't always happen where you need it. If, for instance, you want to crop to someone's face in the bottom right corner of the image, `centerCrop` will do the wrong thing.\n\nBy specifying a focus point, you can say which part of the image should be centered in the view. If you specify the focus point to be at the top of the image, such as (0.5f, 0f), we guarantee that, no matter what, this point will be visible and centered in the view as much as possible.\n\nFocus points are specified in a relative coordinate system. That is, (0f, 0f) is the top-left corner, and (1f, 1f) is the bottom-right corner. Relative coordinates allow focus points to be scale-invariant, which is highly useful.\n\nA focus point of (0.5f, 0.5f) is equivalent to a scale type of `centerCrop.`\n\nTo use focus points, you must first set the right scale type in your XML:\n\n```xml\n fresco:actualImageScaleType=\"focusCrop\"\n```\n\nIn your Java code, you must programmatically set the correct focus point for your image:\n\n```java\nPointF focusPoint = new PointF(0f, 0.5f);\nmSimpleDraweeView\n .getHierarchy()\n .setActualImageFocusPoint(focusPoint);\n```\n\n### ScaleType: \"none\"\n\nIf you are using Drawables that make use of Android's tile mode, you need to use the `none` scale type for this to work correctly.\n\n### Scale Type: A Custom ScaleType\n\nSometimes you need to scale the image in a way that none of the existing scale types does. Drawee allows you to do that easily by implementing your own `ScalingUtils.ScaleType`. There is only one method in that interface, `getTransform`, which is supposed to compute the transformation matrix based on:\n\n* parent bounds (rectangle where the image should be placed in the view's coordinate system)\n* child size (width and height of the actual bitmap)\n* focus point (relative coordinates in the child's coordinate system)\n\nOf course, your class can contain any additional data you might need to compute the transformation.\n\nLet's look at an example. Assume the `parentBounds` are `(100, 150, 500, 450)`, and the child dimensions are `(420,210)`. Observe that the parent width is `500 - 100 = 400`, and the height is `450 - 150 = 300`. If we don't do any transformation (i.e. we set the transformation to be the identity matrix), the image will be drawn in `(0, 0, 420, 210)`. But `ScaleTypeDrawable` has to respect the bounds imposed by the parent and will so clip the canvas to `(100, 150, 500, 450)`. That means that only the bottom-right part of the image will actually be visible: `(100, 150, 420, 210)`.\n\nWe can fix that by doing a translation by `(parentBounds.left, parentBounds.top)`, which is in this case `(100, 150)`. But now the right part of the image got clipped as the image is actually wider than the parent bounds! Image is now placed at `(100, 150, 500, 360)` in the view coordinates, or equivalently `(0, 0, 400, 210)` in the child coordinates. We lost `20` pixels on the right.\n\nTo avoid image to be clipped we can downscale it. Here we can scale by `400/420` which will make the image be of the size `(400,200)`.\nThe image now fits exactly in the view horizontally, but it is not centered in it vertically.\n\nIn order to center the image we need to translate it a bit more. We can see that the amount of empty space in the parent bounds is `400 - 400 = 0` horizontally, and `300 - 200 = 100` vertically. If we translate by half of this empty space, we will leave equal amount of empty space on each side, effectively making the image centered in the parent bounds.\n\nCongratulations! You just implemented the `FIT_CENTER` scale type:\n\n```java\n public class AbstractScaleType implements ScaleType {\n @Override\n public Matrix getTransform(Matrix outTransform, Rect parentRect, int childWidth, int childHeight, float focusX, float focusY) {\n // calculate scale; we take the smaller of the horizontal and vertical scale factor so that the image always fits\n final float scaleX = (float) parentRect.width() / (float) childWidth;\n final float scaleY = (float) parentRect.height() / (float) childHeight;\n final float scale = Math.min(scaleX, scaleY);\n\n // calculate translation; we offset by parent bounds, and by half of the empty space\n // note that the child dimensions need to be adjusted by the scale factor\n final float dx = parentRect.left + (parentRect.width() - childWidth * scale) * 0.5f;\n final float dy = parentRect.top + (parentRect.height() - childHeight * scale) * 0.5f;\n\n // finally, set and return the transform\n outTransform.setScale(scale, scale);\n outTransform.postTranslate((int) (dx + 0.5f), (int) (dy + 0.5f));\n return outTransform;\n }\n }\n```\n\n### Full Sample\n\nFor a full sample see the `DraweeScaleTypeFragment` in the showcase app: [DraweeScaleTypeFragment.java](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/drawee/DraweeScaleTypeFragment.java)\n\n![Showcase app with a scale type example](/static/images/docs/01-scaletypes-sample-1.png)\n\n![Showcase app with a scale type example](/static/images/docs/01-scaletypes-sample-2.png)\n" }, { "path": "docs/_docs/shared-transitions.md", "content": "---\ndocid: shared-transitions\ntitle: Shared Transitions\nlayout: docs\npermalink: /docs/shared-transitions.html\n---\n\n## Use ChangeBounds, not ChangeImageTransform\n\nAndroid 5.0 (Lollipop) introduced [shared element transitions](http://developer.android.com/training/material/animations.html#Transitions), allowing apps to share a View between multiple Activities and define a transition between them.\n\nYou can define your transitions in XML. There is a transform called ChangeImageTransform which captures an ImageView's matrix and animates it during the transition. This will not work in Fresco, which has its own set of matrices to scale with.\n\nFortunately there is an easy workaround. Just use the [ChangeBounds](http://developer.android.com/reference/android/transition/ChangeBounds.html) transition instead. This animates the changes in the layout *bounds*. Fresco will automatically adjust the scaling matrix as you update the bounds, so your animation will appear exactly as you want it.\n" }, { "path": "docs/_docs/supported-uris.md", "content": "---\ndocid: supported-uris\ntitle: Supported URIs\nlayout: docs\npermalink: /docs/supported-uris.html\n---\n\nFresco supports images in a variety of locations. Fresco does **not** accept relative URIs. All URIs must be absolute and must include the scheme.\n\nThese are the URI schemes accepted:\n\n\n| Type | Scheme | Fetch method used\n| ---------------- | ------- | ------------- |\n| File on network | `http://,` `https://` | `HttpURLConnection` or [network layer](using-other-network-layers.html) |\n| File on device | `file://` | `FileInputStream` |\n| Content provider | `content://` | `ContentResolver` |\n| Asset in app | `asset://` | `AssetManager` |\n| Resource in app | `res://` as in `res:///12345` | `Resources.openRawResource` |\n| Data in URI | `data:mime/type;base64,` | Following [data URI spec](http://tools.ietf.org/html/rfc2397) (UTF-8 only) |\n\n
\nNote: Only image resources can be used with the image pipeline (e.g. a PNG image). Other resource types such as Strings or XML Drawables make no sense in the context of the image pipeline and so cannot be supported by definition. One potentially confusing case is drawable declared in XML (e.g. ShapeDrawable). Important thing to note is that this is **not** an image. If you want to display an XML drawable as the main image, then set it as a [placeholder](placeholder-failure-retry.html) and use the `null` uri.\n\n### Sample: Loading an URI\n\nFor a sample that just loads an URI see the `DraweeSimpleFragment` in the showcase app: [DraweeSimpleFragment.java](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/drawee/DraweeSimpleFragment.java)\n\n![A simple URI sample](/static/images/docs/01-using-simpledraweeview-sample.png)\n\n### Sample: Loading a Local File\n\nFor a sample on how to correctly load user-selected files (e.g. using the `content://` URI) see the `DraweeMediaPickerFragment` in the showcase app: [DraweeMediaPickerFragment.java](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/drawee/DraweeMediaPickerFragment.java)\n\n![A sample with local files](/static/images/docs/01-supported-uris-sample-local-file.png)\n\n### Sample: Loading a Data URI\n\nThe Fresco showcase app has a [ImageFormatDataUriFragment](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/imageformat/datauri/ImageFormatDataUriFragment.java) that demonstrates using placeholder, failure and retry images.\n\n![A data URI sample](/static/images/docs/01-supported-uris-sample-data-uri.png)\n\n### More\n\n**Tip:** You can override the displayed image URI in many samples in the showcase app by using the *URI Override* option in the global settings:\n\n![The URI override setting](/static/images/docs/01-supported-uris-sample-override.png)\n" }, { "path": "docs/_docs/troubleshooting.md", "content": "---\ndocid: troubleshooting\ntitle: Troubleshooting\nlayout: docs\npermalink: /docs/troubleshooting.html\n---\n\n## Troubleshooting\n\n### Image is displayed with repeated edges\n\nThis is a known limitation when rounding is used. See [Rounding](http://frescolib.org/docs/rounded-corners-and-circles.html#_) for more information and how to workaround.\n\n\n### Image doesn't load\n\nYou can get more information from the image pipeline by examining the verbose logcat as explained later in this section. Here are some common reasons why image loads might fail:\n\n#### File not available\n\nFor example, an incorrect path for local files or an unavailable network URI is given.\n\nTry opening a network URI in a mobile browser. If it doesn't work, the issue is likely neither in Fresco nor your app.\n\nFor a local file, try opening a file input stream directly from your app:\n\n```\nFileInputStream fis = new FileInputStream(new File(localUri.getPath()));\n```\n\nIf that throws an exception, the issue is likely not in Fresco, **but** it may be in your app. One possibility is a permission issue, such as trying to access the SD card without requiring the necessary permission in your application manifest. Another possibility is that the pathy is not correct - perhaps you forgot to properly escape it. Finally, the file may simply not exist.\n\n#### OOMs and failing to allocate a bitmap\n\nThe most common reason for this happening is loading too big images. If the image to be loaded is of considerably bigger size than the view hosting it, it should be [resized](resizing.html).\n\n#### Bitmap too large to be uploaded to a texture\n\nAndroid cannot display images more than 2048 pixels long in either dimension. This is beyond the capability of the OpenGL rendering system. Fresco will resize your image if it exceeds this limit.\n\n\n### Investigating issues with logcat\n\nThere are various issues one might encounter when it comes to image handling. With Fresco, most of them can be diagnosed by simply looking at the `VERBOSE` logcat. This should be your starting point when investigating an issue with Fresco.\n\n#### Setting up logcat\n\nBy default, Fresco does not write out all its logs. You need to [configure the image pipeline](configure-image-pipeline.html#_) to do so.\n\n```java\nSet requestListeners = new HashSet<>();\nrequestListeners.add(new RequestLoggingListener());\nImagePipelineConfig config = ImagePipelineConfig.newBuilder(context)\n // other setters\n .setRequestListeners(requestListeners)\n .build();\nFresco.initialize(context, config);\nFLog.setMinimumLoggingLevel(FLog.VERBOSE);\n```\n\n#### Examining logcat\n\nAll of Fresco's logs can be examined by this command:\n\n```\nadb logcat -v threadtime | grep -iE 'LoggingListener|AbstractDraweeController|BufferedDiskCache'\n```\n\nThe output shows what is happening with the image requests within the image pipeline. It looks something like this:\n\n```\n08-12 09:11:14.791 6690 6690 V unknown:AbstractDraweeController: controller 28ebe0eb 0 -> 1: initialize\n08-12 09:11:14.791 6690 6690 V unknown:AbstractDraweeController: controller 28ebe0eb 1: onDetach\n08-12 09:11:14.791 6690 6690 V unknown:AbstractDraweeController: controller 28ebe0eb 1: setHierarchy: null\n08-12 09:11:14.791 6690 6690 V unknown:AbstractDraweeController: controller 28ebe0eb 1: setHierarchy: com.facebook.drawee.generic.GenericDraweeHierarchy@2bb88e4\n08-12 09:11:14.791 6690 6690 V unknown:AbstractDraweeController: controller 28ebe0eb 1: onAttach: request needs submit\n08-12 09:11:14.791 6690 6690 V unknown:PipelineDraweeController: controller 28ebe0eb: getDataSource\n08-12 09:11:14.791 6690 6690 V unknown:RequestLoggingListener: time 11201791: onRequestSubmit: {requestId: 1, callerContext: null, isPrefetch: false}\n08-12 09:11:14.792 6690 6690 V unknown:RequestLoggingListener: time 11201791: onProducerStart: {requestId: 1, producer: BitmapMemoryCacheGetProducer}\n08-12 09:11:14.792 6690 6690 V unknown:RequestLoggingListener: time 11201792: onProducerFinishWithSuccess: {requestId: 1, producer: BitmapMemoryCacheGetProducer, elapsedTime: 1 ms, extraMap: {cached_value_found=false}}\n08-12 09:11:14.792 6690 6690 V unknown:RequestLoggingListener: time 11201792: onProducerStart: {requestId: 1, producer: BackgroundThreadHandoffProducer}\n08-12 09:11:14.792 6690 6690 V unknown:AbstractDraweeController: controller 28ebe0eb 1: submitRequest: dataSource: 36e95857\n08-12 09:11:14.792 6690 6734 V unknown:RequestLoggingListener: time 11201792: onProducerFinishWithSuccess: {requestId: 1, producer: BackgroundThreadHandoffProducer, elapsedTime: 0 ms, extraMap: null}\n08-12 09:11:14.792 6690 6734 V unknown:RequestLoggingListener: time 11201792: onProducerStart: {requestId: 1, producer: BitmapMemoryCacheProducer}\n08-12 09:11:14.792 6690 6734 V unknown:RequestLoggingListener: time 11201792: onProducerFinishWithSuccess: {requestId: 1, producer: BitmapMemoryCacheProducer, elapsedTime: 0 ms, extraMap: {cached_value_found=false}}\n08-12 09:11:14.792 6690 6734 V unknown:RequestLoggingListener: time 11201792: onProducerStart: {requestId: 1, producer: EncodedMemoryCacheProducer}\n08-12 09:11:14.792 6690 6734 V unknown:RequestLoggingListener: time 11201792: onProducerFinishWithSuccess: {requestId: 1, producer: EncodedMemoryCacheProducer, elapsedTime: 0 ms, extraMap: {cached_value_found=false}}\n08-12 09:11:14.792 6690 6734 V unknown:RequestLoggingListener: time 11201792: onProducerStart: {requestId: 1, producer: DiskCacheProducer}\n08-12 09:11:14.792 6690 6735 V unknown:BufferedDiskCache: Did not find image for http://www.example.com/image.jpg in staging area\n08-12 09:11:14.793 6690 6735 V unknown:BufferedDiskCache: Disk cache read for http://www.example.com/image.jpg\n08-12 09:11:14.793 6690 6735 V unknown:BufferedDiskCache: Disk cache miss for http://www.example.com/image.jpg\n08-12 09:11:14.793 6690 6735 V unknown:RequestLoggingListener: time 11201793: onProducerFinishWithSuccess: {requestId: 1, producer: DiskCacheProducer, elapsedTime: 1 ms, extraMap: {cached_value_found=false}}\n08-12 09:11:14.793 6690 6735 V unknown:RequestLoggingListener: time 11201793: onProducerStart: {requestId: 1, producer: NetworkFetchProducer}\n08-12 09:11:15.161 6690 7358 V unknown:RequestLoggingListener: time 11202161: onProducerFinishWithSuccess: {requestId: 1, producer: NetworkFetchProducer, elapsedTime: 368 ms, extraMap: null}\n08-12 09:11:15.162 6690 6742 V unknown:BufferedDiskCache: About to write to disk-cache for key http://www.example.com/image.jpg\n08-12 09:11:15.162 6690 6734 V unknown:RequestLoggingListener: time 11202162: onProducerStart: {requestId: 1, producer: DecodeProducer}\n08-12 09:11:15.163 6690 6742 V unknown:BufferedDiskCache: Successful disk-cache write for key http://www.example.com/image.jpg\n08-12 09:11:15.169 6690 6734 V unknown:RequestLoggingListener: time 11202169: onProducerFinishWithSuccess: {requestId: 1, producer: DecodeProducer, elapsedTime: 7 ms, extraMap: {hasGoodQuality=true, queueTime=0, bitmapSize=600x400, isFinal=true}}\n08-12 09:11:15.169 6690 6734 V unknown:RequestLoggingListener: time 11202169: onRequestSuccess: {requestId: 1, elapsedTime: 378 ms}\n08-12 09:11:15.184 6690 6690 V unknown:AbstractDraweeController: controller 28ebe0eb 1: set_final_result @ onNewResult: image: CloseableReference 2fd41bb0\n```\n\nIn this case, we see that the controller `28ebe0eb` associated with a DraweeView started datasource `36e95857` which issued image request `1`. We can now see that the image was not found in the bitmap cache, nor in the encoded memory cache, nor in the disk cache, and so the network fetch had to be performed. The fetch was successful, the image was decoded and the request finished successfully. Finally, the datasource notified the controller which then set the resulting image to the hierarchy (`set_final_result`).\n" }, { "path": "docs/_docs/using-controllerbuilder.md", "content": "---\ndocid: using-controllerbuilder\ntitle: Using the ControllerBuilder\nlayout: docs\npermalink: /docs/using-controllerbuilder.html\n---\n\n`SimpleDraweeView` has two methods for specifying an image. The easy way is to just call `setImageURI.`\n\nIf you want more control over how the Drawee displays your image, you can use a [DraweeController](concepts.html). This page explains how to build and use one.\n\n### Building a DraweeController\n\nPass the uri to a [PipelineDraweeControllerBuilder](../javadoc/reference/com/facebook/drawee/backends/pipeline/PipelineDraweeControllerBuilder.html). Then specify additional options for the controller:\n\n```java\nControllerListener listener = new BaseControllerListener() {...}\n\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setUri(uri)\n .setTapToRetryEnabled(true)\n .setOldController(mSimpleDraweeView.getController())\n .setControllerListener(listener)\n .build();\n\nmSimpleDraweeView.setController(controller);\n```\n\nYou should call `setOldController` when building a new controller. This will allow for the old controller to be reused and a couple of unnecessary memory allocations to be avoided.\n\nMore details:\n\n* [Controller Listeners](listening-to-events.html)\n\n### Customizing the ImageRequest\n\nFor still more advanced usage, you might need to set an [ImageRequest](../javadoc/reference/com/facebook/imagepipeline/request/ImageRequest.html) to the pipeline, instead of merely a URI. An example of this is using a [postprocessor](modifying-image.html).\n\n```java\nUri uri;\nPostprocessor myPostprocessor = new Postprocessor() { ... }\nImageRequest request = ImageRequestBuilder.newBuilderWithSource(uri)\n .setPostprocessor(myPostprocessor)\n .build();\n\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setImageRequest(request)\n .setOldController(mSimpleDraweeView.getController())\n // other setters as you need\n .build();\n```\n\nMore details:\n\n* [Postprocessors](modifying-image.html)\n* [Requesting Multiple Images](requesting-multiple-images.html)\n* [Resizing](resizing.html)\n* [Rotation](rotation.html)\n" }, { "path": "docs/_docs/using-image-pipeline.md", "content": "---\ndocid: using-image-pipeline\ntitle: Using the Image Pipeline Directly\nlayout: docs\npermalink: /docs/using-image-pipeline.html\n---\n\nThis page is intended for advanced usage only. Most apps should be using [Drawees](using-simpledraweeview.html) to interact with Fresco's image pipeline.\n\nUsing the image pipeline directly is challenging because of the memory usage. Drawees automatically keep track of whether or not your images need to be in memory. They will swap them out and load them back as soon as they need to be displayed. If you are using the image pipeline directly, your app must repeat this logic.\n\nThe image pipeline returns objects wrapped in a [CloseableReference](closeable-references.html). Drawees keep these references alive for as long as they need their image, and then call the `.close()` method on these references when they are finished with them. If your app is not using Drawees, it **must** do the same.\n\nIf you do not keep a Java reference to a `CloseableReference` returned by the pipleine, the `CloseableReference` will get garbage collected and the underlying `Bitmap` may get recycled while still being used. If you do not close the `CloseableReference` once you are done with it, you risk memory leaks and OOMs.\n\nTo be precise, the Java garbage collector will free image memory when Bitmap objects go out of scope, but this may be too late. Garbage collection is expensive, and relying on it for large objects leads to performance issues. This is especially true on Android 4.x and lower, when Android did not maintain a separate memory space for Bitmaps.\n\n### Calling the pipeline\n\nYou must [build an image request](image-requests.html). Having done that, you can pass it directly to the `ImagePipeline:`\n\n```java\nImagePipeline imagePipeline = Fresco.getImagePipeline();\nDataSource>\n dataSource = imagePipeline.fetchDecodedImage(imageRequest, callerContext);\n```\n\nSee the page on [DataSources](datasources-datasubscribers.html) for information on how to receive data from them.\n\n### Skipping the decode\n\nIf you don't want to decode the image, but want to get the image bytes in their original compressed format, just use `fetchEncodedImage` instead:\n\n```java\nDataSource>\n dataSource = imagePipeline.fetchEncodedImage(imageRequest, callerContext);\n```\n\n### Instant results from the bitmap cache\n\nLookups to the bitmap cache, unlike the others, are done in the UI thread. If a Bitmap is there, you get it instantly.\n\n```java\nDataSource> dataSource =\n imagePipeline.fetchImageFromBitmapCache(imageRequest, callerContext);\ntry {\n CloseableReference imageReference = dataSource.getResult();\n if (imageReference != null) {\n try {\n // Do something with the image, but do not keep the reference to it!\n // The image may get recycled as soon as the reference gets closed below.\n // If you need to keep a reference to the image, read the following sections.\n } finally {\n CloseableReference.closeSafely(imageReference);\n }\n } else {\n // cache miss\n ...\n }\n} finally {\n dataSource.close();\n}\n```\n\n### Synchronous image loading\n\nIn a similar way to how you can immediately retrieve images from the bitmap cache, it is also possible to load an image from the network synchronously using `DataSources.waitForFinalResult()`.\n\n```java\nDataSource> dataSource =\n imagePipeline.fetchImageFromBitmapCache(imageRequest, callerContext);\ntry {\n CloseableReference result = DataSources.waitForFinalResult(dataSource);\n if (result != null) {\n // Do something with the image, but do not keep the reference to it!\n // The image may get recycled as soon as the reference gets closed below.\n // If you need to keep a reference to the image, read the following sections.\n }\n} finally {\n dataSource.close();\n}\n```\n\nDo **not** skip these `finally` blocks!\n\n### The caller Context\n\nAs we can see, most of the `ImagePipeline` fetch methods contains a second parameter named `callerContext` of type `Object`. We can see it as an implementation of the [Context Object Design Pattern](https://www.dre.vanderbilt.edu/~schmidt/PDF/Context-Object-Pattern.pdf). It's basically an object we bind to a specific `ImageRequest` that can be used for different purposes (e.g. Log). The same object can also be accessed by all the `Producer` implementations into the `ImagePipeline`.\n\nThe caller Context can also be `null`.\n" }, { "path": "docs/_docs/using-other-network-layers.md", "content": "---\ndocid: using-other-network-layers\ntitle: Using Other Network Layers\nlayout: docs\npermalink: /docs/using-other-network-layers.html\n---\n\nBy default, the image pipeline uses the [HttpURLConnection](https://developer.android.com/training/basics/network-ops/connecting.html) which is included in the Android framework. However, if needed by the app a custom network layer can be used. Fresco already contains one alternative network layer that is based on OkHttp.\n\n### Using OkHttp\n\n[OkHttp](http://square.github.io/okhttp) is a popular open-source networking library.\n\n### 1. Gradle setup\n\nIn order to use it, the `dependencies` section of your `build.gradle` file needs to be changed. Along with the Gradle dependencies given on the [Getting started](index.html) page, add **just one** of these:\n\nFor OkHttp2:\n\n```groovy\ndependencies {\n // your project's other dependencies\n implementation \"com.facebook.fresco:imagepipeline-okhttp:{{site.current_version}}\"\n}\n```\n\nFor OkHttp3:\n\n```groovy\ndependencies {\n // your project's other dependencies\n implementation \"com.facebook.fresco:imagepipeline-okhttp3:{{site.current_version}}\"\n}\n```\n\n#### 2. Configuring the image pipeline to use OkHttp\n\nYou must also configure the image pipeline. Instead of using `ImagePipelineConfig.newBuilder`, use `OkHttpImagePipelineConfigFactory`:\n\n```java\nContext context;\nOkHttpClient okHttpClient; // build on your own\nImagePipelineConfig config = OkHttpImagePipelineConfigFactory\n .newBuilder(context, okHttpClient)\n . // other setters\n . // setNetworkFetcher is already called for you\n .build();\nFresco.initialize(context, config);\n```\n\nFor a more detailed example of this, see how this if configured in the [Fresco showcase app](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/ShowcaseApplication.java).\n\n### Handling sessions and cookies correctly\n\nThe `OkHttpClient` you pass to Fresco in the above step should be set up with interceptors needed to handle authentications to your servers. See [this bug](https://github.com/facebook/fresco/issues/385) and the solutions outlined there for some problems that have occurred with cookies.\n\n### Using your own network fetcher (optional)\n\nFor complete control on how the networking layer should behave, you can provide one for your app. You must subclass [NetworkFetcher](../javadoc/reference/com/facebook/imagepipeline/producers/NetworkFetcher.html), which controls communications to the network. You can also optionally subclass [FetchState](../javadoc/reference/com/facebook/imagepipeline/producers/FetchState.html), which is a data structure for request-specific information.\n\nOur implementation for `OkHttp 3` can be used as an example. See [its source code](https://github.com/facebook/fresco/blob/main/imagepipeline-backends/imagepipeline-okhttp3/src/main/java/com/facebook/imagepipeline/backends/okhttp3/OkHttpNetworkFetcher.java).\n\nYou must pass your network producer to the image pipeline when [configuring it](configure-image-pipeline.html):\n\n```java\nImagePipelineConfig config = ImagePipelineConfig.newBuilder()\n .setNetworkFetcher(myNetworkFetcher);\n . // other setters\n .build();\nFresco.initialize(context, config);\n```\n" }, { "path": "docs/_docs/using-simpledraweeview.md", "content": "---\ndocid: using-simpledraweeview\ntitle: Using SimpleDraweeView\nlayout: docs\npermalink: /docs/using-simpledraweeview.html\nredirect_from:\n - /docs/using-drawees-xml.html\n - /docs/using-drawees-code.html\n---\n\nWhen using Fresco, you will use `SimpleDraweeView` to display images. These can be used in XML layouts. The simplest usage example of `SimpleDraweeView` is:\n\n```xml\n\n```\n\n**NOTE:** `SimpleDraweeView` does not support `wrap_content` for `layout_width` or `layout_height` attributes. More information can be found [here](faq.html). The only exception to this is when you are setting an aspect ratio, like so:\n\n```xml\n\n```\n\n### Loading an image\n\nThe easiest way to load an image into a `SimpleDraweeView` is to call `setImageURI`:\n\n```java\nmSimpleDraweeView.setImageURI(uri);\n```\n\nThat's it, you are now displaying images with Fresco!\n\n### Advanced XML attributes\n\n`SimpleDraweeView`, despite its name, supports a great deal of customization through XML attributes. The example below presents all of them:\n\n```xml\n\n```\n\n### Customizing from code\n\nAlthough it's generally recommended to set these options in XML, all of the attributes above can also be set from code. In order to do this, you will need to create a `DraweeHierarchy` before setting the image URI:\n\n```java\nGenericDraweeHierarchy hierarchy =\n GenericDraweeHierarchyBuilder.newInstance(getResources())\n .setActualImageColorFilter(colorFilter)\n .setActualImageFocusPoint(focusPoint)\n .setActualImageScaleType(scaleType)\n .setBackground(background)\n .setDesiredAspectRatio(desiredAspectRatio)\n .setFadeDuration(fadeDuration)\n .setFailureImage(failureImage)\n .setFailureImageScaleType(scaleType)\n .setOverlays(overlays)\n .setPlaceholderImage(placeholderImage)\n .setPlaceholderImageScaleType(scaleType)\n .setPressedStateOverlay(overlay)\n .setProgressBarImage(progressBarImage)\n .setProgressBarImageScaleType(scaleType)\n .setRetryImage(retryImage)\n .setRetryImageScaleType(scaleType)\n .setRoundingParams(roundingParams)\n .build();\nmSimpleDraweeView.setHierarchy(hierarchy);\nmSimpleDraweeView.setImageURI(uri);\n```\n\n**NOTE:** some of these options can be set on an existing hierarchy without having to build a new one. To do this, simply get the hierarchy from a `SimpleDraweeView` and call any of the setter methods on it, e.g.:\n\n```java\nmSimpleDraweeView.getHierarchy().setPlaceHolderImage(placeholderImage);\n```\n\n### Full Sample\n\nFor a full sample see the `DraweeSimpleFragment` in the showcase app: [DraweeSimpleFragment.java](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/drawee/DraweeSimpleFragment.java)\n\n![Showcase app with a scale type example](/static/images/docs/01-using-simpledraweeview-sample.png)\n" }, { "path": "docs/_docs/webp-support.md", "content": "---\ndocid: webp-support\ntitle: WebP Images\nlayout: docs\npermalink: /docs/webp-support.html\n---\n\n[WebP](https://en.wikipedia.org/wiki/WebP) is an image format that supports lossy and lossless compressions. Furthermore, it allows for transparency and animations.\n\n### Support on Android\n\nAndroid added WebP support in version 4.0 and improved it in 4.2.1:\n\n* 4.0+ (Ice Cream Sandwich) have basic webp support\n* 4.2.1+ (Jelly Beam MR1) have support for transparency and lossless WebP\n\nBy adding the Fresco webpsupport module, apps can display all kinds of WebP images on all versions of Android:\n\n| Configuration | Basic WebP | Lossless or Transparent WebP | Animated WebP |\n|--- |:-: |:-: |:-: |\n| OS < 4.0 | | | |\n| OS >= 4.0 | ✓ | | |\n| OS >= 4.2.1 | ✓ | ✓ | |\n| Any OS + webpsupport | ✓ | ✓ | |\n| Any OS + animated-webp | ✓ | (✓ if webpsupport or OS >= 4.2.1) | ✓ |\n\n### Adding Support for Static WebP images on Older Versions\n\nThe only thing you need to do is add the `webpsupport` library to your dependencies. This adds support for all types of non-animated WebP images. E.g. you can use it to display transparent WebP images on Gingerbread.\n\n```groovy\ndependencies {\n // ... your app's other dependencies\n implementation 'com.facebook.fresco:webpsupport:{{site.current_version}}'\n}\n```\n\n### Animated WebP\n\nIn order to display animated WebP images, you have to add the following dependencies:\n\n```groovy\ndependencies {\n // ... your app's other dependencies\n implementation 'com.facebook.fresco:animated-webp:{{site.current_version}}'\n implementation 'com.facebook.fresco:webpsupport:{{site.current_version}}'\n}\n```\n\nYou can then load the animated WebP images like any other URI. In order to auto-start the animation, you can set `setAutoPlayAnimations(true)` on the `DraweeController`:\n\n```java\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setUri(\"http://example.org/somefolder/animated.webp\")\n .setAutoPlayAnimations(true)\n .build();\nmSimpleDraweeView.setController(controller);\n```\n\n### Full Sample\n\nFor the full sample see the `ImageFormatWebpFragment` in the showcase app: [ImageFormatWebpFragment.java](https://github.com/facebook/fresco/blob/main/samples/showcase/src/main/java/com/facebook/fresco/samples/showcase/imageformat/webp/ImageFormatWebpFragment.java)\n\n![Showcase app with a notification](/static/images/docs/03-webp-support-sample.png)\n" }, { "path": "docs/_docs/writing-custom-views.md", "content": "---\ndocid: writing-custom-views\ntitle: Writing Custom Views\nlayout: docs\npermalink: /docs/writing-custom-views.html\n---\n\n### DraweeHolders\n\nThere will always be times when `DraweeViews` won't fit your needs. You may need to show additional content inside the same view as your image. You might need to show multiple images inside a single view.\n\nWe provide two alternative classes you can use to host your Drawee:\n\n* `DraweeHolder` for a single image\n* `MultiDraweeHolder` for multiple images\n\n`DraweeHolder` is a class that holds one DraweeHierarchy and the associated DraweeController. It allows you to make use of all the functionality Drawee provides in your custom views and other places where you need a drawable instead of a view. To get the drawable, you just do `mDraweeHolder.getTopLevelDrawable()`. Keep in mind that Android drawables require a bit of housekeeping which we covered below.\n`MultiDraweeHolder` is basically just an array of `DraweeHolder`s with some syntactic sugar added on top of it.\n\n### Responsibilities of custom views\n\nAndroid lays out View objects, and only they get notified of system events. `DraweeViews` handle these events and use them to manage memory effectively. When using the holders, you must implement some of this functionality yourself.\n\n#### Handling attach/detach events\n\n**Your app may leak memory, or the image may not be displayed at all, if these steps are not followed.**\n\nThere is no point in images staying in memory when Android is no longer displaying the view - it may have scrolled off-screen, or otherwise not be drawing. Drawees listen for detaches and release memory when they occur. They will automatically restore the image when it comes back on-screen.\n\nAll this is automatic in a `DraweeView,` but won't happen in a custom view unless you handle four system events. These must be passed to the `DraweeHolder`. Here's how:\n\n```java\nDraweeHolder mDraweeHolder;\n\n@Override\npublic void onDetachedFromWindow() {\n super.onDetachedFromWindow();\n mDraweeHolder.onDetach();\n}\n\n@Override\npublic void onStartTemporaryDetach() {\n super.onStartTemporaryDetach();\n mDraweeHolder.onDetach();\n}\n\n@Override\npublic void onAttachedToWindow() {\n super.onAttachedToWindow();\n mDraweeHolder.onAttach();\n}\n\n@Override\npublic void onFinishTemporaryDetach() {\n super.onFinishTemporaryDetach();\n mDraweeHolder.onAttach();\n}\n```\n\nIt is important that `Holder` receives all the attach/detach events that the view itself receives. If the holder misses an attach event the image may not be displayed because Drawee will think that the view is not visible. Likewise, if the holder misses an detach event, the image may still remain in memory because Drawee will think that the view is still visible. Best way to ensure that is to create the holder from your view's constructor.\n\n#### Handling touch events\n\nIf you have enabled [tap to retry](placeholder-failure-retry.html) in your Drawee, it will not work unless you tell it that the user has touched the screen. Like this:\n\n```java\n@Override\npublic boolean onTouchEvent(MotionEvent event) {\n return mDraweeHolder.onTouchEvent(event) || super.onTouchEvent(event);\n}\n```\n\n#### Your custom onDraw\n\nYou must call\n\n```java\nDrawable drawable = mDraweeHolder.getTopLevelDrawable();\ndrawable.setBounds(...);\n...\ndrawable.draw(canvas);\n```\nor the Drawee won't appear at all.\n\n* Do not downcast this Drawable. The underlying implementation may change without any notice.\n* Do not translate it. Just set the proper bounds.\n* If you need to apply some canvas transformations, then make sure that you properly invalidate the area that the drawable occupies in the view. See below on how to do that.\n\n#### Other responsibilities\n\n* Set [Drawable.Callback](http://developer.android.com/reference/android/graphics/drawable/Drawable.Callback.html)\n\n```java\n// When a holder is set to the view for the first time,\n// don't forget to set the callback to its top-level drawable:\nmDraweeHolder = ...\nmDraweeHolder.getTopLevelDrawable().setCallback(this);\n\n// In case the old holder is no longer needed,\n// don't forget to clear the callback from its top-level drawable:\nmDraweeHolder.getTopLevelDrawable().setCallback(null);\nmDraweeHolder = ...\n```\n\n* Override `verifyDrawable:`\n\n```java\n@Override\nprotected boolean verifyDrawable(Drawable who) {\n if (who == mDraweeHolder.getTopLevelDrawable()) {\n return true;\n }\n // other logic for other Drawables in your view, if any\n}\n```\n\n* Make sure `invalidateDrawable` invalidates the region occupied by your Drawee. If you apply some canvas transformations on the drawable before it gets drawn, then those transformations needs to be taken into account in invalidation. The simplest thing to do is what Android ImageView does in its [invalidateDrawable](http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.4.4_r1/android/widget/ImageView.java#192) method. That is, to just invalidate the whole view when the drawable gets invalidated.\n\n\n### Constructing the View and DraweeHolder\n\nThis should be done carefully. See below.\n\n#### Arranging your Constructors\n\nWe recommend the following pattern for constructors:\n\n* Override all three of the three View constructors.\n* Each constructor calls its superclass counterpart and then a private `init` method.\n* All of your initialization happens in `init.`\n\nThat is, do not use the `this` to call one constructor from another. This is because Android View already calls one constructor from another, and it does so in an unintuitive way.\n\nThis approach guarantees that the correct initialization is called no matter what constructor is used. It is in the `init` method that your holder is created.\n\n#### Creating the Holder\n\nIf possible, always create Drawees when your view gets created. Creating a hierarchy is not cheap so it's best to do it only once. More importantly, holder's lifecycle should be bound to the view's lifecycle for the reasons explained in the attach/detach section. Best way to ensure that is to create the holder when the view gets constructed as explained above.\n\n```java\nclass CustomView extends View {\n DraweeHolder mDraweeHolder;\n\n // constructors following above pattern\n\n private void init() {\n GenericDraweeHierarchy hierarchy = new GenericDraweeHierarchyBuilder(getResources());\n .set...\n .set...\n .build();\n mDraweeHolder = DraweeHolder.create(hierarchy, context);\n }\n}\n```\n\n#### Setting an image\n\nUse a [controller builder](using-controllerbuilder.html), but call `setController` on the holder instead of a View:\n\n```java\nDraweeController controller = Fresco.newDraweeControllerBuilder()\n .setUri(uri)\n .setOldController(mDraweeHolder.getController())\n .build();\nmDraweeHolder.setController(controller);\n```\n\n### MultiDraweeHolder\n\nIf you are dealing with multiple drawees in your custom view, `MultiDraweeHolder` might come handy. There are `add`, `remove`, and `clear` methods for dealing with DraweeHalders:\n\n```java\nMultiDraweeHolder mMultiDraweeHolder;\n\nprivate void init() {\n GenericDraweeHierarchy hierarchy = new GenericDraweeHierarchyBuilder(getResources());\n .set...\n .build();\n mMultiDraweeHolder = new MultiDraweeHolder();\n mMultiDraweeHolder.add(new DraweeHolder(hierarchy, context));\n // repeat for more hierarchies\n}\n```\n\nYou must override system events, set bounds, and do all the same responsibilities as for a single `DraweeHolder.`\n" }, { "path": "docs/_includes/blog_pagination.html", "content": "\r\n{% if paginator.total_pages > 1 %}\r\n
\r\n

\r\n {% if paginator.previous_page %}\r\n « Prev\r\n {% else %}\r\n « Prev\r\n {% endif %}\r\n\r\n {% for page in (1..paginator.total_pages) %}\r\n {% if page == paginator.page %}\r\n {{ page }}\r\n {% elsif page == 1 %}\r\n {{ page }}\r\n {% else %}\r\n {{ page }}\r\n {% endif %}\r\n {% endfor %}\r\n\r\n {% if paginator.next_page %}\r\n Next »\r\n {% else %}\r\n Next »\r\n {% endif %}\r\n
\r\n
\r\n{% endif %}\r\n\r\n" }, { "path": "docs/_includes/content/gridblocks.html", "content": "
\r\n{% for item in {{include.data_source}} %}\r\n {% include content/items/gridblock.html item=item gridtype=include.grid_type %}\r\n{% endfor %}\r\n
" }, { "path": "docs/_includes/content/items/gridblock.html", "content": "
\r\n {% if item.image %}\r\n \"{{\r\n {% endif %}\r\n

{{ item.title }}

\r\n {% if item.text %}\r\n {{ item.text | markdownify }}\r\n {% endif %}\r\n
\r\n" }, { "path": "docs/_includes/doc.html", "content": "
\r\n
\r\n

{% if include.truncate %}{{ page.title }}{% else %}{{ page.title }}{% endif %}

\r\n
\r\n\r\n
\r\n {% if include.truncate %}\r\n {% if page.content contains '' %}\r\n {{ page.content | split:'' | first }}\r\n
\r\n \r\n ...Read More\r\n \r\n
\r\n {% else %}\r\n {{ page.content }}\r\n {% endif %}\r\n {% else %}\r\n {{ content }}\r\n {% endif %}\r\n
\r\n {% include doc_paging.html %}\r\n
\r\n" }, { "path": "docs/_includes/doc_paging.html", "content": "" }, { "path": "docs/_includes/footer.html", "content": "
\r\n
\r\n
\r\n
\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n

Facebook Open Source

\r\n
\r\n
\r\n Open Source Projects\r\n GitHub\r\n Twitter\r\n
\r\n
\r\n Contribute to this project on GitHub\r\n
\r\n
\r\n
\r\n
\r\n\r\n" }, { "path": "docs/_includes/head.html", "content": "\n \n \n \n\n {% seo %}\n\n \n \n \n\n \n\n {% comment %}\n For our RSS feed.xml\n https://help.github.com/articles/atom-rss-feeds-for-github-pages/\n {% endcomment %}\n {% feed_meta %}\n\n" }, { "path": "docs/_includes/hero.html", "content": "" }, { "path": "docs/_includes/home_header.html", "content": "
\r\n
\r\n
\r\n
\r\n

{{ site.tagline }}

\r\n
\r\n

{% if page.excerpt %}{{ page.excerpt | strip_html }}{% else %}{{ site.description }}{% endif %}

\r\n
\r\n
\r\n {% for promo in site.data.promo %}\r\n
\r\n {% include plugins/{{promo.type}}.html href=promo.href text=promo.text children=promo.children %}\r\n
\r\n {% endfor %}\r\n
\r\n
\r\n
\r\n \"{{\r\n
\r\n
\r\n
\r\n
\r\n" }, { "path": "docs/_includes/nav.html", "content": "
\r\n
\r\n
\r\n \r\n \r\n

{{ site.title }}

\r\n \r\n\r\n
\r\n \r\n
\r\n
\r\n
\r\n
\r\n {% include react/header_nav.html %}\r\n
\r\n" }, { "path": "docs/_includes/nav_search.html", "content": "
  • \n \n
    • \n\n\n" }, { "path": "docs/_includes/plugins/all_share.html", "content": "
    \n {% include plugins/like_button.html %}{% include plugins/twitter_share.html %}{% include plugins/google_share.html %}\n
    " }, { "path": "docs/_includes/plugins/button.html", "content": "
    \n {{ include.text }}\n
    " }, { "path": "docs/_includes/plugins/fb_pagelike.html", "content": "
    \n
    {{ include.text }}
    \n
    \n" }, { "path": "docs/_includes/plugins/github_star.html", "content": "
    \n Star\n
    \n" }, { "path": "docs/_includes/plugins/github_watch.html", "content": "
    \n Watch\n
    \n" }, { "path": "docs/_includes/plugins/google_share.html", "content": "
    \n
    \n
    \n\n\n" }, { "path": "docs/_includes/plugins/group_join.html", "content": "{{ include.text }}" }, { "path": "docs/_includes/plugins/like_button.html", "content": "
    \r\n" }, { "path": "docs/_includes/plugins/plugin_row.html", "content": "
    \n{% for child in include.children %}\n {% include plugins/{{child.type}}.html href=child.href text=child.text %}\n{% endfor %}\n
    " }, { "path": "docs/_includes/plugins/post_social_plugins.html", "content": "
    \r\n Tweet\r\n
    \r\n
    \r\n\r\n\r\n\r\n" }, { "path": "docs/_includes/plugins/slideshow.html", "content": "
    \r\n\r\n" }, { "path": "docs/_includes/plugins/twitter_share.html", "content": "
    \n Tweet\n
    \n" }, { "path": "docs/_includes/post.html", "content": "
    \r\n {% assign author = site.data.authors[page.author] %}\r\n
    \r\n {% if author.fbid %}\r\n
    \r\n \"{{\r\n
    \r\n {% endif %}\r\n {% if author.full_name %}\r\n

    {{ author.full_name }}

    \r\n {% endif %}\r\n

    {% if include.truncate %}{{ page.title }}{% else %}{{ page.title }}{% endif %}

    \r\n

    Posted {{ page.date | date: '%B %d, %Y' }}{% if page.meta %} • {{ page.meta }}{% endif %}

    \r\n
    \r\n\r\n
    \r\n {% if include.truncate %}\r\n {% if page.content contains '' %}\r\n {{ page.content | split:'' | first | markdownify }}\r\n
    \r\n \r\n Read More\r\n \r\n
    \r\n {% else %}\r\n {{ page.content | markdownify }}\r\n {% endif %}\r\n {% else %}\r\n {{ content }}\r\n {% endif %}\r\n {% unless include.truncate %}\r\n {% include plugins/all_share.html %}\r\n {% endunless %}\r\n
    \r\n
    \r\n" }, { "path": "docs/_includes/powered_by.html", "content": "{% if site.data.powered_by.first.items %}\n
    \n
    \n

    {{ site.data.powered_by.first.title }}

    \n
    \n {% if site.data.powered_by_highlight.first.items %}\n {% for item in site.data.powered_by_highlight.first.items %}\n
    \n \"{{\n
    \n {% endfor %}\n {% endif %}\n {% for item in site.data.powered_by.first.items %}\n
    \n {{ item.name }}\n
    \n {% endfor %}\n
    \n
    Does your app use Fresco? Add it to this list with a pull request!
    \n
    \n
    \n{% endif %}" }, { "path": "docs/_includes/react/collection_nav.html", "content": "
    \n \n
    \n\n" }, { "path": "docs/_includes/react/header_nav.html", "content": "\n" }, { "path": "docs/_includes/react/nav_blog.html", "content": "\r\n{% include react/collection_nav.html %}\r\n" }, { "path": "docs/_includes/react/nav_docs.html", "content": "\n{% include react/collection_nav.html %}\n" }, { "path": "docs/_includes/social_plugins.html", "content": "Tweet\r\n
    \r\n\r\n
    \r\n\r\n\r\n\r\n" }, { "path": "docs/_includes/ui/button.html", "content": "{{ include.button_text }}" }, { "path": "docs/_layouts/basic.html", "content": "---\r\nlayout: doc_default\r\n---\r\n\r\n
    \r\n
    \r\n
    \r\n {{ content }}\r\n
    \r\n
    \r\n
    \r\n\r\n" }, { "path": "docs/_layouts/blog.html", "content": "---\r\ncategory: blog\r\nlayout: blog_default\r\n---\r\n\r\n
    \r\n
    \r\n {{ content }}\r\n
    \r\n
    \r\n\r\n" }, { "path": "docs/_layouts/blog_default.html", "content": "\n\n {% include head.html %}\n \n {% include nav.html alwayson=true %}\n
    \n
    \n {% include react/nav_blog.html %}\n {{ content }}\n
    \n {% include footer.html %}\n
    \n \n\n" }, { "path": "docs/_layouts/default.html", "content": "\r\n\r\n {% include head.html %}\r\n \r\n {% include nav.html alwayson=true %}\r\n
    \r\n {{ content }}\r\n {% include footer.html %}\r\n
    \r\n \r\n\r\n\r\n" }, { "path": "docs/_layouts/doc_default.html", "content": "\n\n {% include head.html %}\n \n {% include nav.html alwayson=true %}\n
    \n
    \n {% include react/nav_docs.html %}\n {{ content }}\n
    \n {% include footer.html %}\n
    \n \n\n" }, { "path": "docs/_layouts/doc_page.html", "content": "---\r\nlayout: doc_default\r\n---\r\n\r\n
    \r\n
    \r\n {{ content }}\r\n
    \r\n
    \r\n\r\n" }, { "path": "docs/_layouts/docs.html", "content": "---\r\nlayout: doc_page\r\n---\r\n\r\n{% include doc.html %}" }, { "path": "docs/_layouts/home.html", "content": "\r\n\r\n {% include head.html %}\r\n \r\n {% include nav.html alwayson=true %}\r\n
    \r\n {% include home_header.html %}\r\n
    \r\n
    \r\n {{ content }}\r\n
    \r\n {% include powered_by.html %}\r\n
    \r\n {% include footer.html %}\r\n
    \r\n \r\n\r\n" }, { "path": "docs/_layouts/page.html", "content": "---\r\nlayout: blog\r\n---\r\n" }, { "path": "docs/_layouts/plain.html", "content": "---\r\nlayout: default\r\n---\r\n\r\n
    \r\n
    \r\n {{ content }}\r\n
    \r\n
    \r\n\r\n" }, { "path": "docs/_layouts/post.html", "content": "---\r\ncollection: blog\r\nlayout: blog\r\n---\r\n\r\n
    \r\n{% include post.html %}\r\n
    " }, { "path": "docs/_layouts/redirect.html", "content": "\r\n\r\n \r\n\r\n\r\n\r\n" }, { "path": "docs/_sass/_base.scss", "content": "body {\r\n background: $secondary-bg;\r\n color: $text;\r\n\tfont: normal #{$base-font-size}/#{$base-line-height} $base-font-family;\r\n height: 100vh;\r\n\ttext-align: left;\r\n\ttext-rendering: optimizeLegibility;\r\n}\r\n\r\nimg {\r\n max-width: 100%;\r\n}\r\n\r\narticle {\r\n p {\r\n img {\r\n max-width: 100%;\r\n display:block;\r\n margin-left: auto;\r\n margin-right: auto;\r\n }\r\n }\r\n}\r\n\r\na {\r\n border-bottom: 1px dotted $primary-bg;\r\n color: $text;\r\n text-decoration: none;\r\n -webkit-transition: background 0.3s, color 0.3s;\r\n transition: background 0.3s, color 0.3s;\r\n}\r\n\r\nblockquote {\r\n padding: 15px 30px 15px 15px;\r\n margin: 20px 0 0 10px;\r\n background-color: rgba(204, 122, 111, 0.1);\r\n border-left: 10px solid rgba(191, 87, 73, 0.2);\r\n}\r\n\r\n#fb_oss a {\r\n border: 0;\r\n}\r\n\r\nh1, h2, h3, h4 {\r\n font-family: $header-font-family;\r\n font-weight: 900;\r\n}\r\n\r\n.navPusher {\r\n border-top: $header-height + $header-ptop + $header-pbot solid $primary-bg;\r\n\theight: 100%;\r\n\tleft: 0;\r\n\tposition: relative;\r\n\tz-index: 99;\r\n}\r\n\r\n.homeContainer {\r\n background: $primary-bg;\r\n color: $primary-overlay;\r\n\r\n a {\r\n color: $primary-overlay;\r\n }\r\n\r\n .homeSplashFade {\r\n color: white;\r\n }\r\n\r\n .homeWrapper {\r\n padding: 2em 10px;\r\n text-align: left;\r\n\r\n .wrapper {\r\n margin: 0px auto;\r\n max-width: $content-width;\r\n padding: 0 20px;\r\n }\r\n\r\n .projectLogo {\r\n img {\r\n height: 100px;\r\n margin-bottom: 0px;\r\n }\r\n }\r\n\r\n h1#project_title {\r\n font-family: $header-font-family;\r\n font-size: 300%;\r\n letter-spacing: -0.08em;\r\n line-height: 1em;\r\n margin-bottom: 80px;\r\n }\r\n\r\n h2#project_tagline {\r\n font-family: $header-font-family;\r\n font-size: 200%;\r\n letter-spacing: -0.04em;\r\n line-height: 1em;\r\n }\r\n }\r\n}\r\n\r\n.wrapper {\r\n\tmargin: 0px auto;\r\n\tmax-width: $content-width;\r\n\tpadding: 0 10px;\r\n}\r\n\r\n.projectLogo {\r\n display: none;\r\n\r\n img {\r\n height: 100px;\r\n margin-bottom: 0px;\r\n }\r\n}\r\n\r\nsection#intro {\r\n margin: 40px 0;\r\n}\r\n\r\n.fbossFontLight {\r\n font-family: $base-font-family;\r\n font-weight: 300;\r\n font-style: normal;\r\n}\r\n\r\n.fb-like {\r\n display: block;\r\n margin-bottom: 20px;\r\n width: 100%;\r\n}\r\n\r\n.center {\r\n display: block;\r\n text-align: center;\r\n}\r\n\r\n.mainContainer {\r\n background: $secondary-bg;\r\n overflow: auto;\r\n\r\n .mainWrapper {\r\n padding: 4vh 10px;\r\n text-align: left;\r\n\r\n .allShareBlock {\r\n padding: 10px 0;\r\n\r\n .pluginBlock {\r\n margin: 12px 0;\r\n padding: 0;\r\n }\r\n }\r\n\r\n a {\r\n &:hover,\r\n &:focus {\r\n background: $primary-bg;\r\n color: $primary-overlay;\r\n }\r\n }\r\n\r\n em, i {\r\n font-style: italic;\r\n }\r\n\r\n strong, b {\r\n font-weight: bold;\r\n }\r\n\r\n h1 {\r\n font-size: 300%;\r\n line-height: 1em;\r\n padding: 1.4em 0 1em;\r\n text-align: left;\r\n }\r\n\r\n h2 {\r\n font-size: 250%;\r\n line-height: 1em;\r\n margin-bottom: 20px;\r\n padding: 1.4em 0 20px;\r\n text-align: left;\r\n\r\n & {\r\n border-bottom: 1px solid darken($primary-bg, 10%);\r\n color: darken($primary-bg, 10%);\r\n font-size: 22px;\r\n padding: 10px 0;\r\n }\r\n\r\n &.blockHeader {\r\n border-bottom: 1px solid white;\r\n color: white;\r\n font-size: 22px;\r\n margin-bottom: 20px;\r\n padding: 10px 0;\r\n }\r\n }\r\n\r\n h3 {\r\n font-size: 150%;\r\n line-height: 1.2em;\r\n padding: 1em 0 0.8em;\r\n }\r\n\r\n h4 {\r\n font-size: 130%;\r\n line-height: 1.2em;\r\n padding: 1em 0 0.8em;\r\n }\r\n\r\n p {\r\n padding: 0.8em 0;\r\n }\r\n\r\n ul {\r\n list-style: disc;\r\n }\r\n\r\n ol, ul {\r\n padding-left: 24px;\r\n li {\r\n padding-bottom: 4px;\r\n padding-left: 6px;\r\n }\r\n }\r\n\r\n strong {\r\n font-weight: bold;\r\n }\r\n\r\n .post {\r\n position: relative;\r\n\r\n &.basicPost {\r\n margin-top: 30px;\r\n }\r\n\r\n a {\r\n color: $primary-bg;\r\n\r\n &:hover,\r\n &:focus {\r\n color: #fff;\r\n }\r\n }\r\n\r\n h2 {\r\n border-bottom: 4px solid $primary-bg;\r\n font-size: 130%;\r\n }\r\n\r\n h3 {\r\n border-bottom: 1px solid $primary-bg;\r\n font-size: 110%;\r\n }\r\n\r\n ol {\r\n list-style: decimal outside none;\r\n }\r\n\r\n .post-header {\r\n padding: 1em 0;\r\n\r\n h1 {\r\n font-size: 150%;\r\n line-height: 1em;\r\n padding: 0.4em 0 0;\r\n\r\n a {\r\n border: none;\r\n }\r\n }\r\n\r\n .post-meta {\r\n color: $primary-bg;\r\n font-family: $header-font-family;\r\n text-align: center;\r\n }\r\n }\r\n\r\n .postSocialPlugins {\r\n padding-top: 1em;\r\n }\r\n\r\n .docPagination {\r\n background: $primary-bg;\r\n bottom: 0px;\r\n left: 0px;\r\n position: absolute;\r\n right: 0px;\r\n\r\n .pager {\r\n display: inline-block;\r\n width: 50%;\r\n }\r\n\r\n .pagingNext {\r\n float: right;\r\n text-align: right;\r\n }\r\n\r\n a {\r\n border: none;\r\n color: $primary-overlay;\r\n display: block;\r\n padding: 4px 12px;\r\n\r\n &:hover {\r\n background-color: $secondary-bg;\r\n color: $text;\r\n }\r\n\r\n .pagerLabel {\r\n display: inline;\r\n }\r\n\r\n .pagerTitle {\r\n display: none;\r\n }\r\n }\r\n }\r\n }\r\n\r\n .posts {\r\n .post {\r\n margin-bottom: 6vh;\r\n }\r\n }\r\n }\r\n}\r\n\r\n#integrations_title {\r\n font-size: 250%;\r\n margin: 80px 0;\r\n}\r\n\r\n.ytVideo {\r\n height: 0;\r\n overflow: hidden;\r\n padding-bottom: 53.4%; /* 16:9 */\r\n padding-top: 25px;\r\n position: relative;\r\n}\r\n\r\n.ytVideo iframe,\r\n.ytVideo object,\r\n.ytVideo embed {\r\n height: 100%;\r\n left: 0;\r\n position: absolute;\r\n top: 0;\r\n width: 100%;\r\n}\r\n\r\n@media only screen and (min-width: 480px) {\r\n h1#project_title {\r\n font-size: 500%;\r\n }\r\n\r\n h2#project_tagline {\r\n font-size: 250%;\r\n }\r\n\r\n .projectLogo {\r\n img {\r\n margin-bottom: 10px;\r\n height: 200px;\r\n }\r\n }\r\n\r\n .homeContainer .homeWrapper {\r\n padding-left: 10px;\r\n padding-right: 10px;\r\n }\r\n\r\n .mainContainer {\r\n .mainWrapper {\r\n .post {\r\n h2 {\r\n font-size: 180%;\r\n }\r\n\r\n h3 {\r\n font-size: 120%;\r\n }\r\n\r\n .docPagination {\r\n a {\r\n .pagerLabel {\r\n display: none;\r\n }\r\n .pagerTitle {\r\n display: inline;\r\n }\r\n }\r\n }\r\n }\r\n }\r\n }\r\n}\r\n\r\n@media only screen and (min-width: 900px) {\r\n .homeContainer {\r\n .homeWrapper {\r\n position: relative;\r\n\r\n #inner {\r\n box-sizing: border-box;\r\n max-width: 600px;\r\n padding-right: 40px;\r\n }\r\n\r\n .projectLogo {\r\n align-items: center;\r\n bottom: 0;\r\n display: flex;\r\n justify-content: flex-end;\r\n left: 0;\r\n padding: 2em 20px 4em;\r\n position: absolute;\r\n right: 20px;\r\n top: 0;\r\n\r\n img {\r\n height: 100%;\r\n max-height: 250px;\r\n }\r\n }\r\n }\r\n }\r\n}\r\n\r\n@media only screen and (min-width: 1024px) {\r\n .mainContainer {\r\n .mainWrapper {\r\n .post {\r\n box-sizing: border-box;\r\n display: block;\r\n\r\n .post-header {\r\n h1 {\r\n font-size: 250%;\r\n }\r\n }\r\n }\r\n\r\n .posts {\r\n .post {\r\n margin-bottom: 4vh;\r\n width: 100%;\r\n }\r\n }\r\n }\r\n }\r\n}\r\n\r\n@media only screen and (min-width: 1200px) {\r\n .homeContainer {\r\n .homeWrapper {\r\n #inner {\r\n max-width: 750px;\r\n }\r\n }\r\n }\r\n\r\n .wrapper {\r\n max-width: 1100px;\r\n }\r\n}\r\n\r\n@media only screen and (min-width: 1500px) {\r\n .homeContainer {\r\n .homeWrapper {\r\n #inner {\r\n max-width: 1100px;\r\n padding-bottom: 40px;\r\n padding-top: 40px;\r\n }\r\n }\r\n }\r\n\r\n .wrapper {\r\n max-width: 1400px;\r\n }\r\n}\r\n" }, { "path": "docs/_sass/_blog.scss", "content": ".blogContainer {\n .posts {\n margin-top: 60px;\n\n .post {\n border: 1px solid $primary-bg;\n border-radius: 3px;\n padding: 10px 20px 20px;\n }\n }\n\n .lonePost {\n margin-top: 60px;\n\n .post {\n padding: 10px 0px 0px;\n }\n }\n\n .post-header {\n h1 {\n text-align: center;\n }\n\n .post-authorName {\n color: rgba($text, 0.7);\n font-size: 14px;\n font-weight: 900;\n margin-top: 0;\n padding: 0;\n text-align: center;\n }\n\n .authorPhoto {\n border-radius: 50%;\n height: 50px;\n left: 50%;\n margin-left: -25px;\n overflow: hidden;\n position: absolute;\n top: -25px;\n width: 50px;\n }\n }\n}" }, { "path": "docs/_sass/_buttons.scss", "content": ".button {\n border: 1px solid $primary-bg;\n border-radius: 3px;\n color: $primary-bg;\n display: inline-block;\n font-size: 14px;\n font-weight: 900;\n line-height: 1.2em;\n padding: 10px;\n text-transform: uppercase;\n transition: background 0.3s, color 0.3s;\n\n &:hover {\n background: $primary-bg;\n color: $primary-overlay;\n }\n}\n\n.homeContainer {\n .button {\n border-color: $primary-overlay;\n border-width: 1px;\n color: $primary-overlay;\n\n &:hover {\n background: $primary-overlay;\n color: $primary-bg;\n }\n }\n}\n\n.blockButton {\n display: block;\n}\n\n.edit-page-link {\n float: right;\n font-size: 14px;\n font-weight: normal;\n line-height: 20px;\n opacity: 0.6;\n transition: opacity 0.5s;\n}\n\n.edit-page-link:hover {\n opacity: 1;\n}\n" }, { "path": "docs/_sass/_footer.scss", "content": ".footerContainer {\n background: $secondary-bg;\n color: $primary-bg;\n overflow: hidden;\n padding: 0 10px;\n text-align: left;\n\n .footerWrapper {\n border-top: 1px solid $primary-bg;\n padding: 0;\n\n .footerBlocks {\n align-items: center;\n align-content: center;\n display: flex;\n flex-flow: row wrap;\n margin: 0 -20px;\n padding: 10px 0;\n }\n\n .footerSection {\n box-sizing: border-box;\n flex: 1 1 25%;\n font-size: 14px;\n min-width: 275px;\n padding: 0px 20px;\n\n a {\n border: 0;\n color: inherit;\n display: inline-block;\n line-height: 1.2em;\n }\n\n .footerLink {\n padding-right: 20px;\n }\n }\n\n .fbOpenSourceFooter {\n align-items: center;\n display: flex;\n flex-flow: row nowrap;\n max-width: 25%;\n\n .facebookOSSLogoSvg {\n flex: 0 0 31px;\n height: 30px;\n margin-right: 10px;\n width: 31px;\n\n path {\n fill: $primary-bg;\n }\n\n .middleRing {\n opacity: 0.7;\n }\n\n .innerRing {\n opacity: 0.45;\n }\n }\n\n h2 {\n display: block;\n font-weight: 900;\n line-height: 1em;\n }\n }\n }\n}\n\n@media only screen and (min-width: 900px) {\n .footerSection {\n &.rightAlign {\n margin-left: auto;\n max-width: 25%;\n text-align: right;\n }\n }\n}" }, { "path": "docs/_sass/_gridBlock.scss", "content": ".gridBlock {\n margin: -5px 0;\n padding: 0;\n padding-bottom: 20px;\n\n .twoByGridBlock {\n padding: 5px 0;\n\n img {\n margin-top: 6vh;\n max-width: 100%;\n }\n\n &.featureBlock h3 {\n border-bottom: 1px solid rgba($primary-bg, 0.5);\n color: $primary-bg;\n font-size: 18px;\n margin: 0;\n padding: 10px 0;\n }\n }\n\n .gridClear {\n clear: both;\n }\n}\n\n@media only screen and (min-width: 1024px) {\n .gridBlock {\n display: flex;\n flex-direction: row;\n flex-wrap: wrap;\n margin: -10px -10px 10px -10px;\n\n .twoByGridBlock {\n box-sizing: border-box;\n flex: 1 0 50%;\n padding: 10px;\n }\n }\n\n h2 + .gridBlock {\n padding-top: 20px;\n }\n}\n\n@media only screen and (min-width: 1400px) {\n .gridBlock {\n display: flex;\n flex-direction: row;\n flex-wrap: wrap;\n margin: -10px -20px 10px -20px;\n\n .twoByGridBlock {\n box-sizing: border-box;\n flex: 1 0 50%;\n padding: 10px 20px;\n }\n }\n}\n\n.videoBlock {\n text-align: center;\n}\n" }, { "path": "docs/_sass/_header.scss", "content": ".fixedHeaderContainer {\n background: $primary-bg;\n color: $primary-overlay;\n height: $header-height;\n padding: $header-ptop 0 $header-pbot;\n position: fixed;\n width: 100%;\n z-index: 9999;\n\n a {\n align-items: center;\n border: 0;\n color: $primary-overlay;\n display: flex;\n flex-flow: row nowrap;\n height: $header-height;\n }\n\n header {\n display: flex;\n flex-flow: row nowrap;\n position: relative;\n text-align: left;\n\n img {\n height: 100%;\n margin-right: 10px;\n }\n\n h2 {\n display: block;\n font-family: $header-font-family;\n font-weight: 900;\n line-height: 18px;\n position: relative;\n }\n }\n}\n\n.navigationFull {\n height: 34px;\n margin-left: auto;\n\n nav {\n position: relative;\n\n ul {\n display: flex;\n flex-flow: row nowrap;\n margin: 0 -10px;\n\n li {\n padding: 0 10px;\n display: block;\n\n a {\n border: 0;\n color: $primary-overlay-special;\n font-size: 16px;\n font-weight: 400;\n line-height: 1.2em;\n\n &:hover {\n border-bottom: 2px solid $primary-overlay;\n color: $primary-overlay;\n }\n }\n\n &.navItemActive {\n a {\n color: $primary-overlay;\n }\n }\n }\n }\n }\n}\n\n/* 900px\n\n\n .fixedHeaderContainer {\n .navigationWrapper {\n nav {\n padding: 0 1em;\n position: relative;\n top: -9px;\n\n ul {\n margin: 0 -0.4em;\n li {\n display: inline-block;\n\n a {\n padding: 14px 0.4em;\n border: 0;\n color: $primary-overlay-special;\n display: inline-block;\n\n &:hover {\n color: $primary-overlay;\n }\n }\n\n &.navItemActive {\n a {\n color: $primary-overlay;\n }\n }\n }\n }\n }\n\n &.navigationFull {\n display: inline-block;\n }\n\n &.navigationSlider {\n display: none;\n }\n }\n }\n\n 1200px\n\n .fixedHeaderContainer {\n header {\n max-width: 1100px;\n }\n }\n\n 1500px\n .fixedHeaderContainer {\n header {\n max-width: 1400px;\n }\n }\n */" }, { "path": "docs/_sass/_poweredby.scss", "content": ".poweredByContainer {\n background: $primary-bg;\n color: $primary-overlay;\n margin-bottom: 20px;\n\n a {\n color: $primary-overlay;\n }\n\n .poweredByWrapper {\n h2 {\n border-color: $primary-overlay-special;\n color: $primary-overlay-special;\n }\n }\n\n .poweredByMessage {\n color: $primary-overlay-special;\n font-size: 14px;\n padding-top: 20px;\n }\n}\n\n.poweredByItems {\n display: flex;\n flex-flow: row wrap;\n margin: 0 -10px;\n}\n\n.poweredByItem {\n box-sizing: border-box;\n flex: 1 0 50%;\n line-height: 1.1em;\n padding: 5px 10px;\n\n &.itemLarge {\n flex-basis: 100%;\n padding: 10px;\n text-align: center;\n\n &:nth-child(4) {\n padding-bottom: 20px;\n }\n\n img {\n max-height: 30px;\n }\n }\n}\n\n@media only screen and (min-width: 480px) {\n .itemLarge {\n flex-basis: 50%;\n max-width: 50%;\n }\n}\n\n@media only screen and (min-width: 1024px) {\n .poweredByItem {\n flex-basis: 25%;\n max-width: 25%;\n\n &.itemLarge {\n padding-bottom: 20px;\n text-align: left;\n }\n }\n}\n\n" }, { "path": "docs/_sass/_promo.scss", "content": ".promoSection {\n display: flex;\n flex-flow: column wrap;\n font-size: 125%;\n line-height: 1.6em;\n margin: -10px 0;\n position: relative;\n z-index: 99;\n\n .promoRow {\n padding: 10px 0;\n\n .pluginWrapper {\n display: block;\n\n &.ghWatchWrapper, &.ghStarWrapper {\n height: 28px;\n }\n }\n\n .pluginRowBlock {\n display: flex;\n flex-flow: row wrap;\n margin: 0 -2px;\n\n .pluginWrapper {\n padding: 0 2px;\n }\n }\n }\n}" }, { "path": "docs/_sass/_react_docs_nav.scss", "content": ".docsNavContainer {\n background: $sidenav;\n height: 35px;\n left: 0;\n position: fixed;\n width: 100%;\n z-index: 100;\n}\n\n.docMainWrapper {\n .wrapper {\n &.mainWrapper {\n padding-left: 0;\n padding-right: 0;\n padding-top: 10px;\n }\n }\n}\n\n.docsSliderActive {\n .docsNavContainer {\n box-sizing: border-box;\n height: 100%;\n overflow-y: auto;\n -webkit-overflow-scrolling: touch;\n padding-bottom: 50px;\n }\n\n .mainContainer {\n display: none;\n }\n}\n\n.navBreadcrumb {\n box-sizing: border-box;\n display: flex;\n flex-flow: row nowrap;\n font-size: 12px;\n height: 35px;\n overflow: hidden;\n padding: 5px 10px;\n\n a, span {\n border: 0;\n color: $sidenav-text;\n }\n\n i {\n padding: 0 3px;\n }\n}\n\nnav.toc {\n position: relative;\n\n section {\n padding: 0px;\n position: relative;\n\n .navGroups {\n display: none;\n padding: 40px 10px 10px;\n }\n }\n\n .toggleNav {\n background: $sidenav;\n color: $sidenav-text;\n position: relative;\n transition: background-color 0.3s, color 0.3s;\n\n .navToggle {\n cursor: pointer;\n height: 24px;\n margin-right: 10px;\n position: relative;\n text-align: left;\n width: 18px;\n\n &::before, &::after {\n content: \"\";\n position: absolute;\n top: 50%;\n left: 0;\n left: 8px;\n width: 3px;\n height: 6px;\n border: 5px solid $sidenav-text;\n border-width: 5px 0;\n margin-top: -8px;\n transform: rotate(45deg);\n z-index: 1;\n }\n\n &::after {\n transform: rotate(-45deg);\n }\n\n i {\n &::before, &::after {\n content: \"\";\n position: absolute;\n top: 50%;\n left: 2px;\n background: transparent;\n border-width: 0 5px 5px;\n border-style: solid;\n border-color: transparent $sidenav-text;\n height: 0;\n margin-top: -7px;\n opacity: 1;\n width: 5px;\n z-index: 10;\n }\n\n &::after {\n border-width: 5px 5px 0;\n margin-top: 2px;\n }\n }\n\n &.navToggleActive {\n &::before, &::after {\n border-width: 6px 0;\n height: 0px;\n margin-top: -6px;\n }\n\n i {\n opacity: 0;\n }\n }\n }\n\n .navGroup {\n background: $sidenav-overlay;\n margin: 1px 0;\n\n ul {\n display: none;\n }\n\n h3 {\n background: $sidenav-overlay;\n color: $sidenav-text;\n cursor: pointer;\n font-size: 14px;\n font-weight: 400;\n line-height: 1.2em;\n padding: 10px;\n transition: color 0.2s;\n\n i:not(:empty) {\n width: 16px;\n height: 16px;\n display: inline-block;\n box-sizing: border-box;\n text-align: center;\n color: rgba($sidenav-text, 0.5);\n margin-right: 10px;\n transition: color 0.2s;\n }\n\n &:hover {\n color: $primary-bg;\n\n i:not(:empty) {\n color: $primary-bg;\n }\n }\n }\n\n &.navGroupActive {\n background: $sidenav-active;\n color: $sidenav-text;\n\n ul {\n display: block;\n padding-bottom: 10px;\n padding-top: 10px;\n }\n\n h3 {\n background: $primary-bg;\n color: $primary-overlay;\n }\n }\n }\n\n ul {\n padding-left: 0;\n padding-right: 24px;\n\n li {\n list-style-type: none;\n padding-bottom: 0;\n padding-left: 0;\n\n a {\n border: none;\n color: $sidenav-text;\n display: inline-block;\n font-size: 14px;\n line-height: 1.1em;\n margin: 2px 10px 5px;\n padding: 5px 0 2px;\n transition: color 0.3s;\n\n &:hover,\n &:focus {\n color: $primary-bg;\n }\n\n &.navItemActive {\n color: $primary-bg;\n font-weight: 900;\n }\n }\n }\n }\n }\n\n .toggleNavActive {\n .navBreadcrumb {\n background: $sidenav;\n margin-bottom: 20px;\n position: fixed;\n width: 100%;\n }\n\n section {\n .navGroups {\n display: block;\n }\n }\n }\n}\n\n.docsNavVisible {\n .navPusher {\n .mainContainer {\n padding-top: 35px;\n }\n }\n}\n\n@media only screen and (min-width: 900px) {\n .navBreadcrumb {\n padding: 5px 0;\n }\n\n nav.toc {\n section {\n .navGroups {\n padding: 40px 0 0;\n }\n }\n }\n}\n\n@media only screen and (min-width: 1024px) {\n .navToggle {\n display: none;\n }\n\n .docsSliderActive {\n .mainContainer {\n display: block;\n }\n }\n\n .docsNavVisible {\n .navPusher {\n .mainContainer {\n padding-top: 0;\n }\n }\n }\n\n .docsNavContainer {\n background: none;\n box-sizing: border-box;\n height: auto;\n margin: 40px 40px 0 0;\n overflow-y: auto;\n position: relative;\n width: 300px;\n }\n\n nav.toc {\n section {\n .navGroups {\n display: block;\n padding-top: 0px;\n }\n }\n\n .toggleNavActive {\n .navBreadcrumb {\n margin-bottom: 0;\n position: relative;\n }\n }\n }\n\n .docMainWrapper {\n display: flex;\n flex-flow: row nowrap;\n margin-bottom: 40px;\n\n .wrapper {\n padding-left: 0;\n padding-right: 0;\n\n &.mainWrapper {\n padding-top: 0;\n }\n }\n }\n\n .navBreadcrumb {\n display: none;\n h2 {\n padding: 0 10px;\n }\n }\n}" }, { "path": "docs/_sass/_react_header_nav.scss", "content": ".navigationFull {\n display: none;\n}\n\n.navigationSlider {\n position: absolute;\n right: 0px;\n\n .navSlideout {\n cursor: pointer;\n padding-top: 4px;\n position: absolute;\n right: 10px;\n top: 0;\n transition: top 0.3s;\n z-index: 101;\n }\n\n .slidingNav {\n background: $secondary-bg;\n box-sizing: border-box;\n height: 0px;\n padding: 0;\n position: absolute;\n right: 0px;\n top: 0;\n transition: height 0.3s cubic-bezier(0.68, -0.55, 0.265, 1.55), width 0.3s cubic-bezier(0.68, -0.55, 0.265, 1.55);\n width: 0;\n\n &.slidingNavActive {\n height: auto;\n padding-top: $header-height + $header-pbot;\n width: 300px;\n }\n\n ul {\n flex-flow: column nowrap;\n list-style: none;\n padding: 10px;\n\n li {\n margin: 0;\n padding: 2px 0;\n\n a {\n color: $primary-bg;\n display: inline;\n margin: 3px 5px;\n padding: 2px 0px;\n transition: background-color 0.3s;\n\n &:focus,\n &:hover {\n border-bottom: 2px solid $primary-bg;\n }\n }\n }\n }\n }\n}\n\n.menuExpand {\n display: flex;\n flex-flow: column nowrap;\n height: 20px;\n justify-content: space-between;\n\n span {\n background: $primary-overlay;\n border-radius: 3px;\n display: block;\n flex: 0 0 4px;\n height: 4px;\n position: relative;\n top: 0;\n transition: background-color 0.3s, top 0.3s, opacity 0.3s, transform 0.3s;\n width: 20px;\n }\n}\n\n.navSlideout.navSlideoutActive {\n top: -2px;\n .menuExpand {\n span:nth-child(1) {\n background-color: $text;\n top: 16px;\n transform: rotate(45deg);\n }\n span:nth-child(2) {\n opacity: 0;\n }\n span:nth-child(3) {\n background-color: $text;\n transform: rotate(-45deg);\n }\n }\n}\n\n.navPusher {\n border-top: $header-height + $header-ptop + $header-pbot solid $primary-bg;\n\tposition: relative;\n\tleft: 0;\n\tz-index: 99;\n\theight: 100%;\n\n &::after {\n position: absolute;\n top: 0;\n right: 0;\n width: 0;\n height: 0;\n background: rgba(0,0,0,0.4);\n content: '';\n opacity: 0;\n -webkit-transition: opacity 0.5s, width 0.1s 0.5s, height 0.1s 0.5s;\n transition: opacity 0.5s, width 0.1s 0.5s, height 0.1s 0.5s;\n }\n\n .sliderActive &::after {\n width: 100%;\n height: 100%;\n opacity: 1;\n -webkit-transition: opacity 0.5s;\n transition: opacity 0.5s;\n z-index: 100;\n }\n}\n\n\n@media only screen and (min-width: 1024px) {\n .navigationFull {\n display: block;\n }\n\n .navigationSlider {\n display: none;\n }\n}" }, { "path": "docs/_sass/_reset.scss", "content": "html, body, div, span, applet, object, iframe,\r\nh1, h2, h3, h4, h5, h6, p, blockquote, pre,\r\na, abbr, acronym, address, big, cite, code,\r\ndel, dfn, em, img, ins, kbd, q, s, samp,\r\nsmall, strike, strong, sub, sup, tt, var,\r\nb, u, i, center,\r\ndl, dt, dd, ol, ul, li,\r\nfieldset, form, label, legend,\r\ntable, caption, tbody, tfoot, thead, tr, th, td,\r\narticle, aside, canvas, details, embed, \r\nfigure, figcaption, footer, header, hgroup, \r\nmenu, nav, output, ruby, section, summary,\r\ntime, mark, audio, video {\r\n\tmargin: 0;\r\n\tpadding: 0;\r\n\tborder: 0;\r\n\tfont-size: 100%;\r\n\tfont: inherit;\r\n\tvertical-align: baseline;\r\n}\r\n/* HTML5 display-role reset for older browsers */\r\narticle, aside, details, figcaption, figure, \r\nfooter, header, hgroup, menu, nav, section {\r\n\tdisplay: block;\r\n}\r\nbody {\r\n\tline-height: 1;\r\n}\r\nol, ul {\r\n\tlist-style: none;\r\n}\r\nblockquote, q {\r\n\tquotes: none;\r\n}\r\nblockquote:before, blockquote:after,\r\nq:before, q:after {\r\n\tcontent: '';\r\n\tcontent: none;\r\n}\r\ntable {\r\n\tborder-collapse: collapse;\r\n\tborder-spacing: 0;\r\n}" }, { "path": "docs/_sass/_search.scss", "content": "input[type=\"search\"] {\r\n -moz-appearance: none;\r\n -webkit-appearance: none;\r\n}\r\n\r\n.navSearchWrapper {\r\n align-self: center;\r\n position: relative;\r\n\r\n &::before {\r\n border: 3px solid $primary-overlay-special;\r\n border-radius: 50%;\r\n content: \" \";\r\n display: block;\r\n height: 6px;\r\n left: 15px;\r\n width: 6px;\r\n position: absolute;\r\n top: 4px;\r\n z-index: 1;\r\n }\r\n\r\n &::after {\r\n background: $primary-overlay-special;\r\n content: \" \";\r\n height: 7px;\r\n left: 24px;\r\n position: absolute;\r\n transform: rotate(-45deg);\r\n top: 12px;\r\n width: 3px;\r\n z-index: 1;\r\n }\r\n\r\n .aa-dropdown-menu {\r\n background: $secondary-bg;\r\n border: 3px solid rgba($text, 0.25);\r\n color: $text;\r\n font-size: 14px;\r\n left: auto !important;\r\n line-height: 1.2em;\r\n right: 0 !important;\r\n\r\n .algolia-docsearch-suggestion--category-header {\r\n background: $primary-overlay-special;\r\n color: $primary-bg;\r\n\r\n .algolia-docsearch-suggestion--highlight {\r\n background-color: $primary-bg;\r\n color: $primary-overlay;\r\n }\r\n }\r\n\r\n .algolia-docsearch-suggestion--title .algolia-docsearch-suggestion--highlight,\r\n .algolia-docsearch-suggestion--subcategory-column .algolia-docsearch-suggestion--highlight {\r\n color: $primary-bg;\r\n }\r\n\r\n .algolia-docsearch-suggestion__secondary,\r\n .algolia-docsearch-suggestion--subcategory-column {\r\n border-color: rgba($text, 0.3);\r\n }\r\n }\r\n}\r\n\r\ninput#search_input {\r\n padding-left: 25px;\r\n font-size: 14px;\r\n line-height: 20px;\r\n border-radius: 20px;\r\n background-color: rgba($primary-overlay-special, 0.25);\r\n border: none;\r\n color: rgba($primary-overlay-special, 0);\r\n outline: none;\r\n position: relative;\r\n transition: background-color .2s cubic-bezier(0.68, -0.55, 0.265, 1.55), width .2s cubic-bezier(0.68, -0.55, 0.265, 1.55), color .2s ease;\r\n width: 60px;\r\n\r\n &:focus, &:active {\r\n background-color: $secondary-bg;\r\n color: $text;\r\n width: 240px;\r\n }\r\n}\r\n\r\n.reactNavSearchWrapper {\r\n &::before {\r\n left: 6px;\r\n top: 6px;\r\n }\r\n\r\n &::after {\r\n left: 15px;\r\n top: 14px;\r\n }\r\n\r\n input#search_input_react {\r\n box-sizing: border-box;\r\n padding-left: 25px;\r\n font-size: 14px;\r\n line-height: 20px;\r\n border-radius: 20px;\r\n background-color: rgba($primary-overlay-special, 0.25);\r\n border: none;\r\n color: $text;\r\n outline: none;\r\n position: relative;\r\n transition: background-color .2s cubic-bezier(0.68, -0.55, 0.265, 1.55), width .2s cubic-bezier(0.68, -0.55, 0.265, 1.55), color .2s ease;\r\n width: 100%;\r\n\r\n &:focus, &:active {\r\n background-color: $primary-bg;\r\n color: $primary-overlay;\r\n }\r\n }\r\n\r\n .algolia-docsearch-suggestion--subcategory-inline {\r\n display: none;\r\n }\r\n\r\n & > span {\r\n width: 100%;\r\n }\r\n\r\n .aa-dropdown-menu {\r\n background: $secondary-bg;\r\n border: 0px solid $secondary-bg;\r\n color: $text;\r\n font-size: 12px;\r\n line-height: 2em;\r\n max-height: 140px;\r\n min-width: auto;\r\n overflow-y: scroll;\r\n -webkit-overflow-scrolling: touch;\r\n padding: 0;\r\n border-radius: 0;\r\n position: relative !important;\r\n width: 100%;\r\n }\r\n}" }, { "path": "docs/_sass/_slideshow.scss", "content": ".slideshow {\r\n position: relative;\r\n \r\n .slide {\r\n display: none;\r\n \r\n img {\r\n display: block;\r\n margin: 0 auto;\r\n }\r\n \r\n &.slideActive {\r\n display: block;\r\n }\r\n \r\n a {\r\n border: none;\r\n display: block;\r\n }\r\n }\r\n\r\n .pagination {\r\n display: block;\r\n margin: -10px;\r\n padding: 1em 0;\r\n text-align: center;\r\n width: 100%;\r\n \r\n .pager {\r\n background: transparent;\r\n border: 2px solid rgba(255, 255, 255, 0.5);\r\n border-radius: 50%;\r\n cursor: pointer;\r\n display: inline-block;\r\n height: 12px;\r\n margin: 10px;\r\n transition: background-color 0.3s, border-color 0.3s;\r\n width: 12px;\r\n \r\n &.pagerActive {\r\n background: rgba(255, 255, 255, 0.5);\r\n border-width: 4px;\r\n height: 8px;\r\n width: 8px;\r\n }\r\n }\r\n }\r\n}" }, { "path": "docs/_sass/_syntax-highlighting.scss", "content": "\r\n\r\n.rougeHighlight { background-color: $code-bg; color: #93a1a1 }\r\n.rougeHighlight .c { color: #586e75 } /* Comment */\r\n.rougeHighlight .err { color: #93a1a1 } /* Error */\r\n.rougeHighlight .g { color: #93a1a1 } /* Generic */\r\n.rougeHighlight .k { color: #859900 } /* Keyword */\r\n.rougeHighlight .l { color: #93a1a1 } /* Literal */\r\n.rougeHighlight .n { color: #93a1a1 } /* Name */\r\n.rougeHighlight .o { color: #859900 } /* Operator */\r\n.rougeHighlight .x { color: #cb4b16 } /* Other */\r\n.rougeHighlight .p { color: #93a1a1 } /* Punctuation */\r\n.rougeHighlight .cm { color: #586e75 } /* Comment.Multiline */\r\n.rougeHighlight .cp { color: #859900 } /* Comment.Preproc */\r\n.rougeHighlight .c1 { color: #72c02c; } /* Comment.Single */\r\n.rougeHighlight .cs { color: #859900 } /* Comment.Special */\r\n.rougeHighlight .gd { color: #2aa198 } /* Generic.Deleted */\r\n.rougeHighlight .ge { color: #93a1a1; font-style: italic } /* Generic.Emph */\r\n.rougeHighlight .gr { color: #dc322f } /* Generic.Error */\r\n.rougeHighlight .gh { color: #cb4b16 } /* Generic.Heading */\r\n.rougeHighlight .gi { color: #859900 } /* Generic.Inserted */\r\n.rougeHighlight .go { color: #93a1a1 } /* Generic.Output */\r\n.rougeHighlight .gp { color: #93a1a1 } /* Generic.Prompt */\r\n.rougeHighlight .gs { color: #93a1a1; font-weight: bold } /* Generic.Strong */\r\n.rougeHighlight .gu { color: #cb4b16 } /* Generic.Subheading */\r\n.rougeHighlight .gt { color: #93a1a1 } /* Generic.Traceback */\r\n.rougeHighlight .kc { color: #cb4b16 } /* Keyword.Constant */\r\n.rougeHighlight .kd { color: #268bd2 } /* Keyword.Declaration */\r\n.rougeHighlight .kn { color: #859900 } /* Keyword.Namespace */\r\n.rougeHighlight .kp { color: #859900 } /* Keyword.Pseudo */\r\n.rougeHighlight .kr { color: #268bd2 } /* Keyword.Reserved */\r\n.rougeHighlight .kt { color: #dc322f } /* Keyword.Type */\r\n.rougeHighlight .ld { color: #93a1a1 } /* Literal.Date */\r\n.rougeHighlight .m { color: #2aa198 } /* Literal.Number */\r\n.rougeHighlight .s { color: #2aa198 } /* Literal.String */\r\n.rougeHighlight .na { color: #93a1a1 } /* Name.Attribute */\r\n.rougeHighlight .nb { color: #B58900 } /* Name.Builtin */\r\n.rougeHighlight .nc { color: #268bd2 } /* Name.Class */\r\n.rougeHighlight .no { color: #cb4b16 } /* Name.Constant */\r\n.rougeHighlight .nd { color: #268bd2 } /* Name.Decorator */\r\n.rougeHighlight .ni { color: #cb4b16 } /* Name.Entity */\r\n.rougeHighlight .ne { color: #cb4b16 } /* Name.Exception */\r\n.rougeHighlight .nf { color: #268bd2 } /* Name.Function */\r\n.rougeHighlight .nl { color: #93a1a1 } /* Name.Label */\r\n.rougeHighlight .nn { color: #93a1a1 } /* Name.Namespace */\r\n.rougeHighlight .nx { color: #93a1a1 } /* Name.Other */\r\n.rougeHighlight .py { color: #93a1a1 } /* Name.Property */\r\n.rougeHighlight .nt { color: #268bd2 } /* Name.Tag */\r\n.rougeHighlight .nv { color: #268bd2 } /* Name.Variable */\r\n.rougeHighlight .ow { color: #859900 } /* Operator.Word */\r\n.rougeHighlight .w { color: #93a1a1 } /* Text.Whitespace */\r\n.rougeHighlight .mf { color: #2aa198 } /* Literal.Number.Float */\r\n.rougeHighlight .mh { color: #2aa198 } /* Literal.Number.Hex */\r\n.rougeHighlight .mi { color: #2aa198 } /* Literal.Number.Integer */\r\n.rougeHighlight .mo { color: #2aa198 } /* Literal.Number.Oct */\r\n.rougeHighlight .sb { color: #586e75 } /* Literal.String.Backtick */\r\n.rougeHighlight .sc { color: #2aa198 } /* Literal.String.Char */\r\n.rougeHighlight .sd { color: #93a1a1 } /* Literal.String.Doc */\r\n.rougeHighlight .s2 { color: #2aa198 } /* Literal.String.Double */\r\n.rougeHighlight .se { color: #cb4b16 } /* Literal.String.Escape */\r\n.rougeHighlight .sh { color: #93a1a1 } /* Literal.String.Heredoc */\r\n.rougeHighlight .si { color: #2aa198 } /* Literal.String.Interpol */\r\n.rougeHighlight .sx { color: #2aa198 } /* Literal.String.Other */\r\n.rougeHighlight .sr { color: #dc322f } /* Literal.String.Regex */\r\n.rougeHighlight .s1 { color: #2aa198 } /* Literal.String.Single */\r\n.rougeHighlight .ss { color: #2aa198 } /* Literal.String.Symbol */\r\n.rougeHighlight .bp { color: #268bd2 } /* Name.Builtin.Pseudo */\r\n.rougeHighlight .vc { color: #268bd2 } /* Name.Variable.Class */\r\n.rougeHighlight .vg { color: #268bd2 } /* Name.Variable.Global */\r\n.rougeHighlight .vi { color: #268bd2 } /* Name.Variable.Instance */\r\n.rougeHighlight .il { color: #2aa198 } /* Literal.Number.Integer.Long */\r\n\r\n.highlighter-rouge {\r\n color: darken(#72c02c, 8%);\r\n font: 800 12px/1.5em Hack, monospace;\r\n max-width: 100%;\r\n\r\n .rougeHighlight {\r\n border-radius: 3px;\r\n margin: 20px 0;\r\n padding: 0px;\r\n overflow-x: scroll;\r\n -webkit-overflow-scrolling: touch;\r\n\r\n table {\r\n background: none;\r\n border: none;\r\n\r\n tbody {\r\n tr {\r\n background: none;\r\n display: flex;\r\n flex-flow: row nowrap;\r\n\r\n td {\r\n display: block;\r\n flex: 1 1;\r\n\r\n &.gutter {\r\n border-right: 1px solid lighten($code-bg, 10%);\r\n color: lighten($code-bg, 15%);\r\n margin-right: 10px;\r\n max-width: 40px;\r\n padding-right: 10px;\r\n\r\n pre {\r\n max-width: 20px;\r\n }\r\n }\r\n }\r\n }\r\n }\r\n }\r\n }\r\n}\r\n\r\np > .highlighter-rouge,\r\nli > .highlighter-rouge,\r\na > .highlighter-rouge {\r\n font-size: 16px;\r\n font-weight: 400;\r\n line-height: inherit;\r\n}\r\n\r\na:hover {\r\n .highlighter-rouge {\r\n color: white;\r\n }\r\n}" }, { "path": "docs/_sass/_tables.scss", "content": "table {\n background: $lightergrey;\n border: 1px solid $lightgrey;\n border-collapse: collapse;\n display:table;\n margin: 20px 0;\n\n thead {\n border-bottom: 1px solid $lightgrey;\n display: table-header-group;\n }\n tbody {\n display: table-row-group;\n }\n tr {\n display: table-row;\n &:nth-of-type(odd) {\n background: $greyish;\n }\n\n th, td {\n border-right: 1px dotted $lightgrey;\n display: table-cell;\n font-size: 14px;\n line-height: 1.3em;\n padding: 10px;\n text-align: left;\n\n &:last-of-type {\n border-right: 0;\n }\n\n code {\n color: $green;\n display: inline-block;\n font-size: 12px;\n }\n }\n\n th {\n color: #000000;\n font-weight: bold;\n font-family: $header-font-family;\n text-transform: uppercase;\n }\n }\n}" }, { "path": "docs/css/main.scss", "content": "---\r\n# Only the main Sass file needs front matter (the dashes are enough)\r\n---\r\n@charset \"utf-8\";\r\n\r\n@font-face {\r\n\tfont-family: 'Lato';\r\n\tsrc: url('{{ site.baseurl }}/static/fonts/LatoLatin-Italic.woff2') format('woff2'),\r\n\t\turl('{{ site.baseurl }}/static/fonts/LatoLatin-Italic.woff') format('woff');\r\n\tfont-weight: normal;\r\n\tfont-style: italic;\r\n}\r\n\r\n@font-face {\r\n\tfont-family: 'Lato';\r\n\tsrc: url('{{ site.baseurl }}/static/fonts/LatoLatin-Black.woff2') format('woff2'),\r\n\t\turl('{{ site.baseurl }}/static/fonts/LatoLatin-Black.woff') format('woff');\r\n\tfont-weight: 900;\r\n\tfont-style: normal;\r\n}\r\n\r\n@font-face {\r\n\tfont-family: 'Lato';\r\n\tsrc: url('{{ site.baseurl }}/static/fonts/LatoLatin-BlackItalic.woff2') format('woff2'),\r\n\t\turl('{{ site.baseurl }}/static/fonts/LatoLatin-BlackItalic.woff') format('woff');\r\n\tfont-weight: 900;\r\n\tfont-style: italic;\r\n}\r\n\r\n@font-face {\r\n\tfont-family: 'Lato';\r\n\tsrc: url('{{ site.baseurl }}/static/fonts/LatoLatin-Light.woff2') format('woff2'),\r\n\t\turl('{{ site.baseurl }}/static/fonts/LatoLatin-Light.woff') format('woff');\r\n\tfont-weight: 300;\r\n\tfont-style: normal;\r\n}\r\n\r\n@font-face {\r\n\tfont-family: 'Lato';\r\n\tsrc: url('{{ site.baseurl }}/static/fonts/LatoLatin-Regular.woff2') format('woff2'),\r\n\t\turl('{{ site.baseurl }}/static/fonts/LatoLatin-Regular.woff') format('woff');\r\n\tfont-weight: normal;\r\n\tfont-style: normal;\r\n}\r\n\r\n// Our variables\r\n$base-font-family: 'Lato', Calibri, Arial, sans-serif;\r\n$header-font-family: 'Lato', 'Helvetica Neue', Arial, sans-serif;\r\n$base-font-size: 18px;\r\n$small-font-size: $base-font-size * 0.875;\r\n$base-line-height: 1.4em;\r\n\r\n$spacing-unit: 12px;\r\n\r\n// Two configured colors (see _config.yml)\r\n$primary-bg: \t\t\t\t{{ site.color.primary }};\r\n$secondary-bg: \t\t\t\t{{ site.color.secondary }};\r\n\r\n// $primary-bg overlays\r\n{% if site.color.primary-overlay == 'light' %}\r\n$primary-overlay: \t\tdarken($primary-bg, 70%);\r\n$primary-overlay-special:\t\tdarken($primary-bg, 40%);\r\n{% else %}\r\n$primary-overlay: \t\t \t#fff;\r\n$primary-overlay-special:\t\tlighten($primary-bg, 30%);\r\n{% endif %}\r\n\r\n// $secondary-bg overlays\r\n{% if site.color.secondary-overlay == 'light' %}\r\n$text: #393939;\r\n$sidenav: \t\t\t\t darken($secondary-bg, 20%);\r\n$sidenav-text: \t\t\t$text;\r\n$sidenav-overlay: \tdarken($sidenav, 10%);\r\n$sidenav-active: \t\tlighten($sidenav, 10%);\r\n{% else %}\r\n$text: #fff;\r\n$sidenav: \t\t\t\t lighten($secondary-bg, 20%);\r\n$sidenav-text: \t\t\t$text;\r\n$sidenav-overlay: \tlighten($sidenav, 10%);\r\n$sidenav-active: \t\tdarken($sidenav, 10%);\r\n{% endif %}\r\n\r\n$code-bg: \t\t\t\t\t#002b36;\r\n\r\n$header-height: 34px;\r\n$header-ptop: 10px;\r\n$header-pbot: 8px;\r\n\r\n// Width of the content area\r\n$content-width: 900px;\r\n\r\n// Table setting variables\r\n$lightergrey: #F8F8F8;\r\n$greyish: #E8E8E8;\r\n$lightgrey: #B0B0B0;\r\n$green: #2db04b;\r\n\r\n// Using media queries with like this:\r\n// @include media-query($on-palm) {\r\n// .wrapper {\r\n// padding-right: $spacing-unit / 2;\r\n// padding-left: $spacing-unit / 2;\r\n// }\r\n// }\r\n@mixin media-query($device) {\r\n @media screen and (max-width: $device) {\r\n @content;\r\n }\r\n}\r\n\r\n\r\n\r\n// Import partials from `sass_dir` (defaults to `_sass`)\r\n@import\r\n \"reset\",\r\n \"base\",\r\n\t\t\t\t\"header\",\r\n \"search\",\r\n \"syntax-highlighting\",\r\n\t\t\t\t\"promo\",\r\n\t\t\t\t\"buttons\",\r\n\t\t\t\t\"gridBlock\",\r\n\t\t\t\t\"poweredby\",\r\n\t\t\t\t\"footer\",\r\n\t\t\t\t\"react_header_nav\",\r\n\t\t\t\t\"react_docs_nav\",\r\n\t\t\t\t\"tables\",\r\n\t\t\t\t\"blog\"\r\n;\r\n\r\n// Anchor links\r\n// http://ben.balter.com/2014/03/13/pages-anchor-links/\r\n.header-link {\r\n position: absolute;\r\n margin-left: 0.2em;\r\n opacity: 0;\r\n\r\n -webkit-transition: opacity 0.2s ease-in-out 0.1s;\r\n -moz-transition: opacity 0.2s ease-in-out 0.1s;\r\n -ms-transition: opacity 0.2s ease-in-out 0.1s;\r\n}\r\n\r\nh2:hover .header-link,\r\nh3:hover .header-link,\r\nh4:hover .header-link,\r\nh5:hover .header-link,\r\nh6:hover .header-link {\r\n opacity: 1;\r\n}\r\n" }, { "path": "docs/docs/index.html", "content": "---\r\nid: docs\r\ntitle: Docs\r\nlayout: redirect\r\ndestination: /docs/getting-started.html\r\n---\r\n" }, { "path": "docs/index.md", "content": "---\nlayout: home\ntitle: Fresco | An image management library.\nid: home\n---\n## Watch Introductory Video\n\n
    \n \n
    \n\n
    \n
    \n### Image Pipeline\n\nFresco's image pipeline will load images from the network, local storage, or local resources. To save data and CPU, it has three levels of cache; two in memory and another in internal storage.\n
    \n
    \n### Drawees\n\nFresco's `Drawee` shows a placeholder for you until the image has loaded and then automatically shows the image when it arrives. When the image goes off-screen, it automatically releases its memory.\n
    \n
    \n\n## Features\n\n
    \n
    \n### Memory\n\nA decompressed image - an Android `Bitmap` - takes up a lot of memory. This leads to more frequent runs of the Java garbage collector. This slows apps down. The problem is especially bad without the improvements to the garbage collector made in Android 5.0.\n\nOn Android 4.x and lower, Fresco puts images in a special region of Android memory. It also makes sure that images are automatically released from memory when they're no longer shown on screen. This lets your application run faster - and suffer fewer crashes.\n\nApps using Fresco can run even on low-end devices without having to constantly struggle to keep their image memory footprint under control.\n\n
    \n
    \n### Loading\n\nFresco's image pipeline lets you customize the load in a variety of ways:\n\n* Specify several different uris for an image, and choose the one already in cache for display\n* Show a low-resolution image first and swap to a higher-res one when it arrives\n* Send events back into your app when the image arrives\n* If the image has an EXIF thumbnail, show it first until the full image loads (local images only)\n* Resize or rotate the image\n* Modify the downloaded image in-place\n* Decode WebP images, even on older versions of Android that don't fully support them\n\n
    \n
    \n### Drawing\n\nFresco uses `Drawees` for display. These offer a number of useful features:\n\n* Scale the image to a custom focus point, instead of the center\n* Show the image with rounded corners, or a circle\n* Let users tap the placeholder to retry load of the image, if the network load failed\n* Show custom backgrounds, overlays, or progress bars on the image\n* Show a custom overlay when the user presses the image\n\n
    \n
    \n### Streaming\n\nProgressive JPEG images have been on the Web for years. These let a low-resolution scan of the image download first, then gradually improve the quality as more of the image downloads. This is a lifesaver for users on slow networks.\n\nAndroid's own imaging libraries don't support streaming. Fresco does. Just specify a URI, and your app will automatically update its display as more data arrives.\n\n
    \n
    \n### Animations\n\nAnimated GIFs and WebPs can be challenging for apps. Each frame is a large Bitmap, and each animation is a series of frames. Fresco takes care of loading and disposing of frames and managing their memory.\n
    \n
    \n" }, { "path": "docs/javadoc/assets/customizations.css", "content": "#header {\n border-bottom: 3px solid #0767a4;\n}\n\n#search_filtered .jd-selected {\n background-color: #0767a4;\n}\n" }, { "path": "docs/javadoc/assets/customizations.js", "content": "" }, { "path": "docs/javadoc/assets/doclava-developer-core.css", "content": "/* file: doclava-developer-core.css\n info: core developer styles\n*/\n\n/* RESET STYLES */\n\nhtml,body,div,h1,h2,h3,h4,h5,h6,p,img,\ndl,dt,dd,ol,ul,li,table,caption,tbody,\ntfoot,thead,tr,th,td,form,fieldset,\nembed,object,applet {\n margin: 0;\n padding: 0;\n border: 0;\n}\n\n/* BASICS */\n\nhtml, body {\n overflow:hidden; /* keeps scrollbar off IE */\n background-color:#fff;\n}\n\nbody {\n font-family:arial,sans-serif;\n color:#000;\n font-size:13px;\n color:#333;\n background-image:url(images/bg_fade.jpg);\n background-repeat:repeat-x;\n}\n\na, a code {\n color:#006699;\n}\n\na:active,\na:active code {\n color:#f00;\n}\n\na:visited,\na:visited code {\n color:#006699;\n}\n\ninput, select,\ntextarea, option, label {\n font-family:inherit;\n font-size:inherit;\n padding:0;\n margin:0;\n vertical-align:middle;\n}\n\noption {\n padding:0 4px;\n}\n\np {\n padding:0;\n margin:0 0 1em;\n}\n\ncode, pre {\n color:#007000;\n font-family:monospace;\n line-height:1em;\n}\n\nvar {\n color:#007000;\n font-style:italic;\n}\n\npre {\n border:1px solid #ccc;\n background-color:#fafafa;\n padding:10px;\n margin:0 0 1em 1em;\n overflow:auto;\n line-height:inherit; /* fixes vertical scrolling in webkit */\n}\n\nh1,h2,h3,h4,h5 {\n margin:1em 0;\n padding:0;\n}\n\np,ul,ol,dl,dd,dt,li {\n line-height:1.3em;\n}\n\nul,ol {\n margin:0 0 .8em;\n padding:0 0 0 2em;\n}\n\nli {\n padding:0 0 .5em;\n}\n\ndl {\n margin:0 0 1em 0;\n padding:0;\n}\n\ndt {\n margin:0;\n padding:0;\n}\n\ndd {\n margin:0 0 1em;\n padding:0 0 0 2em;\n}\n\nli p {\n margin:.5em 0 0;\n}\n\ndd p {\n margin:1em 0 0;\n}\n\nli pre, li table, li img {\n margin:.5em 0 0 1em;\n}\n\ndd pre,\n#jd-content dd table,\n#jd-content dd img {\n margin:1em 0 0 1em;\n}\n\nli ul,\nli ol,\ndd ul,\ndd ol {\n margin:0;\n padding: 0 0 0 2em;\n}\n\nli li,\ndd li {\n margin:0;\n padding:.5em 0 0;\n}\n\ndl dl,\nol dl,\nul dl {\n margin:0 0 1em;\n padding:0;\n}\n\ntable {\n font-size:1em;\n margin:0 0 1em;\n padding:0;\n border-collapse:collapse;\n border-width:0;\n empty-cells:show;\n}\n\ntd,th {\n border:1px solid #ccc;\n padding:6px 12px;\n text-align:left;\n vertical-align:top;\n background-color:inherit;\n}\n\nth {\n background-color:#dee8f1;\n}\n\ntd > p:last-child {\n margin:0;\n}\n\nhr.blue {\n background-color:#DDF0F2;\n border:none;\n height:5px;\n margin:20px 0 10px;\n}\n\nblockquote {\n margin: 0 0 1em 1em;\n padding: 0 4em 0 1em;\n border-left:2px solid #eee;\n}\n/* LAYOUT */\n\n#body-content {\n /* \"Preliminary\" watermark for draft documentation.\n background:transparent url(images/preliminary.png) repeat scroll 0 0; */\n margin:0;\n position:relative;\n width:100%;\n}\n\n#header {\n height: 44px;\n position:relative;\n z-index:100;\n min-width:675px; /* min width for the tabs, before they wrap */\n padding:0 10px;\n border-bottom:3px solid #94b922;\n}\n\n#headerLeft{\n position:absolute;\n padding: 10px 0 0;\n left:8px;\n bottom:3px;\n}\n\n#headerRight {\n position:absolute;\n right:0;\n bottom:3px;\n padding:0;\n text-align:right;\n}\n\n#masthead-title {\n font-size:28px;\n color: #2f74ae;\n}\n\n/* Tabs in the header */\n\n#header ul {\n list-style: none;\n margin: 7px 0 0;\n padding: 0;\n height: 29px;\n}\n\n#header li {\n float: left;\n margin: 0px 2px 0px 0px;\n padding:0;\n}\n\n#header li a {\n text-decoration: none;\n display: block;\n background-image: url(images/bg_images_sprite.png);\n background-position: 0 -58px;\n background-repeat: no-repeat;\n color: #666;\n font-size: 13px;\n font-weight: bold;\n width: 94px;\n height: 29px;\n text-align: center;\n margin: 0px;\n}\n\n#header li a:hover {\n background-image: url(images/bg_images_sprite.png);\n background-position: 0 -29px;\n background-repeat: no-repeat;\n}\n\n#header li a span {\n position:relative;\n top:7px;\n}\n\n#header li a span+span {\n display:none;\n}\n\n/* tab highlighting */\n\n.home #home-link a,\n.guide #guide-link a,\n.reference #reference-link a,\n.sdk #sdk-link a,\n.resources #resources-link a,\n.videos #videos-link a {\n background-image: url(images/bg_images_sprite.png);\n background-position: 0 0;\n background-repeat: no-repeat;\n color: #fff;\n font-weight: bold;\n cursor:default;\n}\n\n.home #home-link a:hover,\n.guide #guide-link a:hover,\n.reference #reference-link a:hover,\n.sdk #sdk-link a:hover,\n.resources #resources-link a:hover,\n.videos #videos-link a:hover {\n background-image: url(images/bg_images_sprite.png);\n background-position: 0 0;\n}\n\n#headerLinks {\n margin:10px 10px 0 0;\n height:13px;\n font-size: 11px;\n vertical-align: top;\n}\n\n#headerLinks a {\n color: #7FA9B5;\n}\n\n#headerLinks img {\n vertical-align:middle;\n}\n\n#language {\n margin:0 10px 0 4px;\n}\n\n#search {\n margin:8px 10px 0 0;\n}\n\n/* MAIN BODY */\n\n#mainBodyFluid {\n margin: 20px 10px;\n color:#333;\n}\n\n#mainBodyFixed {\n margin: 20px 10px;\n color: #333;\n width:930px;\n position:relative;\n}\n\n#mainBodyFixed h3,\n#mainBodyFluid h3 {\n color:#336666;\n font-size:1.25em;\n margin: 0em 0em 0em 0em;\n padding-bottom:.5em;\n}\n\n#mainBodyFixed h2,\n#mainBodyFluid h2 {\n color:#336666;\n font-size:1.25em;\n margin: 0;\n padding-bottom:.5em;\n}\n\n#mainBodyFixed h1,\n#mainBodyFluid h1 {\n color:#435A6E;\n font-size:1.7em;\n margin: 1em 0;\n}\n\n#mainBodyFixed .green,\n#mainBodyFluid .green,\n#jd-content .green {\n color:#7BB026;\n background-color:none;\n}\n\n#mainBodyLeft {\n float: left;\n width: 600px;\n margin-right: 20px;\n color: #333;\n position:relative;\n}\n\ndiv.indent {\n margin-left: 40px;\n margin-right: 70px;\n}\n\n#mainBodyLeft p {\n color: #333;\n font-size: 13px;\n}\n\n#mainBodyLeft p.blue {\n color: #669999;\n}\n\n#mainBodyLeft #communityDiv {\n float: left;\n background-image:url(images/bg_community_leftDiv.jpg);\n background-repeat: no-repeat;\n width: 581px;\n height: 347px;\n padding: 20px 0px 0px 20px;\n}\n\n#mainBodyRight {\n float: left;\n width: 300px;\n color: #333;\n}\n\n#mainBodyRight p {\n padding-right: 50px;\n color: #333;\n}\n\n#mainBodyRight table {\n width: 100%;\n}\n\n#mainBodyRight td {\n border:0px solid #666;\n padding:0px 5px;\n text-align:left;\n}\n\n#mainBodyRight td p {\n margin:0 0 1em 0;\n}\n\n#mainBodyRight .blueBorderBox {\n border:5px solid #ddf0f2;\n padding:18px 18px 18px 18px;\n text-align:left;\n}\n\n#mainBodyFixed .separator {\n background-image:url(images/hr_gray_side.jpg);\n background-repeat:no-repeat;\n width: 100%;\n float: left;\n clear: both;\n}\n\n#mainBodyBottom {\n float: left;\n width: 100%;\n clear:both;\n color: #333;\n}\n\n#mainBodyBottom .separator {\n background-image:url(images/hr_gray_main.jpg);\n background-repeat:no-repeat;\n width: 100%;\n float: left;\n clear: both;\n}\n\n/* FOOTER */\n\n#footer {\n float: left;\n width:90%;\n margin: 20px;\n color: #aaa;\n font-size: 11px;\n}\n\n#footer a {\n color: #aaa;\n font-size: 11px;\n}\n\n#footer a:hover {\n text-decoration: underline;\n color:#aaa;\n}\n\n#footerlinks {\n margin-top:2px;\n}\n\n#footerlinks a,\n#footerlinks a:visited {\n color:#006699;\n}\n\n/* SEARCH FILTER */\n\n#search_autocomplete {\n color:#aaa;\n}\n\n#search-button {\n display:inline;\n}\n\n#search_filtered_div {\n position:absolute;\n margin-top:-1px;\n z-index:101;\n border:1px solid #BCCDF0;\n background-color:#fff;\n}\n\n#search_filtered {\n min-width:100%;\n}\n#search_filtered td{\n background-color:#fff;\n border-bottom: 1px solid #669999;\n line-height:1.5em;\n}\n\n#search_filtered .jd-selected {\n background-color: #94b922;\n cursor:pointer;\n}\n#search_filtered .jd-selected,\n#search_filtered .jd-selected a {\n color:#fff;\n}\n\n.no-display {\n display: none;\n}\n\n.jd-autocomplete {\n font-family: Arial, sans-serif;\n padding-left: 6px;\n padding-right: 6px;\n padding-top: 1px;\n padding-bottom: 1px;\n font-size: 0.81em;\n border: none;\n margin: 0;\n line-height: 1.05em;\n}\n\n.show-row {\n display: table-row;\n}\n.hide-row {\n display: hidden;\n}\n\n/* SEARCH */\n\n/* restrict global search form width */\n#searchForm {\n width:350px;\n}\n\n#searchTxt {\n width:200px;\n}\n\n/* disable twiddle and size selectors for left column */\n#leftSearchControl div {\n width: 100%;\n}\n\n#leftSearchControl .gsc-twiddle {\n background-image : none;\n}\n\n#leftSearchControl td, #searchForm td {\n border: 0px solid #000;\n}\n\n#leftSearchControl .gsc-resultsHeader .gsc-title {\n padding-left : 0px;\n font-weight : bold;\n font-size : 13px;\n color:#006699;\n display : none;\n}\n\n#leftSearchControl .gsc-resultsHeader div.gsc-results-selector {\n display : none;\n}\n\n#leftSearchControl .gsc-resultsRoot {\n padding-top : 6px;\n}\n\n#leftSearchControl div.gs-visibleUrl-long {\n display : block;\n color:#006699;\n}\n\n.gsc-webResult div.gs-visibleUrl-short,\ntable.gsc-branding,\n.gsc-clear-button {\n display : none;\n}\n\n.gsc-cursor-box .gsc-cursor div.gsc-cursor-page,\n.gsc-cursor-box .gsc-trailing-more-results a.gsc-trailing-more-results,\n#leftSearchControl a,\n#leftSearchControl a b {\n color:#006699;\n}\n\n.gsc-resultsHeader {\n display: none;\n}\n\n/* Disable built in search forms */\n.gsc-control form.gsc-search-box {\n display : none;\n}\ntable.gsc-search-box {\n margin:6px 0 0 0;\n border-collapse:collapse;\n}\n\ntd.gsc-input {\n padding:0 2px;\n width:100%;\n vertical-align:middle;\n}\n\ninput.gsc-input {\n border:1px solid #BCCDF0;\n width:99%;\n padding-left:2px;\n font-size:.95em;\n}\n\ntd.gsc-search-button {\n text-align: right;\n padding:0;\n vertical-align:top;\n}\n\n#search-button {\n margin:0 0 0 2px;\n font-size:11px;\n}\n\n/* search result tabs */\n\n#doc-content .gsc-control {\n position:relative;\n}\n\n#doc-content .gsc-tabsArea {\n position:relative;\n white-space:nowrap;\n}\n\n#doc-content .gsc-tabHeader {\n padding: 3px 6px;\n position:relative;\n}\n\n#doc-content .gsc-tabHeader.gsc-tabhActive {\n border-top: 2px solid #94B922;\n}\n\n#doc-content h2#searchTitle {\n padding:0;\n}\n\n#doc-content .gsc-resultsbox-visible {\n padding:1em 0 0 6px;\n}\n\n/* Pretty printing styles. Used with prettify.js. */\n\n.str { color: #080; }\n.kwd { color: #008; }\n.com { color: #800; }\n.typ { color: #606; }\n.lit { color: #066; }\n.pun { color: #660; }\n.pln { color: #000; }\ndl.tag-list dt code,\n.tag { color: #008; }\ndl.atn-list dt code,\n.atn { color: #828; }\n.atv { color: #080; }\n.dec { color: #606; }\n\n@media print {\n .str { color: #060; }\n .kwd { color: #006; font-weight: bold; }\n .com { color: #600; font-style: italic; }\n .typ { color: #404; font-weight: bold; }\n .lit { color: #044; }\n .pun { color: #440; }\n .pln { color: #000; }\n .tag { color: #006; font-weight: bold; }\n .atn { color: #404; }\n .atv { color: #060; }\n}\n" }, { "path": "docs/javadoc/assets/doclava-developer-docs.css", "content": "/* file: doclava-developer-docs.css\n info: developer doc styles\n*/\n\n@import url(\"doclava-developer-core.css\");\n\n#title {\n border-bottom: 4px solid #ccc;\n display:none;\n}\n\n#title h1 {\n color:#336666;\n margin:0;\n padding: 5px 10px;\n font-size: 1em;\n line-height: 15px;\n}\n\n#title h1 .small{\n color:#000;\n margin:0;\n font-size: 13px;\n padding:0 0 0 15px;\n}\n\n/* SIDE NAVIGATION */\n\n#side-nav {\n padding:0 6px 0 0;\n background-color: #fff;\n font-size:12px;\n}\n\n#side-nav.not-resizable {\n background:url('images/sidenav-rule.png') no-repeat 243px 0;\n}\n\n#resize-packages-nav {\n/* keeps the resize handle below the h-scroll handle */\n height:270px;\n overflow:hidden;\n max-height:100%;\n}\n\n#packages-nav {\n height:270px;\n max-height:inherit;\n position:relative;\n overflow:auto;\n}\n\n#classes-nav,\n#devdoc-nav {\n overflow:auto;\n position:relative;\n}\n\n#side-nav ul {\n list-style: none;\n margin: 0;\n padding:5px 0;\n}\n\n#side-nav ul ul {\n margin: .35em 0 0 0;\n padding: 0;\n}\n\n#side-nav li {\n padding:0;\n line-height:16px;\n white-space:nowrap;\n zoom:1;\n}\n\n#side-nav li h2 {\n font-size:12px;\n font-weight: bold;\n margin:.5em 0 0 0;\n padding: 3px 0 1px 9px;\n}\n\n#side-nav li a {\n text-decoration:none;\n padding: 0 0 0 18px;\n zoom:1;\n}\n\n#side-nav li a span+span {\n display:none;\n}\n\n#side-nav li a:hover {\n text-decoration:underline;\n}\n\n#side-nav li a+a {\n padding: 0;\n}\n/*second level (nested) list*/\n#side-nav li li li a {\n padding: 0 0 0 28px;\n}\n/*third level (nested) list*/\n#side-nav li li li li a {\n padding: 0 0 0 38px;\n}\n\n#side-nav .selected {\n background-color: #435a6e;\n color: #fff;\n font-weight:bold;\n}\n\n#side-nav .selected a {\n color: #fff;\n text-decoration:none;\n}\n\n#side-nav strong {\n display:block;\n}\n\n#side-nav .toggle-list .toggle-img {\n margin:0;\n padding:0;\n position:absolute;\n top:0;\n left:0;\n height:16px;\n width:15px;\n outline-style:none;\n}\n/* second-level toggle */\n#side-nav .toggle-list .toggle-list .toggle-img {\n left:10px;\n}\n\n#side-nav .closed .toggle-img,\n#side-nav .open .closed .toggle-img {\n background:url('images/triangle-closed-small.png') 7px 4px no-repeat;\n}\n#side-nav .open .toggle-img {\n background:url('images/triangle-opened-small.png') 7px 4px no-repeat;\n}\n\n#side-nav .toggle-list {\n position:relative;\n}\n\n#side-nav .toggle-list ul {\n margin:0;\n display:none;\n}\n\n#side-nav .toggle-list div {\n display:block;\n}\n\n#index-links .selected {\n background-color: #fff;\n color: #000;\n font-weight:normal;\n text-decoration:none;\n}\n\n#index-links {\n padding:7px 0 4px 10px;\n}\n\n/* nav tree */\n\n#nav-tree ul {\n padding:5px 0 1.5em;\n}\n\n#side-nav #nav-tree ul li a,\n#side-nav #nav-tree ul li span.no-children {\n padding: 0 0 0 0;\n margin: 0;\n}\n\n#nav-tree .plus {\n margin: 0 3px 0 0;\n}\n\n#nav-tree ul ul {\n list-style: none;\n margin: 0;\n padding: 0 0 0 0;\n}\n\n#nav-tree ul li {\n margin: 0;\n padding: 0 0 0 0;\n white-space: nowrap;\n}\n\n#nav-tree .children_ul {\n margin:0;\n}\n\n#nav-tree a.nolink {\n color: black;\n text-decoration: none;\n}\n\n#nav-tree span.label {\n width: 100%;\n}\n\n#nav-tree {\n overflow-x: auto;\n overflow-y: scroll;\n}\n\n#nav-swap {\n font-size:10px;\n line-height:10px;\n margin-left:1em;\n text-decoration:none;\n display:block;\n position:absolute;\n bottom:2px;\n left:0px;\n}\n\n#tree-link {\n\n}\n\n/* DOCUMENT BODY */\n\n#doc-content {\n overflow:auto;\n}\n\n#jd-header {\n background-color: #E2E2E2;\n padding: 7px 15px;\n}\n\n#jd-header h1 {\n margin: 0 0 10px;\n font-size:1.7em;\n}\n\n#jd-header .crumb {\n font-size:.9em;\n line-height:1em;\n color:#777;\n}\n\n#jd-header .crumb a,\n#jd-header .crumb a:visited {\n text-decoration:none;\n color:#777;\n}\n\n#jd-header .crumb a:hover {\n text-decoration:underline;\n}\n\n#jd-header table {\n margin:0;\n padding:0;\n}\n\n#jd-header td {\n border:none;\n padding:0;\n vertical-align:top;\n}\n\n#jd-header.guide-header {\n background-color:#fff;\n color:#435a6e;\n height:50px;\n}\n\n#jd-descr {\n position:relative;\n}\n\n/* summary tables for reference pages */\n.jd-sumtable {\n margin: .5em 1em 1em 1em;\n width:95%; /* consistent table widths; within IE's quirks */\n font-size:.9em;\n}\n\n.jd-sumtable a {\n text-decoration:none;\n}\n\n.jd-sumtable a:hover {\n text-decoration:underline;\n}\n\n/* the link inside a sumtable for \"Show All/Hide All\" */\n.toggle-all {\n display:block;\n float:right;\n font-weight:normal;\n font-size:0.9em;\n}\n\n/* adjustments for in/direct subclasses tables */\n.jd-sumtable-subclasses {\n margin: 1em 0 0 0;\n max-width:968px;\n}\n\n/* extra space between end of method name and open-paren */\n.sympad {\n margin-right: 2px;\n}\n\n/* right alignment for the return type in sumtable */\n.jd-sumtable .jd-typecol {\n text-align:right;\n white-space: nowrap;\n}\n\n/* adjustments for the expando table-in-table */\n.jd-sumtable-expando {\n margin:.5em 0;\n padding:0;\n}\n\n/* a div that holds a short description */\n.jd-descrdiv {\n padding:3px 1em 0 1em;\n margin:0;\n border:0;\n}\n\n/* page-top-right container for reference pages (holds\nlinks to summary tables) */\n#api-info-block {\n font-size:.8em;\n padding:6px 10px;\n font-weight:normal;\n float:right;\n text-align:right;\n color:#999;\n max-width:70%;\n}\n\n#api-level-toggle {\n padding:0 0px;\n font-size:11px;\n margin:3px 10px 0 0;\n}\n\n#api-level-toggle label.disabled {\n color:#999;\n}\n\ndiv.api-level {\n font-size:.8em;\n font-weight:normal;\n color:#999;\n float:right;\n padding:0 7px 0;\n margin-top:-25px;\n}\n\n#api-info-block div.api-level {\n font-size:1.3em;\n font-weight:bold;\n float:none;\n color:#444;\n padding:0;\n margin:0;\n}\n\n/* Force link colors for IE6 */\ndiv.api-level a {\n color:#999;\n}\n#api-info-block div.api-level a:link {\n color:#444;\n}\n#api-level-toggle a {\n color:#999;\n}\n\ndiv#naMessage {\n display:none;\n width:555px;\n height:0;\n margin:0 auto;\n}\n\ndiv#naMessage div {\n width:450px;\n position:fixed;\n margin:50px 0;\n padding:4em 4em 3em;\n background:#FFF;\n background:rgba(255,255,255,0.7);\n border:1px solid #dddd00;\n}\n/* IE6 can't position fixed */\n* html div#naMessage div { position:absolute; }\n\ndiv#naMessage strong {\n font-size:1.1em;\n}\n\n.absent,\n.absent a:link,\n.absent a:visited,\n.absent a:hover,\n.absent * {\n color:#bbb !important;\n cursor:default !important;\n text-decoration:none !important;\n}\n\n#api-level-toggle a,\n.api-level a {\n color:inherit;\n text-decoration:none;\n}\n\n#api-level-toggle a:hover,\n.api-level a:hover {\n color:inherit;\n text-decoration:underline !important;\n cursor:pointer !important;\n}\n\n#side-nav li.absent.selected,\n#side-nav li.absent.selected *,\n#side-nav div.label.absent.selected,\n#side-nav div.label.absent.selected * {\n background-color:#eaeaea !important;\n}\n/* IE6 quirk (won't chain classes, so just keep background blue) */\n* html #side-nav li.selected,\n* html #side-nav li.selected *,\n* html #side-nav div.label.selected,\n* html #side-nav div.label.selected * {\n background-color: #435a6e !important;\n}\n\n\n.absent h4.jd-details-title,\n.absent h4.jd-details-title * {\n background-color:#f6f6f6 !important;\n}\n\n.absent img {\n opacity: .3;\n filter: alpha(opacity=30);\n -ms-filter:\"progid:DXImageTransform.Microsoft.Alpha(Opacity=30)\";\n}\n\n\n/* applies to a div containing links to summary tables */\n.sum-details-links {\n padding:0;\n font-weight:normal;\n}\n\n.sum-details-links a {\n text-decoration:none;\n}\n\n.sum-details-links a:hover {\n text-decoration:underline;\n}\n\n\n/* inheritance table */\n.jd-inheritance-table {\n border-spacing:0;\n margin:0;\n padding:0;\n font-size:.9em;\n}\n.jd-inheritance-table td {\n border: none;\n margin: 0;\n padding: 0;\n}\n.jd-inheritance-table .jd-inheritance-space {\n font-weight:bold;\n width:1em;\n}\n.jd-inheritance-table .jd-inheritance-interface-cell {\n padding-left: 17px;\n}\n\n#jd-content {\n padding: 18px 15px;\n}\n\nhr {\n background-color:#ccc;\n border-color:#fff;\n margin:2em 0 1em;\n}\n\n/* DOC CLASSES */\n\n#jd-content h1 {\n/*sdk page*/\n font-size:1.6em;\n color:#336666;\n margin:0 0 .5em;\n}\n\n#jd-content h2 {\n font-size:1.45em;\n color:#111;\n border-top:2px solid #ccc;\n padding: .5em 0 0;\n margin: 2em 0 1em 0;\n}\n\n#jd-content h3 {\n font-size:1.2em;\n color:#222;\n padding: .75em 0 .65em 0;\n margin:0;\n}\n\n#jd-content h4 {\n font-size:1.1em;\n margin-bottom:.5em;\n color:#222;\n}\n\n#jd-content .small-header {\n font-size:1em;\n color:#000;\n font-weight:bold;\n border:none;\n padding:0;\n margin:1em 0 .5em;\n position:inherit;\n}\n\n#jd-content table {\n margin: 0 0 1em 1em;\n}\n\n#jd-content img {\n margin: 0 0 1em 1em;\n}\n\n#jd-content li img,\n#jd-content dd img {\n margin:.5em 0 0 1em;\n}\n\n.nolist {\n list-style:none;\n padding:0;\n margin:0 0 1em 1em;\n}\n\n.nolist li {\n padding:0 0 2px;\n margin:0;\n}\n\nh4 .normal {\n font-size:.9em;\n font-weight:normal;\n}\n\n.caps {\n font-variant:small-caps;\n font-size:1.2em;\n}\n\ndl.tag-list dl.atn-list {\n padding:0 0 0 2em;\n}\n\n.jd-details {\n/* border:1px solid #669999;\n padding:4px; */\n margin:0 0 1em;\n}\n\n/* API reference: a container for the\n.tagdata blocks that make up the detailed\ndescription */\n.jd-details-descr {\n padding:0;\n margin:.5em .25em;\n}\n\n/* API reference: a block containing\na detailed description, a params table,\nseealso list, etc */\n.jd-tagdata {\n margin:.5em 1em;\n}\n\n.jd-tagdata p {\n margin:0 0 1em 1em;\n}\n\n/* API reference: adjustments to\nthe detailed description block */\n.jd-tagdescr {\n margin:.25em 0 .75em 0;\n line-height:1em;\n}\n\n.jd-tagdescr p {\n margin:.5em 0;\n padding:0;\n\n}\n\n.jd-tagdescr ol,\n.jd-tagdescr ul {\n margin:0 2.5em;\n padding:0;\n}\n\n.jd-tagdescr table,\n.jd-tagdescr img {\n margin:.25em 1em;\n}\n\n.jd-tagdescr li {\nmargin:0 0 .25em 0;\npadding:0;\n}\n\n/* API reference: heading marking\nthe details section for constants,\nattrs, methods, etc. */\nh4.jd-details-title {\n font-size:1.15em;\n background-color: #E2E2E2;\n margin:1.5em 0 .6em;\n padding:3px 95px 3px 3px; /* room for api-level */\n}\n\nh4.jd-tagtitle {\n margin:0;\n}\n\n/* API reference: heading for \"Parameters\", \"See Also\", etc.,\nin details sections */\nh5.jd-tagtitle {\n margin:0 0 .25em 0;\n font-size:1em;\n}\n\n.jd-tagtable {\n margin:0;\n}\n\n.jd-tagtable td,\n.jd-tagtable th {\n border:none;\n background-color:#fff;\n vertical-align:top;\n font-weight:normal;\n padding:2px 10px;\n}\n\n.jd-tagtable th {\n font-style:italic;\n}\n\n#jd-content table h2 {\n background-color: #d6d6d6;\n font-size: 1.1em;\n margin:0 0 10px;\n padding:5px;\n left:0;\n width:auto;\n}\n\ndiv.special {\n padding: .5em 1em 1em 1em;\n margin: 0 0 1em;\n background-color: #DAF3FC;\n border:1px solid #d3ecf5;\n border-radius:5px;\n -moz-border-radius:5px;\n -webkit-border-radius:5px;\n}\n\n.toggle-content-toggleme {\n display:none;\n}\n\n.toggle-content-button {\n font-size:.9em;\n line-height:.9em;\n text-decoration:none;\n position:relative;\n top:5px;\n}\n\n.toggle-content-button:hover {\n text-decoration:underline;\n}\n\ndiv.special p {\n margin: .5em 0 0 0;\n}\n\ndiv.special ol {\n margin: 0;\n}\n\ndiv.special ol li {\n margin: 0;\n padding: 0;\n}\n\n#jd-content div.special h2,\n#jd-content div.special h3 {\n color:#669999;\n font-size:1.2em;\n border:none;\n margin:0 0 .5em;\n padding:0;\n}\n\np.note, p.caution, p.warning {\n margin: 1em;\n padding: 0 0 0 .5em;\n border-left: 4px solid;\n}\n\np.special-note {\n background-color:#EBF3DB;\n padding:10px 20px;\n margin:0 0 1em;\n}\n\np.note {\n border-color: #99aacc;\n}\n\np.warning {\n border-color: #aa0033;\n}\n\np.caution {\n border-color: #ffcf00;\n}\n\np.warning b, p.warning strong {\n font-weight: bold;\n}\n\nli p.note, li p.warning {\n margin: .5em 0 0 0;\n padding: .2em .5em .2em .9em;\n}\n\ndl.xml dt {\n font-variant:small-caps;\n font-size:1.2em;\n}\n\ndl.xml dl {\n padding:0;\n}\n\ndl.xml dl dt {\n font-variant:normal;\n font-size:1em;\n}\n\n.listhead li {\n font-weight: bold;\n}\n\n.listhead li *, /*ie*/.listhead li li {\n font-weight: normal;\n}\n\nol.no-style,\nul.no-style {\n list-style:none;\n padding-left:1em;\n}\n\n.new {\n font-size: .78em;\n font-weight: bold;\n color: #ff3d3d;\n text-decoration: none;\n vertical-align:top;\n line-height:.9em;\n}\n\npre.classic {\n background-color:transparent;\n border:none;\n padding:0;\n}\n\np.img-caption {\n margin: -0.5em 0 1em 1em; /* matches default img left-margin */\n}\n\ndiv.figure {\n float:right;\n clear:right;\n margin:1em 0 0 3em;\n padding:0;\n background-color:#fff;\n /* width must be defined w/ an inline style matching the image width */\n}\n\n#jd-content\ndiv.figure img {\n margin: 0 0 1em;\n}\n\ndiv.figure p.img-caption {\n margin: -0.5em 0 1em 0;\n}\n\np.table-caption {\n margin: 0 0 0.5em 1em; /* matches default table left-margin */\n}\n\n/* Begin sidebox sidebar element styles */\n\n.sidebox-wrapper {\n float:right;\n clear:right;\n width:310px; /* +35px padding */\n background-color:#fff;\n margin:0;\n padding:0 0 20px 35px;\n}\n\n.sidebox {\n border-left:1px solid #dee8f1;\n background-color:#ffffee;\n margin:0;\n padding:8px 12px;\n font-size:0.9em;\n width:285px; /* +24px padding; +1px border */\n}\n\n.sidebox p {\n margin-bottom: .25em;\n}\n\n.sidebox ul {\n padding: 0 0 0 1.5em;\n}\n\n.sidebox li ul {\n margin-top:0;\n margin-bottom:.1em;\n}\n\n.sidebox li {\npadding:0 0 0 0em;\n}\n\n#jd-content .sidebox h2,\n#jd-content .sidebox h3,\n#jd-content .sidebox h4,\n#jd-content .sidebox h5 {\n border:none;\n font-size:1em;\n margin:0;\n padding:0 0 8px;\n left:0;\n z-index:0;\n}\n\n.sidebox hr {\n background-color:#ccc;\n border:none;\n}\n\n/* End sidebox sidebar element styles */\n\n/* table of contents */\n\nol.toc {\n margin: 0 0 1em 0;\n padding: 0;\n list-style: none;\n font-size:95%;\n}\n\nol.toc li {\n font-weight: bold;\n margin: 0 0 .5em 1em;\n padding: 0;\n}\n\nol.toc li p {\n font-weight: normal;\n}\n\nol.toc li ol {\n margin: 0;\n padding: 0;\n}\n\nol.toc li li {\n padding: 0;\n margin: 0 0 0 1em;\n font-weight: normal;\n list-style: none;\n}\n\ntable ol.toc {\n margin-left: 0;\n}\n\n.columns td {\n padding:0 5px;\n border:none;\n}\n\n/* link table */\n.jd-linktable {\n margin: 0 0 1em;\n border-bottom: 1px solid #888;\n}\n.jd-linktable th,\n.jd-linktable td {\n padding: 3px 5px;\n vertical-align: top;\n text-align: left;\n border:none;\n}\n.jd-linktable tr {\n background-color: #fff;\n}\n.jd-linktable td {\n border-top: 1px solid #888;\n background-color: inherit;\n}\n.jd-linktable td p {\n padding: 0 0 5px;\n}\n.jd-linktable .jd-linkcol {\n}\n.jd-linktable .jd-descrcol {\n}\n.jd-linktable .jd-typecol {\n text-align:right;\n white-space: nowrap;\n}\n.jd-linktable .jd-valcol {\n}\n.jd-linktable .jd-commentrow {\n border-top:none;\n padding-left:25px;\n}\n.jd-deprecated-warning {\n margin-top: 0;\n margin-bottom: 10px;\n}\n\ntr.alt-color {\n background-color: #f6f6f6;\n}\n\n/* expando trigger */\n#jd-content .jd-expando-trigger-img {\n margin:0;\n}\n\n/* jd-expando */\n.jd-inheritedlinks {\n padding:0 0 0 13px\n}\n\n/* SDK PAGE */\ntable.download tr {\n background-color:#d9d9d9;\n}\n\ntable.download tr.alt-color {\n background-color:#ededed;\n}\n\ntable.download td,\ntable.download th {\n border:2px solid #fff;\n padding:10px 5px;\n}\n\ntable.download th {\n background-color:#6d8293;\n color:#fff;\n}\n\n/* INLAY 180 COPY and 240PX EXTENSION */\n/* modified to 43px so that all browsers eliminate the package panel h-scroll */\n.g-tpl-240 .g-unit,\n.g-unit .g-tpl-240 .g-unit,\n.g-unit .g-unit .g-tpl-240 .g-unit {\n display: block;\n margin: 0 0 0 243px;\n width: auto;\n float: none;\n}\n.g-unit .g-unit .g-tpl-240 .g-first,\n.g-unit .g-tpl-240 .g-first,\n.g-tpl-240 .g-first {\n display: block;\n margin: 0;\n width: 243px;\n float: left;\n}\n/* 240px alt */\n.g-tpl-240-alt .g-unit,\n.g-unit .g-tpl-240-alt .g-unit,\n.g-unit .g-unit .g-tpl-240-alt .g-unit {\n display: block;\n margin: 0 243px 0 0;\n width: auto;\n float: none;\n}\n.g-unit .g-unit .g-tpl-240-alt .g-first,\n.g-unit .g-tpl-240-alt .g-first,\n.g-tpl-240-alt .g-first {\n display: block;\n margin: 0;\n width: 243px;\n float: right;\n}\n\n/* 180px */\n.g-tpl-180 .g-unit,\n.g-unit .g-tpl-180 .g-unit,\n.g-unit .g-unit .g-tpl-180 .g-unit {\n display: block;\n margin: 0 0 0 180px;\n width: auto;\n float: none;\n}\n.g-unit .g-unit .g-tpl-180 .g-first,\n.g-unit .g-tpl-180 .g-first,\n.g-tpl-180 .g-first {\n display: block;\n margin: 0;\n width: 180px;\n float: left;\n}\n/* 180px alt */\n.g-tpl-180-alt .g-unit,\n.g-unit .g-tpl-180-alt .g-unit,\n.g-unit .g-unit .g-tpl-180-alt .g-unit {\n display: block;\n margin: 0 180px 0 0;\n width: auto;\n float: none;\n}\n.g-unit .g-unit .g-tpl-180-alt .g-first,\n.g-unit .g-tpl-180-alt .g-first,\n.g-tpl-180-alt .g-first {\n display: block;\n margin: 0;\n width: 180px;\n float: right;\n}\n\n\n/* JQUERY RESIZABLE STYLES */\n.ui-resizable { position: relative; }\n.ui-resizable-handle { position: absolute; display: none; font-size: 0.1px; z-index:1; }\n.ui-resizable .ui-resizable-handle { display: block; }\nbody .ui-resizable-disabled .ui-resizable-handle { display: none; }\nbody .ui-resizable-autohide .ui-resizable-handle { display: none; }\n.ui-resizable-s { cursor: s-resize; height: 6px; width: 100%; bottom: 0px; left: 0px;\n background: transparent url(\"images/resizable-s2.gif\") repeat scroll center top; }\n.ui-resizable-e { cursor: e-resize; width: 6px; right: 0px; top: 0px; height: 100%;\n background: transparent url(\"images/resizable-e2.gif\") repeat scroll right center; }\n\n@media print {\n\n body {\n overflow:visible;\n }\n\n #header {\n height:50px;\n }\n\n #header-tabs,\n #headerRight,\n #side-nav,\n #api-info-block {\n display:none;\n }\n\n #body-content {\n position:inherit;\n }\n\n #doc-content {\n margin-left:0 !important;\n height:auto !important;\n width:auto !important;\n overflow:inherit;\n display:inline;\n }\n\n #jd-header {\n padding:10px 0;\n }\n\n #jd-content {\n padding:15px 0 0;\n }\n\n #footer {\n float:none;\n margin:2em 0 0;\n }\n\n h4.jd-details-title {\n border-bottom:1px solid #666;\n }\n\n pre {\n /* these allow lines to break (if there's a white space) */\n overflow: visible;\n text-wrap: unrestricted;\n white-space: -moz-pre-wrap; /* Moz */\n white-space: -pre-wrap; /* Opera 4-6 */\n white-space: -o-pre-wrap; /* Opera 7 */\n white-space: pre-wrap; /* CSS3 */\n word-wrap: break-word; /* IE 5.5+ */\n }\n\n h1, h2, h3, h4, h5, h6 {\n page-break-after: avoid;\n }\n\n table, img {\n page-break-inside: avoid;\n }\n" }, { "path": "docs/javadoc/assets/doclava-developer-docs.js", "content": "var resizePackagesNav;\nvar classesNav;\nvar devdocNav;\nvar sidenav;\nvar content;\nvar HEADER_HEIGHT = -1;\nvar cookie_namespace = 'doclava_developer';\nvar NAV_PREF_TREE = \"tree\";\nvar NAV_PREF_PANELS = \"panels\";\nvar nav_pref;\nvar toRoot;\nvar toAssets;\nvar isMobile = false; // true if mobile, so we can adjust some layout\nvar isIE6 = false; // true if IE6\n\n// TODO: use $(document).ready instead\nfunction addLoadEvent(newfun) {\n var current = window.onload;\n if (typeof window.onload != 'function') {\n window.onload = newfun;\n } else {\n window.onload = function() {\n current();\n newfun();\n }\n }\n}\n\nvar agent = navigator['userAgent'].toLowerCase();\n// If a mobile phone, set flag and do mobile setup\nif ((agent.indexOf(\"mobile\") != -1) || // android, iphone, ipod\n (agent.indexOf(\"blackberry\") != -1) ||\n (agent.indexOf(\"webos\") != -1) ||\n (agent.indexOf(\"mini\") != -1)) { // opera mini browsers\n isMobile = true;\n addLoadEvent(mobileSetup);\n// If not a mobile browser, set the onresize event for IE6, and others\n} else if (agent.indexOf(\"msie 6\") != -1) {\n isIE6 = true;\n addLoadEvent(function() {\n window.onresize = resizeAll;\n });\n} else {\n addLoadEvent(function() {\n window.onresize = resizeHeight;\n });\n}\n\nfunction mobileSetup() {\n $(\"body\").css({'overflow':'auto'});\n $(\"html\").css({'overflow':'auto'});\n $(\"#body-content\").css({'position':'relative', 'top':'0'});\n $(\"#doc-content\").css({'overflow':'visible', 'border-left':'3px solid #DDD'});\n $(\"#side-nav\").css({'padding':'0'});\n $(\"#nav-tree\").css({'overflow-y': 'auto'});\n}\n\n/* loads the lists.js file to the page.\nLoading this in the head was slowing page load time */\naddLoadEvent( function() {\n var lists = document.createElement(\"script\");\n lists.setAttribute(\"type\",\"text/javascript\");\n lists.setAttribute(\"src\", toRoot+\"lists.js\");\n document.getElementsByTagName(\"head\")[0].appendChild(lists);\n} );\n\naddLoadEvent( function() {\n $(\"pre:not(.no-pretty-print)\").addClass(\"prettyprint\");\n prettyPrint();\n} );\n\nfunction setToRoot(root, assets) {\n toRoot = root;\n toAssets = assets;\n // note: toRoot also used by carousel.js\n}\n\nfunction restoreWidth(navWidth) {\n var windowWidth = $(window).width() + \"px\";\n content.css({marginLeft:parseInt(navWidth) + 6 + \"px\"}); //account for 6px-wide handle-bar\n\n if (isIE6) {\n content.css({width:parseInt(windowWidth) - parseInt(navWidth) - 6 + \"px\"}); // necessary in order for scrollbars to be visible\n }\n\n sidenav.css({width:navWidth});\n resizePackagesNav.css({width:navWidth});\n classesNav.css({width:navWidth});\n $(\"#packages-nav\").css({width:navWidth});\n}\n\nfunction restoreHeight(packageHeight) {\n var windowHeight = ($(window).height() - HEADER_HEIGHT);\n var swapperHeight = windowHeight - 13;\n $(\"#swapper\").css({height:swapperHeight + \"px\"});\n sidenav.css({height:windowHeight + \"px\"});\n content.css({height:windowHeight + \"px\"});\n resizePackagesNav.css({maxHeight:swapperHeight + \"px\", height:packageHeight});\n classesNav.css({height:swapperHeight - parseInt(packageHeight) + \"px\"});\n $(\"#packages-nav\").css({height:parseInt(packageHeight) - 6 + \"px\"}); //move 6px to give space for the resize handle\n devdocNav.css({height:sidenav.css(\"height\")});\n $(\"#nav-tree\").css({height:swapperHeight + \"px\"});\n}\n\nfunction readCookie(cookie) {\n var myCookie = cookie_namespace+\"_\"+cookie+\"=\";\n if (document.cookie) {\n var index = document.cookie.indexOf(myCookie);\n if (index != -1) {\n var valStart = index + myCookie.length;\n var valEnd = document.cookie.indexOf(\";\", valStart);\n if (valEnd == -1) {\n valEnd = document.cookie.length;\n }\n var val = document.cookie.substring(valStart, valEnd);\n return val;\n }\n }\n return 0;\n}\n\nfunction writeCookie(cookie, val, section, expiration) {\n if (val==undefined) return;\n section = section == null ? \"_\" : \"_\"+section+\"_\";\n if (expiration == null) {\n var date = new Date();\n date.setTime(date.getTime()+(10*365*24*60*60*1000)); // default expiration is one week\n expiration = date.toGMTString();\n }\n document.cookie = cookie_namespace + section + cookie + \"=\" + val + \"; expires=\" + expiration+\"; path=/\";\n}\n\nfunction getSection() {\n if (location.href.indexOf(\"/reference/\") != -1) {\n return \"reference\";\n } else if (location.href.indexOf(\"/guide/\") != -1) {\n return \"guide\";\n } else if (location.href.indexOf(\"/resources/\") != -1) {\n return \"resources\";\n }\n var basePath = getBaseUri(location.pathname);\n return basePath.substring(1,basePath.indexOf(\"/\",1));\n}\n\nfunction init() {\n HEADER_HEIGHT = $(\"#header\").height()+3;\n $(\"#side-nav\").css({position:\"absolute\",left:0});\n content = $(\"#doc-content\");\n resizePackagesNav = $(\"#resize-packages-nav\");\n classesNav = $(\"#classes-nav\");\n sidenav = $(\"#side-nav\");\n devdocNav = $(\"#devdoc-nav\");\n\n var cookiePath = getSection() + \"_\";\n\n if (!isMobile) {\n $(\"#resize-packages-nav\").resizable({handles: \"s\", resize: function(e, ui) { resizePackagesHeight(); } });\n $(\".side-nav-resizable\").resizable({handles: \"e\", resize: function(e, ui) { resizeWidth(); } });\n var cookieWidth = readCookie(cookiePath+'width');\n var cookieHeight = readCookie(cookiePath+'height');\n if (cookieWidth) {\n restoreWidth(cookieWidth);\n } else if ($(\".side-nav-resizable\").length) {\n resizeWidth();\n }\n if (cookieHeight) {\n restoreHeight(cookieHeight);\n } else {\n resizeHeight();\n }\n }\n\n if (devdocNav.length) { // only dev guide, resources, and sdk\n tryPopulateResourcesNav();\n highlightNav(location.href);\n }\n}\n\nfunction highlightNav(fullPageName) {\n var lastSlashPos = fullPageName.lastIndexOf(\"/\");\n var firstSlashPos;\n if (fullPageName.indexOf(\"/guide/\") != -1) {\n firstSlashPos = fullPageName.indexOf(\"/guide/\");\n } else if (fullPageName.indexOf(\"/sdk/\") != -1) {\n firstSlashPos = fullPageName.indexOf(\"/sdk/\");\n } else {\n firstSlashPos = fullPageName.indexOf(\"/resources/\");\n }\n if (lastSlashPos == (fullPageName.length - 1)) { // if the url ends in slash (add 'index.html')\n fullPageName = fullPageName + \"index.html\";\n }\n // First check if the exact URL, with query string and all, is in the navigation menu\n var pathPageName = fullPageName.substr(firstSlashPos);\n var link = $(\"#devdoc-nav a[href$='\"+ pathPageName+\"']\");\n if (link.length == 0) {\n var htmlPos = fullPageName.lastIndexOf(\".html\", fullPageName.length);\n pathPageName = fullPageName.slice(firstSlashPos, htmlPos + 5); // +5 advances past \".html\"\n link = $(\"#devdoc-nav a[href$='\"+ pathPageName+\"']\");\n if ((link.length == 0) && ((fullPageName.indexOf(\"/guide/\") != -1) || (fullPageName.indexOf(\"/resources/\") != -1))) {\n // if there's no match, then let's backstep through the directory until we find an index.html page\n // that matches our ancestor directories (only for dev guide and resources)\n lastBackstep = pathPageName.lastIndexOf(\"/\");\n while (link.length == 0) {\n backstepDirectory = pathPageName.lastIndexOf(\"/\", lastBackstep);\n link = $(\"#devdoc-nav a[href$='\"+ pathPageName.slice(0, backstepDirectory + 1)+\"index.html']\");\n lastBackstep = pathPageName.lastIndexOf(\"/\", lastBackstep - 1);\n if (lastBackstep == 0) break;\n }\n }\n }\n\n // add 'selected' to the
  • or
  • ) and the parent