-
Notifications
You must be signed in to change notification settings - Fork 239
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix the leak of WebImage with animation and NavigationLink. #163
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| /* | ||
| * This file is part of the SDWebImage package. | ||
| * (c) DreamPiggy <[email protected]> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| import SwiftUI | ||
| import SDWebImage | ||
|
|
||
| /// A Image observable object for handle aniamted image playback. This is used to avoid `@State` update may capture the View struct type and cause memory leak. | ||
| @available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *) | ||
| public final class ImagePlayer : ObservableObject { | ||
| var player: SDAnimatedImagePlayer? | ||
|
|
||
| /// Max buffer size | ||
| public var maxBufferSize: UInt? | ||
|
|
||
| /// Custom loop count | ||
| public var customLoopCount: UInt? | ||
|
|
||
| /// Animation runloop mode | ||
| public var runLoopMode: RunLoop.Mode = .common | ||
|
|
||
| /// Animation playback rate | ||
| public var playbackRate: Double = 1.0 | ||
|
|
||
| deinit { | ||
| player?.stopPlaying() | ||
| currentFrame = nil | ||
| } | ||
|
|
||
| /// Current playing frame image | ||
| @Published public var currentFrame: PlatformImage? | ||
|
|
||
| /// Start the animation | ||
| public func startPlaying() { | ||
| player?.startPlaying() | ||
| } | ||
|
|
||
| /// Pause the animation | ||
| public func pausePlaying() { | ||
| player?.pausePlaying() | ||
| } | ||
|
|
||
| /// Stop the animation | ||
| public func stopPlaying() { | ||
| player?.stopPlaying() | ||
| } | ||
|
|
||
| /// Clear the frame buffer | ||
| public func clearFrameBuffer() { | ||
| player?.clearFrameBuffer() | ||
| } | ||
|
|
||
|
|
||
| /// Setup the player using Animated Image | ||
| /// - Parameter image: animated image | ||
| public func setupPlayer(image: PlatformImage?) { | ||
| if player != nil { | ||
| return | ||
| } | ||
| if let animatedImage = image as? SDAnimatedImageProvider & PlatformImage { | ||
| if let imagePlayer = SDAnimatedImagePlayer(provider: animatedImage) { | ||
| imagePlayer.animationFrameHandler = { [weak self] (_, frame) in | ||
| self?.currentFrame = frame | ||
| } | ||
| // Setup configuration | ||
| if let maxBufferSize = maxBufferSize { | ||
| imagePlayer.maxBufferSize = maxBufferSize | ||
| } | ||
| if let customLoopCount = customLoopCount { | ||
| imagePlayer.totalLoopCount = UInt(customLoopCount) | ||
| } | ||
| imagePlayer.runLoopMode = runLoopMode | ||
| imagePlayer.playbackRate = playbackRate | ||
|
|
||
| self.player = imagePlayer | ||
|
|
||
| // Setup poster frame | ||
| if let cgImage = animatedImage.cgImage { | ||
| currentFrame = PlatformImage(cgImage: cgImage, scale: animatedImage.scale, orientation: .up) | ||
| } else { | ||
| currentFrame = .empty | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here.
From Swift, the struct will not cause retain cycle. However, SwiftUI
@Statewill keep anStorageLocationwith an global mapping, which bind each View struct with the@Statereference type. (Yes, each View struct will keep an reference)So, if we write here, the retain cycle is:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By break off to use ImageManager a pure
ObservableObject, this retain cycle can be avoided.