mirror of https://github.com/oxen-io/session-ios
Removed YYImage and libWebP, fixed a couple of bugs
• Removed YYImage and libWebP dependencies (replaced with custom `AnimatedImageView` class) • Fixed an issue where animated images (WebP/GIF) may not correctly render in the "All Media" grid UI • Fixed an issue where selecting a GIF for the display picture would incorrectly convert it into a JPG instead of keeping the GIFpull/1061/head
Morgan Pretty
1 week ago
parent
fab3b5683f
commit
417976995b
@ -0,0 +1,91 @@
|
||||
# Building
|
||||
|
||||
We typically develop against the latest stable version of Xcode.
|
||||
|
||||
As of this writing, that's Xcode 12.4
|
||||
|
||||
## Prerequistes
|
||||
|
||||
Install [CocoaPods](https://guides.cocoapods.org/using/getting-started.html).
|
||||
|
||||
## 1. Clone
|
||||
|
||||
Clone the repo to a working directory:
|
||||
|
||||
```
|
||||
git clone https://github.com/oxen-io/session-ios.git
|
||||
```
|
||||
|
||||
**Recommendation:**
|
||||
|
||||
We recommend you fork the repo on GitHub, then clone your fork:
|
||||
|
||||
```
|
||||
git clone https://github.com/<USERNAME>/session-ios.git
|
||||
```
|
||||
|
||||
You can then add the Session repo to sync with upstream changes:
|
||||
|
||||
```
|
||||
git remote add upstream https://github.com/oxen-io/session-ios
|
||||
```
|
||||
|
||||
## 2. Submodules
|
||||
|
||||
Session requires a number of submodules to build, these can be retrieved by navigating to the project directory and running:
|
||||
|
||||
```
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
## 3. libSession build dependencies
|
||||
|
||||
The iOS project has a share C++ library called `libSession` which is built as one of the project dependencies, in order for this to compile the following dependencies need to be installed:
|
||||
- cmake
|
||||
- m4
|
||||
- pkg-config
|
||||
|
||||
These can be installed with Homebrew via `brew install cmake m4 pkg-config`
|
||||
|
||||
Additionally `xcode-select` needs to be setup correctly (depending on the order of installation it can point to the wrong directory and result in a build error similar to `tool '{name}' requires Xcode, but active developer directory '/Library/Developer/CommandLineTools' is a command line tools instance`), this can be setup correctly by running:
|
||||
|
||||
`sudo xcode-select -s /Applications/Xcode.app/Contents/Developer`
|
||||
|
||||
## 4. Xcode
|
||||
|
||||
Open the `Session.xcodeproj` in Xcode.
|
||||
|
||||
```
|
||||
open Session.xcodeproj
|
||||
```
|
||||
|
||||
In the TARGETS area of the General tab, change the Team dropdown to
|
||||
your own. You will need to do that for all the listed targets, e.g.
|
||||
Session, SessionShareExtension, and SessionNotificationServiceExtension. You
|
||||
will need an Apple Developer account for this.
|
||||
|
||||
On the Capabilities tab, turn off Push Notifications and Data Protection,
|
||||
while keeping Background Modes on. The App Groups capability will need to
|
||||
remain on in order to access the shared data storage.
|
||||
|
||||
Build and Run and you are ready to go!
|
||||
|
||||
## Known issues
|
||||
|
||||
### Address & Undefined Behaviour Sanitizer Linker Errors
|
||||
It seems that there is an open issue with Swift Package Manager (https://github.com/swiftlang/swift-package-manager/issues/4407) where some packages (in our case `libwebp`) run into issues when the Address Sanitizer or Undefined Behaviour Sanitizer are enabled within the scheme, if you see linker errors like the below when building this is likely the issue and can be resolved by disabling these sanitisers.
|
||||
|
||||
In order to still benefit from these settings they are explicitly set as `Other C Flags` for the `SessionUtil` target when building in debug mode to enable better debugging of `libSession`.
|
||||
```
|
||||
Undefined symbol: ___asan_init
|
||||
Undefined symbol: ___ubsan_handle_add_overflow
|
||||
```
|
||||
|
||||
### Third-party Installation
|
||||
The database for the app is stored within an `App Group` directory which is based on the app identifier, unfortunately the identifier cannot be retrieved at runtime so it's currently hard-coded in the code. In order to be able to run session on a device you will need to update the `UserDefaults.applicationGroup` variable in `SessionUtilitiesKit/General/SNUserDefaults` to match the value provided (You may also need to create the `App Group` on your Apple Developer account).
|
||||
|
||||
### Push Notifications
|
||||
Features related to push notifications are known to be not working for
|
||||
third-party contributors since Apple's Push Notification service pushes
|
||||
will only work with the Session production code signing
|
||||
certificate.
|
||||
@ -0,0 +1,129 @@
|
||||
// Copyright © 2025 Rangeproof Pty Ltd. All rights reserved.
|
||||
|
||||
import UIKit
|
||||
import ImageIO
|
||||
|
||||
public class AnimatedImageView: UIImageView {
|
||||
private var imageSource: CGImageSource?
|
||||
private var frameCount: Int = 0
|
||||
private var frameDurations: [TimeInterval] = []
|
||||
private var totalDuration: TimeInterval = 0
|
||||
private var displayLink: CADisplayLink?
|
||||
private var currentFrame: Int = 0
|
||||
private var currentTime: TimeInterval = 0
|
||||
|
||||
// MARK: - Functions
|
||||
|
||||
public func loadAnimatedImage(from path: String) {
|
||||
loadAnimatedImage(from: URL(fileURLWithPath: path))
|
||||
}
|
||||
|
||||
public func loadAnimatedImage(from url: URL) {
|
||||
guard let imageSource: CGImageSource = CGImageSourceCreateWithURL(url as CFURL, nil) else { return }
|
||||
|
||||
loadAnimatedImage(from: imageSource)
|
||||
}
|
||||
|
||||
public func loadAnimatedImage(from data: Data?) {
|
||||
guard
|
||||
let data: Data = data,
|
||||
let imageSource: CGImageSource = CGImageSourceCreateWithData(data as CFData, nil)
|
||||
else { return }
|
||||
|
||||
loadAnimatedImage(from: imageSource)
|
||||
}
|
||||
|
||||
// MARK: - Internal Functions
|
||||
|
||||
private func loadAnimatedImage(from source: CGImageSource) {
|
||||
self.imageSource = source
|
||||
self.frameCount = CGImageSourceGetCount(source)
|
||||
|
||||
guard frameCount > 1 else {
|
||||
self.image = createImage(at: 0)
|
||||
return
|
||||
}
|
||||
|
||||
calculateFrameDurations()
|
||||
startAnimation()
|
||||
}
|
||||
|
||||
private func calculateFrameDurations() {
|
||||
frameDurations = []
|
||||
totalDuration = 0
|
||||
|
||||
for i in 0..<frameCount {
|
||||
let duration = frameDuration(at: i)
|
||||
frameDurations.append(duration)
|
||||
totalDuration += duration
|
||||
}
|
||||
}
|
||||
|
||||
private func frameDuration(at index: Int) -> TimeInterval {
|
||||
guard let imageSource: CGImageSource = imageSource, index < frameCount else { return 0.1 }
|
||||
|
||||
guard let frameProperties = CGImageSourceCopyPropertiesAtIndex(imageSource, index, nil) as? [String: Any] else {
|
||||
return 0.1
|
||||
}
|
||||
|
||||
if let gifProps = frameProperties[kCGImagePropertyGIFDictionary as String] as? [String: Any],
|
||||
let delayTime = gifProps[kCGImagePropertyGIFDelayTime as String] as? Double {
|
||||
return delayTime > 0 ? delayTime : 0.1
|
||||
}
|
||||
|
||||
if let webpProps = frameProperties[kCGImagePropertyWebPDictionary as String] as? [String: Any],
|
||||
let delayTime = webpProps[kCGImagePropertyWebPDelayTime as String] as? Double {
|
||||
return delayTime > 0 ? delayTime : 0.1
|
||||
}
|
||||
|
||||
return 0.1
|
||||
}
|
||||
|
||||
private func createImage(at index: Int) -> UIImage? {
|
||||
guard
|
||||
let imageSource: CGImageSource = imageSource,
|
||||
index < frameCount,
|
||||
let cgImage: CGImage = CGImageSourceCreateImageAtIndex(imageSource, index, nil)
|
||||
else { return nil }
|
||||
|
||||
return UIImage(cgImage: cgImage)
|
||||
}
|
||||
|
||||
private func startAnimation() {
|
||||
stopAnimation()
|
||||
currentFrame = 0
|
||||
currentTime = 0
|
||||
|
||||
// Set the initial frame
|
||||
if let image: UIImage = createImage(at: 0) {
|
||||
self.image = image
|
||||
}
|
||||
|
||||
// Add a display link callback to trigger the frame changes
|
||||
displayLink = CADisplayLink(target: self, selector: #selector(updateFrame))
|
||||
displayLink?.add(to: .main, forMode: .common)
|
||||
}
|
||||
|
||||
private func stopAnimation() {
|
||||
displayLink?.invalidate()
|
||||
displayLink = nil
|
||||
}
|
||||
|
||||
@objc private func updateFrame(displayLink: CADisplayLink) {
|
||||
currentTime += displayLink.duration
|
||||
|
||||
if currentTime >= frameDurations[currentFrame] {
|
||||
currentTime = 0
|
||||
currentFrame = (currentFrame + 1) % frameCount
|
||||
|
||||
if let image: UIImage = createImage(at: currentFrame) {
|
||||
self.image = image
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public override func removeFromSuperview() {
|
||||
stopAnimation()
|
||||
super.removeFromSuperview()
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue