136 lines
6.2 KiB
Objective-C
136 lines
6.2 KiB
Objective-C
/*
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import <UIKit/UIKit.h>
|
|
|
|
#import <React/RCTBridge.h>
|
|
#import <React/RCTImageCache.h>
|
|
#import <React/RCTImageDataDecoder.h>
|
|
#import <React/RCTImageURLLoader.h>
|
|
#import <React/RCTResizeMode.h>
|
|
#import <React/RCTURLRequestHandler.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
* If available, RCTImageRedirectProtocol is invoked before loading an asset.
|
|
* Implementation should return either a new URL or nil when redirection is
|
|
* not needed.
|
|
*/
|
|
|
|
@protocol RCTImageRedirectProtocol
|
|
|
|
- (NSURL *)redirectAssetsURL:(NSURL *)URL;
|
|
|
|
@end
|
|
|
|
/**
|
|
* Image Downloading priority.
|
|
* Use PriorityImmediate to download images at the highest priority.
|
|
* Use PriorityPrefetch to prefetch images at a lower priority.
|
|
* The priority logic is up to each @RCTImageLoaderProtocol implementation
|
|
*/
|
|
typedef NS_ENUM(NSInteger, RCTImageLoaderPriority) { RCTImageLoaderPriorityImmediate, RCTImageLoaderPriorityPrefetch };
|
|
|
|
@protocol RCTImageLoaderProtocol <RCTURLRequestHandler>
|
|
|
|
/**
|
|
* The maximum number of concurrent image loading tasks. Loading and decoding
|
|
* images can consume a lot of memory, so setting this to a higher value may
|
|
* cause memory to spike. If you are seeing out-of-memory crashes, try reducing
|
|
* this value.
|
|
*/
|
|
@property (nonatomic, assign) NSUInteger maxConcurrentLoadingTasks;
|
|
|
|
/**
|
|
* The maximum number of concurrent image decoding tasks. Decoding large
|
|
* images can be especially CPU and memory intensive, so if your are decoding a
|
|
* lot of large images in your app, you may wish to adjust this value.
|
|
*/
|
|
@property (nonatomic, assign) NSUInteger maxConcurrentDecodingTasks;
|
|
|
|
/**
|
|
* Decoding large images can use a lot of memory, and potentially cause the app
|
|
* to crash. This value allows you to throttle the amount of memory used by the
|
|
* decoder independently of the number of concurrent threads. This means you can
|
|
* still decode a lot of small images in parallel, without allowing the decoder
|
|
* to try to decompress multiple huge images at once. Note that this value is
|
|
* only a hint, and not an indicator of the total memory used by the app.
|
|
*/
|
|
@property (nonatomic, assign) NSUInteger maxConcurrentDecodingBytes;
|
|
|
|
/**
|
|
* Loads the specified image at the highest available resolution.
|
|
* Can be called from any thread, will call back on an unspecified thread.
|
|
*/
|
|
- (nullable RCTImageLoaderCancellationBlock)loadImageWithURLRequest:(NSURLRequest *)imageURLRequest
|
|
callback:(RCTImageLoaderCompletionBlock)callback;
|
|
/**
|
|
* As above, but includes download `priority`.
|
|
*/
|
|
- (nullable RCTImageLoaderCancellationBlock)loadImageWithURLRequest:(NSURLRequest *)imageURLRequest
|
|
priority:(RCTImageLoaderPriority)priority
|
|
callback:(RCTImageLoaderCompletionBlock)callback;
|
|
|
|
/**
|
|
* As above, but includes target `size`, `scale` and `resizeMode`, which are used to
|
|
* select the optimal dimensions for the loaded image. The `clipped` option
|
|
* controls whether the image will be clipped to fit the specified size exactly,
|
|
* or if the original aspect ratio should be retained.
|
|
* `partialLoadBlock` is meant for custom image loaders that do not ship with the core RN library.
|
|
* It is meant to be called repeatedly while loading the image as higher quality versions are decoded,
|
|
* for instance with progressive JPEGs.
|
|
*/
|
|
- (nullable RCTImageLoaderCancellationBlock)loadImageWithURLRequest:(NSURLRequest *)imageURLRequest
|
|
size:(CGSize)size
|
|
scale:(CGFloat)scale
|
|
clipped:(BOOL)clipped
|
|
resizeMode:(RCTResizeMode)resizeMode
|
|
progressBlock:(RCTImageLoaderProgressBlock)progressBlock
|
|
partialLoadBlock:(RCTImageLoaderPartialLoadBlock)partialLoadBlock
|
|
completionBlock:(RCTImageLoaderCompletionBlock)completionBlock;
|
|
|
|
/**
|
|
* Finds an appropriate image decoder and passes the target `size`, `scale` and
|
|
* `resizeMode` for optimal image decoding. The `clipped` option controls
|
|
* whether the image will be clipped to fit the specified size exactly, or
|
|
* if the original aspect ratio should be retained. Can be called from any
|
|
* thread, will call callback on an unspecified thread.
|
|
*/
|
|
- (RCTImageLoaderCancellationBlock)decodeImageData:(NSData *)imageData
|
|
size:(CGSize)size
|
|
scale:(CGFloat)scale
|
|
clipped:(BOOL)clipped
|
|
resizeMode:(RCTResizeMode)resizeMode
|
|
completionBlock:(RCTImageLoaderCompletionBlock)completionBlock;
|
|
|
|
/**
|
|
* Get image size, in pixels. This method will do the least work possible to get
|
|
* the information, and won't decode the image if it doesn't have to.
|
|
*/
|
|
- (RCTImageLoaderCancellationBlock)getImageSizeForURLRequest:(NSURLRequest *)imageURLRequest
|
|
block:(void (^)(NSError *error, CGSize size))completionBlock;
|
|
/**
|
|
* Determines whether given image URLs are cached locally. The `requests` array is expected
|
|
* to contain objects convertible to NSURLRequest. The return value maps URLs to strings:
|
|
* "disk" for images known to be cached in non-volatile storage, "memory" for images known
|
|
* to be cached in memory. Dictionary items corresponding to images that are not known to be
|
|
* cached are simply missing.
|
|
*/
|
|
- (NSDictionary *)getImageCacheStatus:(NSArray *)requests;
|
|
|
|
/**
|
|
* Allows developers to set their own caching implementation for
|
|
* decoded images as long as it conforms to the RCTImageCache
|
|
* protocol. This method should be called in bridgeDidInitializeModule.
|
|
*/
|
|
- (void)setImageCache:(id<RCTImageCache>)cache;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|